> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yahont.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# TestRail

> Индексирование тест-кейсов из проектов TestRail

Коннектор TestRail индексирует тест-кейсы из ваших проектов TestRail.
Каждый кейс становится одним документом с шагами и ожидаемыми результатами в виде текста и ссылкой на кейс в TestRail.

## Как это работает

| Содержимое | Поведение |
| - | - |
| Тест-кейсы | Один документ на кейс. Документ называется `<ключ кейса>: <заголовок>`, чтобы кейс можно было найти по его ключу TestRail. |
| Шаги | Индексируются раздельные шаги и их ожидаемые результаты. Если у кейса нет раздельных шагов, Yahont использует обычные поля шагов и ожидаемого результата. |
| Поля | Значения пользовательских полей преобразуются в их метки, поэтому раскрывающийся список читается как текст, а не как сохранённое число. |
| Наборы | Yahont читает каждый набор (suite) в проекте. Проект в режиме одного набора читается напрямую. |
| Права | Недоступно. **Auto Sync Permissions** для TestRail не предлагается, поэтому тип доступа может быть только **Public** или **Private**. |

## Перед началом

Вам понадобятся:

* URL вашего сайта TestRail, например `https://example.testrail.io`
* Пользователь TestRail, который может читать проекты, которые вы хотите индексировать
* API-ключ этого пользователя
* Включённый API TestRail для сайта
* Аккаунт администратора Yahont

О включении API и создании ключа см.
[документацию по доступу к API
TestRail](https://support.testrail.com/hc/en-us/articles/7077039051284-Accessing-the-TestRail-API).

> [!NOTE]
>
> Коннектор читает только то, что может читать его пользователь TestRail.

## Настройка Yahont

**1. Откройте коннектор TestRail**

В Yahont откройте **Панель администратора → Добавить коннектор** и выберите **TestRail**.

**2. Создайте учётные данные**

Введите URL сайта в **TestRail Base URL**,
логин пользователя в **TestRail Username** и API-ключ в **TestRail API Key**.

![Создание учётных данных TestRail с базовым URL, именем пользователя и API-ключом](https://mintcdn.com/yahont-ai/gQVGDVoirOMFHw3D/assets/admins/connectors/testrail/TestRailCredential.png?fit=max\&auto=format\&n=gQVGDVoirOMFHw3D\&q=85\&s=653ae493f27a73b16f7bb03cb723616b)

**3. Выберите проекты**

Задайте коннектору название. В **Project IDs** введите список идентификаторов проектов TestRail через запятую,
например `1,2,3`. Оставьте пустым, чтобы индексировать каждый проект, который может читать пользователь.

**4. Выберите тип доступа**

**Public** делает все проиндексированные кейсы видимыми каждому пользователю Yahont.
**Private** ограничивает коннектор выбранными группами пользователей Yahont и является функцией Enterprise Edition:
группы пользователей в Yahont CE недоступны.

**5. Подключите и проверьте**

Нажмите **Create Connector**. Затем откройте **Панель администратора → Существующие коннекторы**,
выберите коннектор и убедитесь, что первая попытка индексации завершилась.

### Расширенные настройки

| Настройка | По умолчанию | Назначение |
| - | - | - |
| Cases Page Size | 250 | Сколько кейсов Yahont запрашивает за один вызов API. Уменьшите, если TestRail не успевает ответить на больших проектах. |
| Max Pages | 10000 | Ограничитель, чтобы цикл постраничной выдачи не мог работать бесконечно. Увеличивайте только для проекта больше допустимого. |
| Skip Document Character Limit | 200000 | Кейс с текстом длиннее этого значения пропускается, а не индексируется. Пропуск записывается в журнал. |

## Ограничения

| Ограничение | Значение | Примечания |
| - | - | - |
| Вызов API TestRail | 60 с | Задайте `REQUEST_TIMEOUT_SECONDS`, чтобы изменить. Это глобальная настройка. |
| Кейсов на страницу | 250 | **Cases Page Size** выше. |
| Страниц на проект | 10000 | **Max Pages** выше. |
| Текст кейса | 200000 символов | **Skip Document Character Limit** выше. Более длинный кейс пропускается. |

Коннектор не индексирует вложения, поэтому у него нет ограничения размера файла.

## Устранение неполадок

> **Учётные данные отклонены**
>
> `Invalid or expired TestRail credentials (HTTP 401)` означает,
> что имя пользователя или API-ключ неверны или ключ отозван. Убедитесь,
> что имя пользователя — это логин пользователя, и создайте новый API-ключ. Также убедитесь,
> что API включён в настройках сайта TestRail.

> **Доступ запрещён**
>
> `Insufficient permissions to access TestRail resources (HTTP 403)` означает,
> что пользователь не может читать индексируемые проекты.
> Предоставьте ему доступ в TestRail или сузьте **Project IDs** до проектов, которые он может читать.

> **Проект или кейс отсутствует**
>
> Убедитесь, что пользователь может открыть его в TestRail и что идентификатор его проекта указан в **Project IDs**,
> если это поле не пусто. Кейс длиннее **Skip Document Character Limit** пропускается и записывается в журнал;
> увеличьте лимит, чтобы проиндексировать его.

> **Индексация медленная или завершается по тайм-ауту**
>
> Уменьшите **Cases Page Size**, чтобы каждый вызов API возвращал меньше данных,
> и увеличьте `REQUEST_TIMEOUT_SECONDS`, если TestRail отвечает медленно.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.