Starting Command Line Tools
Use
Use this procedure to start the following command line tools:
● CBS command line tool.
● CMS command line tool.
● DC command line tool.
● DTR command line tool
● DTR console.
Procedure
Starting the Command Line Tools in SAP NetWeaver Developer Studio
...
1. Open the Java perspective.
2. From the menu path, choose Run → Open Run Dialog…
3. In the dialog that appears, double-click the Eclipse Application node.
A new configuration is created.
4. Specify a display name for the configuration. For example: CBS Command Line Tool.
5. From Program to Run, select Run an application.
6. From the dropdown menu, select the application to activate:
Eclipse Application |
Command Line Tool |
com.sap.di.cltools.cbsconsole |
CBS command line tool |
com.sap.di.cltools.cmsconsole |
CMS command line tool |
com.sap.di.cltools.dcconsole |
DC command line tool |
com.sap.di.cltools.dtrclient |
DTR command line client |
com.sap.di.cltools.dtrshell |
DTR command line shell – DTR console |
7. Starting the launch configuration.
You can either choose Run button of the launch configuration dialog, or use the Run button from the tool bar of the Java perspective.
For some of the command line tools, there are concrete system variables that need to be specified. These settings are specified in the Arguments tab page of the launch configuration.
If a tool run into an out of memory error, you should increase the heap size by changing the VM argument –Xmx.
For example, set the heap size to 512 MB (-Xmx512m).
Setting up the DC command line tool
For the DC command line tool (com.sap.di.cltools.dcconsole), the path of the used JDK is necessary to perform the DC build related commands. This information is specified using the system property dctool.JDK_PATH. In this sense the system property dctool.JDK_PROPERTY_NAME is used to define a name/label for the used JDK. By default you can take the string default as the value for this system property.
Eclipse Application |
System Variable |
Example VM Argument |
com.sap.di.cltools.dcconsole |
dctool.JDK_PATH |
-Ddctool.JDK_PATH= C:\javasdk\jdk1.5.0_12 |
com.sap.di.cltools.dcconsole |
dctool.JDK_PROPERTY_NAME |
-Ddctool.JDK_PROPERTY_ NAME=default |
Setting up DTR tools
For the DTR command line client (com.sap.di.cltools.dtrclient) and DTR command line shell (com.sap.di.cltools.dtrshell), specify the DTR configuration folder using the system property vfs.configfolder. If the DTR configuration folder is set incorrectly the tools will not run. You can use the (optional) system property vfs.logging to specify a property file that contains logging and tracing settings for the DTR client. To specify these settings, open the Arguments tab page:
Eclipse Application |
System Variable |
Example VM Argument |
com.sap.di.cltools.dtrclient |
vfs.configfolder |
-Dvfs.configfolder= C:\nwds\ws.jdi\.dtr |
com.sap.di.cltools.dtrclient |
vfs.logging |
-Dvfs.logging= C:\nwds\dtrclient.properties |
com.sap.di.cltools.dtrshell |
vfs.configfolder |
-Dvfs.configfolder= C:\nwds\ws.jdi\.dtr |
com.sap.di.cltools.dtrshell |
vfs.logging |
-Dvfs.logging= C:\nwds\dtrclient.properties |
Choose Apply.
Starting the Command Line Tools in DOS Console
You can launch the command line tools from a DOS console. For this purpose you have to start the SAP NetWeaver Developer Studio in what is called headless mode. This starts the Eclipse as a Java application. For this purpose the JAR need to be on the classpath that contains class org.eclipse.core.launcher.Main. The JAR is located in the plug-ins directory of the Eclipse. You have to search for a JAR file that starts with org.eclipse.equinox.launcher.
For example, the CBS command line tool is launched with the following command:
java -cp C:\nwds_installed\eclipse\plugins\org.eclipse.equinox.launcher_1.0.1.R33x_v20070828.jar org.eclipse.core.launcher.Main -application com.sap.di.cltools.cbsconsole %*
Note that in option -application the Eclipse application that should be executed is specified. Do not forget to pass also the required system variables as VM arguments for those command line tools that rely on this information.
This launch call can be put into a batch file that you simply call to launch the tool.
Starting the Command Line Tools Without a Developer Studio
You can start the command line tools separately from the Developer Studio. To do that:
...
1. Get the DICLIENTS SCA from SAP Service Marketplace (Downloads area, enter DICLIENTS as the search term).
2. Open the file tc~di~cmd_tools~sda.sda (deploy archives) from the SCA.
3. Extract the file di_cmd_tools.zip from the SDA. The ZIP file can be copied to other machines as well.
4. Extract the ZIP file. Open the folder of the command line tool and have a look at the readme.txt file to check which environment variables should be set and for further information about using the tool.