← Tutti i documenti
Portal Studio guida sul campo

Costruisci in modo audace. Pubblica in sicurezza.

Un riferimento pratico per gli amministratori che modellano l'esperienza del cliente e gli sviluppatori che lo estendono. Documenta la vera architettura Studio, il percorso di rilascio governato, la proprietà dell'help Center, l'identità, le migrazioni, i contratti dei componenti e il recupero.

Portal Documento v2Amministratore + SviluppatoreFlusso di lavoro per il rilascio delle impreseAggiornato 1 Agosto 2026
Guida amministratore · Architettura

Scopri cosa possiede Studio

Portal Studio possiede la shell di customer-face: pagine, posizionamento dei componenti, token del marchio, comportamento reattivo, navigazione, piè di pagina, presentazione dell'identità, viaggi dei biglietti e release. L'Help Center possiede lingue, categorie, sezioni e contenuti degli articoli. Lo studio consuma quel contenuto attraverso un ponte protetto; non crea mai un secondo negozio di articoli.

Centro assistenza + biglietto + servizi di identitàAdattatori di dati per la sicurezza delle emissioniPortal Documento v2 progettoUn compilatore e un rendererAnteprima e pubblicato Portal
Regola di un giocatore: l'anteprima e le pagine pubbliche utilizzano lo stesso contratto di documento/compiler. La pubblicazione non passa mai a un modello non correlato.
Portal Studio · Mappa del Workspace
Tela liveDesktop · cliente
Portale clienteStesso documento strutturato utilizzato in anteprima e rendering pubblico
Mappa dell'interfaccia: la guida del lavoro, la tela dal vivo e l'ispettore si rivolgono alla stessa pagina stabile e selezione dei nodi.
Amministratore · Avvio

Prontezza completa prima di costruire profondamente

  1. Aprire Portal Studio → Avviare → Prontezza.
  2. Confermare l'indirizzo del Portale canonico e aprirlo in una scheda separata.
  3. Impostare il logo, icona del browser, icone touch, immagine sociale e colore tema.
  4. Confermare le lingue del Centro di Aiuto; cambiare l'autorità della lingua in Centro di aiuto, non Studio.
  5. Configurare la navigazione e il footer aziendale globale.
  6. Scegli un viaggio di biglietto e configura almeno un modulo di richiesta.
  7. Mantenere almeno un metodo di firma sicuro attivo e rivedere la scoperta dell'identità.
  8. Eseguire la qualità e stabilire il stretta di mano firmata anteprima.
  9. Creare il primo rilascio governato dopo ogni elemento di blocco è chiaro.

La percentuale di disponibilità viene calcolata dai dati salvati dello spazio di lavoro e dallo stato dell'anteprima.

Amministratore · Costruire

Costruire pagine e sezioni riutilizzabili

  1. Aprire Creare → Pagine e selezionare una pagina di sistema protetta o creare una pagina personalizzata.
  2. Impostare il percorso, il titolo, la modalità di accesso e il comportamento locale.
  3. Aprire Componenti, filtrare per lavoro o maturità e posizionare un componente in una slot compatibile.
  4. Utilizzare l'ispettore per contenuti, aspetto, vincolo, visibilità e accessibilità.
  5. Utilizzare modelli riutilizzabili per strutture ripetute; mantenere l'organizzazione o le differenze di marca nelle varianti.
  6. Salvare il progetto e l'esercizio di carico, vuoto, errore, guest e stati firmati in anteprima.
Libreria dei componenti · Mappa dell'interfaccia Sanitized
Ricerca della conoscenzaGA · cassaforte per i clientiCategoria grigliaGA · Centro assistenzaArticoloGA · tradotto DTOModulo richiestaGA · versioneTimeline dei bigliettiBeta · avvertimentoGrafico dei datiPianificato · blocchi pubblicare
Mappa dell'interfaccia: categoria, compatibilità e maturità sono visibili prima del posizionamento. Componenti pianificati bloccano la pubblicazione; componenti beta richiedono un trattamento esplicito di rilascio.
Amministratore · Brand e responsive

