Kredity

Alokační pravidla, která zajistí automatizované přidělení kreditu na základě konkrétní události a naopak revertování původního přidělení kreditu na základě jiné události.

allocations

-

-

Specifická konfigurace pro konkrétní měny.

V případě, že je seznam prázdný, tak jsou kredity povoleny pro všechny měny. V opačném případě jsou kredity povoleny jen pro měny definované v tomto seznamu.

List: currencies/currency

-

-

Časový interval po kterém dojde k vypršení platnosti kredity.

Časový interval se počítá od přidělení kreditu.

Po vypršení platnosti nelze již kredity uplatnit.

TimeInterval

-

1y

Časový interval před koncem platnosti kreditu, kdy se mají odeslat upozornění na konec platnosti.

TimeInterval

-

7d

Priorita uplatnění cenové politiky pro kredity. Standardně by se kredity měly uplatnit jako poslední, proto je default hodnota velmi nízká.

Čím vyšší je priorita, tím dříve se politika uplatní.

Long

-

-1000000

Pokud je povoleno, kredit se uplatní jako platba (PAYMENT) namísto slevy z objednávky (ABSOLUTE_ORDER).

Prakticky to znamená:

• kredit se odečítá jako úhrada částky k zaplacení,
• v režimu daní poukazů SINGLE se sníží základ DPH (kredit je chápán jako předplacená platba),
• v režimu MULTI se základ DPH nemění.

Výchozí hodnota: false (kvůli zpětné kompatibilitě).

Boolean

-

-

