Параметры команд

При создании новой команды в Дистансис выбирается предопределённый тип команды.

Тип команды определяет, какое действие будет выполнено на удалённом компьютере: проверка кассы, работа с файлами, запуск приложения, чтение реестра, перезапуск службы, выполнение операции 1С и другие действия.

Создание команды

Для создания команды:

1. Откройте раздел Команды.
2. Нажмите Добавить команду.
3. Укажите наименование команды.
4. Выберите предопределённый тип команды из списка.

5. При необходимости установите дополнительные флаги:

6. Для 1С;

7. Для службы;
8. Быстрая команда бота.
9. Заполните параметры команды.
10. Нажмите Сохранить.

Как указываются параметры

Параметры команды указываются в таблице Параметры команды.

Каждый параметр добавляется отдельной строкой через кнопку Добавить строку.

В строке указываются два поля:

Поле	Назначение
Параметр	имя параметра
Значение	значение параметра

Имя параметра указывается обязательно. Значение можно указать сразу при создании команды или позже при создании задачи.

Не используйте точку с запятой

В текущем интерфейсе параметры не нужно записывать одной строкой через ;. Каждый параметр добавляется отдельной строкой.

Правильно:

Параметр	Значение
file_from	C:\Install\file.txt
file_to	C:\Backup\file.txt

Неправильно:

C:\Install\file.txt;C:\Backup\file.txt

Когда значение можно оставить пустым

Значение параметра можно оставить пустым, если оно должно задаваться при создании задачи.

Например, можно создать универсальную команду Копирование файла с параметрами:

Параметр	Значение
file_from
file_to

При создании задачи оператор укажет конкретные значения:

Параметр	Значение
file_from	C:\Install\setup.exe
file_to	C:\Temp\setup.exe

Такой подход удобен, когда одна команда используется для разных файлов, клиентов или компьютеров.

Флаг «Для службы»

Флаг Для службы означает, что команда будет выполняться службой агента Дистансис.

Этот режим используется для команд, которым нужны системные права или выполнение без участия пользователя.

Примеры:

• перезапуск службы Windows;
• проверка файлов;
• чтение системных каталогов;
• запуск служебных операций;
• работа с кассовым оборудованием;
• операции, которые не требуют взаимодействия с рабочим столом пользователя.

Права выполнения

Если команда должна работать с системными каталогами, службами или настройками Windows, обычно требуется выполнение через службу.

Флаг «Для 1С»

Флаг Для 1С используется для команд, связанных с запуском внешник обработок 1С.

Флаг «Быстрая команда бота»

Флаг Быстрая команда бота используется для команд, которые должны быть доступны как быстрые действия через бота.

Такие команды должны быть безопасными, понятными и заранее проверенными.

Не рекомендуется добавлять в быстрые команды действия, которые могут удалить файлы, изменить настройки системы или повлиять на работу клиента без дополнительной проверки.

Команды для касс Атол

AtolCheckOFD

Проверяет отправку чеков в ОФД кассы Атол.

Параметры не требуются.

AtolChekDateTimeKKM

Устанавливает время кассы Атол, если оно не совпадает со временем компьютера.

Параметры не требуются.

AtolGetFNEndDate

Получает дату окончания фискального накопителя кассы Атол.

Параметры не требуются.

AtolGetFNNumber

Получает номер фискального накопителя кассы Атол.

Параметры не требуются.

AtolGetFactoryNumberKKT

Получает заводской номер кассового аппарата кассы Атол.

Параметры не требуются.

AtolGetItemsKKM

Получает значение настройки кассового аппарата Атол.

Параметры:

Параметр	Обязательный	Описание	Пример значения
item	Да	числовой номер настройки кассы	273

Пример заполнения:

Параметр	Значение
item	273

AtolSetNumericItemsKKM

Устанавливает числовое значение настройки кассового аппарата Атол.

Параметры:

Параметр	Обязательный	Описание	Пример значения
item	Да	числовой номер настройки кассы	274
value	Да	числовое значение настройки	19801

Пример заполнения:

Параметр	Значение
item	274
value	19801

AtolSetStringItemsKKM

Устанавливает строковое значение настройки кассового аппарата Атол.

Параметры:

Параметр	Обязательный	Описание	Пример значения
item	Да	числовой номер настройки кассы	273
value	Да	строковое значение настройки	ofdp.platformaofd.ru

Пример заполнения:

Параметр	Значение
item	273
value	ofdp.platformaofd.ru

Команды для касс Штрих-М

CheckTimeKKM

Устанавливает время кассы Штрих-М.

Параметры не требуются.

Check_OFD_Date

Проверяет отправку чеков в ОФД кассы Штрих-М.

Параметры не требуются.

GetFactoryNumberKKT