Anteprima viaggi reali, non uno schermo felice

  1. Scegli il supporto degli ospiti, il biglietto firmato, la cura della fatturazione, l'organizzazione o il handoff di conoscenza.
  2. Interruttore personas, organizzazione, ruolo e linguaggio Centro assistenza.
  3. Ispezione di dispositivi mobili, grandi dispositivi mobili e tablet, laptop, desktop, breakpoint ampi ed ultrawide.
  4. Controllare i valori ereditati, sovrascritti e reset; evitare duplicazioni di breakpoint inutili.
  5. Eseguire tastiera, RTL, ridotto movimento, carico, vuoto, non disponibile e gli stati di autorizzazione.
  6. Utilizzare Test Lab per l'accessibilità, il carico di pagamento, la rotta, i risultati del binding e del renderr prima della revisione.
Una tela verde non è una decisione di rilascio. Preflight governato, stato di revisione, capacità e prove di rilascio decidono se il Portale può pubblicare.
Amministratore · Esperienza

Operare un Centro di aiuto a livello Zendesk senza duplicare il contenuto

  1. Crea categorie, sezioni, articoli, traduzioni, allegati e modelli in Centro assistenza.
  2. Attivare le lingue lì; localizzato slug, ricerca, feed, SEO e articolo cromo seguire la stessa autorità.
  3. In Studio, posizionare la ricerca della conoscenza, categorie / griglie di risorse, feed, argomento fisarmonica, articolo, tabella dei contenuti, feedback, relativi e componenti precedenti/next.
  4. Configurare feed in evidenza, popolari e recenti; utilizzare suggerimenti contestuali nei flussi dei biglietti.
  5. Anteprima no-risultati, articoli lunghi, allegati, feedback, orologio/iscrizione e biglietto di consegna.
  6. Verificare percorsi locali puliti, canonici/hreflang, dati strutturati e invalidazione della cache dopo la pubblicazione.
Limite dell'autorità: modificare il contenuto dell'articolo e le lingue dei clienti in Centro assistenza. Utilizza Portal Studio solo per comporre come la conoscenza viene scoperta e visualizzata.
Amministratore · Identità e organizzazioni

Configurare il login in modo sicuro

  1. Aprire Identità & organizzazioni → identità e mantenere almeno un percorso di accesso abilitato.
  2. Scegli il metodo predefinito, la politica di registrazione, la durata della sessione, SSO_-domain e il comportamento di imposizione e scoperta.
  3. Aggiungi fornitori con campi di instradamento visivo: tipo, domini, priorità, presentazione, abilitato e stato verificato.
  4. Per SCIM, abilitare il provisioning, copiare l'endpoint esatto dello spazio di lavoro e ruotare il token.
  5. Pianta rivendicazioni e appartenenza all'organizzazione, quindi prova creare, aggiornare, membro del gruppo e disattivazione con un inquilino di test.
  6. Anteprima ospite, cliente, organizzazione delegata e stati bloccati prima della pubblicazione.
Non inviare mai un cookie di sessione Studio a SCIM. È un portatore senza sessione, di lavoro API. Ruotare un token dopo esposizione accidentale.
Amministratore · Viaggi di biglietti

Componi il viaggio di supporto completo

  1. Selezionare la forma diretta, guidata, prima ricerca, hub o voce di servizio-desk.
  2. Creare un modulo di richiesta chiamato, versioned con sezioni e etichette sul campo accessibili.
  3. Costruire condizioni visive, routing, SLA e passi di approvazione; avanzato JSON è solo per modifiche di sviluppatori revisionati.
  4. Configurare l'elenco, i dettagli, il thread, la timeline, l'allegato, l’approvazione, le superfici SLA e risposta.
  5. Provare la ricerca degli ospiti, le richieste firmate, la visibilità dell'organizzazione, il fallimento del caricamento, la notifica e-mail e la deflezione della conoscenza.
  6. Salvare una bozza; pubblicare solo dopo il percorso adattatore e la procedura di notifica.
Amministratore · Rassegna e rilascio

Spostare attraverso un rilascio governato

Progetto salvatoIn rassegnaApprovazioneProgrammazione o pubblicazioneOsservato o rotolato indietro
  1. Eseguire la validazione e il laboratorio di prova. Risolvere i risultati del blocco; riconoscere gli avvisi consentiti con contesto.
  2. Aggiungi note di rilascio e richiesta recensione. Commento dei recensori su percorsi pagina/nodo stabili.
  3. Gli utenti ispezionano il diff, i viaggi d'anteprima, le modifiche del permesso e le prove.
  4. Pubblicare o programmare attraverso il lavoratore di sfondo. Lasciando Studio non cancella un lavoro durevole.
  5. Guarda i progressi, la salute e l'ID di correlazione. Stop/recupera solo dai controlli del lavoro.
  6. Verificare percorsi critici, identità, biglietti e conoscenze. Ripiegare su un'immutabile pubblicazione preliminare quando necessario.
