IntelliJ IDEA 2016.3 Help

Run/Debug Configuration: Spring DM Server (Remote)

Run | Edit Configurations | /help/img/idea/2016.3/new.png | Spring dmServer | Local or Remote


Spring dmServer run/debug configurations let you deploy and debug your applications on SpringSource dm Server and Virgo. (The dmServer Support plugin must be enabled.)

Note that if you are starting the server by means of the default script startup.bat or startup.sh, you should properly set the environment variable JAVA_HOME.

See also, Working with Server Run/Debug Configurations.

Name field and Share option

ItemDescription
NameUse this field to edit the name of the run/debug configuration.

This field is not available when editing the run/debug configuration defaults.

Share Select this check box to make the run/debug configuration available to other team members.

If the directory-based project format is used, the settings for a run/debug configuration are stored in a separate .xml file in the .idea\runConfigurations folder if the run/debug configuration is shared, or in the .idea\workspace.xml file otherwise.

If the file-based format is used, the settings are stored in the .ipr file for shared configurations, or in the .iws file otherwise.

This check box is not available when editing the run/debug configuration defaults.

Server tab for a remote configuration

ItemDescription
Application server Select the server configuration to be used. Note that this is a local server configuration. (When working with a remote server, the same server version must be available locally.)

Click Configure to create a new server configuration or edit an existing one. (The Application Servers dialog will open.)

After launch Select this check box to start a web browser after connecting to the server and deploying the artifacts.

Select the browser from the list. Click /help/img/idea/2016.3/browseButton.png (Shift+Enter) to configure your web browsers.

With JavaScript debugger If this check box is selected, the web browser is started with the JavaScript debugger enabled.

Note that JavaScript debugging is available only for Firefox and Google Chrome. When you debug your JavaScript in Firefox for the first time, the JetBrains Firefox extension is installed.

The field underneath After launch Specify the URL the browser should go to when started. In most typical cases, this URL corresponds to the root of your Web application or its starting page.
On 'Update' action Select the necessary option for the Update application function (/help/img/idea/2016.3/update_icon.png or Ctrl+F10 in the Run or Debug tool window).

The options are:

  • Hot swap classes. Changed classes are recompiled and reloaded at runtime. This option works only in the debug mode.
  • Redeploy. The application artifact is rebuilt and redeployed.
Show dialog Select this check box if you want to see the Update dialog every time you use the Update application function.

The Update dialog is used to select the update option prior to actually updating the application.

On frame deactivation Specify what IntelliJ IDEA should do when you switch from the IDE to a different application (for example, a web browser). (Frame deactivation means switching to a different application.)

The options other than Do nothing have the same meanings as in the case of the Update action.

JMX Port Specify the JMX server port.
PingClick this button to ping the JMX port on the server.
JMX UserSpecify the name of the user on whose behalf IntelliJ IDEA will connect to the JMX server port.
JMX PasswordSpecify the password of the JMX user.
Remote staging This section contains the settings related to staging. An example of remote staging settings for a mounted folder is provided after this table.
Type Select the way the staging environment or host is accessed for transferring the application artifact or artifacts from your local computer. (In the user interface of IntelliJ IDEA this setting is also referred to as the connection type.)

The available options are:

  • Same file system. Select this option if the target server is installed on your local computer. The artifacts in this case are deployed locally and, thus, don't need to be transferred to a remote host.
  • ftp. The File Transfer Protocol or Secure FTP is used.
  • Local or mounted folder. The staging environment is a local folder or is accessed as a mounted folder.

If the list is empty, you have to enable the Remote Hosts Access plugin which supports the corresponding functionality.

HostIf Same file system is selected for Type, the only available option for Host is also Same file system.

In all other cases, the list contains the existing configurations of the selected type. So each configuration corresponds to an individual (S)FTP connection, or a local or mounted folder.

Select an existing configuration or create a new one.

