← Kaikki asiakirjat
Portal Studio -kenttäopas

Rakenna rohkeasti ja julkaise turvallisesti.

Yksi käytännön viite ylläpitäjille, jotka muokkaavat asiakaskokemusta ja kehittäjiä, jotka laajentavat sitä. Se dokumentoi todellisen Studio-arkkitehtuurin, ohjatun julkaisupolun, Help Centerin omistamisen, identiteetin, muuttojen, komponenttien sopimusten ja palautuksen.

Portaaliasiakirja v2Hallintovirkamies + kehittäjäYritystoiminnan vapautuminenPäivitetty 1 Elokuu 2026
Hallintovirkamies opas · Arkkitehtuuri

Tiedä mitä Studio omistaa

Portal Studio omistaa asiakaslähtöisen kuori: sivut, komponenttisijoittelu, merkki kuponkia, reagoiva käyttäytyminen, navigointi, alatunniste, lipunmyynti ja julkaisut. Help Center omistaa kieliä, luokat, osiot ja artikkelin sisältöä. Studyo kuluttaa sisällön kautta suojattu silta; se ei koskaan luo toista artikkelimyymälää.

Ohjekeskus + lippu + henkilökorttipalvelutKäyttöoikeuden turvaavat tietosovittimetPortaaliasiakirjan v2 luonnosYksi kääntäjä ja renderöijäEsikatselu ja julkaistu portaali
Yhden käänteen sääntö: Esikatselu ja julkiset sivut käyttävät samaa dokumenttia/kompelleria. Julkaisu ei koskaan vaihda etuyhteydetöntä mallia.
Portal Studio · Workspace kartta
Elävät kankaatTyöpöytä · asiakas
AsiakasportaaliSama jäsennelty asiakirja, jota käytetään esikatselussa ja julkisessa renderöinnissä
Liitäntäkartta: työrata, live kankaalla ja tarkastajan tavoite on sama vakaa sivu ja solmun valinta.
Hallintovirkamies · Aloita

Valmistaudu perusteellisesti ennen rakentamista

  1. Avaa Portaalistudio → Aloitus → Valmius.
  2. Vahvista kanoninen portaalin osoite ja avaa se erillisellä välilehdellä.
  3. Aseta logo, selain kuvake, kosketuskuvake, sosiaalinen kuva ja teeman väri.
  4. Vahvista Ohjekeskus kielet; muuttaa kieli auktoriteettia Tukikeskus, ei Studio.
  5. Määrittele navigointi ja globaali yritysalatunniste.
  6. Valitse matkalippu ja määritä vähintään yksi hakulomake.
  7. Pidä ainakin yksi turvallinen sisäänkirjautumismenetelmä aktiivisena ja tarkista henkilöllisyys.
  8. Suorita laatu ja vahvistaa allekirjoitettu esikatselu kädenpuristus.
  9. Luo ensimmäinen ohjattu julkaisu jokaisen eston jälkeen on selvä.

Valmiusprosentti lasketaan tallennetuista työtilatiedoista ja esikatselutilasta. Valitsemalla kohteen reitit suoraan sen omalle paneelille.

Hallintovirkamies · Koosta

Koosta sivut ja uudelleen käytettävät osat

  1. Avaa Koosta → Sivuja ja valitse suojattu järjestelmä sivu tai luoda mukautettu sivu.
  2. Aseta reitti, otsikko, käyttötila ja paikallinen käyttäytyminen. Suojattuja järjestelmäreittejä ei voi poistaa.
  3. Avaa Osat, suodattaa työn tai kypsyyden mukaan ja sijoittaa komponentin yhteensopivaan lähtöpaikkaan.
  4. Tarkastajan on käytettävä sisältöä, ulkonäköä, sitovuutta, näkyvyyttä ja saavutettavuutta.
  5. Käytä uudelleenkäytettävissä kuvioita toistuvia rakenteita; pitää organisaatio-tai brändi eroja variantteja.
  6. Tallenna luonnos ja harjoitus lastaus, tyhjä, virhe, vieras ja kirjautunut tilassa esikatselu.