Получает заводской номер кассового аппарата кассы Штрих-М.

Параметры не требуются.

GetFnEndDate

Получает дату окончания фискального накопителя кассы Штрих-М.

Параметры не требуются.

ReadWriteTableFromStringDrawer

Получает или записывает значение настройки кассового аппарата Штрих-М.

Параметры:

Параметр	Обязательный	Описание	Пример значения
command	Да	команда чтения или записи	ReadStringTableValue
TableNumber	Да	номер таблицы	1
FieldNumber	Да	номер поля	2
RowNumber	Да	номер ряда	1
value	Для записи	значение для записи	example

Допустимые значения параметра command:

Значение	Назначение
ReadStringTableValue	прочитать строковое значение
ReadIntegerTableValue	прочитать числовое значение
WriteStringTableValue	записать строковое значение
WriteIntegerTableValue	записать числовое значение

Параметр value указывается только для команд:

• WriteStringTableValue;
• WriteIntegerTableValue.

Пример чтения значения:

Параметр	Значение
command	ReadStringTableValue
TableNumber	1
FieldNumber	2
RowNumber	1

Пример записи значения:

Параметр	Значение
command	WriteStringTableValue
TableNumber	1
FieldNumber	2
RowNumber	1
value	example

Команды для файлов и облака

CheckFileInCloud

Проверяет наличие файла в облаке.

Параметры:

Параметр	Обязательный	Описание	Пример значения
file_path	Да	путь к каталогу или файлу	C:\Install\
file_name	Да	имя файла	setup.exe
sub_dir_cloud	Да	подкаталог в облаке	instal_files

Пример заполнения:

Параметр	Значение
file_path	C:\Install\
file_name	setup.exe
sub_dir_cloud	instal_files

DownloadFileFromCloud

Скачивает файл из облака на удалённый компьютер.

Параметры:

Параметр	Обязательный	Описание	Пример значения
file_path	Да	путь к каталогу на удалённом компьютере	C:\Install\
file_name	Да	имя файла	setup.exe
private	Да	признак приватного файла	false
sub_dir_cloud	Да	подкаталог в облаке	instal_files

Пример заполнения:

Параметр	Значение
file_path	C:\Install\
file_name	setup.exe
private	false
sub_dir_cloud	instal_files

UploadFileToCloud

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

Параметры:

Параметр	Обязательный	Описание	Пример значения
file_path	Да	путь к каталогу на удалённом компьютере	C:\Install\
file_name	Да	имя файла	setup.exe
private	Да	признак приватного каталога компьютера	false
sub_dir_cloud	Да	подкаталог в облаке	instal_files

Пример заполнения:

Параметр	Значение
file_path	C:\Install\
file_name	setup.exe
private	false
sub_dir_cloud	instal_files

FindFilesAndUploadToCloud

Ищет файлы по маске и загружает найденные файлы в облако.

Параметры:

Параметр	Обязательный	Описание	Пример значения
path	Да	каталог для поиска файлов	C:\Logs\
mask	Да	маска имени файла	*.log
private	Да	признак приватного каталога компьютера	false
sub_dir_cloud	Да	подкаталог в облаке	logs

Пример заполнения:

Параметр	Значение
path	C:\Logs\
mask	*.log
private	false
sub_dir_cloud	logs

CopyFile

Копирует файл на удалённом компьютере.

Параметры:

Параметр	Обязательный	Описание	Пример значения
file_from	Да	исходный путь к файлу	C:\Install\file.txt
file_to	Да	путь назначения	C:\Backup\file.txt

Пример заполнения:

Параметр	Значение
file_from	C:\Install\file.txt
file_to	C:\Backup\file.txt

CreateDirectory

Создаёт каталог на удалённом компьютере.

Параметры:

Параметр	Обязательный	Описание	Пример значения
path	Да	путь создаваемого каталога	C:\Install

Пример заполнения:

Параметр	Значение
path	C:\Install

FileExists

Проверяет существование файла на удалённом компьютере.

Параметры:

Параметр	Обязательный	Описание	Пример значения
file_name	Да	полный путь к файлу	C:\Install\setup.exe

Пример заполнения:

Параметр	Значение
file_name	C:\Install\setup.exe

CheckFreeSpaceDisk

Проверяет свободное место по указанному пути.

Если значение параметра need_free_space_gb больше фактического свободного места, команда завершится с ошибкой.

Параметры:

Параметр	Обязательный	Описание	Пример значения
path	Да	путь к диску или каталогу	C:\
need_free_space_gb	Да	необходимый объём свободного места в гигабайтах	10

Пример заполнения:

Параметр	Значение
path	C:\
need_free_space_gb	10

Команды Windows

ExecuteApp

Запускает приложение на удалённом компьютере.

