Управление сервисами и утилитами

<Имя сервиса/утилиты> up

Развернуть сервис

<Имя сервиса/утилиты> down

Остановить и удалить сервис

<Имя сервиса/утилиты> start

Запустить сервис

<Имя сервиса/утилиты> stop

Остановить сервис

<Имя сервиса/утилиты> restart

Перезапустить сервис

<Имя сервиса/утилиты> config_up

Сгенерировать настройки сервиса

<Имя сервиса/утилиты> check

Проверить работоспособность сервиса

Управление всеми сервисами и утилитами

all up

Развернуть все сервисы

all down

Остановить и удалить все сервисы

all start

Запустить все сервисы

all stop

Остановить все сервисы

all restart

Перезапустить все сервисы

all config_up

Сгенерировать настройки всех сервисов

all check

Проверить работоспособность всех сервисов

Управление платформой

platform up

Развернуть компонент платформы

platform down

Остановить и удалить компонент платформы

platform start

Запустить компонент платформы

platform stop

Остановить компонент платформы

platform restart

Перезапустить компонент платформы

platform config_up

Сгенерировать конфигурационные файлы сервисов платформы в формате XML на основе config.yml

platform generate_config_yaml

Сгенерировать конфигурационный файл config.yml с минимальными настройками платформы

platform check

Проверить работоспособность платформы

Настройка IIS

iis configure

Настроить IIS

Шифрование параметров конфигурационного файла

enc encrypt_config <Значение>

Зашифровать значение параметра

enc decrypt_config <Значение>

Расшифровать значение параметра

Управление компонентами

components list

Получить список компонентов в виде таблицы. В таблице отображаются установленные, добавленные и доступные для добавления компоненты

components add <Имя компонента>

Добавить компонент по имени

components add_package <Путь к архиву с компонентом>

Добавить компонент из архива. При этом в папку etc/_builds/<Имя компонента> будет распакован архив с файлами компонента

components add_package <Путь к архиву с компонентом> --force_add

Принудительно добавить компонент из архива. Например, если компонент уже есть и его нужно перезаписать. При этом в папку etc/_builds/<Имя компонента> будет распакован архив с файлами компонента

components delete <Имя компонента>

Удалить компонент.

При удалении проверяются зависимости компонентов. Если зависимость есть, то возникает ошибка и указанный компонент не удаляется. Например, нельзя удалить компонент Platform без прикладной разработки Directum RX, веб-справки WebHelp. В этом случае удалите сначала зависимые компоненты

components delete_all

Удалить все компоненты

components fix_plugins_links

Восстановить работоспособность путей к папкам с компонентами системы.

Команду необходимо выполнять, если папку с Directum Launcher переименовали или переместили

<Имя компонента> install

Установить компонент.

С командой можно использовать один из ключей:

•--package;

•--package-from-component

<Имя компонента> install --package="<Путь до пакета с компонентом>"

Установить компонент и опубликовать заказную разработку из указанного пакета. Если пакетов несколько, перечислите их через точку с запятой. При этом выполняется инициализация и применение настроек, также для устанавливаемого компонента импортируются шаблоны документов.

В качестве имени компонента можно указать:

•projectplanning – «Планирование проектов»;

•agile – «Agile-доски»;

•memo – «База знаний»;

•rxmd – «Встроенный редактор»;

•genai  – «Генеративный искусственный интеллект»

<Имя компонента> install --package-from-component="<Имя связанного компонента 1>;<Имя связанного компонента N>"

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

ВАЖНО. Импорт шаблонов документов, инициализация и применение настроек выполняется только для устанавливаемого компонента.

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

do agile install --package-from-component="memo;projectplanning;directumrx"

В качестве имени компонента можно указать:

•projectplanning – «Планирование проектов»;

•agile – «Agile-доски»;

•memo – «База знаний»;

•rxmd – «Встроенный редактор»;

•genai  – «Генеративный искусственный интеллект»

rx install --do-not-init

Опубликовать стандартную прикладную разработку без инициализации и применения настроек

rx install --package="<Путь до пакета с прикладной разработкой>"

Опубликовать стандартную прикладную разработку Directum RX и заказную разработку из указанного пакета.  Если пакетов несколько, перечислите имена компонентов через точку с запятой. При этом импортируются шаблоны документов, выполняется инициализация и применение настроек

rx install --package-from-component="<Имя компонента>"

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

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

do rx install --package-from-component="memo;agile;projectplanning"

rx install --package-from-component="<Имя компонента>" --force-install

Принудительно опубликовать стандартную прикладную разработку Directum RX и заказную разработку из указанного компонента. Например, если разработка уже есть и ее нужно перепубликовать. Если пакетов несколько, перечислите имена компонентов через точку с запятой. При этом импортируются шаблоны документов, выполняется инициализация и применение настроек

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

do rx install --package-from-component="agile;projectplanning;memo" --force-install

Работа с базой данных

db up

Развернуть базу данных. Чтобы перезаписать существующую базу данных, укажите ключ:

--overwrite=True

db convert

Сконвертировать базу данных

db check

Проверить подключение к базе данных по указанной строке подключения CONNECTION_STRING

Работа со средой разработки

dds run

Запустить утилиту DevelopmentStudio.exe

dds config_up

Сгенерировать конфигурационный файл утилиты DevelopmentStudio.exe в формате XML на основе config.yml

Публикация разработки, импорт шаблонов

rxcmd import_templates

Импортировать стандартные шаблоны документов. Чтобы импортировать свои шаблоны, укажите путь к папке с ними в ключе:

--templates_dir_path = “<Путь к шаблонам>”

Прочие команды

generate_data_protection_cert_from_config

Сгенерировать сертификат для проверки токена доступа к сервисам (Sungero data protection). Команда генерирует сертификат из конфигурационного файла по пути, заданному в параметре DATA_PROTECTION_CERTIFICATE_FILE, с паролем, указанным в DATA_PROTECTION_CERTIFICATE_FILE_PASSWORD

update --package=”<Путь до архива с новой версией>”

Сгенерировать и выполнить скрипт обновления

clean_logs --config_path="<Путь до config.yml>" --skip_last_modified_days="<Количество дней>"

Очистить папку с лог-файлами, путь до которой указан в конфигурационном файле config.yml. При этом остаются лог-файлы, созданные за указанное количество дней.

Ключи --config_path и --skip_last_modified_days необязательные. Если они не указаны, используется конфигурационный файл, который находится в папке DirectumLauncher, и сохраняются лог-файлы, созданные за последние 7 дней