Плейсхолдеры для описания Правила обработки события

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

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

СобытиеПлейсхолдерОписаниеТипПример



Общее для всех событий

owner.status

статус владельца клиентаstringowner.status = "active"

owner.country

2-буквенный код страны (ISO), к которой принадлежит владелец клиента (например, BY для Республики Беларусь)stringowner.country = "BY"

owner.city

название города, к которой принадлежит владелец клиентаstringowner.city = "Minsk"
current_dateтекущая датаdatecurrent_date





Клиент изменен (Account changed)

Недостаточно средств на балансе (Low balance)

Создание сервера (Create instance)

Сброс пароля сервера (Reset instance password)

account.type_idid типа клиентаintegeraccount.type_id = 1
account.type_keyключ типа клиентаstringaccount.type_key = "business"
account.class_idid правила обслуживания клиентаintegeraccount.class_id = 1
account.class_keyключ правила обслуживания клиентаstringaccount.class_key = "manual"
account.billing_day

финансовый день, установленный в правиле предоставления тарифного плана, на который подписан клиент;

порядковый номер дня в месяце

integeraccount.billing_day = 30
account.credit_limit

integeraccount.credit_limit = 100
account.balanceбаланс клиентаintegeraccount.balance = 1000
account.balance.wasпредыдущее значение баланса клиентаintegeraccount.balance.was = 100
account.statusстатус клиентаstringaccount.status = "inactive"
account.status.wasпредыдущий статус клиентаstringaccount.status.was = "inactive"
account.country2-буквенный код страны (ISO), к которой принадлежит клиент (например, BY для Республики Беларусь)stringaccount.country = "BY"
account.cityназвание города, к которой принадлежит клиентstringaccount.city = "Minsk"
Недостаточно средств на балансе (Low balance)account.regular_sending

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

  • Если "account.regular_sending = true", отправка уведомлений осуществляется при выполнении биллинг процесса.
  • Если "account.regular_sending = false", отправка уведомлений осуществляется в момент изменения баланса.
  • Если параметр "regular_sending" не задан, отправка уведомлений осуществляется дважды: при выполнении биллинг процесса и в момент изменения баланса.
boolean "account.regular_sending = true"
account.has_endless_trial_subscriptions

параметр используется для установки типа подписок для которых необходимо отправлять СМС уведомления (пробная подписка/ коммерческая подписка)

Если "account.has_endless_trial_subscriptions = true" СМС уведомление о низком балансе отправляется только при наличии хотя бы одной активной коммерческой подписки, работающей по потребленным ресурсам (IaaS).

boolean"account.has_endless_trial_subscriptions = true"

Закрытие Акта (Invoice closed)

invoice.statusстатус актаstringinvoice.status = "open"

Ручная операция (Manual Operation)

operation.idid операцииintegeroperation.id = 1
operation.statusстатус операцииstringoperation.status = "approval_required"

Приглашение пользователя (User invitation)

----






Платеж получен (Payment has been received)

account.type_keyключ типа клиентаstringaccount.type_key = "business"
account.class_keyключ правила обслуживания клиентаstringaccount.class_key = "manual"
account.billing_day

финансовый день - число месяца, в которое производится формирование aктов (см. Управление Актами) и изменение статуса cписаний (см. Просмотр Списаний) для клиента (данный параметр может иметь значение от 1 до 31, определяющее день месяца)

integeraccount.billing_day = 30
account.credit_limit

integeraccount.credit_limit = 100
account.balanceбаланс клиентаintegeraccount.balance = 1000
account.balance.wasпредыдущее значение баланса клиентаintegeraccount.balance.was = 100
account.statusстатус клиентаstringaccount.status = "inactive"
account.status.wasпредыдущий статус клиентаstringaccount.status.was = "inactive"
account.countryназвание страны, к которой принадлежит клиентstringaccount.country = "Belarus"
account.cityназвание города, к которой принадлежит клиентstringaccount.city = "Minsk"
payment.totalобщая сумма платежа (Итого),integerpayment.total = 100
payment.statusстатус платежаstringpayment.status = "completed"

Запрос сброса пароля (Password reset request)

Подтверждение email (Verify email)

user.idid пользователяintegeruser.id = 1











До окончания периода подписки
(Before subscription expiration)

После окончания периода подписки
(After subscription expiration)

Подписка переведена из пробного статуса в платный 
(After subscription switched from trial to non-trial)

Подписка изменена (Subscription changed)

account.type_key


ключ типа клиентаstringaccount.type_key = "business"
account.class_keyключ правила обслуживания клиентаstringaccount.class_key = "manual"
account.billing_day

финансовый день - число месяца, в которое производится формирование aктов (см. Управление Актами) и изменение статуса cписаний (см. Просмотр Списаний) для клиента (данный параметр может иметь значение от 1 до 31, определяющее день месяца)

integeraccount.billing_day = 30
account.credit_limit

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