Если включён флаг Для службы, приложение запускается от имени системы.

Если флаг Для службы выключен, приложение запускается от имени текущего пользователя. В этом случае на компьютере должен выполняться процесс UserHelpApp.exe.

Параметры:

Параметр	Обязательный	Описание	Пример значения
file_name	Да	полный путь к исполняемому файлу	C:\Install\setup.exe
parametrs	Нет	параметры запуска приложения	/silent
App	Для запуска от пользователя	приложение или параметр для запуска в пользовательской сессии	C:\Install\setup.exe

Название параметра

В интерфейсе используется параметр parametrs. Указывайте имя параметра именно так, если оно ожидается выбранной командой.

Пример запуска через службу:

Параметр	Значение
file_name	C:\Install\setup.exe
parametrs	/silent

RestartService

Перезапускает службу Windows.

Параметры:

Параметр	Обязательный	Описание	Пример значения
service_name	Да	имя службы Windows	Spooler

Пример заполнения:

Параметр	Значение
service_name	Spooler

StartService

Запускает службу Windows.

Параметры:

Параметр	Обязательный	Описание	Пример значения
service_name	Да	имя службы Windows	Spooler

Пример заполнения:

Параметр	Значение
service_name	Spooler

StoptService

Останавливает службу Windows.

Параметры:

Параметр	Обязательный	Описание	Пример значения
service_name	Да	имя службы Windows	Spooler

Пример заполнения:

Параметр	Значение
service_name	Spooler

RegisterDll

Регистрирует DLL-файл.

Параметры:

Параметр	Обязательный	Описание	Пример значения
dll_name	Да	имя или полный путь к DLL-файлу	C:\Program Files\App\example.dll

Пример заполнения:

Параметр	Значение
dll_name	C:\Program Files\App\example.dll

ReadReestr

Читает значение из 32-битной версии реестра Windows.

Параметры:

Параметр	Обязательный	Описание	Пример значения
root_key	Да	корневой раздел реестра	HKEY_LOCAL_MACHINE
sub_key	Да	ветка реестра	SOFTWARE\Microsoft\Windows\CurrentVersion\Run
key_name	Да	имя параметра	ИмяПараметра

Пример заполнения:

Параметр	Значение
root_key	HKEY_LOCAL_MACHINE
sub_key	SOFTWARE\Microsoft\Windows\CurrentVersion\Run
key_name	ИмяПараметра

Допустимые примеры root_key:

• HKEY_LOCAL_MACHINE;
• HKEY_CURRENT_USER.

WriteReestr

Записывает значение в 32-битную версию реестра Windows.

Параметры:

Параметр	Обязательный	Описание	Пример значения
root_key	Да	корневой раздел реестра	HKEY_LOCAL_MACHINE
sub_key	Да	ветка реестра	SOFTWARE\Microsoft\Windows\CurrentVersion\Run
key_name	Да	имя параметра	ИмяПараметра
key_value	Да	значение параметра	ЗначениеПараметра

Пример заполнения:

Параметр	Значение
root_key	HKEY_LOCAL_MACHINE
sub_key	SOFTWARE\Microsoft\Windows\CurrentVersion\Run
key_name	ИмяПараметра
key_value	ЗначениеПараметра

Команды 1С

Clear_cache1C

Очищает кэш базы 1С.

Параметры не требуются.

TestBD_1C

Исправляет файл базы данных 1С.

Используется для файловых баз. Перед выполнением операции предварительно создаётся копия базы данных.

Параметры не требуются.

UploadFile_ibases.v8i_InCloud

Загружает в облако список баз 1С.

После выполнения этой команды следует использовать команду загрузки списка баз 1С из файла в облаке на сервере.

Параметры не требуются.

Execute1CCode

Выполняет функцию общего модуля 1С.

Параметры:

Параметр	Обязательный	Описание	Пример значения
name_module	Да	имя общего модуля	ОбщийМодульИнтеграции
name_func	Да	имя функции	ВыполнитьКоманду

Пример заполнения:

Параметр	Значение
name_module	ОбщийМодульИнтеграции
name_func	ВыполнитьКоманду

Служебные команды Дистансис

GetVersionAPP

Получает версию UserHelpApp.exe.

Параметры не требуются.

GetVersionService

Получает версию службы ServiceUsersHelp.exe.

Параметры не требуются.

GroupTask

Системная команда. Используется при выполнении групповой задачи.

Обычно эта команда не используется вручную для обычных задач.

Параметры:

Параметр	Обязательный	Описание	Пример значения
name	Да	название групповой задачи	Обновление 1С

Пример заполнения:

Параметр	Значение
name	Обновление 1С

MakeScreenshot

Используется в групповой задаче создания скриншота экрана.

Параметры не требуются.

PingClient

Проверяет, что компьютер находится в состоянии Online.

Параметры не требуются.

SendPhotoInTelegram

Отправляет фото в Telegram.

Для работы команды должен быть заполнен Token Telegram в данных Telegram.

Параметры:

Параметр	Обязательный	Описание	Пример значения
photo	Да	путь к изображению на удалённом компьютере	C:\UsersHelp\screen.jpg

Пример заполнения:

Параметр	Значение
photo	C:\UsersHelp\screen.jpg

Краткая таблица команд

Команда	Назначение	Параметры
AtolCheckOFD	Проверка отправки чеков в ОФД кассы Атол	Не требуются
AtolChekDateTimeKKM	Установка времени кассы Атол, если оно не совпадает со временем компьютера	Не требуются
AtolGetFNEndDate	Получить дату окончания фискального накопителя кассы Атол	Не требуются
AtolGetFNNumber	Получить номер фискального накопителя кассы Атол	Не требуются
AtolGetFactoryNumberKKT	Получить заводской номер кассового аппарата кассы Атол	Не требуются
AtolGetItemsKKM	Получить значение настройки кассы Атол	item
AtolSetNumericItemsKKM	Установить числовое значение настройки кассы Атол	item, value
AtolSetStringItemsKKM	Установить строковое значение настройки кассы Атол	item, value
CheckFileInCloud	Проверить наличие файла в облаке	file_path, file_name, sub_dir_cloud
CheckFreeSpaceDisk	Проверить свободное место по пути	path, need_free_space_gb
CheckTimeKKM	Установка времени кассы Штрих-М	Не требуются
Check_OFD_Date	Проверка отправки чеков в ОФД кассы Штрих-М	Не требуются
Clear_cache1C	Очистить кэш базы 1С	Не требуются
CopyFile	Копировать файл	file_from, file_to
CreateDirectory	Создать каталог	path
DownloadFileFromCloud	Скачать файл из облака на компьютер	file_path, file_name, private, sub_dir_cloud
ExecuteApp	Запустить приложение	file_name, parametrs, App
FileExists	Проверить существование файла	file_name
FindFilesAndUploadToCloud	Найти файлы по маске и загрузить в облако	path, mask, private, sub_dir_cloud
GetFactoryNumberKKT	Получить заводской номер кассы Штрих-М	Не требуются
GetFnEndDate	Получить дату окончания фискального накопителя Штрих-М	Не требуются
GetVersionAPP	Получить версию UserHelpApp.exe	Не требуются
GetVersionService	Получить версию службы ServiceUsersHelp.exe	Не требуются
GroupTask	Системная команда групповой задачи	name
MakeScreenshot	Создать скриншот экрана	Не требуются
PingClient	Проверить, что компьютер Online	Не требуются
ReadReestr	Прочитать 32-битную версию реестра Windows	root_key, sub_key, key_name
ReadWriteTableFromStringDrawer	Прочитать или записать настройку кассы Штрих-М	command, TableNumber, FieldNumber, RowNumber, value
RegisterDll	Зарегистрировать DLL-файл	dll_name
RestartService	Перезапустить службу Windows	service_name
SendPhotoInTelegram	Отправить фото в Telegram	photo
StartService	Запустить службу Windows	service_name
StoptService	Остановить службу Windows	service_name
TestBD_1C	Исправить файловую базу 1С	Не требуются
UploadFileToCloud	Загрузить файл с компьютера в облако	file_path, file_name, private, sub_dir_cloud
UploadFile_ibases.v8i_InCloud	Загрузить в облако список баз 1С	Не требуются
WriteReestr	Записать значение в 32-битную версию реестра Windows	root_key, sub_key, key_name, key_value
Execute1CCode	Выполнить функцию общего модуля 1С	name_module, name_func

Ошибки при заполнении параметров

Команда может завершиться с ошибкой, если:

• не указан обязательный параметр;
• имя параметра написано неверно;
• значение параметра не заполнено;
• указан неверный путь к файлу;
• указан неверный номер настройки кассы;
• команда выполняется без нужных прав;
• выбран неправильный режим выполнения;
• команда запускается не на той операционной системе;
• значение было оставлено пустым при создании команды, но не заполнено при создании задачи.

Рекомендуемый порядок проверки команды

Перед массовым применением команды:

1. Создайте команду.
2. Укажите имена параметров.
3. При необходимости заполните значения параметров.
4. Запустите команду на одном тестовом компьютере.
5. Проверьте результат выполнения.
6. При необходимости скорректируйте параметры.
7. Только после проверки используйте команду для нескольких компьютеров.

Не запускайте непроверенные команды массово

Ошибка в параметрах при массовом запуске может привести к одинаковой ошибке сразу на нескольких компьютерах клиента.