# Локальный агент

# Установка Локального агента на Windows

## Цель 
Установить Локальный агент мониторинга на рабочую станцию Windows с подключённым локальным МФУ для учёта заданий печати.

## Предусловия

- Сервер Мониторинга установлен и доступен по сети.
- Получен клиентский ключ из панели администратора Мониторинга (см. ниже "Подготовка: получить клиентский ключ").
- Командная строка запущена от имени администратора.


## Что потребуется

- Дистрибутив Локального агента, содержащий 5 файлов в одной директории:
  - установочный msi-пакет файл конфигурации в формате XML: `Printum.JobTracking.WindowsService.exe.config`.
  - скрипт установки: `install.bat`
  - скрипт удаления: `uninstall.bat`
  - файл редактирования реестра: `word_hotfix.reg`
- IP-адрес (или имя) сервера Мониторинга и порт (`8000` для `http`, `8001` для `https`).
- Клиентский ключ из раздела "Клиентские ключи" в панели администратора Мониторинга.

## Подготовка: получить клиентский ключ

1. Войдите в панель администратора Мониторинга.
2. Перейдите в раздел "Локальные принтеры" → "Клиентские ключи", нажмите кнопку «Добавить».
3. Заполните поля:
    - **Название** — имя ключа (любое значение).
    - **Ключ** — произвольная строка формата UUID ( \*\*\*\*\*\*\*\*-\*\*\*\*-\*\*\*\*-\*\*\*\*-\*\*\*\*\*\*\*\*\*\*\*\* ), например `5f17bc69-e37e-47ce-b025-60a57dcd20b1`. Заполнять не требуется — генерируется автоматически.
    - **Описание** — подробная информация (необязательное поле).
    - **Включен** — должен быть активирован (установлена галочка).
    - **Компания** — выбрать компанию, к которой будет привязан ключ.
4. Нажмите кнопку "Сохранить".
5. Ключ отобразится в таблице "Клиентские ключи".

## Шаги установки

### Шаг 1. Сохранить файлы дистрибутива

Сохраните на локальный диск компьютера, к которому подключено устройство, файлы локального агента. Все 5 файлов должны находиться в одной директории.

### Шаг 2. Настроить конфигурационный файл

Откройте конфигурационный файл **Printum.JobTracking.WindowsService.exe.config** и отредактируйте параметры: 
```
<setting name="PrintumURL" serializeAs="String">
<value>http://127.0.0.1:8000/localprinter/</value>
</setting>
<setting name="PrintumClientKey" serializeAs="String">
<value>cb074c67-30a3-43c2-9ffc-26753f6441c2</value>
</setting>
```
где:
- **PrintumURL** — замените `http://127.0.0.1:8000` на IP-адрес (или имя) системы мониторинга и действующий порт. Порт может быть `8000` для `http` или `8001` для `https` схемы подключения.
- **PrintumClientKey** — замените `cb074c67-30a3-43c2-9ffc-26753f6441c2` на значение, полученное в разделе "Подготовка: получить локальный ключ". 
- **SerialNumber** — серийный номер МФУ, генерируется автоматически. Заполнять не нужно. 

Для работы по протоколу и порту `https`-`8001` добавьте CA-сертификат из сервера с Мониторингом. Текущий используемый CA-сертификат находится в директории `/home/printum/certs/ca/printum_ca.crt` . Сохраните файл.

### Шаг 3. Запустить установку

Запустите от имени администратора установщик `install.bat`.

При успешном завершении установки в консоли появится сообщение:
```
Install finished. Msiexec log saved in install.log.
```

### Шаг 4. Проверить работоспособность

Запустите печать любого документа на подключённом устройстве.

Зайдите в Личный кабинет, раздел "Управление" → "Устройства". В панели фильтров укажите период, в который попадает сегодняшний день. Проверьте, что устройство появилось в списке.

Зайдите в Личный кабинет, раздел "Аналитика" → "Отчеты по устройствам". Проверьте, что напечатанные страницы были учтены. 

Устройства, подключённые по USB, в конце строки помечаются значком `USB`. 

## Ожидаемый результат

- Установка завершается с сообщением `Install finished`.
- Локальный МФУ отображается в Личном кабинете Мониторинга с отметкой `USB`.
- Задания печати учитываются.


## Как проверить установку

Распечатать тестовый документ и убедиться, что устройство появилось в Личном кабинете → "Управление" → "Устройства", задание появилось в Личном кабинете → "Управление" - "Задания".

