← Al dokumentation
Portal Studio-feltguide

Byg dristigt, forlagsvirksomhed sikkert.

En praktisk reference for administratorer, der former kundeoplevelsen og udviklere, der udvider den. Det dokumenterer den virkelige Studio arkitektur, styret release sti, Hjælp Center ejerskab, identitet, migreringer, komponent kontrakter og inddrivelse.

Portaldokument v2Administrator + udviklerWorkflow til virksomhedsudgivelsesNameOpdateret 1 August 2026
Administrator guide · Arkitektur

Vide, hvad Studio ejer

Portal Studio ejer customer- face shell: sider, komponent placering, mærke tokens, lydhør adfærd, navigation, fod, identitet præsentation, billet rejser og udgivelser. The Help Center ejer sprog, kategorier, sektioner og artikel indhold. Studio bruger dette indhold gennem en beskyttet bro; det aldrig skaber en anden artikel butik.

Hjælp Center + billet + identitetstjenesterPermission- sikre dataadapterePortal Dokument v2 udkastEn kompilerer og rendererPreview og offentliggjort Portal
One- renderregel: preview og offentlige sider bruger samme dokument / compiler kontrakt. Offentliggørelse aldrig skifter til en ikke-relateret skabelon.
Portal Studio · Arbejdspladskort
Lærredsvævet, af vægt over 150 g pr. m2Desktop · Kunde
KundeportalSamme strukturerede dokument, der anvendes i forhåndsvisning og offentlig rendering
Grænseflade kort: job skinne, levende lærred og inspektør mål den samme stabile side og node udvælgelse.
Administrator · Tilmeld dig

Fuldstændig beredskab før bygning

  1. Åbn Portal Studio → Start → Opvarsel.
  2. Bekræft den kanoniske Portaladresse og åbn den i en separat fane.
  3. Sæt logo, browser ikon, touch ikon og social image og tema farve.
  4. Bekræft Help Center sprog; ændre sprogmyndighed i Hjælp Center, ikke Studio.
  5. Indstil navigation og den globale enterprise-fod.
  6. Vælg en billet rejse og konfigurere mindst én anmodning formular.
  7. Hold mindst én sikker sign- in metode aktiv og gennemgå identitetsopdagelse.
  8. Kør Kvalitet og etablere den underskrevne preview håndtryk.
  9. Opret den første regulerede udgivelse efter hver blokerende element er klar.

Beredskabsprocenten beregnes ud fra gemte arbejdsrums data og forhåndsvisning af tilstand. Valg af et element ruter direkte til sin ejer panel.

Administrator · Byg

Bygge sider og genanvendelige sektioner

  1. Åbn Byg → sider og vælg en beskyttet systemside eller opret en brugerdefineret side.
  2. Indstil rute, titel, adgangstilstand og lokal adfærd. Beskyttede systemruter kan ikke slettes.
  3. Åbn Komponenter, filtrere efter job eller modenhed og placere en komponent i et kompatibelt slot.
  4. Brug inspektøren til indhold, udseende, binding, synlighed og tilgængelighed.
  5. Brug genanvendelige mønstre til gentagne strukturer; holde organisation eller brand forskelle i varianter.
  6. Gem udkastet og motion indlæsning, tom, fejl, gæst og signed-i stater i preview.
Komponentbibliotek · Sanificeret grænsefladekort
KundskabssøgningGA · kundesikkerhedKategori gitterGA · HjælpecenterArtikel 9GA · oversatte DTOAnmodningsformularGA · versioneretBillettidslinjeBeta · advarselDatakortPlanlagte blokke
Interface kort: kategori, kompatibilitet og modenhed er synlige før placering. Planlagte komponenter blok offentliggørelse; beta-komponenter kræver eksplicitte frigivelsesbehandling.
Administrator. Mærke og lydhør

Vis eksempler på rigtige rejser, ikke en glad skærm

  1. Vælg gæstestøtte, signed-in billet, fakturering pleje, organisation eller viden overdragelse.
  2. Skift persona, organisation, rolle og Hjælp Center sprog.
  3. Inspect mobile, store mobil, tablet, laptop, desktop, brede og ultrawide breakpoints.
  4. Kontroller arvede, overridede og nulstillede værdier; undgå unødvendige breakpoint duplikering.
  5. Kør tastatur, RTL, reduceret-bevægelse, indlæsning, tom, utilgængelig og tilladelse stater.
  6. Brug Test Lab for tilgængelighed, nyttelast, rute, binding og renderer resultater før gennemgang.
