Available settings

This appendix lists all settings that can be used in different sections.

Note

Settings can be localized. See the Translations appendix for supported translations.

Setting section

The Setting section is used to import libraries, resource files and variable files and to define metadata for test suites and test cases. It can be included in test case files and resource files. Note that in a resource file, a Setting section can only include settings for importing libraries, resources, and variables.

Name	Description
Library	Used for importing libraries.
Resource	Used for taking resource files into use.
Variables	Used for taking variable files into use.
Name	Used for setting a custom suite name.
Documentation	Used for specifying a suite or resource file documentation.
Metadata	Used for setting free suite metadata.
Suite Setup	Used for specifying the suite setup.
Suite Teardown	Used for specifying the suite teardown.
Test Tags	Used for specifying test case tags for all tests in a suite.
Force Tags, Default Tags	Deprecated settings for specifying test case tags.
Keyword Tags	Used for specifying user keyword tags for all keywords in a certain file.
Test Setup	Used for specifying a default test setup.
Test Teardown	Used for specifying a default test teardown.
Test Template	Used for specifying a default template keyword for test cases.
Test Timeout	Used for specifying a default test case timeout.
Task Setup, Task Teardown, Task Template, Task Timeout	Aliases for Test Setup, Test Teardown, Test Template and Test Timeout, respectively, that can be used when creating tasks.

Test Case section

The settings in the Test Case section are always specific to the test case for which they are defined. Some of these settings override the default values defined in the Settings section.

Exactly same settings are available when creating tasks in the Task section.

Name	Description
[Documentation]	Used for specifying a test case documentation.
[Metadata]	Used for setting free test metadata.
[Tags]	Used for tagging test cases.
[Setup]	Used for specifying a test setup.
[Teardown]	Used for specifying a test teardown.
[Template]	Used for specifying a template keyword.
[Timeout]	Used for specifying a test case timeout.

Keyword section

Settings in the Keyword section are specific to the user keyword for which they are defined.

Name	Description
[Documentation]	Used for specifying a user keyword documentation.
[Tags]	Used for specifying user keyword tags.
[Arguments]	Used for specifying user keyword arguments.
[Setup]	Used for specifying a user keyword setup. New in Robot Framework 7.0.
[Teardown]	Used for specifying user keyword teardown.
[Timeout]	Used for specifying a user keyword timeout.
[Return]	Used for specifying user keyword return values. Deprecated in Robot Framework 7.0. Use the RETURN statement instead.