OMrun Help Online Manual for OMrun Version 4

Start via Batch File


Start syntax

Call OMrun with Parameters: (parameter separated by space). Order of parameters does not matter.
The parameters in red = mandatory / green = optional / orange = deprecated.  

"[OMrunPath\]OMrun.exe" "TAT:[Project path]" "BSS:[Business system]" "ENV:[Environment]" "TSC:[Sceanario]"

"REP:[Result report path]" "RET:[Report type]" "REM:[Report processes in memory]" "REY:[Report format]" "ROW:[Rows exported]" "LIC:Modify"

"RTL:[Parameter list]" "PUB:[OMdashboard path]"


OMrun path

Start path of the application executable.

Example (Default value)
"C:\Program Files\OMIS\OMrun\OMrun.exe"


Project path (TAT)

Path to the OMrun test script files.

Example
"TAT:D:\ProjectX\OMrun\TestScripts"


Buisiness system (BSS)

Name of the overall OMrun Project choosen for execution by batch.

Example
"BSS:DataQuality"


Environment (ENV)

Name of the environment choosen for execution by batch.

Example
"ENV:INT"


Scenario (TSC)

Name of the environment choosen for execution by batch.

Example
"TSC:DailyCheck"


Report path (REP)

Result reports and scenario overviews will be generated into this directory. Each link of every report will be exported to OMdashboard to open the report directly via browser.
Therefore it is mandatory to enter the path in UNC syntax (like \\<server>\<share>\<path>).

Example
"REP:\\myServer\$C\ProjectX\OMrun\Reports"


Report Type (RET)

Parameter defines the selected result type for the report output:

  • "All" = passed and failed
  • "Passed" = passed only
  • "Failed" = failed only (Default)

Example
"RET:All"


Concurrent report processes in memory (REM)

Purpose of the parameter REM is to adjust creation of concurrent reports depending on available memory size and amount of processor kernels (Default: 10 processes) .

Example
"REM:5"


Report format (REY)

Depending on the purpose of the report, there are two formats available:

Value Description
Excel

Creates an Excel report, stores it to the defined report path (REP) and displays a download link for it on OMdashboard (Default).
Designed for end user access.

Csv

Creates a CSV report, stores it to the defined report path (REP) and does not display a link for it on OMdashboard.
Designed for machine reusable access, e.g. collecting data from heterogenious sources by applying business rules and uploading results into other systems.

Example
"REY:Csv"


Amount of rows exported (ROW)

Parameter offers following options:

Value Description
500

First 500 failed rows will be exported to the Excel result file.

10

First 10 failed rows will be exported to the Excel result file.

0

No row will be exported therefore the Excel result file will be created but empty.

-1

All failed rows will be exported to the Excel result file (Default).

Example
"ROW:-1"


Open license key window (LIC)

Parameter shows the license install/uninstall dialog. Needed to update key for runtime licenses.

Example
"LIC:Modify"


Runtime list (RTL)

Deprcated: name of the parameter list choosen to execute by batch. This has been implemented individually into scenarios.

Example
"RTL:Extensive"


Dashboard publish path (PUB)

Deprcated: path to the dashboard DB for publishing results after execution by batch. This path is taken from the OMrun internal setting configured by Dashboard Config.

Example
"PUB:C:\inetpub\wwwroot\OMdashboard\App_Data"


OMrun Exit Codes

OMrun returns an integer as return value:

 Value  Description
 -3  Error, number of installed licenses exeeded
 -2  Error, mandatory parameter missing
 -1  Error, at least one test case could not be executed because of infrastructure problems.
 0  Ok, all test cases executed and 100% passed.
 1  Warning, all test cases executed and passed 100%, at least one test case returned no output.
 2  Warning, all test cases executed, at least one test case failed.

OMrun Log File

Log file contains begin and end timestamps of "Execute Test Scenario" or "Execute Test Cases" runs incl. OMrun application.

Logged Processes:

  • Starting OMrun
  • License modifications
  • Execution runs
  • Publish Test Results
  • Closing OMrun

File Location:
C:\Users\<username>\AppData\Roaming\OMIS\
OMrun\Log\OMrun.Log.txt