How to Create Parameters - Configuration Guide
You can create new parameters if you have the appropriate permissions.
To create a parameter:
-
On the Parameters page, click the “Create Parameter” button in the header.
-
A modal “Create Parameter” will appear. Fill in the following sections:
Parameter Information:
- Name: Enter a unique name for the parameter (e.g., “BASE_URL”, “API_ENDPOINT”, “TEST_USER”). This field is required and must be at least 3 characters long. The name is used to reference the parameter in test cases and shared steps.
- Value: Enter the parameter value (e.g., “https://api.example.com”, “test@example.com”). This field is required. For secret parameters, the value will be masked.
- Description: (Optional) Add a brief description explaining the parameter’s purpose and usage.
Project Scope (workspace only):
- Choose the project scope:
- All Projects: The parameter is available in all projects
- Selected Projects: The parameter is available only in specific projects
- If “Selected Projects” is chosen, use the multi-select dropdown to choose which projects
- You can search for projects by name
-
Click “Create Parameter” to create the parameter.
-
As a result, the new parameter is created and appears in the parameters table. It can now be referenced in test cases, requirements, and shared steps.
Parameter Naming Conventions
When naming parameters, consider:
- Use UPPERCASE: Common convention for constants (e.g.,
BASE_URL,API_KEY) - Use Underscores: Separate words with underscores (e.g.,
TEST_USER_EMAIL) - Be Descriptive: Use names that clearly indicate the parameter’s purpose
- Avoid Spaces: Use underscores or camelCase instead
- Be Consistent: Follow a consistent naming pattern across your workspace
Was this page helpful?