```
public final class RunRobotConfiguration
extends BotRobotConfiguration
                    
```
Robot Framework is a generic open source automation framework for acceptance testing, acceptance test-driven development (ATDD) and robotic process automation (RPA). It has simple, easy-to-use syntax that utilizes the keyword-driven automation approach. Keywords adding new capabilities are implemented in libraries using either Python or Java. New higher level keywords can also be created using Robot Framework's own syntax.
The easiest way to execute Robot Framework is using the robot command created as part of the normal installation. Alternatively it is possible to execute the robot module directly using python -m robot, where python can be replaced with any supported Python interpreter such as jython, ipy or python3. Yet another alternative is running the robot directory like python path/to/robot. Finally, there is a standalone JAR distribution available.
Tests (or tasks in RPA terminology) are created in files typically having the *.robot extension. Files automatically create test (or task) suites and directories with these files create higher level suites. When Robot Framework is executed, paths to these files or directories are given to it as arguments.
By default Robot Framework creates an XML output file and a log and a report in HTML format, but this can be configured using various options listed below. Outputs in HTML format are for human consumption and XML output for integration with other systems. XML outputs can also be combined and otherwise further post-processed with the Rebot tool that is an integral part of Robot Framework. Run rebot --help for more information.
Robot Framework is open source software released under Apache License 2.0. For more information about the framework and the rich ecosystem around it see http://robotframework.org/.
Repetitive options can be specified multiple times. For example, --test first --test third selects test cases with name first and third. If an option accepts a value but is not marked with an asterisk, the last given value has precedence. For example, --log A.html --log B.html creates log file B.html. Options accepting no values can be disabled by using the same option again with no prefix added or dropped. The last option has precedence regardless of how many times options are used. For example, --dryrun --dryrun --nodryrun --nostatusrc --statusrc would not activate the dry-run mode and would return a normal return code.
Long option format is case-insensitive. For example, --SuiteStatLevel is equivalent to but easier to read than --suitestatlevel. Long options can also be shortened as long as they are unique. For example, --logti Title works while --lo log.html does not because the former matches only --logtitle but the latter matches --log, --loglevel and --logtitle.
- ROBOT_OPTIONS: Space separated list of default options to be placed in front of any explicit options on the command line.
- ROBOT_SYSLOG_FILE: Path to a file where Robot Framework writes internal information about parsing test case files and running tests. Can be useful when debugging problems. If not set, or set to a special value NONE, writing to the syslog file is disabled.
- ROBOT_SYSLOG_LEVEL: Log level to use when writing to the syslog file. Available levels are the same as with --loglevel command line option and the default is INFO.
- ROBOT_INTERNAL_TRACES: When set to any non-empty value, Robot Framework's internal methods are included in error tracebacks.
```
# Simple test run using 'robot' command without options.
$ robot tests.robot

# Using options.
$ robot --include smoke --name "Smoke Tests" path/to/tests.robot

#Executing 'robot' module using Python.
$ python -m robot path/to/tests

# Running 'robot' directory with Jython.
$ jython /opt/robot tests.robot

# Executing multiple test case files and using case-insensitive long options.
$ robot --SuiteStatLevel 2 --Metadata Version:3 tests\*.robot more/tests.robot

# Setting default options and syslog file before running tests.
$ export ROBOT_OPTIONS="--outputdir results --suitestatlevel 2"
$ export ROBOT_SYSLOG_FILE=/tmp/syslog.txt
$ robot tests.robot
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`RunRobotConfiguration.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private List<String>`	`skip`
`private List<String>`	`skipOnFailure`
`private final ListProperty<String>`	`extension`
`private final MapProperty<String, String>`	`variables`
`private final ListProperty<String>`	`variableFiles`
`private final RegularFileProperty`	`debugFile`
`private final Property<Integer>`	`maxErrorLines`
`private final ListProperty<String>`	`listener`
`private final Property<Boolean>`	`dryrun`
`private final Property<Boolean>`	`exitOnFailure`
`private final Property<Boolean>`	`exitOnError`
`private final Property<Boolean>`	`skipTearDownOnExit`
`private final Property<String>`	`randomize`
`private final ListProperty<String>`	`preRunModifier`
`private final ListProperty<String>`	`preRebotModifier`
`private final Property<String>`	`console`
`private final Property<Boolean>`	`dotted`
`private final Property<Boolean>`	`quite`
`private final Property<Integer>`	`consoleWidth`
`private final Property<String>`	`consoleMarkers`
`private Property<Boolean>`	`rpa`
`private Property<String>`	`doc`
`private Map<String, String>`	`metaData`
`private List<String>`	`setTags`
`private List<String>`	`test`
`private List<String>`	`task`
`private List<String>`	`suite`
`private List<String>`	`include`
`private List<String>`	`exclude`
`private List<String>`	`critical`
`private List<String>`	`nonCritical`
`private final DirectoryProperty`	`outputDir`
`private File`	`output`
`private File`	`log`
`private File`	`report`
`private File`	`xUnit`
`private Property<Boolean>`	`xUnitSkipNonCritical`
`private Property<Boolean>`	`timestampOutputs`
`private Property<Boolean>`	`split`
`private Property<String>`	`logTitle`
`private Property<String>`	`reportTitle`
`private Property<String>`	`reportBackground`
`private Property<String>`	`logLevel`
`private Property<Integer>`	`suiteStatLevel`
`private List<String>`	`tagStatInclude`
`private List<String>`	`tagStatExclude`
`private Map<String, String>`	`tagStatCombine`
`private Map<String, String>`	`tagDoc`
`private List<String>`	`tagStatLink`
`private List<String>`	`removeKeywords`
`private List<String>`	`flattenKeywords`
`private Property<Boolean>`	`noStatusSrc`
`private Property<String>`	`consoleColors`
`private List<String>`	`argumentFiles`
`private final Property<String>`	`name`
`private ConfigurableFileCollection`	`additionalPythonPaths`

Constructor Summary

Constructors
Constructor	Description
`RunRobotConfiguration(Project project)`

Method Summary

Modifier and Type	Method	Description
`final List<String>`	`getSkip()`	Tests having given tag will be skipped.
`final Unit`	`setSkip(List<String> skip)`	Tests having given tag will be skipped.
`final List<String>`	`getSkipOnFailure()`	Tests having given tag will be skipped if they fail.
`final Unit`	`setSkipOnFailure(List<String> skipOnFailure)`	Tests having given tag will be skipped if they fail.
`final ListProperty<String>`	`getExtension()`	Parse only files with this extension when executing a directory.
`final MapProperty<String, String>`	`getVariables()`	Set variables in the test data.
`final ListProperty<String>`	`getVariableFiles()`	Python or YAML file to read variables from.
`final RegularFileProperty`	`getDebugFile()`	Debug file written during execution.
`final Property<Integer>`	`getMaxErrorLines()`	Maximum number of error message lines to show in report when tests fail.
`final ListProperty<String>`	`getListener()`	A class for monitoring test execution.
`final Property<Boolean>`	`getDryrun()`	Verifies test data and runs tests so that library keywords are not executed.
`final Property<Boolean>`	`getExitOnFailure()`	Stops test execution if any critical test fails.
`final Property<Boolean>`	`getExitOnError()`	Stops test execution if any error occurs when parsing test data, importing libraries, and so on.
`final Property<Boolean>`	`getSkipTearDownOnExit()`	Causes teardowns to be skipped if test execution is stopped prematurely.
`final Property<String>`	`getRandomize()`	Randomizes the test execution order.
`final ListProperty<String>`	`getPreRunModifier()`	Class to programmatically modify the test suite structure before execution.
`final ListProperty<String>`	`getPreRebotModifier()`	Class to programmatically modify the result model before creating reports and logs.
`final Property<String>`	`getConsole()`	How to report execution on the console.
`final Property<Boolean>`	`getDotted()`	Shortcut for `console = "dotted"`.
`final Property<Boolean>`	`getQuite()`	Shortcut for `console = "quite"`.
`final Property<Integer>`	`getConsoleWidth()`	Width of the console output.
`final Property<String>`	`getConsoleMarkers()`	Use colors on console output or not.
`final Property<Boolean>`	`getRpa()`	Turn on the generic automation mode (aka Robot Process Automation).
`final Unit`	`setRpa(Property<Boolean> rpa)`	Turn on the generic automation mode (aka Robot Process Automation).
`final Property<String>`	`getDoc()`	Set the documentation of the top level suite.
`final Unit`	`setDoc(Property<String> doc)`	Set the documentation of the top level suite.
`final Map<String, String>`	`getMetaData()`	Set metadata of the top level suite.
`final Unit`	`setMetaData(Map<String, String> metaData)`	Set metadata of the top level suite.
`final List<String>`	`getSetTags()`	Sets given tag(s) to all tests.
`final Unit`	`setSetTags(List<String> setTags)`	Sets given tag(s) to all tests.
`final List<String>`	`getTest()`	Select tests by name or by long name containing also parent suite name like `Parent.Test`.
`final Unit`	`setTest(List<String> test)`	Select tests by name or by long name containing also parent suite name like `Parent.Test`.
`final List<String>`	`getTask()`	Alias to test.
`final Unit`	`setTask(List<String> task)`	Alias to test.
`final List<String>`	`getSuite()`	Select suites by name.
`final Unit`	`setSuite(List<String> suite)`	Select suites by name.
`final List<String>`	`getInclude()`	Select tests by tag.
`final Unit`	`setInclude(List<String> include)`	Select tests by tag.
`final List<String>`	`getExclude()`	Specify tests not to be included by tag.
`final Unit`	`setExclude(List<String> exclude)`	Specify tests not to be included by tag.
`final List<String>`	`getCritical()`	Opposite of nonCritical
`final Unit`	`setCritical(@Deprecated(message = Since RF 4.0) List<String> critical)`	Opposite of nonCritical
`final List<String>`	`getNonCritical()`	Alias for RunRobotConfiguration.skipOnFailure.
`final Unit`	`setNonCritical(@Deprecated(message = Since RF 4.0) List<String> nonCritical)`	Alias for RunRobotConfiguration.skipOnFailure.
`final DirectoryProperty`	`getOutputDir()`	Where to create output files.
`final File`	`getOutput()`	XML output file.
`final Unit`	`setOutput(File output)`	XML output file.
`final File`	`getLog()`	HTML log file.
`final Unit`	`setLog(File log)`	HTML log file.
`final File`	`getReport()`	HTML report file.
`final Unit`	`setReport(File report)`	HTML report file.
`final File`	`getXUnit()`	xUnit compatible result file.
`final Unit`	`setXUnit(File xUnit)`	xUnit compatible result file.
`final Property<Boolean>`	`getXUnitSkipNonCritical()`	Has no effect anymore.
`final Unit`	`setXUnitSkipNonCritical(@Deprecated(message = Since RF 4.0) Property<Boolean> xUnitSkipNonCritical)`	Has no effect anymore.
`final Property<Boolean>`	`getTimestampOutputs()`	When this option is used, timestamp in a format `YYYYMMDD-hhmmss` is added to all generated output files between their basename and extension.
`final Unit`	`setTimestampOutputs(Property<Boolean> timestampOutputs)`	When this option is used, timestamp in a format `YYYYMMDD-hhmmss` is added to all generated output files between their basename and extension.
`final Property<Boolean>`	`getSplit()`	Split the log file into smaller pieces that open in browsers transparently.
`final Unit`	`setSplit(Property<Boolean> split)`	Split the log file into smaller pieces that open in browsers transparently.
`final Property<String>`	`getLogTitle()`	Title for the generated log file.
`final Unit`	`setLogTitle(Property<String> logTitle)`	Title for the generated log file.
`final Property<String>`	`getReportTitle()`	Title for the generated report file.
`final Unit`	`setReportTitle(Property<String> reportTitle)`	Title for the generated report file.
`final Property<String>`	`getReportBackground()`	Background colors to use in the report file.
`final Unit`	`setReportBackground(Property<String> reportBackground)`	Background colors to use in the report file.
`final Property<String>`	`getLogLevel()`	The threshold level for logging.
`final Unit`	`setLogLevel(Property<String> logLevel)`	The threshold level for logging.
`final Property<Integer>`	`getSuiteStatLevel()`	How many levels to show in `Statistics by Suite` in log and report.
`final Unit`	`setSuiteStatLevel(Property<Integer> suiteStatLevel)`	How many levels to show in `Statistics by Suite` in log and report.
`final List<String>`	`getTagStatInclude()`	Include only matching tags in `Statistics by Tag` in log and report.
`final Unit`	`setTagStatInclude(List<String> tagStatInclude)`	Include only matching tags in `Statistics by Tag` in log and report.
`final List<String>`	`getTagStatExclude()`	Exclude matching tags from `Statistics by Tag`.
`final Unit`	`setTagStatExclude(List<String> tagStatExclude)`	Exclude matching tags from `Statistics by Tag`.
`final Map<String, String>`	`getTagStatCombine()`	Create combined statistics based on tags.
`final Unit`	`setTagStatCombine(Map<String, String> tagStatCombine)`	Create combined statistics based on tags.
`final Map<String, String>`	`getTagDoc()`	Add documentation to tags matching the given pattern.
`final Unit`	`setTagDoc(Map<String, String> tagDoc)`	Add documentation to tags matching the given pattern.
`final List<String>`	`getTagStatLink()`	Add external links into `Statistics by Tag`.
`final Unit`	`setTagStatLink(List<String> tagStatLink)`	Add external links into `Statistics by Tag`.
`final List<String>`	`getRemoveKeywords()`	Remove keywords and their messages altogether.
`final Unit`	`setRemoveKeywords(List<String> removeKeywords)`	Remove keywords and their messages altogether.
`final List<String>`	`getFlattenKeywords()`	Flatten keywords and their messages altogether.
`final Unit`	`setFlattenKeywords(List<String> flattenKeywords)`	Flatten keywords and their messages altogether.
`final Property<Boolean>`	`getNoStatusSrc()`	Sets the return code to zero regardless of failures in test cases.
`final Unit`	`setNoStatusSrc(Property<Boolean> noStatusSrc)`	Sets the return code to zero regardless of failures in test cases.
`final Property<String>`	`getConsoleColors()`	Use colors on console output or not.
`final Unit`	`setConsoleColors(Property<String> consoleColors)`	Use colors on console output or not.
`final List<String>`	`getArgumentFiles()`	Text file to read more arguments from.
`final Unit`	`setArgumentFiles(List<String> argumentFiles)`	Text file to read more arguments from.
`final Property<String>`	`getName()`	Sets the name of the documented library or resource.
`final ConfigurableFileCollection`	`getAdditionalPythonPaths()`	Additional locations where to search for libraries and resources.
`final Unit`	`setAdditionalPythonPaths(ConfigurableFileCollection additionalPythonPaths)`	Additional locations where to search for libraries and resources.
`Array<String>`	`generateArguments()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RunRobotConfiguration
```
RunRobotConfiguration(Project project)
```
- Method Detail
  - getSkip
