← Tüm Belgeler
Portal Studio alan rehberi

Cesur bir şekilde inşa edin. güvenle Kaslish.

Müşteri deneyimini ve onu uzatan geliştiricileri için pratik bir referans. Gerçek Stüdyo mimarisini belgeliyor, yayınlama yolunu, Yardım Merkezi mülkiyete, kimlik, göçlere, bileşen sözleşmelerine ve kurtarmasına yardımcı oluyor.

Portal Doküman v2Yönetici + GeliştiriciEnterprise release iş akışlarıUpdated 1 August 2026
Yönetici rehberi · Mimari

Studio'nun ne sahip olduğunu bilin

Portal Studio müşteriye yüz yüzen kabuk: sayfalar, yerleştirme, marka jetleri, duyarlı davranışlar, navigasyon, ayaklama, kimlik sunumu, bilet yolculuğu ve yayınlar. Yardım Merkezi'nin kendi dillerini, kategorilerini ve makale içeriklerini tüketmektedir; Bu içeriği korumalı bir köprü aracılığıyla asla yapmaz; ikinci bir makale mağazası yaratmaz.

Yardım Merkezi + bilet + kimlik hizmetleriİzin güvenli veri adaptörleriPortal Doküman v2 draftBir derleyici ve formerÖnizleme ve yayınlanan Portal
Bir-renderer kuralı: önizleme ve halk sayfaları aynı belge / kopiler sözleşmesi kullanır. Yayınlama hiçbir zaman ilgili bir şablona geçmeyecektir.
Portal Studio · Workspace Map
Canlı tuvalMasaüstü · Müşteri
Müşteri PortalıAynı yapılandırılmış belge önizleme ve kamu oluşturmada kullanılır
Interface haritası: iş rayı, canlı tuval ve denetçi aynı istikrarlı sayfayı ve node seçimi hedef alıyor.
Yönetici · Start

Binadan önce tam hazır

  1. Portal Studio → Start → Readiness.
  2. Kanonik Portal adresini onaylayın ve ayrı bir sekmede açın.
  3. Logoyu, tarayıcı ikonunu, dokun ikonuna, sosyal görüntü ve tema rengine bakın.
  4. Yardım Merkezi dilleri onaylayın; Help Center'daki dil otoritesini değiştirin, Studio değil.
  5. Configure navigasyon ve global işletme ayağı.
  6. Bir bilet yolculuğu seçin ve en az bir istek formu yapılandırın.
  7. En az bir güvenli işaret yöntemi aktif ve yorum kimlik keşfi tutun.
  8. Kaliteyi çalıştırın ve imzalı ön elhake'i kurdu.
  9. Her blok öğenin açık olduğundan ilk yönetilen sürüm oluşturun.

Hazırlık yüzdesi, kurtarma iş alanı verileri ve önbellek durumu hesaplandı. Bir öğe rotalarını doğrudan kendi paneline seçin.

Yönetici Oluşturun

Sayfalar oluşturun ve yeniden kullanılabilir bölümler

  1. Yap → Sayfalar Korumalı bir sistem sayfasını seçin veya özel bir sayfa oluşturun.
  2. Yol, başlık, erişim modu ve yerel davranış. Korumalı sistem rotaları silinemez.
  3. Bileşenlerİş veya olgunluk tarafından filtre ve uyumlu bir slotta bir bileşen yerleştirin.
  4. İçerik, görünüm, bağlayıcı, görünürlük ve erişilebilirlik için denetimci kullanın.
  5. Tekrarlanan yapılar için yeniden kullanılabilir desenler kullanın; organizasyon veya marka farklılıkları farklı şekillerde tutun.
  6. Tasarı ve egzersiz yüklemesini kurtar, boş, hata, misafir ve onaylanmış devletler.
Bitirme kütüphanesi · Sanitized UI harita haritası
Bilgi aramaGA · müşteri güvenliKategori gridGA · Yardım MerkeziMadde VücutGA · DTO tercümeTalep FormuGA · sürümlendiBilet süresi zaman çizelgesiBeta · uyarıVeri çizimiPlanlanan · bloklar yayın
Interface haritası: kategori, uyumluluk ve olgunluk yerleştirmeden önce görünür. Planlanan bileşenler blok yayını; beta bileşenleri açık salıverme tedavisi gerektirir.
Yönetici · Marka ve duyarlı