To create a new configuration:

  1. Click /help/img/idea/2016.3/browseButton.png to the right of the list.
  2. In the Deployment dialog, click /help/img/idea/2016.3/new.png.
  3. In the Add Server dialog, specify the configuration name, select the type, and click OK.
  4. On the Connection tab, specify the settings in the Upload/download project files section.

    The rest of the settings don't matter.

  5. Click OK in the Deployment dialog.

Deployment access When deploying to the remote host, the application artifact or artifacts are placed into a staging folder (deployment target folder). This folder should be accessible to the server. The settings in this section define the location of this staging folder.
Path from rootThe path to the staging folder relative to the local or mounted folder, or the root of the (S)FTP host.

You can use /help/img/idea/2016.3/browseButton.png to select the folder in the Choose target path dialog.

Mapped as The absolute path to the staging folder in the local file system of the remote host.

The path should be specified as a URL, e.g.

file:///C:/shared/staging

Repository accessWhen deploying to the remote host, the plans (artifacts) are placed into a watched repository. The settings in this section describe this repository.
Path from rootThe path to the repository folder relative to the local or mounted folder, or the root of the (S)FTP host.

You can use /help/img/idea/2016.3/browseButton.png to select the folder in the Choose target path dialog.

NameSpecify the name of the watched repository the way it is defined in the configuration of the remote server.
Remote connection settings The settings for accessing deployed applications.
Host The fully qualified domain name or the IP address of the server host.
Port The server HTTP port.

An example of remote staging settings for a mounted folder

Assuming that:

  • C:\shared is a shared folder on the remote host which is mounted to the local computer as the drive X:.
  • The folder that you are going to use for staging is C:\shared\staging.

Here are the corresponding remote staging settings:

  • Type: Local or mounted folder.
  • Host: The configuration should be selected in which the value in the Folder field is X:\ (the Upload/download project files section on the Connection tab of the Deployment dialog).
  • Staging/Path from root: staging
  • Staging/Mapped as: file:///C:/shared/staging

Deployment tab

Use this tab to specify which artifacts and/or external resources should be deployed onto the server. (An external resource means a deployable Web component such as a .war file which is not represented by a project artifact. Usually, such components are stored outside of the project scope.)

To add items to the deployment list (shown under Deploy at the server startup), use /help/img/idea/2016.3/new.png. To edit the settings for an artifact or external resource, select the corresponding item in the list and use the controls in the right-hand part of the tab. For more information, see the table below.

ItemDescription
/help/img/idea/2016.3/new.png or Alt+Insert Use this icon or shortcut to add an artifact or an external resource to the list.
  • To add an artifact, select Artifact and choose the desired artifact in the dialog that opens.
  • To add an external resource, select External Source and choose the location of the desired resource in the dialog that opens.
/help/img/idea/2016.3/delete.png or Alt+DeleteUse this icon or shortcut to remove the selected artifacts and external resources from the list.
/help/img/idea/2016.3/editFlexLibraryNew.png or F4 Use this icon or shortcut to configure the selected artifact. (The Artifacts page of the Project Structure dialog will open.)

Logs tab

Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.

ItemDescription
Is ActiveSelect check boxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.
Log File EntryThe read-only fields in this column list the log files to show. The list can contain:
  • Full paths to specific files.
  • Ant patterns that define the range of files to be displayed.
  • Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

    If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

Skip ContentSelect this check box to have the previous content of the selected log skipped.
Save console output to fileSelect this check box to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.
Show console when a message is printed to standard output streamSelect this check box to activate the output console and bring it forward if an associated process writes to Standard.out.
Show console when a message is printed to standard error streamSelect this check box to activate the output console and bring it forward if an associated process writes to Standard.err.
/help/img/idea/2016.3/new.png Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.
/help/img/idea/2016.3/editFlexLibraryNew.png Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
/help/img/idea/2016.3/delete.png Click this button to remove the selected log entry from the list.
browseButton.png Click this button to edit the select log file entry. The button is available only when an entry is selected.