Komponenttikirjasto · Sanitized interface map
TietohakuGA · asiakasturvallinenLuokkaruudukkoGA · OhjekeskusArtiklan mukainen elinGA · käännetty DTOPyyntölomakeGA · versioituLippujen aikajanaBeta · varoitusTietotaulukkoSuunnitellut · lohkot julkaista
Liitäntäkartta: luokka, yhteensopivuus ja kypsyys näkyvät ennen sijoitusta. Suunnitellut komponentit lohkon julkaisu; beetakomponentit vaativat nimenomaisesti julkaisua.
Hallintovirkamies · Brand ja reagoiva

Esikatsella todellisia matkoja, ei yhtään iloinen näyttö

  1. Valitse vierastuki, sisäänkirjattu lippu, laskutus hoito, organisaatio tai tiedon luovutus.
  2. Vaihda persoonaa, organisaatiota, roolia ja Tukikeskus kieltä.
  3. Tutki mobiili, iso mobiile, tabletti, kannettava tietokone, työpöytä, laaja ja ultralaaja raja-arvot.
  4. Tarkista periytyvät, ylitykset ja nollausarvot; vältä tarpeetonta keskeytyspisteen päällekkäisyyttä.
  5. Suorita näppäimistö, RTL, alennettu-motion, lastaus, tyhjä, ei saatavilla ja lupa-tilassa.
  6. Käytä Test Lab-koetta ennen arviointia esteettömyys-, hyötykuorma-, reitti-, sitovuus- ja renderointihavaintoihin.
Vihreä kangas ei ole vapautuspäätös. Hallittu esilento, tarkistaa tilaa, valmiuksia ja julkaisutodisteet päättää, voiko portaali julkaista.
Hallintovirkamies · Kokemus

Käytä Zendesk-tason ohjekeskusta ilman kaksoissisältöä

  1. Luo luokat, osiot, artikkelit, käännökset, liitteet ja mallit Ohjekeskus.
  2. Käytä kieliä siellä; paikalliset etanat, haku, syötteet, SEO ja artikkeli kromi seuraavat samaa viranomaista.
  3. Studiossa on tietoa etsittävä, kategoria/resurssiruudukot, syötteet, aiheharmoniikka, artikkeli, sisältötaulukko, palaute, liittyvät ja aiemmat/seuraavat komponentit.
  4. Määrittele esillä olevat, suositut ja viimeaikaiset syötteet; käytä kontekstikohtaisia ehdotuksia lippuvirrassa.
  5. Esikatselu ei tuloksia, pitkiä artikkeleita, liitteet, palaute, katsella / tilaus ja lipun luovutuksesta.
  6. Varmista puhtaat paikalliset reitit, kanoniset/hreflangit, jäsennetyt tiedot ja välimuistin mitätöinti julkaisun jälkeen.
Viranomainen: muokata artikkelin sisältöä ja asiakkaiden kieliä Help Centerissä. Käytä Portal Studio vain säveltää, miten tietoa löydetään ja näytetään.
Hallintovirkamies · Henkilöllisyys ja järjestöt

Aseta kirjautuminen turvallisesti

  1. Avaa Henkilöllisyys ja organisaatiot → Henkilöllisyys ja pitää vähintään yksi sisäänkirjautumistie käytössä.
  2. Valitse oletusmenetelmä, rekisteröintikäytäntö, istunnon kesto SSO-Poikkea valvonta- ja löytökäyttäytymisestä.
  3. Lisää palveluntarjoajia, joilla on näköreitityskentät: tyyppi, verkkotunnukset, prioriteetti, esitystapa, käytössä ja todennettu tila. Salaisuudet pysyvät tunnisteosajärjestelmässä.
  4. SCIM, ota käyttöön varaus, kopioi tarkka työtilan päätepiste ja pyöritä token. Tallenna kertaluonteinen polete IdP:ssä.
  5. Karttavaatimukset ja organisaation jäsenyys, sitten testi luoda, päivittää, ryhmän jäsenyys ja deaktivointi testi vuokralainen.
  6. Esikatseluvieras, asiakas, valtuutettu organisaatio ja estetty valtiot ennen julkaisemista.
