← Minden dokumentáció
Portal Studio mező útmutató

Építs bátran, és adj ki biztonságosan.

Egy gyakorlati hivatkozás a rendszergazda, aki alakítja az ügyfél élményt és fejlesztők, akik kiterjesztik azt. Dokumentálja a valódi Studio architektúra, szabályozott felszabadítási útvonal, Súgó Center tulajdonjog, identitás, vándorlás, komponens szerződések és helyreállítás.

A v2 portáldokumentumAdministrator + FejlesztőVállalati kioldási munkafolyamatFrissítve 1 augusztus 2026
Adminisztrátori útmutató · Építészet

Tudd, mi a stúdió tulajdona.

A Portal Studio a vásárlói arculathéjat birtokolja: oldalak, komponensek elhelyezése, márka zsetonok, reagáló viselkedés, navigáció, lábszár, identitás prezentáció, jegyutak és kiadások. A Súgó Központ nyelveket, kategóriákat, szekciókat és cikktartalmat birtokol. A stúdió ezt a tartalmat egy védett hídon keresztül fogyasztja; soha nem hoz létre egy második cikk áruházat.

Súgó Központ + jegy + identitás szolgáltatásokEngedély- biztonságos adatadapterekPortál dokumentum v2 tervezetEgy fordító és renderelőElőnézet és közzétett portál
Egyrendűségi szabály: Az előnézet és a nyilvános oldalak ugyanazt a dokumentumot / fordítói szerződést használják. A közzététel soha nem kapcsolható más sablonra.
Portal Studio · Munkaterület térkép
Élő vászonAsztali · Ügyfél
Ügyfél-portálAz előnézetben és a nyilvános megjelenítésben használt strukturált dokumentum
Interface map: a munka vasút, élő vászon és ellenőr célpontja ugyanaz stabil oldal és csomópont kiválasztása.
Administrator · Kezdés

Teljes készültség, mielőtt mélyebbre süllyednénk

  1. Megnyitás Portal Studio → Kezdés → Readiness.
  2. Erősítse meg a kanonikai portálcímet, és nyissa meg külön lapon.
  3. A logó, a böngésző ikon, az érintőikont, a társadalmi képet és a téma színét kell beállítani.
  4. Erősítse meg a Súgó Központ nyelveit; a Súgóközpont nyelvi felhatalmazását, nem a Studio-t.
  5. A navigáció és a globális vállalati lábléc beállítása.
  6. Válasszon egy menetjegyet, és állítsa be legalább egy kérési űrlapot.
  7. Legalább egy biztonságos jelszót tartson fenn a módszerben, és vizsgálja felül az azonosság felfedezését.
  8. Futtasd le a Minőség és az aláírt előzetes kézfogás.
  9. Az első szabályozott kiadás létrehozása után minden blokkoló elem tiszta.

A készenléti százalék a megtakarított munkaterületadatok és az előzetes állapot alapján számítható ki. A termék közvetlen útvonalai közvetlenül a tulajdonosi panelhez kerülnek.

Adminisztrátor · Építkezés

Oldalak és újrahasználható szakaszok építése

  1. Megnyitás → Oldalak építése és válasszon ki egy védett rendszeroldalt, vagy hozzon létre egy egyedi oldalt.
  2. Állítsa be az útvonalat, a címet, a hozzáférési módot és a helyi viselkedést. A védett rendszerútvonalakat nem lehet törölni.
  3. Megnyitás Összetevők, szűrés munka vagy érettség szerint, és helyezzen egy komponenst egy kompatibilis résidő.
  4. Az ellenőr segítségével a tartalom, megjelenés, kötelező, láthatóság és hozzáférhetőség.
  5. Használjon újra használható mintákat ismételt struktúrák; tartsa a szervezet vagy márka különbségek változatok.
  6. A vázlat- és gyakorlási betöltés mentése, üres, hiba, vendég és aláírás az előre látható államokban.
A komponens könyvtára · Szanitizált interfész térkép
TudáskeresésGA · ügyfélbiztonságA nemzeti jogszabály tartalma: A veszélyes áruk szállítására vonatkozó követelmények.GA · Segítő Központcikk, (1) bekezdésGA · lefordított DTOKérelmező formanyomtatványGA · változatbanJegyidő-Béta · figyelmeztetésAdattérképA telepített blokkok publikálása
Interface térkép: a kategória, kompatibilitás és érettség látható elhelyezés előtt. Tervezett komponensek blokk közzététele; béta komponensek kifejezett felszabadulási kezelést igényel.
Administrator · Brand and reagensive