Et grønt lærred er ikke en release beslutning. Oversat før flyvning, gennemgang tilstand, kapaciteter og udgivelsesbevis beslutte, om portalen kan offentliggøre.
Administrator · Erfaring

Operér et Zendesk- niveau Hjælp Center uden duplikering af indhold

  1. Opret kategorier, sektioner, artikler, oversættelser, vedhæftede filer og skabeloner i Hjælp center.
  2. Aktivér sprog der; lokaliserede snegle, søgning, feeds, SEO og artiklen krom følge samme myndighed.
  3. I Studio, placere viden søgning, kategori / ressource net, feeds, emne harmonika, artikel, indholdsfortegnelse, feedback, relaterede og tidligere / næste komponenter.
  4. Indstil viste, populære og seneste feeds; brug kontekstuelle forslag i billetten strømme.
  5. Se ingen resultater, lange artikler, vedhæftede filer, feedback, ur / abonnement og billetsalg.
  6. Verificer rene locale ruter, kanoniske / hreflang, strukturerede data og cache ugyldiggørelse efter offentliggørelse.
Myndighedens grænse: redigere artikel indhold og kundesprog i Hjælp Center. Brug kun Portal Studio til at komponere, hvordan viden er opdaget og vises.
Administrator Identitet og organisationer

Indstil signe- in sikkert

  1. Åbn Identitet & organisationer → Identitet og holde mindst én sign-in sti aktiveret.
  2. Vælg standardmetode, registreringspolitik, sessionsvarighed, SSO-domæne håndhævelse og opdagelse adfærd.
  3. Tilføj udbydere med visuelle routingfelter: type, domæner, prioritet, præsentation, aktiveret og verificeret tilstand. Hemmeligheder forbliver i identitetsdelsystemet.
  4. For SCIM, aktivere hensættelse, kopiere den nøjagtige arbejdsområde endpoint og rotere token. Opbevar engangs token i IdP.
  5. Kort krav og organisation medlemskab, derefter test oprette, opdatere, gruppe medlemskab og deaktivering med en testlejer.
  6. Eksempel gæst, kunde, delegeret organisation og blokeret stater før offentliggørelse.
Send aldrig en Studio session cookie til SCIM. Det er en sensationsløs, arbejdsrums-bundet bærer API. Rotere en token efter utilsigtet eksponering.
Administrator · Billetrejser

Sammensæt den komplette supportrejse

  1. Vælg direkte form, guiden, søge- først, hub eller service-desk indgang.
  2. Opret en navngivet, versioneret ansøgningsformular med sektioner og tilgængelige feltetiketter.
  3. Byg visuelle betingelser, routing, SLA og godkendelse trin; avancerede JSON er for gennemgåede udviklerændringer kun.
  4. Indstil liste, detaljer, tråd, tidslinje, vedhæftning, godkendelse, SLA og svar overflader.
  5. Test gæst opslag, signed-i anmodninger, organisation synlighed, upload fiasko, e-mail anmeldelse og viden deformation.
  6. Gem et udkast; udgiv først efter rutekapteren og anmeldelsesvej før flyvning.
Administrator · Revision og frigivelse

Flyt gennem en styret udgivelse

Udkast gemtI den fornyede undersøgelseGodkendtPlanlagt eller offentliggjortMed indhold af kulstof på over 0,5 vægtprocent
  1. Kør validering og Test Lab. Retter blokerende fund; anerkender tilladte advarsler med sammenhæng.
  2. Tilføj udgivelsesnoter og anmodning gennemgang. Anmeldere kommentar på stabil side / node stier.
  3. Godkendelser inspicer diff, preview rejser, tilladelse ændringer og beviser.
  4. Udgiv eller skemalæg gennem baggrundsarbejderen. Forlader Studio aflyser ikke et varigt job.
  5. Se fremskridt, sundhed og korrelations- ID. Stop / prøv kun fra jobkontrol.
  6. Verificer kritiske ruter, identitet, billetter og viden. Rul tilbage til en uforanderlig forudgående udgivelse, når det er nødvendigt.
