Vývojářská podpora

Configurator

Configurator umožňuje integracím zobrazit uživateli výzvu s textem, obrázkem, vstupním polem a tlačítkem. Je určený hlavně pro vývojářské nebo interní scénáře.

Doména
configurator
Kategorie
ostatní
Komunikace
lokální UI callback
Nastavení
systémová vývojářská funkce
Výstup
uživatelská výzva pro integraci
01

Co integrace přidá

Configurator je minimální mechanismus, přes který může jiná integrace požádat uživatele o doplnění informace nebo potvrzení akce. Umí zobrazit text, obrázek a tlačítko; vstupní pole mohou mít popis a volitelný typ.

Po stisku tlačítka se vyvolá callback v integraci, která výzvu vytvořila. Běžný uživatel jej obvykle nepřidává ani nespravuje samostatně.

Kontrolní témata

  1. Je určený pro integrace, které potřebují jednoduchý ruční krok.
  2. Nepřipojuje zařízení ani službu sám o sobě.
  3. Nepoužívejte ho jako obecný formulář pro běžnou správu domácnosti.
  4. Pro nové integrace je vhodnější moderní průvodce nastavením, pokud je k dispozici.
02

Příprava před přidáním

Pokud se v rozhraní objeví výzva Configuratoru, přečtěte si text a ověřte, která integrace ji vyvolala. Nezadávejte citlivé údaje, pokud nevíte, proč jsou potřeba.

Vývojáři by měli výzvu držet krátkou a jednoznačnou, protože Configurator nepokrývá komplexní průvodce ani validaci více kroků.

Configurator je podpůrná vrstva. Pokud ji vidíte bez zřejmého důvodu, zkontrolujte logy a dotčenou integraci.
03

Nastavení v RichPear Home

Configurator se běžně nenastavuje ručně. Je aktivován integrací, která jej potřebuje.

Uživatelsky řešíte jen konkrétní výzvu: přečíst zadání, zadat požadovanou hodnotu a potvrdit tlačítkem, pokud je akce očekávaná.

04

Kontrola entit a funkcí

Po potvrzení ověřte, že integrace, která výzvu vyvolala, pokračovala správně a že se výzva nevrací opakovaně.

Pokud výzva zůstává viset, podívejte se do logů dotčené integrace a ověřte, jestli callback proběhl bez chyby.

Po nastavení

  1. Identifikujte integraci, která výzvu vytvořila.
  2. Nezadávejte tajné údaje do nejasné výzvy.
  3. Po potvrzení zkontrolujte logy.
  4. Opakované výzvy řešte v nastavení konkrétní integrace.
05

Použití v automatizacích

Configurator neposkytuje běžné entity pro automatizace. Jeho smyslem je interaktivní krok v nastavení nebo opravě integrace.

Automatizace stavte až na výsledných entitách dotčené integrace, ne na samotné výzvě Configuratoru.

06

Provoz a údržba

Při údržbě sledujte, zda se výzvy Configuratoru neobjevují po aktualizacích nebo po změně přístupových údajů.

U vlastních integrací používejte tuto vrstvu jen pro jednoduché a bezpečné požadavky.

07

Řešení problémů

Když výzva nejde potvrdit nebo se stále vrací, ověřte chyby v logu dotčené integrace, dostupnost služby, očekávaný formát vstupu a případné změny po aktualizaci.

Potom otevřete Nastavení → Systém → Logy a hledejte chyby podle domény configurator. Integraci neodstraňujte jako první krok; nejdřív ověřte přístup, síť, konfiguraci a poslední úspěšnou aktualizaci.