Workbench Arguments

Getting Started in the Workbench › Workbench Arguments

Workbench Arguments

You can set up the following workbench arguments from the workbench.ini file from the CA Harvest SCM home, to use the Workbench effectively.

-data workspacePath
Specifies the workspace path for the workbench.

Example:

Usage in Windows:

-data

C:/Users/workspace

Usage in Linux/Mac:

-data

/home/harvest/workspace

Note:
- Ensure to type the -data and the workspace path in two lines. The workbench.ini file parses the options and the specified arguments individually.
- You can edit the workspace prompt option by following the instructions:
  1. Open the org.eclipse.ui.ide.prefs file from the @userprofile\.cascm\configuration\.settings\ location.
  2. Set the SHOW_WORKSPACE_SELECTION_DIALOG=true value to get a workspace prompt.
The following parameters are passed to the Java run time and define the amount of memory available to the workbench.
1. -vmargs
  Customizes the Java VM operation to run the workbench.
2. -Xms 40m
  Specifies the minimum memory that the workbench can allocate. This command sets minimum memory size for the pile and heap.
  
  Default: 40 MB.
3. -Xmx 512m
  Specifies the maximum memory that the workbench can allocate. You can set the memory from the Tools, Preferences, and System page. This command sets maximum memory size for the pile and heap.
  
  Default: 512 MB.
Note: Ensure to type the –vmargs, -Xms, and –Xmx arguments on different lines. The workbench.ini file parses the options and the specified arguments individually.
-Dfile.encoding
Specifies the text file encoding mode.

Example:

-Dfile.encoding=utf-8
-clean
Cleans the cached data that is used by the OSGi framework and the cache data that is generated during workbench runtime. This command cleans up the cached data even before starting the Workbench.

If you encounter any error during the start-up or update tasks, add this command in the workbench.ini file and restart the workbench.