KapacitetFormål
Vis / RedigérInspect eller ændre udkast uden frigivelsesmyndighed.
Revision / godkendelseSeparat feedback og godkendelse fra forfatterskabet.
Skema / Publisér / RollbackUafhængige produktionskontroller.
Identitet / SCIM / migrate / komponenter / diagnostikBegræns følsomme specialoperationer.
Administrator og udbygger

Migrere med beviser og en vej tilbage

  1. Vælg den udbyder, der er blueprint og oprette en tør køre.
  2. Gennemgå opdagede indstillinger, ukortlagte værdier, indhold tæller og visuelle paritet indfangning.
  3. Komplet sikker tilknytninger og genkøre den strukturerede diffs.
  4. Anvend på et udkast, forlige tællinger og få vist alle beskyttede rejser.
  5. Optag autoriseret accept; aldrig overskrive den aktuelle offentliggjorte udgivelse under import.
  6. Udgiv gennem styring og holde migration rapport, frigive ID og rollback punkt sammen.
Udvikler udvidelsesguide · Arkitektur

Udvid kontrakter, ikke skabeloner

En sikker udvidelse registrerer en stabil komponent type og skema, erklærer tilladelser og data behov, gør gennem kanonisk compiler, og leverer deterministiske inventar / tests. Må ikke forespørge vilkårlige tabeller, injicere editor JavaScript i den offentlige portal, oprette en anden artikel arkiv, eller omgå udgivelsesporten.

Portaldokument v2

Sider indeholder stabile knudepunkter, slots, egenskaber, bindinger, lydhør tilsidesætter, betingelser og tilgængelighed metadata.

Komponentregister

En kontrakt giver Studio, kompilator, dokumentation, migrations- og modenhedskontrol.

Datakilderegister

Andel, der er opført på listen, kun read- only, permission- scoped DTO 'er erstatter vilkårlig SQL eller dynamiske handlinger.

En renderer

Forhåndsvisning og offentlige output deler udarbejdelse, sanitering, budgetter og driftstimer stater.

Udvikler · Komponentkontrakt

Definer en komponentpakke

Brug en lav- cases navngivet ID og semantisk version. Levere både kompatibilitetsegennavne vist, fordi pakkeinspektion og sikkerhedsvalidering udfører uafhængige kontroller.

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

Knudeform

{
  "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"}
}
  • Identifikationsnumrene er stabile på tværs af redigeringer og migreringer.
  • Egenskaber afviser uanmeldte felter og usikre HTML.
  • Hver databundet visning definerer indlæsning, tom, tilladelse og udskrift af gentrykkelig fejl.
  • Container komponenter navngive deres slots; blade kan ikke acceptere vilkårlige børn.
  • Marker modenhed ærligt: planlagte blokke, beta advarer, GA kræver fuld dokumentation.
Udvikler · Datakilder og bindinger

Brug permission- safe DTO 'er

  1. Vælg et eksisterende stiplet ID såsom tickets.mine, knowledge.featured eller customer.profile.
  2. Bind kun felter erklæret af dens versionerede DTO. Ukendt kilder mislykkes med data_source.unknown.
  3. Pass den allerede godkendte Portal kontekst; aldrig acceptere arbejdsplads / kunde identitet fra en betroet ejendom.
  4. Listegrænser fastgøres til1–100. Normalisere paginering, lokalisering og søgeværdier.
  5. Hvis en ny kilde er uundgåelig, tilføje sin stabile definition, sikker kortlægning, tilladelser, tom adfærd og preview fiksering sammen.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Datakilder er read- only. Mutationer kræver en eksplicit autoriseret service handling, arbejdsrums binding, CSR / session eller bærer validering, idempotens hvor det er nødvendigt og en indtastet fejl konvolut.
Udvikler · Sikkerhed

Bliv inden for tillidsgrænserne