Startup/Connection tab for a remote configuration

This tab shows command-line options for starting the server JVM in the run and debug modes.

ItemDescription
/help/img/idea/2016.3/run.png Run /
/help/img/idea/2016.3/debug.png Debug
Use to switch between the settings for the run and debug modes. The settings are shown in the area under To run/debug...
To run/debug remote server JVM... The command-line options for starting the server JVM. These are shown just for copying elsewhere.
Transport (and all that follows) The GUI for generating the remote debug command-line options shown in the area under To run/debug...

Before Launch options

Specify which tasks should be carried out before starting the run/debug configuration.

ItemShortcutDescription
/help/img/idea/2016.3/new.png Alt+Insert Click this icon to add a task to the list. Select the task to be added:
  • Run External tool. Select this option to run an application which is external to IntelliJ IDEA. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Make. Select this option to compile the project.

    If an error occurs during the compilation, IntelliJ IDEA won't attempt to start the run/debug configuration.

  • Make, no error check. The same as the Make option but IntelliJ IDEA will try to start the run/debug configuration irrespective of the compilation result.
  • Build Artifacts. Select this option to build an artifact or artifacts. In the dialog that opens, select the artifact or artifacts that should be built.

    See also, Working with Artifacts.

  • Run Another Configuration. Select this option to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.
  • Run Ant target. Select this option to run an Ant target. In the dialog that opens, select the target to be run. For more information, see Ant.
  • Generate CoffeeScript Source Maps. Select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.

    For more information, see CoffeeScript Support.

  • Run Maven Goal. Select this option to run a Maven goal. In the dialog that opens, select the goal to be run.

    For more information, see Maven.

  • Run Remote External Tool. Select this option to run a remote application which is external to IntelliJ IDEA. In the dialog that opens, select one or more remote applications to be run. If the necessary applications are not defined in IntelliJ IDEA yet, add their definitions. For more information, see Configuring Third-Party Tools and External Tools.
/help/img/idea/2016.3/delete.png Alt+Delete Click this icon to remove the selected task from the list.
/help/img/idea/2016.3/editFlexLibraryNew.png EnterClick this icon to edit the selected task. Make the necessary changes in the dialog that opens.
/help/img/idea/2016.3/arrowUp.png /help/img/idea/2016.3/arrowDown.pngAlt+Up/Alt+DownClick these icons to move the selected task one line up or down in the list. (The tasks are performed in the order that they appear in the list.)
Show this pageSelect this check box to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window If this check box is selected, the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself if necessary.

Toolbar

ItemShortcutDescription
/help/img/idea/2016.3/new.pngAlt+InsertCreate a run/debug configuration.
/help/img/idea/2016.3/delete.pngAlt+DeleteDelete the selected run/debug configuration.
copyCtrl+DCreate a copy of the selected run/debug configuration.
/help/img/idea/2016.3/settings.pngView and edit the default settings for the selected run/debug configuration.
/help/img/idea/2016.3/arrowUp.png/help/img/idea/2016.3/arrowDown.pngAlt+Up/Alt+DownMove the selected run/debug configuration up and down in the list.

The order of configurations in the list defines the order in which the configurations appear in the corresponding list on the main toolbar.

/help/img/idea/2016.3/folder.pngYou can group run/debug configurations by placing them into folders.

To create a folder, select the configurations to be grouped and click /help/img/idea/2016.3/folder.png. Specify the name of the folder.

Then, to move a configuration into a folder, between the folders or out of a folder, use /help/img/idea/2016.3/arrowUp.png and /help/img/idea/2016.3/arrowDown.png. You can also drag a configuration into a folder.

To remove grouping, select a folder and click /help/img/idea/2016.3/delete.png.

See also, Creating Folders and Grouping Run/Debug Configurations.

See Also

Last modified: 29 November 2016