Using Parameters in Test Cases - Examples
Parameters can be referenced in test cases, requirements, and shared steps using the parameter name wrapped in double curly braces: \{\{PARAMETER_NAME\}\}.
Example Usage
If you have a parameter named BASE_URL with value https://api.example.com, you can reference it in:
- Test Case Steps: “Navigate to {{BASE_URL}}/login”
- Requirements: “The API endpoint {{BASE_URL}}/users should return user data”
- Shared Steps: “Call {{BASE_URL}}/api/health”
When the test case, requirement, or shared step is used, \{\{BASE_URL\}\} will be replaced with https://api.example.com.
Parameter Resolution
- Parameters are resolved at runtime when test cases are executed
- If a parameter doesn’t exist, the reference remains as
\{\{PARAMETER_NAME\}\} - Project parameters override workspace parameters with the same name
- Parameters are case-sensitive
Use Cases
Environment Configuration
- Create
BASE_URLparameter with different values for dev/staging/prod - Reference
\{\{BASE_URL\}\}in test cases - Update the value once to change the environment for all tests
User Credentials
- Create
TEST_USER_EMAILandTEST_USER_PASSWORDparameters - Use secret parameters for passwords
- Reference them in test cases for login steps
API Endpoints
- Create
API_ENDPOINTparameter - Use it across multiple test cases
- Change the endpoint URL in one place
Configuration Values
- Create
TIMEOUTparameter for test timeouts - Create
RETRY_COUNTparameter for retry logic - Reference them in shared steps
Dynamic Data
- Create parameters for data that changes frequently
- Update values without modifying test cases
- Maintain consistency across test artifacts
Best Practices
When using parameters:
- Naming Convention: Use UPPERCASE with underscores for consistency (e.g.,
BASE_URL,API_KEY) - Descriptive Names: Use names that clearly indicate the parameter’s purpose
- Documentation: Add descriptions to explain parameter usage and values
- Environment-Specific: Use parameters for environment-specific values (dev, staging, prod)
- Centralized Values: Store commonly used values as parameters to avoid duplication
- Project Scope: Use “Selected Projects” for project-specific parameters
- Regular Review: Periodically review parameters to remove unused ones
- Secret Parameters: Use secret parameters for sensitive data like passwords and API keys
- Version Control: Document parameter changes and their impact
- Testing: Test parameter references before deploying to production
Next Steps
- Learn about Custom Fields to extend data capture
- Explore Shared Steps to create reusable test steps
- Read about Project Management to understand project-level parameters
Was this page helpful?