> **Примечание:** В некоторых версиях MS Word (например, v.14, MS Office 10 32-bit) неправильно прописывается число копий, отправленных на печать. Microsoft рекомендует устанавливать последние сервис-паки, либо самостоятельно добавлять ключ в реестр Windows. Для этого в состав пакета установки включён файл правки реестра word_hotfix.reg — необходимо отредактировать его в соответствии с установленной версией MS Word и запустить от имени администратора. После этого перезапустить MS Word.

## Типовые ошибки

Локальные принтеры меняют своё название после печати
документов. Проблема связана с неактуальными заданиями печати в спулере рабочей станции, на которой работает локальный агент.

Для исправления:
1. Откройте командную строку с правами администратора, передите в `C:\Windows\System32\spool\PRINTERS`.
2. Остановите спулер:
```
net stop spooler
```
3. Удалите файлы:
```
del *.shd
del *.spl
```
4. Запустите спулер:
```
net start spooler 
```

## Связанные страницы

- [Локальный агент — справка по компоненту](https://wiki.printum.io/books/2-komponenty-sistemy/page/lokalnyi-agent-spravka-po-komponentu)
- [Установка Локального агента на Windows — групповые политики](https://wiki.printum.io/books/3-ustanovka/page/ustanovka-lokalnogo-agenta-na-windows-gruppovye-politiki)
- [Обновление Локального агента на Windows](https://wiki.printum.io/books/3-ustanovka/page/obnovlenie-lokalnogo-agenta-na-windows)
- [Удаление Локального агента на Windows](https://wiki.printum.io/books/3-ustanovka/page/udalenie-lokalnogo-agenta-na-windows)

# Установка Локального агента на Windows — групповые политики

## Цель
Централизованно развернуть Локальный агент мониторинга на рабочих станциях Windows через групповые политики Active Directory.

## Предусловия

- Сервер Мониторинга установлен и доступен по сети.
- Доступны настройки Active Directory и оснастка "Управление групповой политикой".
- Файлы дистрибутива размещены в сетевом каталоге, доступном для всех пользователей и АРМ домена.
- Конфигурационный файл `Printum.JobTracking.WindowsService.exe.config` заполнен (внесены адрес сервера и клиентский ключ). 

## Что потребуется 

Файлы в сетевом каталоге:
- `Printum.JobTracking.WindowsService.exe.config` (с заполненными параметрами)
- `printum_installer.msi`
- `install.bat`
-  Группа безопасности AD с целевыми АРМ.
-  Временная директория на АРМ, например: `C:\Windows\Temp\Printumio`

## Шаги установки

### Шаг 1. Создать группу безопасности в Active Directory

1. В настройках Active Directory выберите нужный домен и кликом в правой части таблицы создайте новую группу.
2. Тип безопасности выберите `группа безопасности`.
3. Двойным кликом войдите во созданную группу и на вкладке "Члены группы" добавьте нужные АРМ.

### Шаг 2. Создать групповую политику

1. В "Управление групповой политикой" выберите нужный домен.
2. Перейдите в контейнер "Объекты групповой политики".
3. В правой части таблицы — правый клик мыши, затем "создать". Задайте имя новой групповой политики, нажмите "Ок". 

### Шаг 3. Настроить делегирование

1. Два раза кликните на вновь созданной политике, перейдите во вкладку "Делегирование", нажмите кнопку "Дополнительно".
2. Выберите группу `прошедшие проверку` и снимите с этой группы галку "Применить групповую политику".
3. Нажмите кнопку "Добавить", выберите типы объектов "Группы", затем нажмите кнопку "Дополнительно".
4. В открывшемся окне нажмите "Поиск". В результатах поиска выберите созданную группу безопасности. Нажмите "Ок", затем ещё раз "Ок".
5. Для вновь добавленной группы установите галку "Применить групповую политику", нажмите кнопку "Ок".

### Шаг 4. Настроить копирование файлов

1. В окне "Управление групповой политикой" в левой части выберите созданную политику и нажмите "Изменить".
2. Настройте копирование 3-х файлов на АРМ пользователей во временную директорию, например в `C:\Windows\Temp\Printumio`:
    - `Printum.JobTracking.WindowsService.exe.config`
    - `printum_installer.msi`
    - `install.bat`
3. Исходные файлы должны находиться в сетевом каталоге, который доступен для всех пользователей и АРМ, прошедших проверку в домене.
4. Выберите "Конфигурация компьютера" → "Настройка" → "Конфигурация Windows" → "Файлы". Создайте новый файл.
5. Выберите действие "Обновить", в "Исходные файлы" укажите сетевой путь к файлу `Printum.JobTracking.WindowsService.exe.config`, в "Конечный файл" укажите путь: `C:\Windows\Temp\Printumio\Printum.JobTracking.WindowsService.exe.config`
6. Проделайте подобную процедуру для файлов `printum_installer.msi` и `install.bat`.
7. У файла `install.bat` должен в итоге оказаться порядок №3.

### Шаг 5. Добавить сценарий автозагрузки

1. Перейдите в "Конфигурация компьютера" → "Политики" → "Конфигурация Windows" → "Сценарии".
2. В правой части таблицы — двойной клик на "Автозагрузка".
3. В открывшемся окне добавьте локальный путь на АРМ пользователя к файлу установки после копирования, например: `C:\Windows\Temp\Printumio\install.bat`.
4. Закройте диалоговое окно кликом по кнопке "Ок".

### Шаг 6. Включить ожидание сети при старте

1. Перейдите в "Конфигурация компьютера" → "Политики" → "Административные шаблоны" → "Система" → "Вход в систему".
2. Двойным кликом в правой части на пункте "всегда ждать сеть при запуске и входе в систему" — переведите в состояние "Включено".
3. Нажмите «Ок». 

### Шаг 7. Применить политику к контейнеру с АРМ

1. Закройте "Редактор управления групповыми политиками".
2. В "Управлении групповой политикой" выберите необходимый контейнер с АРМ, кликните на нём правой кнопкой и выберите пункт "Связать существующий объект групповой политики".
3. В открывшемся окне выберите созданную групповую политику.
4. Нажмите "Ок". 

## Ожидаемый результат

- Через некоторое время на компьютерах в контейнере, выбранном для применения политики, будет установлен Локальный агент мониторинга.
- Служба агента запущена на целевых АРМ.

## Как проверить установку

На целевом АРМ распечатать тестовый документ и убедиться, что задание появилось в Личном кабинете "Управление" → «Задания».
## Типовые ошибки

Локальные принтеры меняют своё название после печати
документов. Проблема связана с неактуальными заданиями печати в спулере рабочей станции, на которой работает локальный агент.

Для исправления:
1. Откройте командную строку с правами администратора, передите в `C:\Windows\System32\spool\PRINTERS`.
2. Остановите спулер:
```
net stop spooler
```
3. Удалите файлы:
```
del *.shd
del *.spl
```
4. Запустите спулер:
```
net start spooler 
```

## Связанные страницы

- [Локальный агент — справка по компоненту](https://wiki.printum.io/books/2-komponenty-sistemy/page/lokalnyi-agent-spravka-po-komponentu)
- [Установка Локального агента на Windows — групповые политики](https://wiki.printum.io/books/3-ustanovka/page/ustanovka-lokalnogo-agenta-na-windows-gruppovye-politiki)
- [Обновление Локального агента на Windows](https://wiki.printum.io/books/3-ustanovka/page/obnovlenie-lokalnogo-agenta-na-windows)

# Установка Локального агента на Linux

## Цель

Установить Локальный агент мониторинга на рабочую станцию Linux с подключённым локальным МФУ для учёта заданий печати. 

## Предусловия 

- Сервер Мониторинга установлен и доступен по сети.
- Получен клиентский ключ из панели администратора Мониторинга.
- Доступ к терминалу рабочей станции.


## Что потребуется

- Дистрибутив Локального агента: `printum-jtm-linux-x.x.tar`.
- IP-адрес сервера Мониторинга.
- Клиентский ключ `CLIENT_KEY` из раздела "Клиентские ключи" в панели администратора Мониторинга.
- Серийный номер принтера (при наличии).

## Подготовка: получить клиентский ключ

1. Войдите в панель администратора Мониторинга.
2. Перейдите в раздел "Локальные принтеры" → "Клиентские ключи", нажмите кнопку «Добавить».
3. Заполните поля:
    - **Название** — имя ключа (любое значение).
    - **Ключ** — произвольная строка формата UUID ( \*\*\*\*\*\*\*\*-\*\*\*\*-\*\*\*\*-\*\*\*\*-\*\*\*\*\*\*\*\*\*\*\*\* ), например `5f17bc69-e37e-47ce-b025-60a57dcd20b1`. Заполнять не требуется — генерируется автоматически.
    - **Описание** — подробная информация (необязательное поле).
    - **Включен** — должен быть активирован (установлена галочка).
    - **Компания** — выбрать компанию, к которой будет привязан ключ.
4. Нажмите кнопку "Сохранить".
5. Ключ отобразится в таблице "Клиентские ключи".

## Шаги установки 

### Шаг 1. Скачать дистрибутив 

Скачайте дистрибутив Локального агента `printum-jtm-linux-x.x.tar`.

### Шаг 2. Запустить установку

После скачивания дистрибутива выполните команды:
```
tar xf printum-jtm-linux-x.x.tar
cd printum-jtm-linux-x.x
SERVER_IP=x.x.x.x CLIENT_KEY=<key> MODULE_IDENT= SN=<123> ./install.sh 
```
где: 
  - **printum-jtm-linux-x.x.tar** — дистрибутив Локального агента версии `x.x`.
  - **printum-jtm-linux-x.x** — директория с распакованным Локальным агентом версии `x.x`.
  - **MODULE_IDENT** — переменная используется для создания идентификатора локального агента. Оставьте её незаполненной.
  - **SERVER_IP** — IP используемого сервера Мониторинга в формате `https://<SERVER_IP>:8001`.
  - **CLIENT_KEY** — значение, которое было получено на этапе "Подготовка: получить клиентский ключ".
  - **SN** — серийный номер принтера; укажите реальный серийный номер. Если серийный номер неизвестен, оставьте поле пустым — он будет генерироваться автоматически.

### Шаг 3. Проверить статус службы

Чтобы проверить, что служба запустилась, выполните команду:
```
systemctl status printum-jtm
```
МФУ, подключённый по USB, должен появиться в Личном кабинете с отметкой в столбце "Дата": "USB".

### Шаг 4. (Опционально) Настроить периодичность опроса

Можно настроить, как часто локальный агент будет отправлять данные. Для этого перейдите в директорию установленного Локального агента:
```
cd /opt/printum-jtm
```
После этого отредактируйте файл `settings.yml`. Поменяйте параметр `upload_interval` — значение указывается в секундах. По умолчанию оно равно `300` . После правки перезапустите службу агента:
```
sudo systemctl restart printum-jtm 
```

## Ожидаемый результат

- Служба `printum-jtm` запущена.
- Локальный МФУ отображается в Личном кабинете Мониторинга с отметкой `USB`.
- Задания печати учитываются.

## Как проверить установку

- Выполнить `systemctl status printum-jtm` — служба должна быть `active (running)`.
- Распечатать тестовый документ и убедиться, что задание появилось в Личном кабинете

## Связанные страницы

- [Локальный агент — справка по компоненту](https://wiki.printum.io/books/2-komponenty-sistemy/page/lokalnyi-agent-spravka-po-komponentu)
- [Установка Локального агента на Windows](https://wiki.printum.io/books/3-ustanovka/page/ustanovka-lokalnogo-agenta-na-windows)
- [Обновление Локального агента на Linux](https://wiki.printum.io/books/3-ustanovka/page/obnovlenie-lokalnogo-agenta-na-linux)

# Обновление Локального агента на Windows

## Цель

Обновить Локальный агент мониторинга на рабочей станции Windows до актуальной версии.

## Предусловия

- Локальный агент ранее установлен на рабочей станции.
- Есть права запуска исполняемых файлов от имени администратора.
- Получен актуальный дистрибутив.

## Что потребуется

- Дистрибутив Локального агента.
- IP-адрес (или имя) сервера Мониторинга и порт (`8000` для `http`, `8001` для `https`).
- Клиентский ключ из раздела "Клиентские ключи" в панели администратора Мониторинга.

## Подготовка: получить клиентский ключ

1. Войдите в панель администратора Мониторинга.
2. Перейдите в раздел "Локальные принтеры" → "Клиентские ключи".
3. Если клиентский ключ ранее был сгенерирован, то используйте ключ из таблицы. Если клиентский ключ ранее сгенерирован не был, нажмите кнопку "Добавить" и выполните пп.4–6.
4. Заполните поля:
    - **Название** — имя ключа (любое значение).
    - **Ключ** — произвольная строка формата UUID ( \*\*\*\*\*\*\*\*-\*\*\*\*-\*\*\*\*-\*\*\*\*-\*\*\*\*\*\*\*\*\*\*\*\* ), например `5f17bc69-e37e-47ce-b025-60a57dcd20b1`. Заполнять не требуется — генерируется автоматически.
    - **Описание** — подробная информация (необязательное поле).
    - **Включен** — должен быть активирован (установлена галочка).
    - **Компания** — выбрать компанию, к которой будет привязан ключ.
5. Нажмите кнопку "Сохранить".
6. Ключ отобразится в таблице "Клиентские ключи".

## Запуск обновления

Обновление ПО осуществляется аналогично установке. Отредактируйте файл в папке распакованного дистрибутива Локального агента **Printum.JobTracking.WindowsService.exe.config**, указав адрес мониторинга в строке `PrintumURL` и полученный ранее клиентский ключ в строке `PrintumClientKey`.

Запустите от имени администратора установщик `install.bat`.

При успешном завершении установки в консоли появится сообщение:
```
Install finished. Msiexec log saved in install.log.
```
Компьютер будет перезагружен.

## Ожидаемый результат

- Локальный агент обновлён до актуальной версии.
- Локальный МФУ отображается в Личном кабинете Мониторинга с отметкой `USB`.
- Задания печати учитываются.

## Как проверить обновление

Распечатать тестовый документ и убедиться, что устройство появилось в Личном кабинете → "Управление" → "Устройства", задание появилось в Личном кабинете → "Управление" - "Задания".

---

## Связанные страницы

- [Установка Локального агента на Windows](http://wiki.printum.io/books/3-ustanovka/page/ustanovka-lokalnogo-agenta-na-windows)
- [Удаление Локального агента на Windows](http://wiki.printum.io/books/3-ustanovka/page/udalenie-lokalnogo-agenta-na-windows)
- [Обновление Локального агента на Linux](https://wiki.printum.io/books/3-ustanovka/page/obnovlenie-lokalnogo-agenta-na-linux)

# Обновление Локального агента на Linux

## Цель

Обновить Локальный агент мониторинга на рабочей станции Linux до актуальной версии.

## Предусловия

- Локальный агент ранее установлен на рабочей станции.
- Доступ к терминалу рабочей станции.
- Получен актуальный дистрибутив.

## Что потребуется

- Дистрибутив актуальной версии: `printum-jtm-linux-x.x.tar`, где `x.x` – актуальная версия агента для Linux.

## Шаги обновления

### Шаг 1. Скачать обновлённый дистрибутив и запустить установку

Скачайте обновлённый дистрибутив и выполните команды:

```
tar xf printum-jtm-linux-x.x.tar
cd printum-jtm-linux-x.x
./install.sh
```

### Шаг 2. Проверить статус службы

Чтобы проверить, что служба работает, выполните:

```
systemctl status printum-jtm
```

## Ожидаемый результат

- Служба `printum-jtm` запущена и работает.
- Задания печати учитываются в Личном кабинете.

## Как проверить обновление

- Выполнить `systemctl status printum-jtm` — служба должна быть `active (running)`.
- Распечатать тестовый документ и убедиться, что задание появилось в Личном кабинете → "Задания".

---

## Связанные страницы

- [Установка Локального агента на Linux](http://wiki.printum.io/books/3-ustanovka/page/ustanovka-lokalnogo-agenta-na-linux)
- [Обновление Локального агента на Windows](https://wiki.printum.io/books/3-ustanovka/page/obnovlenie-lokalnogo-agenta-na-windows)

# Удаление Локального агента на Windows

## Цель

Удалить Локальный агент мониторинга с рабочей станции Windows.

## Предусловия

- Локальный агент установлен на рабочей станции.
- Командная строка или файловый менеджер запущены от имени администратора.
- Доступен файл `uninstall.bat` из дистрибутива агента.

## Что потребуется

- Скрипт удаления `uninstall.bat` из состава дистрибутива Локального агента.

## Запуск удаления Локального агента

Запустите от имени администратора файл `uninstall.bat`.

При успешном завершении удаления в консоли появится сообщение:

```
Uninstall finished. Msiexec log saved in uninstall.log
```

## Ожидаемый результат

- Локальный агент удалён с рабочей станции.
- Служба агента отсутствует в списке служб Windows.

## Как проверить удаление

- Открыть "Службы" и убедиться в отсутствии службы Локального агента.
- Проверить, что устройство перестало отправлять задания в Личный кабинет.

---

## Связанные страницы

- [Установка Локального агента на Windows](http://wiki.printum.io/books/3-ustanovka/page/ustanovka-lokalnogo-agenta-na-windows)
- [Обновление Локального агента на Windows](http://wiki.printum.io/books/3-ustanovka/page/obnovlenie-lokalnogo-agenta-na-windows)