```
 final List<String> getSkip()
```
    Tests having given tag will be skipped. Tag can be a pattern.
  - setSkip
```
 final Unit setSkip(List<String> skip)
```
    Tests having given tag will be skipped. Tag can be a pattern.
  - getSkipOnFailure
```
 final List<String> getSkipOnFailure()
```
    Tests having given tag will be skipped if they fail. Tag can be a pattern.
  - setSkipOnFailure
```
 final Unit setSkipOnFailure(List<String> skipOnFailure)
```
    Tests having given tag will be skipped if they fail. Tag can be a pattern.
  - getExtension
```
 final ListProperty<String> getExtension()
```
    Parse only files with this extension when executing a directory. Has no effect when running individual files or when using resource files.
    Examples:
    extension.add("txt") extension.addAll("robot", "txt")
  - getVariables
```
 final MapProperty<String, String> getVariables()
```
    Set variables in the test data. Only scalar variables with string value are supported and name is given without ${}. See variableFiles for a more powerful variable setting mechanism.
    Examples:
    variable = mapOf("str" to "Hello") => ${str} = `Hello` variable = mapOf("hi" to "Hi_World") => ${hi} = `Hi World` (*) variable = mapOf("x" to null, "y" to "42") => ${x} = ``, ${y} = `42`
    Remarks:
    (*) To replaces _ in Hi_World with space pass -E space:_ as additional argument
    Prefer variableFiles
  - getVariableFiles
