Parameters Overview - Test Case Variables Guide
Parameters are reusable variables that can be used in test cases, requirements, and shared steps. They allow you to centralize values like URLs, environment configurations, user credentials, and other data that may change across different environments or need to be reused across multiple test artifacts.
Understanding Parameters
Parameters are key-value pairs that can be referenced in test cases, requirements, and shared steps. They provide several benefits:
- Centralized Configuration: Store values in one place and update them globally
- Environment Management: Use different parameter values for different environments
- Reusability: Reference the same parameter across multiple test artifacts
- Maintainability: Update values once to affect all usages
Workspace vs Project Parameters
Workspace Parameters:
- Available across all projects in the workspace (or selected projects)
- Created and managed at the workspace level
- Can be shared across multiple projects
- Can have project scope (All Projects or Selected Projects)
Project Parameters:
- Available only within a specific project
- Created and managed at the project level
- Cannot be shared with other projects
- Override workspace parameters with the same name
Regular vs Secret Parameters
Regular Parameters:
- Values are visible in plain text
- Suitable for non-sensitive data like URLs, environment names, configuration values
- Can be viewed and edited by users with appropriate permissions
Secret Parameters:
- Values are masked/hidden for security
- Suitable for sensitive data like passwords, API keys, tokens
- Values are encrypted and not visible in the UI
- Can only be viewed/edited by users with appropriate permissions
Accessing Parameters
To access Parameters:
-
Navigate to the workspace by clicking on it from the Workspaces page.
-
In the workspace sidebar, click on “Parameters” or navigate to
/workspace/:workspaceId/parameters. -
As a result, you’ll see the Parameters page with a table of all parameters in the workspace.
Parameter Properties
Each parameter has the following properties:
- Parameter ID: Unique identifier automatically assigned
- Name: User-defined name (used for referencing)
- Value: The parameter value
- Description: Optional details about the parameter
- Project Scope: For workspace parameters, whether it applies to all projects or selected projects
- Projects: For workspace parameters with selected scope, the list of projects
- Created Timestamp: When the parameter was created
- Created By: User who created the parameter
- Usages: List of testcases, requirements, and shared steps using the parameter
Next Steps
- Learn how to View and Filter Parameters to find and organize parameters
- Explore Creating Parameters to add new parameters
- Check out Managing Parameters to edit and delete parameters
- Review Using Parameters for usage examples and best practices
Was this page helpful?