Valódi utazások előre nézése, nem egy boldog képernyőn

  1. Válassza ki a vendég támogatást, jelezze a jegyen, számlázási ellátás, szervezet vagy tudás átadás.
  2. Személyek, szervezési, szerepcsere- és help Center nyelv.
  3. Megvizsgálható mobil, nagy mobil, tabletta, laptop, asztali, széles és ultramodern töréspontok.
  4. Ellenőrizze az örökölt, felülbírált és reset értékeket; elkerülje a felesleges töréspont átfedéseket.
  5. A billentyűzet, az RTL, a csökkentett mozgás, a betöltés, az üres, a nem elérhető és az engedély állapota.
  6. A vizsgálat eredményei a hozzáférhetőség, hasznos teher, útvonal, kötődés és renderer-leletek előtt.
A zöld vászon nem a kiadás döntése. Advanced preflight, review state, képességek és release bizonyíték dönt arról, hogy a portál lehet közzétenni.
Administrator · Tapasztalat

Egy Zendesk- szintű Súgó Központ üzemeltetése a tartalom másolása nélkül

  1. A kategóriák, szakaszok, cikkek, fordítások, mellékletek és sablonok létrehozása Súgó központ.
  2. Engedélyezze a nyelvek ott; helyi csigák, keresés, feed, SEO és cikk króm követi ugyanazt a hatóságot.
  3. A Studio, a hely tudás keresés, kategória / erőforrás hálózatok, feed, téma harmonika, cikk, tartalomjegyzék, visszajelzés, kapcsolódó és korábbi / következő komponensek.
  4. Beállítások: a megadott, népszerű és friss adatok; kontextuális javaslatok használata jegyáramlások esetén.
  5. Előnézet no-eredmények, hosszú cikkek, csatolmányok, visszajelzések, óra / előfizetés és a jegy átadás.
  6. A tiszta helymeghatározási útvonalak, a kanonikai / hreflang, a strukturált adatok és a gyorsítótár érvénytelenítése közzététele után.
Hatósági határ: szerkeszti a cikk tartalmát és az ügyfelek nyelveit a Súgó Center. Használja a Portal Studio csak, hogy hogyan fedezték fel és megjeleníti a tudást.
Felelős · Személyazonosság és szervezetek

A jel- be történő biztonságos beállítás

  1. Megnyitás Azonosítás és szervezetek → Személyazonosság és legalább egy jelet az úton kell tartani.
  2. Válassza ki az alapértelmezett módszert, regisztrációs politika, munkamenet időtartama, SSO-domain végrehajtási és felfedezési viselkedés.
  3. A szolgáltatók hozzáadása vizuális útválasztási mezők: típus, domainek, prioritás, prezentáció, engedélyezett és ellenőrzött állapot. Titkok maradnak az identitás alrendszerben.
  4. A SCIM-hoz engedélyezheti a feltöltést, másolja le a pontos munkaterület végpontot, és forgassa a token. Az egyszer használatos jelszót tárolja az IdP-ben.
  5. Térképek és a szervezet tagság, majd teszt létrehozása, frissítése, csoport tagság és deaktiválás egy tesztbérlő.
  6. Előnézet vendég, ügyfél, delegált szervezet és blokkolt államok közzététele előtt.
Soha ne küldjön Stúdió session cookie-t SCIM. Ez egy sessionless, workspace-bound hordozó API. Forgasson egy jelvényt véletlen érintkezés után.
Administrator · Jegyutak

A teljes támogató út beállítása

  1. Válassza ki a közvetlen forma, varázsló, keresés-első, hub vagy szerviz-asztal bejegyzést.
  2. Hozzon létre egy névhez kötött, változatos kérőlapot szekciókkal és hozzáférhető mezőcímkékkel.
  3. Építs vizuális feltételeket, útvonal, SLA és jóváhagyási lépések; fejlett JSON csak a felülvizsgált fejlesztői változások.
  4. A lista, a részlet, a szál, az idővonal, a csatolás, a jóváhagyás, az SLA és a válaszfelületek beállítása.
  5. Test vendég keresés, aláírás-a kérések, szervezet láthatósága, feltöltési hiba, e-mail értesítés és tudáseltérítés.
  6. Mentse a vázlatot; csak az útvonal adapter és értesítési út repülés előtt.
