Show TOC Start of Content Area

Background documentation DC Command Line Tool  Locate the document in its SAP Library structure

Caution

Do not use the DC Tool and the SAP NetWeaver Developer studio at the same time.

The DC tool is a command line-based tool that allows you to perform several tasks related to Development Components (DCs):

      Synchronizing / unsynchronizing DCs

      Building DCs locally

      Reporting

      DC refactoring operations

Starting the Tool

The DC command line tool is in the directory <SAP NetWeaver Developer Studio Install Dir>/eclipse/tools/dc.

Note

You can copy the command line tools located under <SAP NetWeaver Developer Studio Install Dir>/eclipse/tools to another machine by simply copying the contents of the tools directory.

The directory <SAP NetWeaver Developer Studio Install Dir>/eclipse/tools/dc contains the following files:

      dctool.bat – DOS batch to launch the DC tool on a Windows platform.

      dctool.sh – shell script to launch the DC tool on a Unix/Linux platform.

      commandfile.txt – text file containing several DC tool commands.

      readme.txt – brief description about DC command line tool.

      dctool_manual.html – offline documentation on the tool.

All JAR files that are required to run the DC command line tool are located in the directory <SAP NetWeaver Developer Studio Install Dir>/eclipse/tools/lib. Note that you have to use the absolute path of the lib directory.

You set the environment variables at the beginning of dctool.bat (for Windows) or dctool.sh (for Unix/Linux).

You can start the tool using dctool script.

Before you run the script dctool you have to set the following environment variables:

      JAVA_HOME – points to the location of the JSDK on your machine.

      NWDITOOLLIB – refers to the lib directory of the NWDI tools. You have to use the absolute path of the lib directory.

To display more information about a specific command (especially which arguments it takes), enter

help <command name>

and choose Enter.

Integration

The DC command line tool writes user messages to the console. You can redirect user messages to a file by using the logfile command.

Example

The user messages will be redirected to the file useroutput.txt.

logfile –f useroutput.txt –m on ––append

If you use the logfile command with option –m and parameter off, the user messages will be redirected back to the console.

Besides user messages, there are also technical messages – that is, stack traces. The stack traces are useful in case of problems or errors.

These messages are not written to the console.

Example

The technical messages will be redirected to the file tracemsg.txt

tracefile ––m on –f tracemsg.txt

If you use the tracefilecommand with option ––sl, you can specify how detailed the trace messages should be.

Features

Removing a DC

You can remove a development configuration from the local disk using the removeconfig or deletedc command. Removing a configuration means that all data under the configuration folder is deleted.

Synchronization

Before you can build DCs locally, you have to synchronize them. For this purpose two commands syncalldcs and syncdc are provided. Both commands have in common that you can specify in which state the DCs shall be synchronized. Note that it depends on the state of the compartment which synchronization mode you can use. For example, if the compartment has archive state, it does not make sense to synchronize its DCs as active or inactive source.

In case option -y is used for syncalldcs or syncdc, the DCs concerned will be synchronized even if they are up-to-date. In order to ensure that the used DCs are synchronized as well, use option --syncused.

Note: in case no compartment is specified for command syncalldcs, all compartments are considered, so that all DCs of the configuration are synchronized with one command (provided that the right mode is used).

The commands unsyncdc and unsyncalldcs are provided to remove those DCs that have been synchronized before from the local disk. While unsyncdc removes one specific DC, unsyncalldcs removes all DCs of the specified compartment. If no compartment has been specified all synchronized DCs are affected.

 

See also:

      Run Modes of the DC Tool

      Commands of the DC Tool

End of Content Area