> For the complete documentation index, see [llms.txt](https://docs.precisiontestautomation.in/scriptlessautomation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.precisiontestautomation.in/scriptlessautomation/get-started/scriptless-config/testmanagementconfiguration/zephyrscale.properties.md).

# zephyrscale.properties

### Introduction

Integrating your automated testing framework with Zephyr Scale streamlines the process of managing test cases, executing tests, and reporting outcomes. This detailed guide explains the configuration settings within the `zephyrscale.properties` file to ensure successful integration.

### Location of `zephyrscale.properties`

Ensure the file is placed in your project structure as follows:

```arduino
project
└── config
    └── testManagementConfiguration
        └── zephyrscale.properties
```

### Configuration Settings in `zephyrscale.properties` 🛠️

Located under your project's configuration directory, the `zephyrscale.properties` file contains the necessary settings for Zephyr Scale integration. Here's what you need to know about each key:

1. **`ZEPHYRE_ENABLE`**: Controls whether the Zephyr Scale integration is active. Set to `enable` to activate the integration or `disable` to deactivate it.
   * **Example**: `ZEPHYRE_ENABLE=disable`
2. **`ZEPHYRE_AUTH`**: Your Zephyr Scale API token used for authentication. This token grants your automated tests access to Zephyr Scale's API for managing test cases and results.
   * **Example**: `ZEPHYRE_AUTH=yourApiTokenHere`
3. **`ZEPHYR_BASE_URL`**: The base URL for the Zephyr Scale API. This URL is where your automated tests will send API requests.
   * **Example**: `ZEPHYR_BASE_URL=https://api.zephyrscale.smartbear.com/v2`
4. **`ZEPHYRE_JIRA_BASE_URL`**: The base URL for your JIRA instance. This is required if your Zephyr Scale is integrated with JIRA for issue tracking.
   * **Example**: `ZEPHYRE_JIRA_BASE_URL=https://yourdomain.atlassian.net/rest/api/3`
5. **`ZEPHYRE_JIRA_USERNAME`**: The username for your JIRA account. This is used alongside the API key for authentication with JIRA.
   * **Example**: `ZEPHYRE_JIRA_USERNAME=yourEmail@example.com`
6. **`ZEPHYRE_JIRA_APIKEY`**: Your JIRA API key. This key is used for authenticating API requests to your JIRA instance.
   * **Example**: `ZEPHYRE_JIRA_APIKEY=yourJiraApiKeyHere`
7. **`ZEPHYRE_PROJECT_NAME`**: The name of the project in Zephyr Scale where your tests are organized. This should match the project name in Zephyr Scale.
   * **Example**: `ZEPHYRE_PROJECT_NAME=YourProjectName`
8. **`ZEPHYRE_TEST_PLAN_NAME`**: The name of the test plan in Zephyr Scale. Test plans are used to group test cycles and cases for specific testing objectives.
   * **Example**: `ZEPHYRE_TEST_PLAN_NAME=YourTestPlanName`
9. **`ZEPHYRE_TEST_PLAN_OBJECTIVE`**: The objective or goal of the test plan. This provides context for the test cases and cycles grouped under this plan.
   * **Example**: `ZEPHYRE_TEST_PLAN_OBJECTIVE=Test Plan Objective`
10. **`ZEPHYRE_TEST_CYCLE_NAME`**: The name of the test cycle. Test cycles are used to execute a group of test cases under a test plan.
    * **Example**: `ZEPHYRE_TEST_CYCLE_NAME=YourTestCycleName`
11. **`ZEPHYRE_TEST_CYCLE_DESCRIPTION`**: A description of the test cycle. This provides additional details about the scope or purpose of the test cycle.
    * **Example**: `ZEPHYRE_TEST_CYCLE_DESCRIPTION=Test Cycle Description`
12. **`ZEPHYRE_TEST_NAME`**: The name of the test or group of tests. This can be used to identify specific tests or test suites within a test cycle.
    * **Example**: `ZEPHYRE_TEST_NAME=YourTestName`

### Conclusion

After configuring the `zephyrscale.properties` file with the appropriate settings, your automated testing framework is equipped to leverage Zephyr Scale for enhanced test management capabilities. This integration facilitates the automated creation and updating of test plans, cycles, and cases, ensuring a seamless workflow between test execution and result reporting.

### zephyrscale Template

{% file src="/files/wNBax26SSOEIOjLEuLs2" %}

{% hint style="info" %}
This feature is available in License Code
{% endhint %}