Administrator · Felülvizsgálat és kiadás

Átlépés a szabályozott kioldáson

A mentett tervezetFelülvizsgálatJóváhagyvaTervezett vagy közzétettMegfigyelt vagy visszahajtott
  1. Futtasd le a validálást és a tesztlabort. Oldd meg a blokkolási eredményeket; ismerd el a megengedett figyelmeztetéseket kontextussal.
  2. Hozzáadja a kiadás feljegyzések és kérje felülvizsgálat. Vélemények komment stabil oldal / csomópont utak.
  3. A jóváhagyók ellenőrzik a diffot, előre néznek útvonalakat, engedélyváltoztatásokat és bizonyítékokat.
  4. A háttérmunkáson keresztül publikálhat vagy ütemezhet. A stúdióból való kilépéskor nem marad le a tartós munka.
  5. Figyelje a fejlődést, az egészségügyi és korrelációs azonosítót. Állítsa / próbálja csak a munka ellenőrzése.
  6. Ellenőrizzék a kritikus útvonalakat, identitást, jegyeket és tudást. Roll vissza egy változhatatlan előzetes kiadás, ha szükséges.
KépességCél
Nézet / SzerkesztésVizsgáld meg vagy cseréld ki a tervezeteket engedély nélkül.
Felülvizsgálat / jóváhagyásKülön visszajelzés és jóváhagyás az szerzőtől.
Ütemezés / közzététel / visszavonásFüggetlen gyártásellenőrzés.
Azonosító / SCIM / Migrát / Összetevők / DiagnosztikaSzigorúan érzékeny speciális műveletek.
Administrator · Migrate and extension

A bizonyíték és a visszaút összekeveredik.

  1. Válassza ki a szolgáltató tervrajzát, és hozzon létre egy száraz futást.
  2. Felülvizsgálat felfedezett beállítások, feltérképezetlen értékek, tartalom szám és vizuális paritás rögzítések.
  3. Teljes biztonságos feltérképezések és újrafuttatni a strukturált diff.
  4. Alkalmazzon a vázlatra, egyeztesse a számokat, és előre minden védett utat.
  5. A felvétel engedélyezett elfogadása; soha ne írja felül a jelenlegi közzétett kiadás importálás alatt.
  6. A Bizottság a következő információkat terjeszti:
Fejlesztő kiterjesztési útmutató · Építészet

A szerződések kiterjesztése, nem sablonok

A biztonságos kiterjesztés regisztrál egy stabil komponens típusa és séma, nyilatkozik engedélyek és adatok igények, rendel keresztül a kanonikai fordító, és szállít determinista rögzítések / tesztek. Ne kérje önkényes táblázatok, fecskendezze szerkesztő JavaScript a nyilvános portálba, hozzon létre egy másik cikk adattár, vagy megkerüli a kiadás kapu.

A v2 portáldokumentum

Az oldalak stabil csomópontokat, résidőket, tulajdonságokat, kötéseket, reagáló felülírásokat, feltételeket és akadálymentesítési metaadatokat tartalmaznak.

Összetevő-nyilvántartás

Egy szerződés táplálja Studio, fordító, dokumentáció, migráció és érettségi ellenőrzések.

Adatforrás-nyilvántartás

A felsorolt, csak olvasható, engedélyezett DTO-k helyettesítik az önkényes SQL vagy dinamikus akciókat.

Egy rendítõ

Előnézet és nyilvános kibocsátás részarány összeállítása, tisztítás, költségvetés és futási idő államok.

Fejlesztő · Alkatrész szerződés

Az alkatrészcsomag meghatározása

A csomag ellenőrzése és a biztonsági ellenőrzés független ellenőrzései miatt mind az kompatibilitási tulajdonnevek megjeleníthetők.