Preview real yolculukları, mutlu bir ekran değil

  1. Misafir desteği seçin, imzalı bilet, fatura bakımı, organizasyon veya bilgi handoff.
  2. Anahtar kişi, organizasyon, rol ve Merkez diline yardım edin.
  3. Inspect mobile, büyük mobil, tablet, dizüstü bilgisayar, masaüstü, geniş ve ultra geniş uç noktaları.
  4. miras alın, overridden ve reset değerleri; gereksiz kırılma noktası rasyondan kaçının.
  5. klavyeyi çalıştır, RTL, azaltılmış duygusal, yükleme, boş, mevcut olmayan ve izin eyaletlerini.
  6. Test Lab'ı erişilebilirlik için kullanın, ücret yükü, rota, bağlayıcı ve projeksiyonel bulguları incelemeden önce.
Yeşil bir tuval serbest bırakılması değildir. Hafifletilmiş ön ışık, inceleme durumu, yetenekleri ve salıverme kanıtları Portal'ın yayınlayabileceğine karar verir.
Yönetici · Deneyim

Tekrarlanan içerik olmadan Zendesk- Seviye Yardım Merkezi Operate a Zendesk i- level Help Center without duplicate content

  1. Kategori Oluşturun, bölümler, makaleler, çeviriler, eks ve şablonlar Yardım Merkezi Yardım.
  2. Orada enable diller; yerelleştirilmiş çamurlar, arama, beslemeler, SEO ve makale krom aynı otoriteyi takip eder.
  3. Stüdyoda, yer bilgisi arama, kategori/resource ızgaralar, beslemeler, konu askıya alındı, makale, içerik tablosu, geri bildirim, ilgili ve önceki / diğer bileşenler.
  4. Configure, popüler ve son beslemeler; bilet akışlarında bağlamsal öneriler kullanın.
  5. Önizleme sonuçları, uzun makaleler, eklentiler, geri bildirim, izleme / abonelik ve bilet teslimat.
  6. Temiz yerel rotaları, kanonik / hreflang, yayından sonra yapılandırılmış veriler ve önbellek geçersizliği onaylayın.
Otorite sınırı: Yardım Merkezi'ndeki makale içeriği ve müşteri dilleri düzenleme. Portal Studio sadece bilgi nasıl keşfedildi ve görüntülendirilebilmek için kullanın.
Yönetici · Kimlik ve Organizasyon

Configure sign-in güvenle

  1. Kimlik ve örgütler → Kimlik Ve en az bir işaret-in yolunu etkinleştirin.
  2. Varsayılan yöntem seçin, kayıt politikası, oturum süresi, SSO-domain uygulama ve keşif davranışları.
  3. Görsel routing alanları ile sağlayıcıları ekleyin: tip, alanlar, öncelikler, sunumlar ve doğrulanmış devlet. Sırlar kimlik alt sistemde kalır.
  4. SCIM için, düzenlemeyi etkinleştirin, tam iş alanı uç noktasını kopyalayın ve token'i döndürün. IdP'de bir kez token.
  5. Harita iddiaları ve organizasyon üyeliği, sonra test oluşturma, güncelleme, grup üyeliği ve bir test onant ile deaktivasyonu test edin.
  6. Preview guest, müşteri, delegeli organizasyon ve yayından önce ülkeleri engelledi.
Asla bir Stüdyo seansı kurabiyesi gönder SCIM. Bu bir seanssız, çalışma alanı-bound ayıer API Bir token kazara maruz kaldıktan sonra.
Yönetici · Bilet yolculukları

Boş destek yolculuğu

  1. Doğrudan form seçin, sihirbaz, arama-ilk, merkez veya hizmet girişi.
  2. Bir isim oluşturun, sürümlenen istek formu bölümler ve erişilebilir alan etiketleri ile açın.
  3. Görsel koşullar inşa edin, routing, SLA ve onay adımları; gelişmiş JSON sadece analiz edilen geliştirici değişiklikler içindir.
  4. Configure list, detay, thread, zaman çizelgesi, ek, onay, SLA ve cevap yüzeyler.
  5. Misafir gözlüğü, imzalanmış istekler, organizasyon görünürlüğü, başarısızlık yükleme, e-posta bildirim ve bilgi defleksiyon.
  6. Bir taslaktan tasarruf edin; sadece rota adaptörü ve bildirim yolu ön ışıktan sonra yayınlayın.
Yönetici · İnceleme ve serbest bırakma

Bir yönetilen serbest bırakılması yoluyla hareket edin

Taslağı kurtarıldıİncelemedeOnaylandıScheduled veya publishedObserved veya geri döndü
  1. Geçerlilik ve Test Lab. bulguları engelleme; bağlam ile uyarıları kabul edin.
  2. Yayın notları ekleyin ve inceleme talep edin. Rezersiz sayfa / düğüm yolları hakkında yorum yapın.
  3. Approvers diff, önizleme yolculukları, izin değişiklikleri ve kanıtları inceler.
  4. Arka plan çalışanı aracılığıyla ortaya çıkmak veya program. Ölü bir Stüdyo kalıcı bir iş iptal etmiyor.
  5. İlerlemeyi izleyin, sağlık ve korelasyon ID. Stop/retry sadece iş kontrollerinden durdurun.
  6. Kritik rotalar, kimlik, biletler ve bilgi. Roll gerektiğinde bir hayal için geri dönüşümlü olarak geri döner.