Pokud je povoleno, kredit použitý jako platba (viz #getUseCreditAsPayment()) může pokrýt také náklady na dopravu a platbu. Pokud je vypnuto, kredit se vztahuje pouze na položky objednávky.

Výchozí hodnota: false.

Boolean

-

-

Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.

-

-

Seznam pravidel pro přidání fixní částky kreditu.

List: fixedAdditions/addition

-

-

Seznam pravidel pro přidání procentuální částky kreditu.

List: percentageAdditions/addition

-

-

Seznam pravidel pro zrušení přiděleného kreditu.

List: reverts/revert

-

-

Unikátní kód pravidla, který se používá k identifikaci pravidla v rámci systému.

Tento kód se eviduje u přidaného kreditu v atributu type (CreditBalanceItem#getType()).

String

-

-

Seznam událostí, na které reaguje toto pravidlo.

V případě, že alespoň jedna událost splňuje podmínky pro vypálenou aplikační událost (např. změna stavu objednávky), tak se toto pravidlo aplikuje.

Pravidlo vyžaduje alespoň jednu událost.

List: events/event

-

-

Výraz (SpEL - Spring Expression Language), který identifikuje zdroj na základě, kterého byly kredity přiděleny. Příkladem může být číslo objednávky. Na základě této hodnoty je pak možné provést např. zrušení přiděleného kreditu v případě storna objednávky.

Toto id se eviduje u přidaného kreditu v atributu source (CreditBalanceItem#getSource().

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.number.

Povinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vrací fixní částku kreditu (java.math.BigDecimal), která se má zákazníkovi přidělit.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.creditAmount nebo 100.

Povinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje katalog, v rámci kterého bude s kredity manipulováno.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.catalogCode.

Povinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který musí vracet true nebo false. Tato hodnota pak určuje, zda má probíhat kontrola duplicitního přidělení kreditu, tedy zda je možné přidělit kredit vícekrát pro stejné allocationId.

Nepovinná hodnota. Pokud není uvedeno, kontrola se provádí.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu false.

String

-

-

Pravidlo schválí událost pokud vlastnosti této události splňují požadavky definované podmínky.

Podmínka může obsahovat libovolný standardní operátor: and, or, not, eq, isTrue, isFalse atd.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu pro událost, která poskytuje vlastnosti state a order, může vypadat následovně:

1and(2  eq(event.state.code,dispatched-order),3  isTrue(event.order.paid)4)

Více na TOBEDONE #1948 odkaz na dokumentaci constraint.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje měnu, v rámci které bude s kredity manipulováno.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.catalogCode.

Povinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje zákazníka (jeho identifikátor), kterému bude kredit přidán/zrušen.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.user.login.

Povinná hodnota.

String

-

-

Název aplikační události.

Pokud název události odpovídá této hodnotě, aby mohla být podmínka splněna.

Pokud není vyplněno, název události se nekontroluje.

String

-

-

Výraz (SpEL - Spring Expression Language), který musí vracet true nebo false. Tato hodnota pak určuje, zda se má platnost kreditu (hodnota vypočtená v rámci výrazu validity) automaticky nastavit na konec dne.

Nepovinná hodnota. Default hodnota je true.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu false.

String

-

-

Výraz (SpEL - Spring Expression Language), který se pro danou událost vyhodnocuje.

Podmínka je splněna pokud daný výraz vrací true. V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event.

Příklad výrazu pro událost, která poskytuje vlastnosti state a order, může vypadat následovně: (event.state.code == 'dispatched-order') && (event.order.isPaid()).

Nepovinný hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje jazyk v jakém se má nacházet případná zpráva.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.lang.

Nepovinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje zprávu pro zákazníka, která může být součástí notifikace.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Dále je možné pomocí klíčového slova texts přistupovat k metodám com.fg.mail.core.business.feature.applicator.processing.TextAccessor, který poskytuje lokalizované texty.

Příklad výrazu texts.get('mail.credit.thanks', event.order.customer).

Nepovinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který dobu platnosti. Výraz musí vracet string výraz, který dokáže vyhodnotit java.time.Duration#parse(CharSequence).

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu P365D (rok), PT15M (15minut) nebo P2DT3H4M (2dny,3hod a 4min).

Nepovinná hodnota. Pokud není uvedeno aplikuje se default hodnota dle nastavení 'expiration'.

String

-

-

Unikátní kód pravidla, který se používá k identifikaci pravidla v rámci systému.

Tento kód se eviduje u přidaného kreditu v atributu type (CreditBalanceItem#getType()).

String

-

-

Seznam událostí, na které reaguje toto pravidlo.

V případě, že alespoň jedna událost splňuje podmínky pro vypálenou aplikační událost (např. změna stavu objednávky), tak se toto pravidlo aplikuje.

Pravidlo vyžaduje alespoň jednu událost.

List: events/event

-

-

Výraz (SpEL - Spring Expression Language), který identifikuje zdroj na základě, kterého byly kredity přiděleny. Příkladem může být číslo objednávky. Na základě této hodnoty je pak možné provést např. zrušení přiděleného kreditu v případě storna objednávky.

Toto id se eviduje u přidaného kreditu v atributu source (CreditBalanceItem#getSource().

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.number.

Povinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje katalog, v rámci kterého bude s kredity manipulováno.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.catalogCode.

Povinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který musí vracet true nebo false. Tato hodnota pak určuje, zda má probíhat kontrola duplicitního přidělení kreditu, tedy zda je možné přidělit kredit vícekrát pro stejné allocationId.

Nepovinná hodnota. Pokud není uvedeno, kontrola se provádí.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu false.

String

-

-

Pravidlo schválí událost pokud vlastnosti této události splňují požadavky definované podmínky.

Podmínka může obsahovat libovolný standardní operátor: and, or, not, eq, isTrue, isFalse atd.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu pro událost, která poskytuje vlastnosti state a order, může vypadat následovně:

1and(2  eq(event.state.code,dispatched-order),3  isTrue(event.order.paid)4)

Více na TOBEDONE #1948 odkaz na dokumentaci constraint.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje měnu, v rámci které bude s kredity manipulováno.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.catalogCode.

Povinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje zákazníka (jeho identifikátor), kterému bude kredit přidán/zrušen.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.user.login.

Povinná hodnota.

String

-

-

Název aplikační události.

Pokud název události odpovídá této hodnotě, aby mohla být podmínka splněna.

Pokud není vyplněno, název události se nekontroluje.

String

-

-

Výraz (SpEL - Spring Expression Language), který musí vracet true nebo false. Tato hodnota pak určuje, zda se má platnost kreditu (hodnota vypočtená v rámci výrazu validity) automaticky nastavit na konec dne.

Nepovinná hodnota. Default hodnota je true.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu false.

String

-

-

Výraz (SpEL - Spring Expression Language), který se pro danou událost vyhodnocuje.

Podmínka je splněna pokud daný výraz vrací true. V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event.

Příklad výrazu pro událost, která poskytuje vlastnosti state a order, může vypadat následovně: (event.state.code == 'dispatched-order') && (event.order.isPaid()).

Nepovinný hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vrací částku, ze které se má vypočíst výše kreditu (java.math.BigDecimal), která se má zákazníkovi přidělit.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.totalPriceOfItemsToPay nebo 100.

Povinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje jazyk v jakém se má nacházet případná zpráva.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.lang.

Nepovinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje zprávu pro zákazníka, která může být součástí notifikace.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Dále je možné pomocí klíčového slova texts přistupovat k metodám com.fg.mail.core.business.feature.applicator.processing.TextAccessor, který poskytuje lokalizované texty.

Příklad výrazu texts.get('mail.credit.thanks', event.order.customer).

Nepovinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vrací procenta (java.math.BigDecimal) pro výpočet výše kreditu, která se má zákazníkovi přidělit.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu 10.

Povinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vrací na kolik (int) desetinných míst se vypočtený kredit zaokrouhlit.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.rounding nebo 0.

Nepovinná hodnota. Default je 0.

String

-

-

Výraz (SpEL - Spring Expression Language), který vrací způsob zaokrouhlení (přesněji jednu z hodnot java.math.RoundingMode).

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.roundingMode nebo T(java.math.RoundingMode).HALF_DOWN.

Nepovinná hodnota. Default je java.math.RoundingMode#DOWN 'DOWN'.

String

-

-

Výraz (SpEL - Spring Expression Language), který dobu platnosti. Výraz musí vracet string výraz, který dokáže vyhodnotit java.time.Duration#parse(CharSequence).

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu P365D (rok), PT15M (15minut) nebo P2DT3H4M (2dny,3hod a 4min).

Nepovinná hodnota. Pokud není uvedeno aplikuje se default hodnota dle nastavení 'expiration'.

String

-

-

Unikátní kód pravidla, který se používá k identifikaci pravidla v rámci systému.

String

-

-

Seznam událostí, na které reaguje toto pravidlo.

V případě, že alespoň jedna událost splňuje podmínky pro vypálenou aplikační událost (např. změna stavu objednávky), tak se toto pravidlo aplikuje.

Pravidlo vyžaduje alespoň jednu událost.

List: events/event

-

-

Výraz (SpEL - Spring Expression Language), který identifikuje zdroj na základě, kterého byly kredity přiděleny. Příkladem může být číslo objednávky. Na základě této hodnoty je pak možné provést např. zrušení přiděleného kreditu v případě storna objednávky.

Toto id se eviduje u přidaného kreditu v atributu source (CreditBalanceItem#getSource().

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.number.

Povinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje katalog, v rámci kterého bude s kredity manipulováno.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.catalogCode.

Povinná hodnota.

String

-

-

Pravidlo schválí událost pokud vlastnosti této události splňují požadavky definované podmínky.

Podmínka může obsahovat libovolný standardní operátor: and, or, not, eq, isTrue, isFalse atd.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu pro událost, která poskytuje vlastnosti state a order, může vypadat následovně:

1and(2  eq(event.state.code,dispatched-order),3  isTrue(event.order.paid)4)

Více na TOBEDONE #1948 odkaz na dokumentaci constraint.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje měnu, v rámci které bude s kredity manipulováno.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.order.catalogCode.

Povinná hodnota.

String

-

-

Výraz (SpEL - Spring Expression Language), který vyhodnocuje zákazníka (jeho identifikátor), kterému bude kredit přidán/zrušen.

V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event. Příklad výrazu event.user.login.

Povinná hodnota.

String

-

-

Název aplikační události.

Pokud název události odpovídá této hodnotě, aby mohla být podmínka splněna.

Pokud není vyplněno, název události se nekontroluje.

String

-

-

Výraz (SpEL - Spring Expression Language), který se pro danou událost vyhodnocuje.

Podmínka je splněna pokud daný výraz vrací true. V rámci výrazu je možné se odkazovat na událost pomocí klíčového slova event.

Příklad výrazu pro událost, která poskytuje vlastnosti state a order, může vypadat následovně: (event.state.code == 'dispatched-order') && (event.order.isPaid()).

Nepovinný hodnota.

String

-

-

Kód měny (ISO 4217 - 3 znaky), pro kterou má být tato konfigurace aplikována. Povinný atribut.

code

-

-

Hodnota určuje minimální hodnota objednávky, pro kterou lze kredity uplatnit.

V případě, že hodnota objednávky nižší, tak kredity nelze uplatnit.

BigDecimal

-

-