GrænseKrævet adfærd
ArbejdsområdeResolve fra den betroede vært / rute / session, derefter se hver læse og skrive før udførelse.
HTMLBrug portalsanitizer / parser allolist. Aldrig koncentrer ubetroede attributter, URLs, CSS eller script.
ForhåndsvisningKræve same- oprindelse kildevindue, underskrevet kanal version og nonce. Ignorer uopfordrede meddelelser.
IdentitetHold hemmeligheder udenfor dokumenter. SCIM er beare- autentificeret, sensationsløs og arbejdsområde-bundet.
PakkerAfvis traversal, absolutte stier, links / specielle filer, oversize arkiver, checksum / signatur mismatch og ukendte tilladelser.
FejlReturnér stabil kode, sikker besked, retryability, oprydning og korrelationsidentifikation; log private undtagelser server- side.
VidenLæs via HelpCenterBridge. Forfatter eller kopierer aldrig artikler fra Hjælp Center i en forlængelse.
{
  "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"}
  }
}
Udvikler · Pakke og migration

Inspect, installer og opgradere atomisk

  1. Sæt component.json på ZIP-roden og holde hver sti relativ.
  2. Kør inspektion først. Installationsprogrammet caps arkiver på 500 indgange og 25 MB ekstraheret; sikkerhedsvalidering tilføjer uafhængige grænser.
  3. Verificer den forventede share-256 og pakkesignatur i udgivelsesprocessen.
  4. Installér til en versioneret mappe. Matricer aldrig en installeret version på plads.
  5. Giv ejendom migreringer for at bryde skema ændringer og bevare ukendte kompatibilitet felter.
  6. Åbn komponenten i et udkast, køre hver stat / viewport / persona fiksering og offentliggøre gennem styring.
  7. Rollback aktiverer den tidligere uforanderlige komponent / dokument-frigivelse; beholder reproducerbarhedsbeviset.
Udvikler · Test og frigivelse

Bevis udvidelsen på samme udgivelseshash

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

Kildeporte er nødvendige, ikke tilstrækkelige. Vedhæft database / migration, real- browser visuelle, identity- udbyder, autorization- isolation, tilgængelighed, ydeevne, kø / cron, mail / vedhæftet fil, backup / retablering og implementering beviser til den samme uforanderlige udgivelse hash. Ukendt påkrævet dokumentation skal mislykkes udgivelsen.

  • Enhed: skema, sanitisering, DTO form, betingelser, migreringer og indtastede fejl.
  • Kontrakt: indlæsning / tom / fejl / succes, modenhed, slots, bindinger og en- renderer paritet.
  • Browser: tastatur, fokus, semantik, RTL, zoom / reclow, reduceret bevægelse og hver breakpoint.
  • Sikkerhed: tværfaglige prober, forfalskede handlinger, pakkeangreb, preview spoofing og hemmelig lækage.
  • Operationer: varige fremskridt, orlov / tilbagevenden, stop / forsøg / genoptage, scheduler hjerteslag og rollback.
Administrator + Udvikler · Inddrivelse

Fejlfinding ved tilstand og korrelationsidentifikation

TilstandHvad skal man gøre?
TilladelseAnmoder om den navngivne evne. Skjult UI er bekvemmelighed; bagenden altid håndhæver det.
ValideringÅbn den rapporterede side / node / felt, rette det, derefter køre igen før flyvning.
KonfliktGenindlæs seneste revision, sammenlign ændringer og genanvend med vilje. Overskriv aldrig.
Offline / kan gentagesBehold udkastet, genoprette forbindelse, prøve igen gennem handlingen og kontrollere holdbar jobtilstand.
Dødelig / ikke tilgængeligKopiér korrelationsidentitet og tidsstempel for understøttelse. Indsæt aldrig hemmeligheder eller privat undtagelsestekst.
Udgiv mislykkedesUndersøg før flyvning / job output, prøv kun gentrykkelige stadier, eller rulle tilbage til den sidste sunde udgivelse.
SCIM 401/403Bekræft endpoint / arbejdsområde, bærer token, aktiveret tilstand og rotation; brug aldrig en browser session cookie.
Viden er gammelVerificer lokalisering / offentliggørelse i Hjælp Center, og inspicer derefter cache invalidering og den rene lokaliserede rute.

Denne guide er print- klar. Brug Print → Gem som PDF for en kontrolleret offline kopi.