Älä koskaan lähetä Studio-session evästettä SCIM. Se on istuntoton, työtilaan sidottu haltija API Pyöritä poletta vahingossa tapahtuneen altistumisen jälkeen.
Hallintovirkamies · Lippumatkat

Kokoa koko tukimatka

  1. Valitse suora muoto, velho, haku ensin, napa tai palvelu- desk merkintä.
  2. Luo nimetty, versioitu pyyntölomake osioiden ja saatavilla kenttätarroja.
  3. Rakenna visuaaliset olosuhteet, reititys, SLA ja hyväksymisvaiheet; JSON on vain tarkistettuja kehittäjän muutoksia.
  4. Määrittele luettelo, yksityiskohdat, lanka, aikajana, kiinnitys, hyväksyntä, SLA ja vastauspinnat.
  5. Koevieraan haku, sisäänkirjautuminen, organisaation näkyvyys, lataushäiriö, sähköpostin ilmoitus ja tiedon taipuma.
  6. Tallenna luonnos; julkaista vasta sen jälkeen, kun reittisovitin ja ilmoitusreitti läpäistä ennen lentoa.
Hallintovirkamies · Katsaus ja julkaisu

Siirrä hallitun julkaisun läpi

Luonnos tallennettuTarkasteluHyväksyttyAikataulu tai julkaistuHuomattu tai rullattu takaisin
  1. Suorita validointi ja Test Lab. Korjaa estohavainnot; tunnusta sallitut varoitukset asiayhteydestä.
  2. Lisää julkaisutiedotteet ja pyyntö tarkistaa. Arvioijat kommentoida vakaa sivu / solmupolkuja.
  3. Hyväksyjät tarkastavat erot, esikatselu matkoja, lupamuutokset ja todisteet.
  4. Julkaise tai aikataulu läpi taustatyöntekijä. Poistu Studio ei peruuta kestävää työtä.
  5. Seuraa edistymistä, terveyttä ja korrelaatiota. Pysäytä/eläkkeellä vain työnohjaajista.
  6. Varmista kriittiset reitit, henkilöllisyys, liput ja tieto. Palaa muuttumattomaan etukäteen vapautumiseen tarvittaessa.
VoimavaraAihe
Näytä / MuokkaaTutki tai muuta luonnoksia ilman julkaisuviranomaista.
Uudelleentarkastelu / hyväksyminenErillinen palaute ja hyväksyntä tekijältä.
Aikataulu / Julkaise / PalautusRiippumaton tuotannon valvonta.
Henkilöllisyys / SCIM / Muuta / Komponentit / DiagnostiikkaRajoita arkaluonteisia erikoistoimintoja.
Hallintovirkamies · Määräysvalta ja laajenna

Siirrä todisteet ja paluumatka

  1. Valitse palveluntarjoajan suunnitelma ja luoda kuivaajo.
  2. Tarkistaa havaittu asetukset, kartantamattomat arvot, sisällön määrät ja visuaalinen pariteetti kaappaa.
  3. Täydellinen turvallinen kartoitus ja uudelleen jäsennelty diff.
  4. Hae luonnos, sovittaa yhteen laskenta ja esikatselu jokaisen suojatun matkan.
  5. Kirjaa hyväksytty hyväksyntä; älä koskaan korvaa nykyistä julkaistua julkaisua tuonnin aikana.
  6. Julkaise hallinnon avulla ja pidä muuttoliikeraportti, ID-tunnus ja kääntöpiste koossa.
Kehittäjän laajennusopas · Architecture

Laajennetaan sopimuksia, ei malleja

Turvallinen laajennus rekisteröi vakaan komponenttityypin ja kaavan, ilmoittaa oikeudet ja tietotarpeet, tekee läpi kanoninen kääntäjä, ja toimittaa deterministiset kalusteet / testit. Älä kysele mielivaltaisia taulukoita, ruiskutus editori JavaScript julkiselle portaalille, luoda toinen artikkelivarasto, tai ohittaa julkaisuportti.