{
  "schema_version": 1,
  "id": "acme.support_health",
  "slug": "acme-support-health",
  "name": "Support health",
  "version": "1.0.0",
  "entry": "renderer.php",
  "renderer": "server",
  "server_renderer": "renderer.php",
  "public_renderer": "public.js",
  "schema": {
    "type": "object",
    "properties": {
      "heading": {"type": "string", "maxLength": 120},
      "showSla": {"type": "boolean", "default": true}
    },
    "additionalProperties": false
  },
  "permissions": ["tickets.read"],
  "data_scopes": ["tickets.mine"],
  "accessibility": {
    "landmark": "section",
    "nameFrom": "heading",
    "emptyState": true,
    "errorState": true
  },
  "performance": {"max_js_bytes": 12000, "max_css_bytes": 8000},
  "performance_budget": {"js": 12000, "css": 8000, "requests": 0}
}

A csomópont alakja

{
  "id": "node-support-health",
  "type": "custom.acme_support_health",
  "props": {"heading": "Support health", "showSla": true},
  "bindings": {"requests": {"source": "tickets.mine", "limit": 5}},
  "responsive": {"mobile": {"padding": "16px"}, "desktop": {"padding": "24px"}},
  "conditions": [{"field": "identity.signed_in", "operator": "equals", "value": true}],
  "a11y": {"label": "Support health"}
}
  • A személyazonosság stabil marad a szélsőségesek és a vándorlások között.
  • A tulajdonjogok elutasítják a be nem jelentett mezőket és a nem biztonságos HTML-t.
  • Minden adatkötõ nézet a betöltést, ürességet, engedélyt és relatitable-error kimenetet határozza meg.
  • A konténerek alkotóelemei nevezzék meg résidőiket; a levelek nem fogadhatnak el önkényes gyerekeket.
  • Jelölje meg az érettséget őszintén: tervezett blokkok, béta figyelmeztetések, GA teljes bizonyítékot igényel.
Fejlesztő · Adatforrások és kötőelemek

Használjon biztonságos DTO-t

  1. Válasszon ki egy meglévő pontozott azonosítót, mint például: tickets.mine, knowledge.featured vagy customer.profile.
  2. Csak a visszavont DTO által bejelentett mezők tartoznak ide. data_source.unknown.
  3. A már engedélyezett portálon keresztül soha ne fogadj el munkaterületet / ügyfélazonosságot egy nem megbízható ingatlantól.
  4. A listahatárok a következők:1–100. Normalizálja a pagináció, lokál és keresési értékek.
  5. Ha egy új forrás elkerülhetetlen, adja hozzá a stabil definíciót, biztonságos feltérképezést, engedélyeket, üres viselkedés és előnézeti rögzítés együtt.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Adatforrások csak olvasható. A mutációk kifejezett, engedélyezett szolgáltatási műveletet, munkaterületkötést, CSRF / munkamenet vagy hordozóérvényesítést, idempotenciát és egy gépelt hibaborítékot igényelnek.
Fejlesztő · Biztonság

Maradj a bizalom határain belül.

HatáridőSzükséges viselkedés
MunkahelyA megbízható host / route / session-től való eltérés, majd a végrehajtás előtt minden olvasást és írást le kell írni.
HTMLA Portal Sanitizer / parser allowlist-ot használja. Soha ne egyeztessen megbízhatatlan attribútumokkal, URLs, CSS vagy forgatókönyv.
ElőnézetKérjen azonos eredetű forrás ablak, aláírt csatorna verzió és nace. Ne vegye figyelembe a kéretlen üzenetek.
AzonosítóA SCIM -nak nincs semmi köze a dokumentumokhoz.
CsomagokA keresztirányú, abszolút menetvonalak, linkek / speciális fájlok, nagyméretű archívumok, csekk-összeg / aláírás eltérések és ismeretlen engedélyek elutasítása.
HibákA biztonságos kód, a biztonságos üzenet, a visszahívhatóság, a kármentesítés és a korreláció azonosítója; a privát kivételek naplója szerveroldalas.
IsmeretOlvassa el a HelpCenterBridge. Soha szerző vagy másolat Súgó Center cikkek egy kiterjesztés.
{
  "success": false,
  "error": {
    "code": "studio.permission_denied",
    "message": "You do not have permission to publish the Portal.",
    "retryable": false,
    "correlation_id": "ps_…",
    "meta": {"capability": "publish"}
  }
}
Fejlesztő · Csomagok és migráció