YetenekliAmaç
Görüntüle / DüzenleMüfettiş veya değişim taslakları serbest bırakma yetkisi olmadan değiştirir.
İnceleme / ApproveYazarlıktan ayrı geri bildirimler ve onay.
Takvim / Yayınla / Geri AlBağımsız üretim kontrolleri.
Kimlik / SCIM / Migrate / Bileşenler / TanılarHassas uzman operasyonları.
Yönetici · Migrate ve genişleme

Migrate kanıt ve bir yol ile geri

  1. Sağlayıcı mavi baskıyı seçin ve kuru bir iş oluşturun.
  2. Yapılanma, keşfedilmemiş değerler, içerik sayıları ve görsel parite yakalamaları.
  3. Güvenli haritalar tamamlayın ve yapılandırılmış diff'ı yeniden çalıştırın.
  4. Bir taslak, uzlaşıcı sayar ve her korumalı yolculuğu önle.
  5. Kayıt yetkili kabul; asla ithalat sırasında yayınlanan sürümü yazma.
  6. Yönetişim yoluyla ortaya çıkmak ve göç raporunu tutmak, kimlik serbest bırakmak ve birlikte geri dönüş noktası.
Geliştirici uzatma kılavuzu · Mimari

Sözleşmeleri uzatmayın, şablonlar değil

Güvenli bir uzatma, istikrarlı bir bileşen türü ve şema kaydeder, izinler ve veri ihtiyaçları, kanonik derleyici ile verir ve malzeme deterministic fikstürleri / test eder. Keyif tabloları sorgulayamaz, editör JavaScript into the public Portal, create another article repository, or throws the release door.

Portal Doküman v2

Sayfalar stabil düğümler, slotlar, özellikler, bağlayıcılar, aşırı tepki verenler, koşullar ve erişilebilir metadata içerir.

Bileşen Kayıt

Bir sözleşme, Studio'yu besler, derleyici, belge, göç ve olgun çekleri kullanır.

Data Source Record Kayıt

İzin verilen, sadece, izinli DTO'lar keyfi SQL veya dinamik eylemleri değiştirir.

Bir

Preview ve halk çıkışı derleme, sanitizasyon, bütçeler ve koşu zaman eyaletlerini paylaşıyor.

Geliştirici · Bitirme sözleşmesi

Bir bileşen paketi tanımlamak

Daha düşük bir isim alanılanmış kimlik ve semantik versiyon kullanın. Paket inceleme ve güvenlik doğrulama bağımsız kontroller gerçekleştirir.

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

Node şekli

{
  "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"}
}
  • ID'ler düzenleme ve göçlerle istikrarlı kalır.
  • Özellikler, alanları ve güvenli olmayan HTML'ı reddediyor.
  • Her veriye dayalı görüş yükleme, boş, izin ve yeniden uygulanabilir- terörizm çıktısını tanımlar.
  • Konteyner bileşenleri yuvalarını adlandırıyor; keyfi çocukları kabul edemiyor.
  • Mark olgunluk dürüstçe: planlanan bloklar, beta uyarır, GA tam kanıt gerektirir.
Geliştirici · Data kaynakları ve bağlayıcılar

İzinli DTO'lar kullanın

  1. Mevcut bir dotted ID'yi seçin gibi tickets.mine, knowledge.featured veya customer.profile.
  2. Bind sadece kendi sürüm DTO tarafından ilan edilen alanlar. Bilinmeyen kaynaklar başarısız data_source.unknown.
  3. Zaten yetkili bir Portal bağlamını geç; hiçbir zaman güvenilmeyen bir mülkten iş alanı/müşteri kimliğini kabul et.
  4. Liste sınırları 1-100. Normalize paginasyon, yerel ve arama değerlerine bağlanır.
  5. Yeni bir kaynak kaçınılmazsa, istikrarlı tanımını ekleyin, güvenli haritalama, izinler, boş davranışlar ve birlikte ön segmenti ekleyin.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Veri kaynakları okunur. Mutations açık bir yetkili hizmet eylemi, iş alanı bağlayıcısı, ÖSSF /session veya ayıcı doğrulama gerektirir, gerekli olan ve tipi bir hata zarfı.
Geliştirici · Güvenlik

Güven sınırları içinde kalın