```
 final ListProperty<String> getVariableFiles()
```
    Python or YAML file to read variables from. Possible arguments to the variable file can be given after the path using colon or semicolon as separator.
    Examples:
    variableFile = "path/vars.yaml" variableFile = "environment.py:testing"
  - getDebugFile
```
 final RegularFileProperty getDebugFile()
```
    Debug file written during execution. Not created unless this option is specified.
  - getMaxErrorLines
```
 final Property<Integer> getMaxErrorLines()
```
    Maximum number of error message lines to show in report when tests fail. Default is 40, minimum is 10 and -1 can be used to show the full message (will be mapped to NONE in cmd call).
    Remark: The lower limit of 10 is not validated by the plugin!
  - getListener
```
 final ListProperty<String> getListener()
```
    A class for monitoring test execution. Gets notifications e.g. when tests start and end. Arguments to the listener class can be given after the name using a colon or a semicolon as a separator.
    Examples:
    listener = listOf("MyListenerClass") listener = listOf("path/to/Listener.py:arg1:arg2")
  - getDryrun
```
 final Property<Boolean> getDryrun()
```
    Verifies test data and runs tests so that library keywords are not executed.
    Default: false
  - getExitOnFailure
```
 final Property<Boolean> getExitOnFailure()
```
    Stops test execution if any critical test fails.
    Default: false
  - getExitOnError