Portaaliasiakirja v2

Sivut sisältävät vakaita solmuja, lähtö- ja saapumisaikoja, ominaisuuksia, sidontoja, reagoivia ohituslaitteita, olosuhteita ja esteettömyysmetatietoja.

Osarekisteri

Yksi sopimus syöttää Studio, kääntäjä, dokumentointi, siirtymä- ja kypsyystarkastukset.

Tietolähderekisteri

Sallitut, vain luettavat, luvalliset DTO:t korvaavat mielivaltaisesti SQL Dynaamisia toimia.

Yksi renderöijä

Esikatselu ja julkinen tuotos jakaa kooste, manitifiointi, talousarviot ja runtime valtiot.

Kehittäjä · Osasopimus

Määrittele komponenttipaketti

Käytä pienaakkosen nimeä ja semanttista versiota. Toimita sekä yhteensopivuusnimet, jotka on esitetty, koska pakettitarkastus ja turvatoimien validointi tekevät riippumattomia tarkastuksia.

{
  "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}
}

Solmun muoto

{
  "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"}
}
  • Henkilöllisyydet pysyvät vakaina kaikissa editoissa ja siirtymissä.
  • Ominaisuudet hylkää pimeät kentät ja turvaton HTML.
  • Jokainen dataan perustuva näkymä määrittelee latauksen, tyhjän, luvan ja uudelleen yritettävissä olevan virhelähdön.
  • Konttien osat nimeävät lähtö- ja saapumisaikansa; lehdet eivät voi hyväksyä mielivaltaisia lapsia.
  • Merkitse kypsyys rehellisesti: suunnitellut lohkot, beeta varoittaa, GA vaatii täyden näytön.
Kehittäjä · Tietolähteet ja sidonnat

Käytä käyttölupaturvallisia suojaverkkoja

  1. Valitse olemassa oleva katkottu tunnus, kuten tickets.mine, knowledge.featured tai customer.profile.
  2. Sitokaa vain versioidun DTO:n ilmoittamat kentät. Tuntematon lähde epäonnistuu data_source.unknown.
  3. Ohita jo hyväksytty portaaliyhteys; älä koskaan hyväksy työtilaa/asiakas-identiteettiä luottamattomasta omaisuudesta.
  4. Listan raja-arvot on kiinnitetty1–100. Normalisoi pagination, locale ja hakuarvot.
  5. Jos uusi lähde on väistämätön, lisää sen vakaa määritelmä, turvallinen kartoitus, oikeudet, tyhjä käyttäytyminen ja esikatselu laite yhdessä.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Tietolähteet ovat luettavia. Mutaatiot vaativat nimenomaisesti valtuutetun palvelun toiminnan, työtilan sitomisen, CSRF:n/käyttöoikeuden tai haltijavalidoinnin, tarvittaessa idemponency-järjestelmän ja kirjoitetun virhekuoren.
Kehittäjä · Turvallisuus

Pysy luottamusrajojen sisällä

RajaVaadittu käytös
TyötilaSelvitä luotettavasta isäntä / reitti / istunto, sitten tutkia jokaisen lukea ja kirjoittaa ennen suoritusta.
HTMLKäytä portaalin sanitizer/parser-lupalistaa. URLs, CSS tai käsikirjoitusta.
EsikatseluVaadi sama lähdeikkuna, allekirjoitettu kanavaversio ja nonce. Älä välitä ei-toivottuja viestejä.
TunnistetiedotPidä salaisuuksia asiakirjojen ulkopuolella. SCIM on haltija-autentiticated, sessionless ja työtilaan sidottu.
PaketitHylätkää matka, absoluuttiset polut, linkit/erityistiedostot, arkistojen ylikoko, tarkistussumma/allekirjoitusero ja tuntemattomat käyttöoikeudet.
VirheetPalauta vakaa koodi, turvallinen viesti, uudelleentryability, korjaus ja korrelaatio ID; loki yksityisiä poikkeuksia palvelimen puolella.
TietoLue HelpCenterBridgen kautta. Älä koskaan kirjoita tai kopioi Ohjekeskus -artikkeleita laajennuksessa.
{
  "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"}
  }
}
Kehittäjä · Paketti ja muuttoliike

