Šablony (UI prvky a snippety)

Pomocí šablon definuje rozšíření v administraci či na ostatních místech systému umístění, kde se mají jednotlivé jeho prvky (bloky, záložky, snippety atd.) zobrazit.

Šablony

V systému Retailys je možné vložit funkcionalitu externí aplikace na různá místa v administraci či šablonách. Je tak možnost přidávat různá tlačítka či snippety ke správě objednávek či produktů, formulářové prvky do objednávkového formuláře na e-shopech a mnohé další. Každá šablona očekává definovanou URL adresu, která dostane (např. ID objednávky) a následně vrátí (např. počet) potřebná data.

Každá šablona má svoji definici, která je dle datového modelu na příslušném endpointu API (System.Layouts). Šablona je aktivní vždy pokud není definována podmínka pro zobrazení pomocí Retailys Language.

UI prvky podporované v Administraci

Více informací o UI prvcích podporovaných v administraci najdete v zde.

UI prvky a snippety podporované v E-Shopu

  • Script

  • Shipping

  • Payment

Více informací o UI prvcích a snippetech v E-Shopech najdete zde.

System.Dashboard.Small : Code

Vloží nový blok na hlavní stránku systému Retailys do malého bloku.

Příklad: rozšíření, které bude zobrazovat aktuální tržbu za poslední měsíc

System.Dashboard.Big : Code

Vloží nový blok na hlavní stránku systému Retailys do velkého bloku.

Příklad: rozšíření, které bude zobrazovat nejnovější objednávky

System.Orders.Actions : XXXXXX

Příklad: hromadné exporty vybraných objednávek

Možná akce u jednotlivých objednávek.

Příklad: tlačítko u objednávky na odeslání objednávky do účetního systému

System.Content.Articles.Article.Actions : Link

Vloží novou možnou akci u produktu.

Příklad: tlačítko na překlad konkrétního produktu.

System.Websites.Templates.Shippings

Vloží data do prodejního kanálu typu elektronický obchod na místo pro výběr odesílací metody.

System.Websites.Templates.Payments

Vloží data do prodejního kanálu typu elektronický obchod na místo pro výběr platební metody.

Příklad: nová platební metoda.

Vloží novou možnou akci u prodejního kanálu.

Příklad: tlačítko na zobrazení souhrných analytických dat o prodejním kanálu.

??? System.Mail ???

Oznámí systému, že v sobě obsahuje mailový účet, který lze nastavit a ten poté bude nabízen všude tam, kde se vybírá mailový server pro odeslání (např. při výběru automatických mailových zpráv při vytváření objednávek nebo při výběru serveru, který se má použít)

??? System.Payments ???

System.Settings.Channels.New :

Umožní přidat nový prodejní kanál včetně formuláře pro jeho nastavení.

System.Extensions.Me.Settings :

Umožní přidání polí do nastavení vyvíjeného modulu.

Datové typy pro šablony

V případě, že na určité místo dané šablonou v administraci či webu generovaném systémem Retailys chcete vložit nějaký prvek, je nutné definovat jeho typ a vlastnosti.

Input

Formulářový prvek.

Vlastnosti

  • name: jméno prvku

  • type: možné hodnoty: text|longtext|select

  • options: pole hodnot vždy klíč-hodnota, případně prázdný řetězec

  • default: defaultní hodnota v případě type:text nebo type:longtext, případně klíč v případě type:select

Link představuje klasický hypertextový odkaz.

Vlastnosti

  • link: url adresa (včetně https://), kam má odkaz směřovat

  • target: možné hodnoty: normal|blank|modal

Code

Vloží libovolný html kod. Vložený html kod by měl vhodně graficky korespondovat s ostatní částí administrace.

Array

Array představuje pole klíč-hodnota.

Podmínky a oprávnění

Pokud vývojář chce na konkrétní místo v systému umístit nějaký prvek či funkčnost pouze při určitých příležitostech, může využít bohatých možností podmínek.

Příkladů, kdy podmínek využít, může být spousta:

  • vývojář může chce zobrazit tlačítko na odeslání faktury do učetního softwaru pouze u objednávek, u kterých už je faktura vytvořena,

  • tisk štítků pro poštu je možné zobrazit pouze tehdy, pokud předtím došlo k odeslání údajů o objednávce do systému pošty a ta tak mohla štítek vygenerovat,

  • zobrazíme tlačítko na odeslání do účetního softwaru pouze tehdy, pokud je objednávka vedena na firmu č. 123,

  • tlačítko na odeslání do účetního softwaru se má zobrazit pouze účetní, která má patřičná oprávnění.

Ke skrytí či zobrazení jednotlivých prvků slouží podmínky (Retailys Language).

Podmínky pouze kosmeticky skrývají či zobrazují jednotlivé prvky rozšíření v šabloně systému Retailys. Validitu získávaných dat přes REST API musí vývojář kontrolovat přímo ve svém kódu!