EGLCMD

The EGLCMD command gives you access to the workbench batch interface. You must satisfy the prerequisites specified in “Generating from the workbench batch interface.” For details on generating a main part and on generating by part, see “Generation mode.”

The command has several forms, and the last section in this topic gives reference details for any form.

Sections are as follows:

To generate and deploy from a command file

If you are using a command file, use the following form of the EGLCMD command:


EGLCMD syntax diagram when a command file is used

The following examples assume that you are starting java EGLCMD in the directory that includes the command file:

java EGLCMD "commandfile.xml"

java EGLCMD "myCommand.xml" 
   -sqlID myID -sqlPassword myPW
   -destUserID myUserID -destPassword myPass

java EGLCMD "/MyProject/MyCommands/Command1.xml" -data "c:\myWorkSpace"

java EGLCMD "/MyProject/MyCommands/Command1.xml"
    -data "myWorkSpace"
    -sqlID myID -sqlPassword myPW
    -destUserID myUserID -destPassword myPass

Place the content for a given command on a single line. If your command file is in another directory, you must add the path to the command file name.

To generate a main part and its associates

If you are generating a main part and its associates and are not using a command file, use the generate subcommand:


EGLCMD syntax diagram for the generate subcommand

Here is an example, which belongs on a single line:

java EGLCMD generate
    -generateFile "/MyProject/EGLSource/my/pkg/myProg.egl"
    -data "myWorkSpace"
    -buildDescriptorFile "/MyProject/EGLSource/myProject.eglbld"
    -buildDescriptorName myBuildDescriptor

To generate by part

If you are generating by part and are not using a command file, use the generatePart subcommand:


EGLCMD syntax diagram for the generatePart subcommand
Here are examples, each of which belongs on a single line:
  • Generate a program:
    java EGLCMD generatePart 
               -data "myWorkSpace" 
               -project "MyProject" 
               -part "test.my.pkg.program1"
               -buildDescriptorFile "/MyProject/EGLSource/myProject.eglbld" 
               -buildDescriptorName myBuildDescriptor
  • Generate all IR files in package myPackage: 
    java EGLSDK generatePart 
               -data "myWorkSpace" 
               -project "MyProject"
               -part "test.my.pkg.*"
               -buildDescriptorFile "c:/myBuild.eglbld" 
               -buildDescriptorName myBuildDescriptor
  • Generate the output for a Record part: 
    java EGLCMD generatePart
               -data "myWorkSpace" 
               -project "MyProject"
               -part "MyRecords.myRecord"
               -buildDescriptorFile "/MyProject/EGLSource/myProject.eglbld"
               -buildDescriptorName myBuildDescriptor

To deploy output

If you are deploying output and are not using a command file, use the deploy subcommand:


EGLCMD syntax diagram for the deploy subcommand
Here is an example, which belongs on a single line:
  • Deploy the output from a single EGL deployment descriptor:
    java EGLCMD deploy 
               -data "myWorkSpace" 
               -deployDescriptorFile "/MyProject/EGLSource/myDeploy.egldd"

Do not specify an asterisk (*) in place of a file name because, if you do, only the alphabetically first deployment descriptor is processed, and the command ends with an error.

Additional reference details

Here are additional details, in alphabetical order:

–bdOption bdOptionValue
An option value that overrides the related value in the build descriptor or in the command file.
Specify an option name for bdOption and specify the related value for bdOptionValue. The following build descriptor options are supported:
  • desthost
  • destport
  • destuserid
  • destpassword
  • destdirectory
  • destlibrary
  • gendirectory
  • sqlid
  • sqlpassword
  • sqldb
  • sqljndiname
  • genproject
  • tempDirectory
  • templatedir
  • reservedword
  • projectid

A build descriptor option that you specify when invoking the EGLCMD command takes precedence over the same build descriptor option in the build descriptor (if any) that is referenced in the EGL command file. The options that are only in the EGLCMD command or only in the build descriptor are also in effect at generation time.

–buildDescriptorFile bdFile
The path of the build file that contains the build descriptor. As described in relation to cmd, the file location is relative to the workspace root.

Embed the path in double quotation marks.

If you do not specify this value, the EGL generator searches for the master build descriptor.

–buildDescriptorName bdName
The name of a Build Descriptor part that guides generation. The build descriptor must be at the top level of an EGL build (.eglbld) file.

If you do not specify this value, the EGL generator searches for the master build descriptor.

Please note that debugging information is never included in the generated output, even if you specify a debug build descriptor.

cmdFile
The path of an EGL command file. The location is relative to the workspace root. For example, a command file might be in the MyProject project, in folder MyCommands, and might be named Command1.xml. Here is the specification of the command file: 
/MyProject/MyCommands/Command1.xml
Note:
Eclipse path names are case sensitive.

Embed the path in double quotation marks.

The command file must be in your workspace before you run the EGLCMD command. If the command file is not in the workspace, use the Eclipse import process to import the file and then rerun the EGLCMD command.

–data workSpace
The absolute or relative path of the workspace directory. Relative paths are relative to the directory in which you run the command.

If you do not specify a value, the command accesses the Eclipse default workspace.

Embed the path in double quotation marks.

–deploymentDescriptorFile deploymentDescriptorFile
The path of the EGL deployment descriptor. As described in relation to cmd, the file location is relative to the workspace root.

Embed the path in double quotation marks. You can specify either the name of the file or an asterisk (*), which represents all EGL deployment descriptors in the path.

–generateFile genFile
The path of the EGL file that contains the part you want to process. As described in relation to cmd, the file location is relative to the workspace root.

Embed the path in double quotation marks.

-part qualifiedPartName
The part you want to generate, qualified by the package name. Enclose the qualified name in double quotes. The part location is resolved from the EGL build path. To generate every part in the package and sub-packages, use an asterisk (*) is in place of a part name.
-project projectName
The name of a project in the workspace. The EGL build path specified for the project is used to resolve part references.
-symparm symparm = value
A symbolic parameter and the related value. If the value includes a space, embed the value in quotation marks. If multiple symparm entries reference the same symbolic parameter, the last entry is in effect.

The symbolic parameters that you specify when invoking the EGLCMD command take precedence over the same-named symbolic parameters in the build descriptor (if any) that is referenced in the EGL command file. The parameters that are only in the EGLCMD command or only in the build descriptor are also in effect at generation time.