RayEval Command Line Interface

<< Click to Display Table of Contents >>

RayEval > 8.0 > User Guide 

RayEval Command Line Interface

RayEval offers a standardized command line interface for parametrized application initialization. The following parameters may be used in conjunction with the RayEval executable.

 

1.Creating a new project

 

Syntax:

 

RayEval.exe -new [-[<PropertyId>] [<PropertyValue>]] [-save [<path_to_local_file>]] 

[-pa [<plugin_arguments>]]

 

Example:

 

RayEval.exe -new -@INSTALLERPATH "C:\Projects\Notepad++.exe" -@APPLANGUAGE POL 

-save "C:\Projects\Project.rex" ‑MYPROPERTY "Test Value" -ANOTHERPROPERTY "Test Value2"

 

Parameters:

 

Parameter

Mandatory

Description

-new

 

Y

Opens the RayEval user interface and initializes a new project.

-[<PropertyID>] [<PropertyValue>]

N

Optional parameters that will add the specified value into the project property with the specified ID.

-pa [<PluginArguments>]

N

Optional arguments that are passed to the export plugins, for example RayFlow.

-save [<path_to_local_file>]

N

Optional parameter to define a location at which the new project file will be created.

 

2.Opening an existing project

 

Syntax:

 

RayEval.exe –open [<PathToRexFile>]

[-[<PropertyId>] [<PropertyValue>]]

[-pa [<PluginArguments>]]

[-minimize]

[-evaluate]

[-export]

[-export [PDF|DOC] -pa [<path_to_local_file>]]

[-export [PDF|DOC] -pa [<rayflow_url>] [<rayflow_username>] [<rayflow_password>] 

[<rayflow_uploadinguser>] [<rayflow_projectID>] [<rayflow_packageID>]]

 

Example:

 

RayEval.exe -open "C:\Projects\Notepad++ - 6.1.37 - 1.0.0.rex" -export -pa 

"C:\Users\Username\Documents\Notepad++ - 6.1.37 - 1.0.0.docx"

 

Parameter

Mandatory

Description

-open

 

Y

Opens the RayEval user interface and opens the selected project.

-[<PropertyID>] [<PropertyValue>]

N

Optional parameters that will add the specified value into the project property with the specified ID.

-pa [<PluginArguments>]

N

Optional arguments that are passed to the export plugins, for example RayFlow.

-minimize

N

Opens the project, goes to the Evaluate screen, and shows the window in minimized state.

-evaluate

N

Opens the project and goes to the Evaluate screen.

-machineName <machineName>

-vm <machineName>

N

When provided, the virtual machine with a given name is automatically started. The machine must be pre-configured in Settings screen.

-export

N

Opens the project and goes to the Export screen.

-export [PDF|DOC]

-pa <path_to_local_file>

N

Opens project and exports the documentation in the selected format (either PDF or DOC) to a local file.

-export [PDF|DOC]

-pa <rayflow_url>

<rayflow_username>

<rayflow_password>

<rayflow_uploadinguser>

<rayflow_projectID>

<rayflow_packageID>

N

Opens project and exports the documentation in the selected format (either PDF or DOC) to RayFlow.

 

3.Open Help

 

Syntax:

 

RayEval.exe -? or RayEval.exe -help

 

Example:

 

RayEval.exe -help

 

Parameter

Mandatory

Description

-help

 

Y

This shows the information about every command that can be used with the command line interface of RayEval.

 

4.Custom project configuration

 

Syntax:

 

RayEval.exe -projectConfiguration "<path>"

 

Example:

 

RayEval.exe -projectConfiguration "C:\Program Files (x86)\RayEval\Config\ProjectConfiguration-custom.xml"

 

papercliper

Note:

This switch can be combined with other actions (for example -open and -new). If the configuration does not exists, an error is written to the log file and RayEval silently reverts to a fallback default configuration.