Vizsgálat, telepítés és korszerűsítés atomikusan

  1. Tedd component.json a ZIP gyökérnél, és minden ösvényt relatív szinten tartani.
  2. Az installáló lezárja az archívumot a 500 bejegyzések és 25 MB kivont; a biztonsági ellenőrzés független korlátokat ad.
  3. Ellenőrizze a várható SHA-256 és csomag aláírás a kiadás folyamat.
  4. Telepítsd egy verziós könyvtárba. Soha ne mutálj telepített változatot a helyedre.
  5. Adja meg a tulajdoni vándorlást a tervváltoztatások megtöréséhez, és őrizze meg az ismeretlen kompatibilitási mezőket.
  6. Az elem megnyitása a tervezetben, futtatás minden állam / nézet / személyiség beállítás és közzététele irányítás.
  7. A visszaforgatás aktiválja a korábbi, változatlan komponens / dokumentum kiadást; megőrzi reprodukálhatósági bizonyítékait.
Fejlesztő · Vizsgálatok és kiadás

Bizonyítsa be a kiterjesztés ugyanazon kiadás hash

php tools/portal_studio_certify.php --source-only --json
php tools/test_portal_studio_contract.php
php tools/test_portal_one_renderer.php
php tools/test_portal_studio_engineer.php
php tools/test_portal_component_contracts.php
php tools/test_portal_one_renderer.php
php tools/test_portal_shell_contract.php
php tools/test_portal_knowledge_contract.php
node node_modules/@playwright/test/cli.js test tests/e2e/portal-studio-shell-visual-contract.spec.js tests/e2e/portal-custom-code-runtime.spec.js

A forráskapuk szükségesek, nem elegendőek. Csatolja az adatbázis- / migráció-, real- böngésző vizuális, identit- szolgáltató, engedélyezés- elszigeteltség, hozzáférhetőség, teljesítmény, sor / cron, mail / csatolás, biztonsági mentés / helyreállítás és telepítés bizonyítékot ugyanahhoz a változatlan kiadáshoz. Ismeretlen szükséges bizonyíték kell, hogy sikerüljön a kiadás.

  • Egység: séma, fertőtlenítés, DTO forma, körülmények, vándorlás és gépelt hibák.
  • Szerződés: betöltés / üres / hiba / siker, érettség, rések, kötések és egyrendűségi paritás.
  • Böngésző: billentyűzet, fókuszálás, szemantika, RTL, zoom / reflow, mozgáscsökkenés és minden töréspont.
  • Biztonság: kereszteződés, hamis akciók, csomagtámadások, előzetes kémkedés és titkos szivárgás.
  • Műveletek: tartós fejlődés, szabadság / visszatérés, stop / retry / revolver, ütemező szívverés és visszaállítás.
Administrator + Fejlesztő · Felépülés

Problémamegoldás az állam és a korrelációs azonosító szerint

ÁllamMit tegyünk?
EngedélyKérje a megnevezett képesség. Rejtett UI kényelem; a backend mindig rögzíti azt.
JóváhagyásNyissa meg a jelentett oldalt / csomópont / mező, javítsa ki, majd futtassa újra az előrepülést.
ÖsszeütközésÚjratöltjük a legújabb felülvizsgálatot, összehasonlítjuk a változásokat és szándékosan újra alkalmazzuk.
Offline / retriableMegtartja a tervezetet, helyreállítja az összeköttetést, újra megpróbálja a cselekvést, és ellenőrzi a tartós munkahelyet.
Végzetes / nem elérhetőMásolja a korrelációs azonosító és időbélyegző támogatást. Soha ne dugja be titkokat vagy privát kivételek szöveget.
A kiadvány nem sikerültVizsgáljuk meg a repülés előtti / munkahelyi kimenetet, próbáljuk meg újra csak a relaxálható szakaszokat, vagy guruljunk vissza az utolsó egészséges kiadáshoz.
SCIM 401/403A végpont / munkaterület megerősítése, bemutatótoken, engedélyezett állapot és forgás; soha ne használjon böngésző munkamenet cookie-t.
A tudás megrekedt.Ellenőrizze a helyazonosságot / publikációt a Súgó Központban, majd ellenőrizze a gyorsítótár érvénytelenítését és a tiszta helyi útvonalat.

Ez az útmutató nyomtatási kész. Használja a Print → Mentés mint PDF egy ellenőrzött offline másolat.