```
 final Property<Boolean> getExitOnError()
```
    Stops test execution if any error occurs when parsing test data, importing libraries, and so on.
    Default: false
  - getSkipTearDownOnExit
```
 final Property<Boolean> getSkipTearDownOnExit()
```
    Causes teardowns to be skipped if test execution is stopped prematurely.
    Default: false
  - getRandomize
```
 final Property<String> getRandomize()
```
    Randomizes the test execution order.
    all: randomizes both suites and tests
    suites: randomizes suites
    tests: randomizes tests
    none: no randomization
    Use syntax VALUE:SEED to give a custom random seed. The seed must be an integer.
    Examples:
    randomize = "all" randomize = "tests:1234"
    Default: none
  - getPreRunModifier
```
 final ListProperty<String> getPreRunModifier()
```
    Class to programmatically modify the test suite structure before execution.
  - getPreRebotModifier
```
 final ListProperty<String> getPreRebotModifier()
```
    Class to programmatically modify the result model before creating reports and logs.
  - getConsole
```
 final Property<String> getConsole()
```
    How to report execution on the console.
    verbose: report every suite and test
    dotted: only show '.' for passed test,
    'f' for failed non-critical tests, and
    'F' for failed critical tests
    quiet: no output except for errors and warnings
    none: no output whatsoever
    Default: verbose
  - getDotted
```
 final Property<Boolean> getDotted()
```
    Shortcut for console = "dotted".
    Default: false
  - getQuite
```
 final Property<Boolean> getQuite()
```
    Shortcut for console = "quite".
    Default: false
  - getConsoleWidth
```
 final Property<Integer> getConsoleWidth()
```
    Width of the console output.
    Default: 78.
  - getConsoleMarkers
```
 final Property<String> getConsoleMarkers()
```
    Use colors on console output or not.
    auto: use colors when output not redirected
    on: always use colors
    ansi: like 'on' but use ANSI colors also on Windows
    off: disable colors altogether
    Note that colors do not work with Jython on Windows.
    Default: auto
  - getRpa
```
 final Property<Boolean> getRpa()
```
    Turn on the generic automation mode (aka Robot Process Automation). Mainly affects terminology so that "test" is replaced with "task" in logs and reports. By default the mode is got from the processed output files.
  - setRpa
```
 final Unit setRpa(Property<Boolean> rpa)
```
    Turn on the generic automation mode (aka Robot Process Automation). Mainly affects terminology so that "test" is replaced with "task" in logs and reports. By default the mode is got from the processed output files.
  - getDoc
```
 final Property<String> getDoc()
```
    Set the documentation of the top level suite. Simple formatting is supported (e.g. *bold*). If the documentation contains spaces, it must be quoted.
    doc = "Very *good* example"
  - setDoc
```
 final Unit setDoc(Property<String> doc)
```
    Set the documentation of the top level suite. Simple formatting is supported (e.g. *bold*). If the documentation contains spaces, it must be quoted.
    doc = "Very *good* example"
  - getMetaData
```
 final Map<String, String> getMetaData()
```
    Set metadata of the top level suite. Value can contain formatting similarly as doc.
    metaData = mapOf("Version" to "1.2")
  - setMetaData
```
 final Unit setMetaData(Map<String, String> metaData)
```
    Set metadata of the top level suite. Value can contain formatting similarly as doc.
    metaData = mapOf("Version" to "1.2")
  - getSetTags
```
 final List<String> getSetTags()
```
    Sets given tag(s) to all tests.
  - setSetTags
```
 final Unit setSetTags(List<String> setTags)
```
    Sets given tag(s) to all tests.
  - getTest
```
 final List<String> getTest()
```
    Select tests by name or by long name containing also parent suite name like Parent.Test. Name is case and space insensitive and it can also be a simple pattern where * matches anything, ? matches any single character, and [chars] matches one character in brackets.
  - setTest
```
 final Unit setTest(List<String> test)
```
    Select tests by name or by long name containing also parent suite name like Parent.Test. Name is case and space insensitive and it can also be a simple pattern where * matches anything, ? matches any single character, and [chars] matches one character in brackets.
  - getTask
```
 final List<String> getTask()
```
    Alias to test. Especially applicable with rpa.
  - setTask
```
 final Unit setTask(List<String> task)
```
    Alias to test. Especially applicable with rpa.
  - getSuite
```
 final List<String> getSuite()
```
    Select suites by name. When this option is used with test, include or exclude, only tests in matching suites and also matching other filtering criteria are selected. Name can be a simple pattern similarly as with test and it can contain parent name separated with a dot. For example, suite = "X.Y" selects suite Y only if its parent is X.
  - setSuite
```
 final Unit setSuite(List<String> suite)
```
    Select suites by name. When this option is used with test, include or exclude, only tests in matching suites and also matching other filtering criteria are selected. Name can be a simple pattern similarly as with test and it can contain parent name separated with a dot. For example, suite = "X.Y" selects suite Y only if its parent is X.
  - getInclude
```
 final List<String> getInclude()
```
    Select tests by tag. Similarly as name with test, tag is case and space insensitive and it is possible to use patterns with *, ? and [] as wildcards. Tags and patterns can also be combined together with AND, OR, and NOT operators.
    include = listOf("foo", "bar*") include = "fooANDbar*"
  - setInclude
```
 final Unit setInclude(List<String> include)
```
    Select tests by tag. Similarly as name with test, tag is case and space insensitive and it is possible to use patterns with *, ? and [] as wildcards. Tags and patterns can also be combined together with AND, OR, and NOT operators.
    include = listOf("foo", "bar*") include = "fooANDbar*"
  - getExclude
```
 final List<String> getExclude()
```
    Specify tests not to be included by tag. They are not selected even if included with include. Tags are matched using same rules as with include.
  - setExclude
```
 final Unit setExclude(List<String> exclude)
```
    Specify tests not to be included by tag. They are not selected even if included with include. Tags are matched using same rules as with include.
  - getCritical
```
 final List<String> getCritical()
```
    Opposite of nonCritical
  - setCritical
```
 final Unit setCritical(@Deprecated(message = Since RF 4.0) List<String> critical)
```
    Opposite of nonCritical
  - getNonCritical
```
 final List<String> getNonCritical()
```
    Alias for RunRobotConfiguration.skipOnFailure.
  - setNonCritical
```
 final Unit setNonCritical(@Deprecated(message = Since RF 4.0) List<String> nonCritical)
```
    Alias for RunRobotConfiguration.skipOnFailure.
  - getOutputDir
```
 final DirectoryProperty getOutputDir()
```
    Where to create output files. The given path is considered relative to command execution directory unless it is absolute.
    Default: ${project.buildDir}/reports/robotframework.
  - getOutput
```
 final File getOutput()
```
    XML output file. Not created unless this option is specified. Given path, similarly as paths given to log, report and xUnit, is relative to outputDir unless given as an absolute path.
  - setOutput
```
 final Unit setOutput(File output)
```
    XML output file. Not created unless this option is specified. Given path, similarly as paths given to log, report and xUnit, is relative to outputDir unless given as an absolute path.
  - getLog
```
 final File getLog()
```
    HTML log file. Can be disabled by passing null.
    Default: log.html
    log = "mylog.html" log = null
  - setLog
```
 final Unit setLog(File log)
```
    HTML log file. Can be disabled by passing null.
    Default: log.html
    log = "mylog.html" log = null
  - getReport
```
 final File getReport()
```
    HTML report file. Can be disabled by passing null similarly as log.
    Default: report.html
  - setReport
```
 final Unit setReport(File report)
```
    HTML report file. Can be disabled by passing null similarly as log.
    Default: report.html
  - getXUnit
```
 final File getXUnit()
```
    xUnit compatible result file. Not created unless this option is specified. Will be stored under outputDir. Default: robot-xunit-results.xml
  - setXUnit
```
 final Unit setXUnit(File xUnit)
```
    xUnit compatible result file. Not created unless this option is specified. Will be stored under outputDir. Default: robot-xunit-results.xml
  - getXUnitSkipNonCritical
```
 final Property<Boolean> getXUnitSkipNonCritical()
```
    Has no effect anymore.
    Mark non-critical tests in xUnit output as skipped.
    Default: disabled (false)
  - setXUnitSkipNonCritical
```
 final Unit setXUnitSkipNonCritical(@Deprecated(message = Since RF 4.0) Property<Boolean> xUnitSkipNonCritical)
```
    Has no effect anymore.
    Mark non-critical tests in xUnit output as skipped.
    Default: disabled (false)
  - getTimestampOutputs
```
 final Property<Boolean> getTimestampOutputs()
```
    When this option is used, timestamp in a format YYYYMMDD-hhmmss is added to all generated output files between their basename and extension.
    timestampOutputs = true output = "output.xml" report = "report.html" log = null
    creates files like output-20070503-154410.xml and report-20070503-154410.html.
    Default: false
  - setTimestampOutputs
```
 final Unit setTimestampOutputs(Property<Boolean> timestampOutputs)
```
    When this option is used, timestamp in a format YYYYMMDD-hhmmss is added to all generated output files between their basename and extension.
    timestampOutputs = true output = "output.xml" report = "report.html" log = null
    creates files like output-20070503-154410.xml and report-20070503-154410.html.
    Default: false
  - getSplit
```
 final Property<Boolean> getSplit()
```
    Split the log file into smaller pieces that open in browsers transparently.
    Default: false
  - setSplit
```
 final Unit setSplit(Property<Boolean> split)
```
    Split the log file into smaller pieces that open in browsers transparently.
    Default: false
  - getLogTitle
```
 final Property<String> getLogTitle()
```
    Title for the generated log file. The default title is <SuiteName> Test Log.
  - setLogTitle
```
 final Unit setLogTitle(Property<String> logTitle)
```
    Title for the generated log file. The default title is <SuiteName> Test Log.
  - getReportTitle
```
 final Property<String> getReportTitle()
```
    Title for the generated report file. The default title is <SuiteName> Test Report.
  - setReportTitle
```
 final Unit setReportTitle(Property<String> reportTitle)
```
    Title for the generated report file. The default title is <SuiteName> Test Report.
  - getReportBackground
```
 final Property<String> getReportBackground()
```
    Background colors to use in the report file. Order is passed:failed:skipped. Both color names and codes work. skipped can be omitted.
    reportBackground = "green:red:yellow" reportBackground = "#00E:#E00"
  - setReportBackground
```
 final Unit setReportBackground(Property<String> reportBackground)
```
    Background colors to use in the report file. Order is passed:failed:skipped. Both color names and codes work. skipped can be omitted.
    reportBackground = "green:red:yellow" reportBackground = "#00E:#E00"
  - getLogLevel
```
 final Property<String> getLogLevel()
```
    The threshold level for logging. Threshold for selecting messages. Available levels: TRACE (default), DEBUG, INFO, WARN, NONE (no msgs). Use syntax LOGLEVEL:DEFAULT to define the default visible log level in log files.
    logLevel = "DEBUG" logLevel = "DEBUG:INFO"
  - setLogLevel
```
 final Unit setLogLevel(Property<String> logLevel)
```
    The threshold level for logging. Threshold for selecting messages. Available levels: TRACE (default), DEBUG, INFO, WARN, NONE (no msgs). Use syntax LOGLEVEL:DEFAULT to define the default visible log level in log files.
    logLevel = "DEBUG" logLevel = "DEBUG:INFO"
  - getSuiteStatLevel
