| // kafka-connector options: START |
| [[camel-robotframework-kafka-connector-sink]] |
| = camel-robotframework-kafka-connector sink configuration |
| |
| When using camel-robotframework-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.kafkaconnector</groupId> |
| <artifactId>camel-robotframework-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-robotframework sink connector supports 53 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.sink.path.resourceUri* | Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod. | null | HIGH |
| | *camel.sink.endpoint.argumentFile* | A text file to read more arguments from. | null | MEDIUM |
| | *camel.sink.endpoint.combinedTagStats* | Creates combined statistics based on tags. Use the format tags:title List | null | MEDIUM |
| | *camel.sink.endpoint.contentCache* | Sets whether to use resource content cache or not | false | MEDIUM |
| | *camel.sink.endpoint.criticalTags* | Tests that have the given tags are considered critical. List | null | MEDIUM |
| | *camel.sink.endpoint.debugFile* | A debug file that is written during execution. | null | MEDIUM |
| | *camel.sink.endpoint.document* | Sets the documentation of the top-level tests suites. | null | MEDIUM |
| | *camel.sink.endpoint.dryrun* | Sets dryrun mode on use. In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax. | false | MEDIUM |
| | *camel.sink.endpoint.excludes* | Selects the tests cases by tags. List | null | MEDIUM |
| | *camel.sink.endpoint.exitOnFailure* | Sets robot to stop execution immediately if a critical test fails. | false | MEDIUM |
| | *camel.sink.endpoint.includes* | Selects the tests cases by tags. List | null | MEDIUM |
| | *camel.sink.endpoint.listener* | Sets a single listener for monitoring tests execution | null | MEDIUM |
| | *camel.sink.endpoint.listeners* | Sets multiple listeners for monitoring tests execution. Use the format ListenerWithArgs:arg1:arg2 or simply ListenerWithoutArgs List | null | MEDIUM |
| | *camel.sink.endpoint.log* | Sets the path to the generated log file. | null | MEDIUM |
| | *camel.sink.endpoint.logLevel* | Sets the threshold level for logging. | null | MEDIUM |
| | *camel.sink.endpoint.logTitle* | Sets a title for the generated tests log. | null | MEDIUM |
| | *camel.sink.endpoint.metadata* | Sets free metadata for the top level tests suites. comma seperated list of string resulting as List | null | MEDIUM |
| | *camel.sink.endpoint.monitorColors* | Using ANSI colors in console. Normally colors work in unixes but not in Windows. Default is 'on'. 'on' - use colors in unixes but not in Windows 'off' - never use colors 'force' - always use colors (also in Windows) | null | MEDIUM |
| | *camel.sink.endpoint.monitorWidth* | Width of the monitor output. Default is 78. | "78" | MEDIUM |
| | *camel.sink.endpoint.name* | Sets the name of the top-level tests suites. | null | MEDIUM |
| | *camel.sink.endpoint.nonCriticalTags* | Tests that have the given tags are not critical. List | null | MEDIUM |
| | *camel.sink.endpoint.noStatusReturnCode* | If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally. | false | MEDIUM |
| | *camel.sink.endpoint.output* | Sets the path to the generated output file. | null | MEDIUM |
| | *camel.sink.endpoint.outputDirectory* | Configures where generated reports are to be placed. | null | MEDIUM |
| | *camel.sink.endpoint.randomize* | Sets the test execution order to be randomized. Valid values are all, suite, and test | null | MEDIUM |
| | *camel.sink.endpoint.report* | Sets the path to the generated report file. | null | MEDIUM |
| | *camel.sink.endpoint.reportBackground* | Sets background colors for the generated report and summary. | null | MEDIUM |
| | *camel.sink.endpoint.reportTitle* | Sets a title for the generated tests report. | null | MEDIUM |
| | *camel.sink.endpoint.runEmptySuite* | Executes tests also if the top level test suite is empty. Useful e.g. with --include/--exclude when it is not an error that no test matches the condition. | false | MEDIUM |
| | *camel.sink.endpoint.runFailed* | Re-run failed tests, based on output.xml file. | null | MEDIUM |
| | *camel.sink.endpoint.runMode* | Sets the execution mode for this tests run. Note that this setting has been deprecated in Robot Framework 2.8. Use separate dryryn, skipTeardownOnExit, exitOnFailure, and randomize settings instead. | null | MEDIUM |
| | *camel.sink.endpoint.skipTeardownOnExit* | Sets whether the teardowns are skipped if the test execution is prematurely stopped. | false | MEDIUM |
| | *camel.sink.endpoint.splitOutputs* | Splits output and log files. | null | MEDIUM |
| | *camel.sink.endpoint.suites* | Selects the tests suites by name. List | null | MEDIUM |
| | *camel.sink.endpoint.suiteStatLevel* | Defines how many levels to show in the Statistics by Suite table in outputs. | null | MEDIUM |
| | *camel.sink.endpoint.summaryTitle* | Sets a title for the generated summary report. | null | MEDIUM |
| | *camel.sink.endpoint.tagDocs* | Adds documentation to the specified tags. List | null | MEDIUM |
| | *camel.sink.endpoint.tags* | Sets the tags(s) to all executed tests cases. List | null | MEDIUM |
| | *camel.sink.endpoint.tagStatExcludes* | Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs. List | null | MEDIUM |
| | *camel.sink.endpoint.tagStatIncludes* | Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs. List | null | MEDIUM |
| | *camel.sink.endpoint.tagStatLinks* | Adds external links to the Statistics by Tag table in outputs. Use the format pattern:link:title List | null | MEDIUM |
| | *camel.sink.endpoint.tests* | Selects the tests cases by name. List | null | MEDIUM |
| | *camel.sink.endpoint.timestampOutputs* | Adds a timestamp to all output files. | false | MEDIUM |
| | *camel.sink.endpoint.variableFiles* | Sets variables using variables files. Use the format path:args List | null | MEDIUM |
| | *camel.sink.endpoint.variables* | Sets individual variables. Use the format name:value List | null | MEDIUM |
| | *camel.sink.endpoint.warnOnSkippedFiles* | Show a warning when an invalid file is skipped. | false | MEDIUM |
| | *camel.sink.endpoint.xunitFile* | Sets the path to the generated XUnit compatible result file, relative to outputDirectory. The file is in xml format. By default, the file name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores. | null | MEDIUM |
| | *camel.sink.endpoint.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM |
| | *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM |
| | *camel.component.robotframework.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM |
| | *camel.component.robotframework.basicProperty Binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.component.robotframework.configuration* | The configuration | null | MEDIUM |
| |=== |
| // kafka-connector options: END |
