#Parameters Overview
Parameters in Hawzu allow you to define reusable, dynamic values that can be referenced inside rich-text content such as test steps, execution steps, descriptions, and defects. They help reduce duplication, improve consistency, and make large test suites easier to maintain.
#What Are Parameters?
Parameters are named variables that resolve to a value at runtime or usage time.
They are typically used for:
- URLs (application URLs, API endpoints)
- Credentials or environment-specific values
- Reusable identifiers (tenant IDs, user roles, feature flags)
- Frequently changing inputs
In editors, parameters are represented as tokens and can be inserted using:
- The Insert Variable ($) button in the toolbar
- Typing
$ directly inside the editor to trigger suggestions
#Workspace vs Project Parameters
Hawzu supports two levels of parameters: Workspace and Project.
#Workspace Parameters
Workspace parameters are global and automatically available across the entire workspace.
Key characteristics:
- Defined once at the workspace level
- Automatically visible and enabled in all projects
- No enable/disable or opt-in mechanism at project level
- Can be used in any project content immediately
- Ideal for organization-wide constants (e.g., base URLs, shared credentials, environment names)
Workspace parameters act as the single source of truth for values that must stay consistent across projects.
#Project Parameters
Project parameters are scoped to a specific project.
Key characteristics:
- Defined at the project level
- Only visible within that project
- Can override usage patterns locally without affecting other projects
- Useful for project-specific data such as:
- Feature-specific URLs
- Project-only test users
- Temporary or experimental values
#Using Parameters in Editors
Parameters can be inserted into rich-text fields such as:
- Test case steps
- Execution steps
- Defect descriptions
- Preconditions and notes
#How to Insert a Parameter
- Type
$ inside the editor
- A suggestion list appears with available parameters
- Select a parameter to insert it as a token
Alternatively, use the Insert Variable ($) button from the editor toolbar.
Once inserted:
- The parameter appears as a styled, non-editable token
- The name is preserved even if the value changes later
- Content remains readable and structured
#Parameter Resolution
- Parameters store references, not raw values
- When a parameter value is updated, all existing usages automatically reflect the new value
- This allows safe updates without editing hundreds of test cases
#Parameter Lifecycle
#Create
- Define name and value at workspace or project level
- Be intentional with naming (clear, descriptive, stable)
#Update
- Values can be updated safely
- Existing content updates automatically
#Remove
- Removing a parameter requires handling existing references
- Hawzu provides safe options during deletion (covered in Managing Parameters)
#When to Use Parameters (and When Not To)
#Use Parameters When:
- A value is reused across multiple test cases
- A value changes between environments
- You want centralized control
#Avoid Parameters When:
- The value is unique to a single step
- The value is unlikely to ever change
- Inline clarity is more important than reuse
#Best Practices
- Use workspace parameters for global constants
- Use project parameters for local overrides
- Keep parameter names human-readable
- Avoid embedding secrets directly in parameters
- Periodically review unused or deprecated parameters
#Next Steps