pp108 : Using the CWS Command-line Tools

Using the CWS Command-line Tools
This topic presents an overview of the CWS command-line tools and their usage.
Prerequisite

Before you execute any of the CWS command-line tools, you must ensure the following:

  • If the operating system is Windows, an environment variable CORDYS_HOME must exist, and its value must be set to the installation directory of the Process Platform environment.
  • The user executing the tool is an authenticated user in the Process Platform environment and must have a Cordys user account with the user ID set as the user name of the operating system user account.
  • The user executing the tool is authorized to do so in the context of a specific organization. The Cordys user must be assigned the Developer role in that organization.
  • On Linux, grant the user execute permissions for the cws script file by executing the following command in the <Installation_Directory>/bin/ folder: 
     chmod a+x cws

You can use command-line tools for the actions that can be performed in CWS, such as building, publishing, packaging, and synchronizing.

Currently, these tools are available in the form of:

  • Generic CWS commands
  • Specific CWS commands

Generic CWS command with sub commands

To execute a sub command with the generic command, you must do the following:

  1. Log in to the Process Platform server.
  2. Open a command prompt and navigate to the <Installation_Directory>/bin/ folder.
  3. Run the command cws with proper sub command and arguments as specified below:
Sub commands

For more information on a sub command and its arguments, see the following topics:

Executing sub command help will show all available sub commands with a brief summary of their functionality:

cws help

To get help on a sub command use:

cws help <sub command>
Arguments

Each sub command has its own arguments. Optionally, you can add one or more of the following tuning arguments:

Setting Setting Default value Example
Heap -MaxHeap xxx Default JVM heap size -MaxHeap 5000
NOM -MaxNOM xxx Default NOM size -MaxNOM 4000
Classpath -cp pathToJar empty -cp ../extraCommand.jar
Language -lang xx_XX empty, using settings from wcp.properties -lang en_US

Specific CWS commands

To execute a specific CWS command, you must do the following:

  1. Log in to the Process Platform server.
  2. Open a command prompt and navigate to the <Installation_Directory>/components/cws/scripts folder. In a Windows environment, you must navigate to the sub folder windows; In a Linux environment, you must navigate to the sub folder linux.
  3. Run the command with proper arguments.
Commands

For more information on a command and its arguments, see the following topics: