Wiki

Clone wiki

1C.Utils / Documentation

Описание командлетов модуля

Модуль содержит следующие командлеты:

Clear-Cache1C

Выводит пронумерованный список баз с размером кэша для каждой базы и дожидается выбора баз для очистки кэша.
По умолчанию очищается только каталог кэша метаданных.
Для ОС Windows C:\Users\NameUser\AppData\Local\1C\1Cv8.
Параметр UserSettings позволяет очистить каталог кэша настроек пользователя.
Для ОС Windows C:\Users\NameUser\AppData\Roaming\1C\1Cv8.

Параметры запуска:

-UserSettings - Очистить кэш настроек пользователя.
Псевдонимы: us
-Force - Очистить кэш у всех баз не спрашивая.
-Wait - После выполнения дождаться нажатия любой клавиши.

Get-DirectoryCache1C

По умолчанию возвращает каталог хранения кэша метаданных.
Если задан параметр UserSettings, то возвращает каталог хранения кэша настроек пользователя.
Если в каталоге кэша обнаружен файл location.cfg, то каталог хранения будет прочитан из файла (параметр location).
По умолчанию для ОС Windows платформы 1C версии 8.3 кэш хранится в каталогах:
- кэш метаданных в C:\Users\NameUser\AppData\Local\1C\1Cv8 - кэш настроек пользователя в C:\Users\NameUser\AppData\Roaming\1C\1Cv8

Параметры запуска:

-UserSettings - Вернуть каталог кэша настроек пользователя.

Get-Exe1C

По переданной строке поиска пытается определить исполняемый файл платформы.
Входной строкой поиска может быть:
- пустая строка - будет произведен поиск исполняемого файла в стандартном каталоге последней установленной версии платформы
- каталог установки 1С - в указанном каталоге будет произведен поиск исполняемого файла последней установленной версии
- номер версии платформы в формате 8.3.XX.XXXX - в стандартном каталоге установки, в подкаталоге с заданным номером версии
будет произведен поиск исполняемого файла
- можно передать сам exe файл, тогда без поиска вернется он же
Если переданный каталог установки или файл не существуют или не установлена переденная версия,
то возвращается исполняемый файл последней установленной версии найденный в стандартном каталоге установки.
Дополнительно можно передать имя исполняемого файла (по умолчанию 1cv8).

Параметры запуска:

-SearchString - Входная строка поиска.
-FileName - Имя исполняемого файла (по умолчанию 1cv8).

Get-iBasesFullName

Возвращает полный путь к файлу iBases.v8i.
* Для ОС Windows: %APPDATA%\1C\1CEStart\iBases.v8i.

Get-InstalledLocation1C

Возвращает полный путь установки платформы 1С по данным файлов:
* Для ОС Windows:
- %ALLUSERSPROFILE%\Application Data\1C\1CEStart
- %APPDATA%\1C\1CEStart

Get-ObjectsXML

Формирует xml-файл объектов метаданных для захвата в хранилище 1С.
Преобразует текстовый отчет сравнения в xml-файл списка объектов как требует платформа 1С для захвата объектов в хранилище 1С (см. справку ключа запуска платформы /ConfigurationRepositoryLock или /ConfigurationRepositoryUnLock).

Параметры запуска:

-ReportOfCompare - Полный путь к текстовому отчету сравнения.

Get-RolesXML

Формирует xml-файл объектов метаданных для захвата в хранилище 1С.
Преобразует список сообщений конфигуратора в xml-файл списка объектов как требует платформа 1С для захвата объектов в хранилище 1С. Список сообщений выдается в окне сообщений конфигуратора при не удачной попытке удаления объектов метаданных в хранилище конфигурации 1С.

Параметры запуска:

-File - Путь к файлу содержащий список сообщений конфигуратора при не удачном удалении метаданных.
-Clipboard - Сообщения конфигуратора взять из буфера обмена.

New-Designer1C

Возвращает объект класса Designer1C. Предназначен для работы с командной строкой конфигуратора в объектной модели - вместо ключей командной строки методы с параметрами.
Если не нашлось необходимого метода, есть метод Run составляющий команндную строку запуска из массива переданных ключей.
Для просмотра всех свойств и методов (со всеми перегрузками) запустите New-Designer1C | Get-Member | Format-List
Описание свойств и методов в описании класса.

Параметры запуска:

[-PathBase] - Задается адрес расположения базы (можно установить методом SetBase):
- для файловой базы c:\CatalogBases1C\NameBase
- для клиент-серверной базы NameServer[:NumberPort]\NameBase
- для базы на веб-сервере http://NameWebServer/NameBase

Псевдонимы: b

[-UserName] - Имя пользователя базы (можно установить методом SetUserBase).
Псевдонимы: u

[-Password] - Пароль пользователя базы (можно установить методом SetUserBase).
Псевдонимы: p

[-IBName] - Имя базы как оно задано в окне запуске 1С.
Псевдонимы: ib

[-Platform] - Номер версии платформы 8.3.XX.XXXX. Если не задан, то будет произведен поиск в стандартном каталоге установки последней установленной версии платформы.
Игнорируется если задан параметр IBName.

[-LogFile] - Полный путь к лог-файлу.
Псевдонимы: l, log

[-Settings] - Путь к файлу настроек класса сохраненных методом ExportToYAML или ExportToJSON (можно загрузить методом ImportFrom).
Псевдонимы: s, import

Set-DebugServer1C

Псевдоним: Dbg-Srv1C

Включает/выключает отладку на сервере 1С.
Запуск без параметров добавляет ключ отладки в строку запуска сервера 1С в реестре Windows и перезапускает службу сервера 1С.

Параметры запуска:

-Off - Отключает отладку на сервере 1С. Если указан, то ключ отладки будет удален из строки запуска сервера.
-NotRestart - Не перезапускать службу сервера 1С.
-Wait - Для завершения работы ждать подтверждения от пользователя.

Start-1C

Псевдоним: RUN-1C

Выполняет в пакетном режиме переданные в файле настроек командные ключи платформы 1С для заданного набора баз.
Позволяет для разных баз выполнить один набор команд. При этом общий набор команд для каждой базы можно переопределить индивидуальным набором команд.
Файл настроек задается в формате YAML или JSON.
Для получения пустого шаблона файла настроек небходимо запустить командлет с ключами:
-CFG C:\ПолныйПутьКФайлу\ШаблонНастроек.YAML -TemplateCFG
-CFG C:\ПолныйПутьКФайлу\ШаблонНастроек.JSON -TemplateCFG -JSON
В сформированном шаблоне настроек представлена инструкция по его наполнению.

Параметры запуска:

-CFG - Полный путь к файлу настроек (наборы ключей и баз) (если первый, то имя параметра можно не указывать).
-TemplateCFG - Создается пустой шаблон файла настроек (необязательный - если указан, то в указаный в предыдущем параметре файл будет записан шаблон настроек в формате yaml)
-JSON - Шаблон настроек будет записан в формате JSON.
-OpenLog - После выполнения открывает лог файла в редакторе по умолчанию.
-Wait - После выполения дожидаться нажатия любой клавиши.

Stop-1C

Псевдоним: Kill-1C

Завершает запущенные процессы платформы 1С.
Выводит список всех запущенных процессов платформы 1С и ожидает подтверждения пользователя для завершения.
Если передана строка поиска, то будут найдены все процессы платформы 1С содержащие в своей командной строке запуска переданную строку.

Параметры запуска:

-Search - Фрагмент строки запуска (или фрагменты через запятую) содержание которого будет определяться в командной строке запуска платформы 1С.
Псевдонимы: s, filter, f
-IncludeServer1C - Включить процессы сервера 1С в список к удалению. По умолчанию процессы сервера 1С в список к удалению не включаются.
-Force - Завершить все найденные процессы без вопросов.

Read-iBases

Преобразует текстовый файл настроек запуска баз iBases.v8i в массив хэш-таблиц,
где в каждой хэш-таблице перечисленны все указаные для одной базы параметры.

Параметры запуска:

-FilePath - Полный путь к файл настроек запуска баз iBases.v8i. Необязательный. Если не указан, то будет взят из профиля текущего пользователя:
* Для ОС Windows: %APPDATA%\1C\1CEStart\iBases.v8i.

Uninstall-1C

Деинсталирует все установленые стандартным установщиком версии платформы 1С кроме:
- заданных по умолчанию в файле iBases.v8i из профиля текущего пользователя
- запущенных на момент выполнения скрипта
После запуска команды выводится список всех установленных платформ для удаления
(список исключений выделен цветом) и ожидается подтверждение пользователя на удаление.

Параметры запуска:

-Wait - После выполнения дожидаться нажатия любой клавиши.
-Force - Деинсталировать все найденные версии без вопросов.

Updated