CapacitàOggetto
Visualizza / ModificaIspezione o modifica bozze senza autorità di rilascio.
Recensione / ApprovoRispondenze separate e approvazione da parte dell'autore.
Programma / Pubblicazione / RollbackControlli di produzione indipendenti.
Identità / SCIM / Migrare / Componenti / DiagnosticsLimitare le operazioni specialistiche sensibili.
Amministratore · Migrare ed estendere

Migrare con le prove e un modo di tornare

  1. Selezionare il modello del fornitore e creare un'uscita a secco.
  2. Rivedere le impostazioni scoperte, i valori non mappati, il conteggio dei contenuti e la parità visiva cattura.
  3. Completa mappature di sicurezza e riscatta il diff strutturato.
  4. Applicare a una bozza, riconciliare i conti e visualizzare in anteprima ogni viaggio protetto.
  5. Registra l'accettazione autorizzata; non sovrascrivere mai la versione pubblicata corrente durante l'importazione.
  6. Pubblica attraverso la governance e mantenere insieme il rapporto di migrazione, rilasciare ID e rollback point.
Guida all'estensione dello sviluppatore · Architettura

Estendere i contratti, non modelli

Un'estensione sicura registra un tipo e uno schema di componenti stabili, dichiara le autorizzazioni e le esigenze dei dati, rende tramite il compilatore canonico e fornisce fissazioni/test deterministiche. JavaScript nel Portale pubblico, creare un altro archivio articolo, o bypassare il cancello di rilascio.

Portal Documento v2

Le pagine contengono nodi stabili, slot, proprietà, binding, override reattive, condizioni e metadati di accessibilità.

Componenti

Un contratto alimenta Studio, compilatore, documentazione, migrazione e controlli di maturità.

Registro delle fonti di dati

I DTOs autorizzati, visualizzati in sola lettura, sostituiscono azioni arbitrarie SQL o dinamiche.

Un rendering

Preview e public output share compilation, sanificazione, budget e stati runtime.

Sviluppatore · Contratto componente

Definire un pacchetto di componenti

Utilizzare un nome minuscolo IDspaziale e versione semantica. Fornire entrambi i nomi di proprietà compatibili visualizzati perché l'ispezione dei pacchetti e la convalida della sicurezza eseguire controlli indipendenti.

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

Forma del nodo

{
  "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"}
}
  • Gli ID rimangono stabili tra modifiche e migrazioni.
  • Le proprietà rifiutano i campi non dichiarati e non sono sicure HTML.
  • Ogni visualizzazione a portata di dati definisce il caricamento, vuoto, autorizzazione e uscita retryable-error.
  • I componenti del contenitore nominano le loro fessure; le foglie non possono accettare bambini arbitrari.
  • Maturazione di marca onestamente: blocchi pianificati, beta avverte, GA richiede prove complete.
Sviluppatore · Fonti e binding dati

Utilizzare DTO per il permesso

  1. Scegliere un ID punteggiato esistente, come tickets.mine, knowledge.featured o customer.profile.
  2. Solo i campi dichiarati dalla sua versione DTO. Le fonti sconosciute non riescono con data_source.unknown.
  3. Passare il contesto Portal già autorizzato; non accettare mai l'identità workspace/customer da una proprietà non attendibile.
  4. I limiti di lista sono bloccati a1–100. Normalizzare i valori di paginazione, localizzazione e ricerca.
  5. Se una nuova fonte è inevitabile, aggiungere la sua definizione stabile, mappatura sicura, autorizzazioni, comportamento vuoto e l'anteprima insieme.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Le modifiche richiedono un'azione esplicita di servizio, una rilegatura dello spazio di lavoro, la convalida CSRF/session o del portatore, l'idempotency se necessario e una busta di errore digitata.
Sviluppatore · Sicurezza

Restare all'interno dei confini della fiducia

