Usm hydra: различия между версиями

Материал из WiKi - UserSide
Нет описания правки
Нет описания правки
 
(не показано 13 промежуточных версий 1 участника)
Строка 1: Строка 1:
[[Usm_hydra_EN|en]] | [[Usm_hydra|ru]]
{{activ}}
{{activ}}


Строка 20: Строка 22:
  usm_hydra.conf.php-example
  usm_hydra.conf.php-example


1. Выделить отдельный ''(произвольный)'' каталог для модуля и поместить в него эти файлы
1. На любом сервере ''(без разницы - сервер биллинга, userside или третья машина)'' выделить отдельный ''(произвольный)'' каталог для модуля и поместить в него эти файлы


2. Выделить отдельный каталог для логов работы модуля. Дайте права на запись в этот каталог.
2. Выделить отдельный каталог для логов работы модуля. Дайте права на запись в этот каталог.
Строка 45: Строка 47:
   
   
  */10 * * * * php usm_hydra.php
  */10 * * * * php usm_hydra.php
Возможно вам потребуется установка дополнительных модулей: https://gist.github.com/hewerthomn/81eea2935051eb2500941a9309bca703


== Параметры ==
== Параметры ==


Настройка модуля осуществляется в файле '''usm_hydra.conf.php'''
Настройка модуля осуществляется в файле '''usm_hydra.conf.php'''
Также можно использовать стандартные параметры из модуля [[usm_billing#Параметры конфигурации|usm_billing]]


  $usersideUrl        - URL к ERP "UserSide"
  $usersideUrl        - URL к ERP "UserSide"
  $usersideApiKey      - API-ключ ERP "UserSide" ''(Указывается в файле "userside/main/config/config.php")''
  $usersideApiKey      - [[UserSide API Key|API-ключ ERP "UserSide"]]
  $billingId          - Номер биллинга в ERP "UserSide" ''("Настройка - Биллинги")''
  $billingId          - Номер биллинга в ERP "UserSide" ''("Настройка - Биллинги")''
  $logPath            - Путь для записи логов
  $logPath            - Путь для записи логов
Строка 62: Строка 68:
  $billingCodePage    - кодировка базы данных биллинга
  $billingCodePage    - кодировка базы данных биллинга
   
   
  $confModuleInetNumber  - номер модуля inet
  $confBillingVersion                - версия биллинга [3|4|5|5.1] ''(по-умолчанию: 3)''
  $confModuleDialupNumber - номер модуля dialup
$confIsCustomerWoAgreenentToOld    - флаг - переводить абонентов без номера договора в бывшие абоненты
  $confModuleIpnNumber   - номер модуля ipn
  $confIsImportMacFromEpSessions    - флаг - импортировать MAC-адреса из таблицы EP_SESSIONS ''(Custom Latera Function)''
   
  $confAddressHierarchyTypeIdExpr   - импортировать адресную иерархию только с указанными типами
  $confAddFieldAgreementNumber - id дополнительного поля с номером договора в таблице contract_parameter_type_1
  $confIsImportAddressWithPrefix    - флаг - импортировать адресные объекты с префиксами
  $confImportAgreementDateClose - id дополнительного поля ERP "UserSide" (tbl_conf_basedopdata.CODE) для импорта даты окончания договора
  $confIsCustomImportCustomerState  - флаг - особый импорт статусов абонентов ''(частное решение)''
   
  $confIsSkipAddressAdditionalPrefix - флаг - импортировать ли префиксы адресных объектов в имени объекта
  $confBillingState0 - статус в биллинге "0 - подключен"
$confImportTariffGoodId            - список id типов тарифных пакетов, что будут импортированы
  $confBillingState1 - статус в биллинге "1 - на отключении"
$confHierarchy                    - массив с типами адресной иерархии
  $confBillingState2 - статус в биллинге "2 - отключен"
$confIsSkipEquipmentAddress        - флаг - не импортировать адреса оборудования
  $confBillingState3 - статус в биллинге "3 - закрыт"
  $confImportCustomerRealLogin      - импортировать "User Real Login" в доп.данные UserSide ''(нужно указать id доп.поля)''
  $confBillingState4 - статус в биллинге "4 - приостановлен"
  $confIsImportHierarchyPrefix      - флаг - импортировать префиксы в адресной иерархии ''(по-умолчанию импортируются суффиксы)''
  $confBillingState5 - статус в биллинге "5 - на подключении"
  $confStateWithPositiveBalance      - состояние/статус абонента при положительному балансе ''((баланс + кредит) >= 0) (1 - Пауза, 2 - Активен, 3 - Стоп)''
  $confStateWithNegativeBalance      - состояние/статус абонента при отрицательном балансе ''((баланс + кредит) < 0) (1 - Пауза, 2 - Активен, 3 - Стоп)''
  $confUserExprString                - дополнительная строка с условием импорта абонентов
  $confImportCustomerPPPoELogin      - импортировать "User PPPoE Login" в доп.данные UserSide ''(нужно указать id доп.поля)''
  $confImportCustomerTaxNumber      - импортировать налоговый номер абонента в в доп.данные UserSide ''(нужно указать id доп.поля)''
  $confImportCustomerIdentityNumber  - импортировать номер документа абонента в в доп.данные UserSide ''(нужно указать id доп.поля)''

Текущая версия от 13:51, 25 октября 2023

en | ru

Эта функция является одной из возможностью
обновления даты активности у объекта

usm_hydra - модуль для организации импорта данных из биллинговой системы ACP "Гидра" в ERP "UserSide"

Данный модуль является заменой устаревшему модулю us_hydra - См.: Переход с us hydra на usm hydra

Язык модуля: PHP

Текущая версия: см. на странице: Модули

Статус модуля: Платный

Дополнительную информацию и перечень импортируемых данных см. на странице: Hydra

Информация по установке модуля

Архив usm_hydra.zip содержит файлы

usm_hydra.php
usm_hydra.conf.php-example

1. На любом сервере (без разницы - сервер биллинга, userside или третья машина) выделить отдельный (произвольный) каталог для модуля и поместить в него эти файлы

2. Выделить отдельный каталог для логов работы модуля. Дайте права на запись в этот каталог.

3. Пример файла конфигурации usm_hydra.conf.php-example следует переименовать в usm_hydra.conf.php и внести в нём требуемые изменения (перечень параметров указан ниже)

4. Запустите несколько раз (*) вручную модуль командой

php usm_hydra.php

Он должен отработать без ошибок и вернуть данные:

usm_hydra
====================================
 Start module at 2015-11-22 17:32:03
Finish module at 2015-11-22 17:32:14
====================================

* - При первом запуске - будут предварительно лишь созданы многие объекты. Чем больше объектов импортирует модуль - тем дольше это будет. При втором и последующих запусках сверяются изменённые данные и только они будут обновлены. Второй запуск также будет длиться долго, т.к. после первого запуска новосозданные объекты практические не содержат данных. А вот третий и последующие запуски будут работать гораздо быстрее.

5. Проверьте визуально полноту импортируемых данных в ERP "UserSide"

6. Когда станет понятно, что модуль работает стабильно - добавляем его в системный cron на периодическую работу (укажите нужные пути)

*/10 * * * * php usm_hydra.php

Возможно вам потребуется установка дополнительных модулей: https://gist.github.com/hewerthomn/81eea2935051eb2500941a9309bca703

Параметры

Настройка модуля осуществляется в файле usm_hydra.conf.php

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

$usersideUrl         - URL к ERP "UserSide"
$usersideApiKey      - API-ключ ERP "UserSide"
$billingId           - Номер биллинга в ERP "UserSide" ("Настройка - Биллинги")
$logPath             - Путь для записи логов
$isSilence           - Флаг "Режим тишины" (скрыть вывод информационных сообщений от модуля в консоль)

$billingDBHost       - адрес сервера биллинга
$billingDBUser       - имя пользователя для доступа к базе биллинга
$billingDBPassword   - пароль для доступа к базе биллинга
$billingDBName       - имя базы данных биллинга
$billingCodePage     - кодировка базы данных биллинга

$confBillingVersion                - версия биллинга [3|4|5|5.1] (по-умолчанию: 3)
$confIsCustomerWoAgreenentToOld    - флаг - переводить абонентов без номера договора в бывшие абоненты
$confIsImportMacFromEpSessions     - флаг - импортировать MAC-адреса из таблицы EP_SESSIONS (Custom Latera Function)
$confAddressHierarchyTypeIdExpr    - импортировать адресную иерархию только с указанными типами
$confIsImportAddressWithPrefix     - флаг - импортировать адресные объекты с префиксами
$confIsCustomImportCustomerState   - флаг - особый импорт статусов абонентов (частное решение)
$confIsSkipAddressAdditionalPrefix - флаг - импортировать ли префиксы адресных объектов в имени объекта 
$confImportTariffGoodId            - список id типов тарифных пакетов, что будут импортированы
$confHierarchy                     - массив с типами адресной иерархии
$confIsSkipEquipmentAddress        - флаг - не импортировать адреса оборудования
$confImportCustomerRealLogin       - импортировать "User Real Login" в доп.данные UserSide (нужно указать id доп.поля)
$confIsImportHierarchyPrefix       - флаг - импортировать префиксы в адресной иерархии (по-умолчанию импортируются суффиксы)
$confStateWithPositiveBalance      - состояние/статус абонента при положительному балансе ((баланс + кредит) >= 0) (1 - Пауза, 2 - Активен, 3 - Стоп)
$confStateWithNegativeBalance      - состояние/статус абонента при отрицательном балансе ((баланс + кредит) < 0) (1 - Пауза, 2 - Активен, 3 - Стоп)
$confUserExprString                - дополнительная строка с условием импорта абонентов
$confImportCustomerPPPoELogin      - импортировать "User PPPoE Login" в доп.данные UserSide (нужно указать id доп.поля)
$confImportCustomerTaxNumber       - импортировать налоговый номер абонента в в доп.данные UserSide (нужно указать id доп.поля)
$confImportCustomerIdentityNumber  - импортировать номер документа абонента в в доп.данные UserSide (нужно указать id доп.поля)