integeraccount.credit_limit = 100
account.balance баланс клиентаintegeraccount.balance = 1000
account.balance.wasпредыдущее значение баланса клиентаintegeraccount.balance.was = 100
account.statusстатус клиентаstringaccount.status = "inactive"
account.status.wasпредыдущий статус клиентаstringaccount.status.was = "inactive"
account.countryназвание страны, к которой принадлежит клиентstringaccount.country = "Belarus"
account.cityназвание города, к которой принадлежит клиентstringaccount.city = "Minsk"
plan.idid тарифного планаintegerplan.id = 1
plan.statusстатус тарифного планаstringplan.status = "completed"
plan_category.keyключ категории тарифных плановstringplan_category.key = "streaming"
plan_period.duration_valueдлительность периода подписки на тарифный планintegerplan_period.duration_value = 30
plan_period.duration_typeтип длительности периода подписки на тарифный план (год, месяц, день)stringplan_period.duration_type = "months"
plan_period.trialявляется ли период тарифного плана пробнымbooleanplan_period.trial = "false"
 plan_period.setup_feeстоимость установки подписки на период тарифного планаinteger plan_period.setup_fee = 100
 plan_period.recurring_feeабонентская плата за подписку на период тарифного планаintegerplan_period.recurring_fee = 100
plan_period.renewal_feeстоимость продления подписки на период тарифного планаintegerplan_period.renewal_fee = 100
subscription.idid подпискиintegersubscription.id = 1
subscription.statusстатус подпискиstringsubscription.status = "active"
subscription.status.wasпредыдущий статус подпискиstringsubscription.status.was="installing"
subscription.auto_renewalвключена ли опция 'Автопродление' в подпискеbooleansubscription.auto_renewal = "true"
subscription.days_leftколичество дней до даты истечения подпискиintegersubscription.days_left = 7
subscription.days_passedколичество дней, прошедших со дня создания подпискиintegersubscription.days_passed = 15
subscription.plan_classid правила предоставления тарифного планаintegersubscription.plan_class = 1
subscription.trial.status

является ли подписка пробной

Плейсхолдер может быть применен при настройке обработчика события для события «Подписка изменена» (“Subscription changed”).

В этом случае при изменении периода тарифного плана подписок, подпадающих под правила обработчика события, с trial на no-trial, должно направляться соответствующее уведомление согласно настройкам обработчика события.

string

subscription.trial.status = "trial"

subscription.trial.status = "no-trial"


Заказ изменен (Order changed)

Заказ создан (Order created)

order.idid заказаintegerorder.id = 1
order.plans_idsid заказанных плановintegerorder.type = "SalesOrder" and (order.plans_ids include? 2000030)
order.statusстатус заказаstringorder.status = "waiting for payment"
order.status.wasпредыдущий статус заказаstringorder.status.was = "provisioning"
 order.totalобщая стоимость заказаinteger order.total = 100
order.typeтип заказаstringorder.type = "RenewalOrder"
order.renewal_pointустановлено ли значение в поле 'Точка автоматического продления (в днях)' на странице Подпискиbooleanorder.renewal_point = "true"


Обещанный платеж создан (Guaranteed payment created)

Обещанный платеж изменен (Guaranteed payment changed)

account.type_idid типа клиентаintegeraccount.type_id = 1
account.type_keyключ типа клиентаstringaccount.type_key = "business"
account.class_idid правила обслуживания клиентаintegeraccount.class_id = 1
account.class_keyключ правила обслуживания клиентаstringaccount.class_key = "manual"
guaranteed_payment.status.wasпредыдущий статус обещанного платежаstringguaranteed_payment.status.was = "provided"
guaranteed_payment.statusстатус обещанного платежаstringguaranteed_payment.status = "revoked"
Финансовый день наступает (Billing day is coming)billing_dayдата Финансового дня, для которого было вызвано событиеintegerbilling_day = 5
billing_day_left

количество дней, которое осталось до Финансового дня, для которого было вызвано событие

В Финансовый день, для которого было вызвано событие, возвращает не 0, а количество дней до следующего Финансового дня

integerbilling_day_left = 7
billing_day_open_charges_amountсумма Cписаний со статусом Открыто для активных Подписок с типами биллинга CSP месячный, Оплата в полном объеме, G-Suite, которые будут закрыты или заблокированы в Финансовый день, для которого было вызвано событиеnumberbilling_day_open_charges_amount = 120.1
plan_idsмассив ID Планов активных Подписок Клиентаarray(int)plan_ids = [200023, 200024]
product_idsмассив ID Продуктов активных Подписок Клиентаarray(int)product_ids = [100022, 100023]
monthly_billingфлаг, указывающий на то, что у Клиента есть не удаленные Подписки с типами биллинга CSP месячный, Оплата в полном объеме, G-Suite, для которых актуален Финансовый день, для которого было вызвано событиеbooleanmonthly_billing = "true"
account.type_keyключ Типа Клиентаstringaccount.type_key = "personal"
account.class_keyключ Правила обслуживания Клиентаstringaccount.class_key = "default"
account.balanceдоступный Баланс Клиентаnumberaccount.balance = 58.5
account.credit_limitКредитный лимит, доступный Клиентуnumberaccount.credit_limit = 10000