```
 final Property<Integer> getSuiteStatLevel()
```
    How many levels to show in Statistics by Suite in log and report. By default all suite levels are shown.
    suiteStatLevel = 3
  - setSuiteStatLevel
```
 final Unit setSuiteStatLevel(Property<Integer> suiteStatLevel)
```
    How many levels to show in Statistics by Suite in log and report. By default all suite levels are shown.
    suiteStatLevel = 3
  - getTagStatInclude
```
 final List<String> getTagStatInclude()
```
    Include only matching tags in Statistics by Tag in log and report. By default all tags are shown. Given tag can be a pattern like with include.
  - setTagStatInclude
```
 final Unit setTagStatInclude(List<String> tagStatInclude)
```
    Include only matching tags in Statistics by Tag in log and report. By default all tags are shown. Given tag can be a pattern like with include.
  - getTagStatExclude
```
 final List<String> getTagStatExclude()
```
    Exclude matching tags from Statistics by Tag. This option can be used with tagStatInclude similarly as exclude is used with include.
  - setTagStatExclude
```
 final Unit setTagStatExclude(List<String> tagStatExclude)
```
    Exclude matching tags from Statistics by Tag. This option can be used with tagStatInclude similarly as exclude is used with include.
  - getTagStatCombine
```
 final Map<String, String> getTagStatCombine()
```
    Create combined statistics based on tags. These statistics are added into Statistics by Tag. If the optional name is not given, name of the combined tag is got from the specified tags. Tags are matched using the same rules as with include.
    tagstatcombine = mapOf("requirement-*" to null) tagstatcombine = mapOf("tag1ANDtag2" to "My_name")
  - setTagStatCombine
```
 final Unit setTagStatCombine(Map<String, String> tagStatCombine)
```
    Create combined statistics based on tags. These statistics are added into Statistics by Tag. If the optional name is not given, name of the combined tag is got from the specified tags. Tags are matched using the same rules as with include.
    tagstatcombine = mapOf("requirement-*" to null) tagstatcombine = mapOf("tag1ANDtag2" to "My_name")
  - getTagDoc
```
 final Map<String, String> getTagDoc()
```
    Add documentation to tags matching the given pattern. Documentation is shown in Test Details and also as a tooltip in Statistics by Tag. Pattern can use *, ? and [] as wildcards like --test. Documentation can contain formatting like --doc.
    tagDoc = mapOf("mytag" to "Example") tagDoc = mapOf("owner-*" to "Original author")
  - setTagDoc
```
 final Unit setTagDoc(Map<String, String> tagDoc)
```
    Add documentation to tags matching the given pattern. Documentation is shown in Test Details and also as a tooltip in Statistics by Tag. Pattern can use *, ? and [] as wildcards like --test. Documentation can contain formatting like --doc.
    tagDoc = mapOf("mytag" to "Example") tagDoc = mapOf("owner-*" to "Original author")
  - getTagStatLink
```
 final List<String> getTagStatLink()
```
    Add external links into Statistics by Tag. Pattern can use *, ? and [] as wildcards like test. Characters matching to * and ? wildcards can be used in link and title with syntax %N, where N is index of the match (starting from 1).
    tagStatLink = listOf("mytag:http://my.domain:Title") tagStatLink = listOf("bug-*:http://url/id=%1:Issue Tracker")
  - setTagStatLink
```
 final Unit setTagStatLink(List<String> tagStatLink)
```
    Add external links into Statistics by Tag. Pattern can use *, ? and [] as wildcards like test. Characters matching to * and ? wildcards can be used in link and title with syntax %N, where N is index of the match (starting from 1).
    tagStatLink = listOf("mytag:http://my.domain:Title") tagStatLink = listOf("bug-*:http://url/id=%1:Issue Tracker")
  - getRemoveKeywords
```
 final List<String> getRemoveKeywords()
```
    Remove keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#removing-keywords.
    ALL - Remove data from all keywords unconditionally.
    PASSED -Remove keyword data from passed test cases. In most cases, log files created using this option contain enough information to investigate possible failures.
    FOR - Remove all passed iterations from for loops except the last one.
    WUKS - Remove all failing keywords inside BuiltIn keyword 'Wait Until Keyword Succeeds' except the last one.
    NAME:<pattern> - Remove data from all keywords matching the given pattern regardless the keyword status.
    TAG:<pattern> - Remove data from keywords with tags that match the given pattern.
    The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.
  - setRemoveKeywords
```
 final Unit setRemoveKeywords(List<String> removeKeywords)
```
    Remove keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#removing-keywords.
    ALL - Remove data from all keywords unconditionally.
    PASSED -Remove keyword data from passed test cases. In most cases, log files created using this option contain enough information to investigate possible failures.
    FOR - Remove all passed iterations from for loops except the last one.
    WUKS - Remove all failing keywords inside BuiltIn keyword 'Wait Until Keyword Succeeds' except the last one.
    NAME:<pattern> - Remove data from all keywords matching the given pattern regardless the keyword status.
    TAG:<pattern> - Remove data from keywords with tags that match the given pattern.
    The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.
  - getFlattenKeywords
```
 final List<String> getFlattenKeywords()
```
    Flatten keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#flattening-keywords.
    FOR - Flatten for loops fully.
    FORITEM - Flatten individual for loop iterations.
    NAME:<pattern> - Flatten keywords matching the given pattern.
    TAG:<pattern> - Flatten keywords with tags matching the given pattern.
    The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.
  - setFlattenKeywords
```
 final Unit setFlattenKeywords(List<String> flattenKeywords)
```
    Flatten keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#flattening-keywords.
    FOR - Flatten for loops fully.
    FORITEM - Flatten individual for loop iterations.
    NAME:<pattern> - Flatten keywords matching the given pattern.
    TAG:<pattern> - Flatten keywords with tags matching the given pattern.
    The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.
  - getNoStatusSrc
```
 final Property<Boolean> getNoStatusSrc()
```
    Sets the return code to zero regardless of failures in test cases. Error codes are returned normally.
  - setNoStatusSrc
```
 final Unit setNoStatusSrc(Property<Boolean> noStatusSrc)
```
    Sets the return code to zero regardless of failures in test cases. Error codes are returned normally.
  - getConsoleColors
```
 final Property<String> getConsoleColors()
```
    Use colors on console output or not.
    auto: use colors when output not redirected (default)
    on: always use colors
    ansi: like on but use ANSI colors also on Windows
    off: disable colors altogether Note that colors do not work with Jython on Windows.
  - setConsoleColors
```
 final Unit setConsoleColors(Property<String> consoleColors)
```
    Use colors on console output or not.
    auto: use colors when output not redirected (default)
    on: always use colors
    ansi: like on but use ANSI colors also on Windows
    off: disable colors altogether Note that colors do not work with Jython on Windows.
  - getArgumentFiles
```
 final List<String> getArgumentFiles()
```
    Text file to read more arguments from. Use special path STDIN to read contents from the standard input stream. File can have both options and input files or directories, one per line. Contents do not need to be escaped but spaces in the beginning and end of lines are removed. Empty lines and lines starting with a hash character (#) are ignored.
    --include regression --name Regression Tests # This is a comment line my_tests.robot path/to/test/directory/
    argumentFile = "argfile.txt" argumentFile = "STDIN"
  - setArgumentFiles
```
 final Unit setArgumentFiles(List<String> argumentFiles)
```
    Text file to read more arguments from. Use special path STDIN to read contents from the standard input stream. File can have both options and input files or directories, one per line. Contents do not need to be escaped but spaces in the beginning and end of lines are removed. Empty lines and lines starting with a hash character (#) are ignored.
    --include regression --name Regression Tests # This is a comment line my_tests.robot path/to/test/directory/
    argumentFile = "argfile.txt" argumentFile = "STDIN"
  - getName
```
 final Property<String> getName()
```
    Sets the name of the documented library or resource.
  - getAdditionalPythonPaths
```
 final ConfigurableFileCollection getAdditionalPythonPaths()
```
    Additional locations where to search for libraries and resources. e.g. src/main/java/com/test/
  - setAdditionalPythonPaths
```
 final Unit setAdditionalPythonPaths(ConfigurableFileCollection additionalPythonPaths)
```
    Additional locations where to search for libraries and resources. e.g. src/main/java/com/test/
  - generateArguments
```
 Array<String> generateArguments()
```

Class RunRobotConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RunRobotConfiguration

Method Detail

getSkip

setSkip

getSkipOnFailure

setSkipOnFailure

getExtension

getVariables

getVariableFiles

getDebugFile

getMaxErrorLines

getListener

getDryrun

getExitOnFailure

getExitOnError

getSkipTearDownOnExit

getRandomize

getPreRunModifier

getPreRebotModifier

getConsole

getDotted

getQuite

getConsoleWidth

getConsoleMarkers

getRpa

setRpa

getDoc

setDoc

getMetaData

setMetaData

getSetTags

setSetTags

getTest

setTest

getTask

setTask

getSuite

setSuite

getInclude

setInclude

getExclude

setExclude

getCritical

setCritical

getNonCritical

setNonCritical

getOutputDir

getOutput

setOutput

getLog

setLog

getReport

setReport

getXUnit

setXUnit

getXUnitSkipNonCritical

setXUnitSkipNonCritical

getTimestampOutputs

setTimestampOutputs

getSplit

setSplit

getLogTitle

setLogTitle

getReportTitle

setReportTitle

getReportBackground

setReportBackground

getLogLevel

setLogLevel

getSuiteStatLevel

setSuiteStatLevel

getTagStatInclude

setTagStatInclude