bitrix_task_control/config/README.md

63 lines
3.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Конфигурация филиала
Код собирается по профилю отдела (`src/departments/<id>`). Набор отчётов и их реализации задаёт профиль. Различия **данных** между таблицами — лист `Config` и Script Properties.
## Развёртывание
Из корня репозитория:
```bash
npm test
npm run deploy -- universal
```
Это тесты, сборка `dist/universal` и `clasp push` в каждый id из `scriptIds` в `departments.json`. Редактор Apps Script не используйте как место правок исходников.
Для новой таблицы:
1. Создайте профиль отдела и запись в `departments.json`.
2. Создайте в таблице лист `Config` по образцу `config/config.sheet.example.md`.
3. Project Settings → Script properties — секреты из списка ниже.
4. `npm run deploy -- <id>`.
Обязательные ключи Config зависят от включённых в профиль отчётов. Если ключ нужен включённому отчёту и не заполнен, запуск останавливается с явной ошибкой.
## Лист Config
Имя листа строго `Config`. Первая строка может быть заголовком `key | value`. Дальше пары ключ–значение.
| Ключ | Смысл |
|------|--------|
| SOURCE_SHEET_ID | gid листа выгрузки задач |
| COMPLETED_SOURCE_SHEET_ID | gid листа выгрузки завершенных задач |
| EMAILS_SHEET_ID | gid листа email сотрудников |
| ROLES_SHEET_ID | gid листа ролей (ячейки B1–B6: РОП, зам. РОПа, рукфил, зам. рукфила, директор, контролёр) |
| BACKUP_EMAILS_SPREADSHEET_ID | таблица с запасными email (листы РП и АП) |
| MANAGER_TABLES_CONFIG_ID | JSON на Drive: исполнитель → персональная таблица |
| ORG_STRUCTURE_FILE_ID | JSON оргструктуры на Drive |
| DEPARTMENT_ID | ID отдела в оргструктуре |
| TEMPLATE_SCAN_DEPARTMENT_ID | отдел для сканера шаблонов |
| BITRIX_PORTAL | `https://example.bitrix24.ru` без слэша на конце |
| BALANCER_URL | URL балансировщика Bitrix REST |
| TEMPLATE_SCANNER_URL | URL сервиса latest template id |
| DEFAULT_FILIAL_HEAD_NAME | ФИО рукфила по умолчанию |
Необязательные:
| Ключ | По умолчанию |
|------|----------------|
| METRICS_SHEET_NAME | Data |
| TASK_INDEX_SHEET_NAME | taskIndex |
## Script Properties (не хранить в git)
| Ключ | Смысл |
|------|--------|
| BALANCER_PUBLIC | публичный ключ HMAC балансировщика |
| BALANCER_SECRET | секрет HMAC |
| BITRIX_WEBHOOK_TASKS | базовый webhook URL для `tasks.task.*` (со слэшем на конце) |
| BITRIX_WEBHOOK_USERS | webhook для `user.get` |
| BITRIX_WEBHOOK_TEMPLATES | webhook для `tasks.template.get` |
Константы самих отчётов (префиксы листов, словари кодов, индекс вставки листа) лежат в `src/core/constants.ts`.