SınırGerekli davranış
İş AlanıGüvenilir ev sahibi/route /session'tan geri alın, sonra her okuma ve yürütmeden önce yaz.
HTMLUse the Portal sanitizer/parser allowlist. Never concatenate untrusted attributes, URLs, CSS or script.
ÖfkeAynı-origin kaynak penceresi, kanal versiyonunu ve nonce imzalamak. Boş olmayan mesajlar görmezden gelmek.
Kimlik KimliğiBelgelerin dışında sırları tutun. SCIM is ayıer-authenticated, sessionless and workspace-bound.
PaketlerReject traversal, mutlak yollar, bağlantılar / özel dosyalar, aşırı arşivler, çeklerum/signature yanlış eşleştirme ve bilinmeyen izinler.
HatalarKalıcı stabil kod, güvenli mesaj, yeniden deneme, remediasyon ve korelasyon ID; özel istisnalar sunucu-side.
Bilgi BilgisiYardımCenterBridge ile okuyun. Asla yazar veya tekrarlanan Yardım Merkezi makalelerini bir uzatmada okuyun.
{
  "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"}
  }
}
Geliştirici · Paket ve geçiş

Inspect, atomik olarak yükleme ve yükseltme

  1. - Ver. component.json ZIP kökünde ve her yolu göreceli tut.
  2. Run inspection first. The installer caps archives at 500 entries and 25 MB extracted; security validation adds independent limits.
  3. SHA-256 ve paket imzasını serbest bırakma sürecinde onaylayın.
  4. Bir sürüme ayarlayın. Asla yerdeki yüklü bir versiyona girmeyin.
  5. Sistem geçişleri şema değişiklikleri kırmak ve bilinmeyen uyumluluk alanları korumak için sağlar.
  6. Bir taslaktaki bileşeni açın, her eyalet/görev / kişi odası fikstürü çalıştırın ve yönetişim yoluyla yayınlayın.
  7. Rollback, önceden düşünülemez bileşeni / kesinti serbest bırakılmasını etkinleştirir; reroditebilite kanıtlarını korur.
Geliştirici · Testler ve salıverme

Aynı sürümdeki uzantıları kanıtlayın 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

Kaynak kapıları gerekli değildir, yeterli değil. Veritabanı / kesinti, gerçek tarayıcı görsel, kimlik-provider, yetkilendirme, erişilebilirlik, performans, kuyruk/kron, posta / ulaşılamaz sürüme dair kanıtları aynı hayal kırıklığına uğratmalıdır.

  • Birim: şema, sanitizasyon, DTO şekli, koşullar, göçler ve tip başarısızlıklar.
  • Sözleşme: yükleme/boş / terörizm / başarı, olgunluk, slotlar, bağlayıcılar ve bir-renderer parite.
  • Tarayıcı: klavye, odak, semantics, RTL, zoom / akış, azalan hareket ve her uç noktası.
  • Güvenlik: çapraz çalışma alanı araştırmaları, genişletilmiş eylemler, paket saldırıları, önizleme spoofing ve gizli sızıntı.
  • Operasyonlar: dayanıklı ilerleme, terk / geri dönüş, stop/retry/resume, zamanlamacı kalp ve rollback.
Yönetici + Geliştirici · Recovery

Devlet ve korelasyon ID tarafından sorun

Devlet DevletiNe yapmalı
İzinAdı yeteneği talep edin. Hidden UI rahatlatır; arka uç her zaman onu uygular.
GeçerlilikRaporlanmış sayfa /node/field açın, doğrulayın, sonra ön ışık yeniden işliyor.
ÇatışmaEn son revizyonu yeniden yükleyin, değişiklikleri karşılaştırın ve kasıtlı olarak tekrar uygulayın. Asla yazmayı zorlamaz.
Offline / yenidentryableTasarıyı tutun, bağlantı geri yükleme, eylem yoluyla yeniden deneme ve kalıcı iş durumunu doğrulama.
Fatal / YokDestek için korelasyon ID ve zaman notampı kopyalayın. Asla sırları veya özel istisna metnini yapıştırın.
Publish başarısız olduInspect preflight /job çıktı, yeniden deneme sadece tekrarlanabilir aşamalar veya son sağlıklı salıverme geri dön.
SCIM 401/403Endpoint/workspace, ayıer token, etkinleştirilen devlet ve rotasyon; asla bir tarayıcı seansı kurabiye kullanma.
Bilgi durYardım Merkezi'nde yerel/halkalılaşmayı onaylayın, sonra önbellek geçersizliği ve temiz yerel rotayı kontrol edin.

Bu kılavuz baskıya hazır. Yazdır kullanın → Kontrollü çevrimdışı kopya için PDF olarak tasarruf edin.