ConfineComportamento richiesto
Spazio di lavoroRisolvere dal fidato host/route/sessione, quindi discutere ogni lettura e scrittura prima dell'esecuzione.
HTMLUtilizzare il Portal sanitizer/parser consentlist. Mai concatenare attributi non attendibili, URLs, CSS o script.
AnteprimaRichiedere la finestra di origine dello stesso-origine, la versione del canale firmata e nonce. Ignora i messaggi non richiesti.
IdentitàTenere segreti fuori documenti. SCIM è portatore-autentico, senza sessione e spazio di lavoro-bound.
PacchettiRespingere percorsi traversali, percorsi assoluti, link/file speciali, archivi oversize, errore di checksum/signature e autorizzazioni sconosciute.
ErroriRestituzione codice stabile, messaggio sicuro, retryability, bonifica e correlazione ID; log eccezioni private lato server.
ConoscenzaLeggere tramite HelpCenterBridge. Non autorizzate mai o duplicate gli articoli del Centro assistenza in un'estensione.
{
  "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"}
  }
}
Sviluppatore · Pacchetto e migrazione

Ispezione, installazione e aggiornamento atomico

  1. Mettiti in mezzo. component.json alla radice ZIP e mantenere ogni percorso relativo.
  2. Eseguire l'ispezione prima. L'installatore caps archivi a 500 voci e 25 MB estratto; la validazione della sicurezza aggiunge limiti indipendenti.
  3. Verificare il previsto SHA-256 e la firma del pacchetto nel processo di rilascio.
  4. Installare una directory versioned. Non modificare mai la versione installata in posizione.
  5. Fornire migrazioni di proprietà per rompere i cambiamenti dello schema e preservare campi di compatibilità sconosciuti.
  6. Aprire il componente in un progetto, eseguire ogni stato / vista / persona fissa e pubblicare attraverso la governance.
  7. Rollback attiva il rilascio di componenti/documenti prima immutabili; conserva le sue prove di riproducibilità.
Sviluppatore · Test e rilascio

Prove l'estensione sullo stesso hash di rilascio

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

I gate di origine sono necessari, non sufficienti. Attacca database/migrazione, reale-browser visual, identitÃ-provider, isolamento-autorizzazione, accessibilità, performance, coda / corona, mail / allegato, backup / ripristino e l'implementazione delle prove allo stesso hash immutabile rilascio.

  • Unità: schema, sanificazione, forma DTO, condizioni, migrazioni e guasti digitati.
  • Contratto: carico/vuoto/rischio/successo, maturità, slot, binding e parità di un creditore.
  • Browser: tastiera, messa a fuoco, semantica, RTL, zoom/riflusso, movimento ridotto e ogni punto di rottura.
  • Sicurezza: sonde trasversali, azioni forgiate, attacchi di pacchetto, spoofing di anteprima e perdita segreta.
  • Operazioni: progresso durevole, congedo / ritorno, arresto / ripasso/riprova, battito cardiaco scheduler e rollback.
Amministratore + Sviluppatore · Recupero

Risoluzione dei problemi tramite ID stato e correlazione

StatoCosa fare
PermessoRichiedi la capacità di nome. L'interfaccia utente nascosta è convenienza; il backend lo applica sempre.
ValidazioneAprire la pagina/nodo/campo, correggerla e poi rifare il preflight.
ConflittoRicaricare l'ultima revisione, confrontare i cambiamenti e riapplicare intenzionalmente. Mai forza sovrascrittura.
Offline / riprovaMantenere il progetto, ripristinare la connettività, riprovare attraverso l'azione e verificare lo stato di lavoro durevole.
Fatale / non disponibileCopiare l'ID di correlazione e il timestamp per supporto. Non incollare mai segreti o testo di eccezione privata.
Pubblicazione fallitaIspezionare l'output preflight/job, riprova solo le fasi di lavoro retrò, o tornare all'ultima versione sana.
SCIM 401/403Confermare endpoint/workspace, token del portatore, stato e rotazione abilitati; non utilizzare mai un cookie di sessione del browser.
La conoscenza è stalloVerificare la localizzazione/pubblicazione in Centro assistenza, quindi ispezionare l'invalidità della cache e il percorso localizzato pulito.

Questa guida è pronta per la stampa. Usa Stampa → Salva come PDF per una copia offline controllata.