Tutki, asenna ja päivitä atomisesti

  1. Laita component.json ZIP-juurta ja pidä kaikki polut suhteellisina.
  2. Suorita tarkastus ensin. Asentajan kansiot arkistot osoitteessa 500 merkinnät ja 25 MB outed; turvallisuusvarmennus lisää riippumattomia rajoja.
  3. Varmistetaan odotettu SHA-arvo 256 ja pakettien allekirjoitus julkaisuprosessissa.
  4. Asenna versioituun hakemistoon. Älä koskaan muuta asennettua versiota paikoilleen.
  5. Tarjoa kiinteistön muuttoja rikkoa skeema muutoksia ja säilyttää tuntematon yhteensopivuus kentät.
  6. Avaa osa luonnoksen, suorita jokainen valtion/näkymä / henkilö ja julkaista kautta hallinto.
  7. Rollback aktivoi aiemman muuttumattoman osan/asiakirjojen julkaisun; säilyttää sen uusittavissa olevat todisteet.
Kehittäjä · Testit ja julkaisu

Todista laajennus sama julkaisu 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

Lähdeportit ovat välttämättömiä, eivät riittäviä. Liitä tietokanta/muutto, reaaliaikainen selain visuaalinen, identiteetti-palveluntarjoaja, valtuutus-eristys, saavutettavuus, suorituskyky, jono/cron, posti/kiinnitys, varmuuskopio/palautus ja käyttöönottotodisteet samaan muuttumattomaan julkaisuhasikseen. Tuntematon vaadittu näyttö ei saa olla release.

  • Yksikkö: skeema, manitisaatio, DTO muoto, olosuhteet, vaellus ja kirjoittaa epäonnistumisia.
  • Sopimus: lastaus/tyhjä/virhe/menestys, kypsyys, lähtö- ja saapumisajat sekä yhden käänteen pariteetti.
  • Selain: näppäimistö, tarkennus, semantiikka, RTL, zoomaus/reflow, liikerajoitteet ja kaikki keskeytyspisteet.
  • Turvallisuus: työtilojen rajat ylittävät luotaimet, väärennetyt toimet, pakettihyökkäykset, esikatselu spoofointi ja salainen vuoto.
  • Toiminta: kestävä kehitys, loma/paluu, pysähdys/retry/resume, ajoittainen syke ja kääntyminen.
Hallintovirkamies + kehittäjä · elpyminen

Vianmääritys tilan ja korrelaation ID:n mukaan

TilaMitä tehdä?
LupaPyydän nimetty kyky. Piilotettu käyttöliittymä on mukavuus; taustaosa aina valvoo sitä.
ValidointiAvaa raportoitu sivu/solmu/kenttä, korjaa se ja suorita lentoa edeltävät.
KonfliktiLataa uusin versio uudelleen, vertaa muutoksia ja käytä niitä tahallaan. Älä koskaan pakota ylikirjoittamaan.
Offline / uudelleen työstettäväSäilytä luonnos, palauttaa yhteydet, yrittää läpi toimen ja varmistaa kestävä työpaikkatila.
Kuolemaan johtanut / ei saatavillaKopioi korrelaatiotunnus ja aikaleima tukea. Älä liitä salaisuuksia tai yksityinen poikkeus teksti.
Julkaiseminen epäonnistuiTutki ennen lentoa/työpaikkaa, yritä uudelleen vain uudelleen-vaiheessa tai siirry takaisin viimeiseen terveeseen julkaisuun.
SCIM 401/403Vahvista päätepiste/työtila, haltijatunnus, käytössä tila ja kierto; älä koskaan käytä selaimen istuntoevästettä.
Tieto on kulunutta.Varmista paikallinen/julkaisu ohjekeskuksessa, tarkista välimuistin mitätöinti ja puhdas paikallinen reitti.

Tämä opas on tulostusvalmis. Käytä Tulosta → Tallenna nimellä PDF Offline-kopiointi on valvottu.