←Dokumentasi dokumentasi
Portal Studio -kenttäopas

Membina dengan berani.

Salah satu referensi praktis untuk administrator yang membentuk pengalaman pelanggan dan pengembang yang memperpanjangnya. ia mendokumentasikan arsitektur Studio yang sebenarnya, mengatur jalur rilis, kepemilikan Pusat Bantuan, identitas, migrasi, kontrak komponen dan pemulihan.

Dokumen Portal v2Administrator + PengembangAliran kerja keluaran EnterpriseDikemaskini: 1 Ogos 2026
Panduan Administrator Ikhlas · Arsitektur

Tahu apa yang Studio miliki

Portal Studio memiliki kerangka yang dilihat oleh pelanggan: halaman, penempatan komponen, token jenama, tingkah laku responsif, navigasi, pengaki, persembahan identiti, perjalanan tiket dan keluaran. Pusat Bantuan memiliki bahasa, kategori, bahagian dan kandungan artikel. Studio menggunakan kandungan itu melalui jambatan yang dilindungi; ia tidak sekali-kali mencipta stor artikel kedua.

Pusat Bantuan Kediaman + tiket + layanan identitasPenyesuai data access-safe ijinPortal Dokumen v2 draftkompilator dan perender kompilPortal Publikasi dan Pratonton
Peraturan satu-penghayat: Halaman prapaparan dan publik menggunakan kontrak dokumen/kompiler yang sama. Publikasi tidak pernah beralih ke template yang tidak terkait.
Portal Studio Toon · Peta Ruang Kerja
kanvas hidupPelanggan · Desktop Outfius
Portal PelangganDokumen struktur yang sama digunakan dalam pralihat dan penerapan publik
Peta antarmuka: rel kerja, kanvas hidup dan inspektur target halaman stabil dan pemilihan node yang sama.
Administrasi Keislaman · Mula

Kesiapan lengkap sebelum membangun dalam

  1. Buka Portal Studio → Mulai → Kesiapan.
  2. Konfirmasi alamat Portal Kanun dan membukanya dalam tab terpisah.
  3. Diset logo, ikon peramban, ikon sentuh, gambar sosial dan warna tema.
  4. Bahasa Pusat Bantuan Konfirmasi; mengubah otoritas bahasa di Pusat Bantuan, bukan Studio.
  5. Konfigurasikan navigasi dan pengaki korporat global.
  6. Áifashi memilih perjalanan tiket dan mengatur setidaknya satu formulir permintaan.
  7. Setidaknya jaga satu metode masuk aman aktif dan tinjau penemuan identitas.
  8. Jalankan Kualiti dan wujudkan jabat tangan pratonton yang ditandatangani.
  9. Cipta keluaran terkawal pertama selepas setiap item penghalang telah diselesaikan.

persentase kesiapan dihitung dari data dan keadaan pratinjau ruang kerja yang tersimpan. Memilih rute item langsung ke panel sendiri.

Administrasi Kependudukan

Bina halaman dan bagian yang dapat digunakan kembali

  1. Buka Binaan → Halaman Wakevis dan pilih halaman sistem terlindungi atau buat halaman tersendiri.
  2. Tetapkan laluan, tajuk, mod akses dan tingkah laku tempatan. Laluan sistem yang dilindungi tidak boleh dipadam.
  3. Buka Komponen, filter oleh pekerjaan atau kematangan, dan menempatkan komponen dalam slot yang kompatibel.
  4. Dia menggunakan inspektur untuk konten, penampilan, pengikatan, kejelasan dan aksesibilitas.
  5. Una urando menggunakan pola yang dapat digunakan kembali untuk struktur berulang; menjaga perbedaan organisasi atau merek dalam varian.
  6. Simpan draf dan latihan memuat, kosong, kesalahan, tamu dan signed-in negara bagian di pratinjau.
Perpustakaan Komponen TOO dan peta antarmuka ter Saniti
Carian pengetahuanGA · pelanggan amanKategorinya ialahPusat Bantuan GA ·Tubuh Artikel· diterjemahkan sebagai DTOBorang permintaan· versi GA ·Garis waktu tiketPeringatan Beta ·Bagan DataBoloned · blok publikasi
Peta antarmuka KATA: kategori, keserasian dan kematangan dapat dilihat sebelum penempatan. Perencanaan komponen blok publikasi; komponen beta memerlukan penanganan pelepasan eksplisit.
Administrator · Brand and responsif

Pratonton perjalanan sebenar, bukan satu skrin yang serba sempurna

  1. Pilih sokongan tetamu, tiket log masuk, penjagaan pengebilan, organisasi atau serahan pengetahuan.
  2. Bahasa Pusat Peran dan Bantuan.
  3. Periksa seluler, mobile besar, tablet, laptop, desktop, luas dan ultralebar breakpoint.
  4. Pemeriksaan esterolfach diwarisi, nilai ditindih dan reset; hindari duplikasi titik putus yang tidak diperlukan.
  5. ¡Jalankan keyboard, RTL, pengurangan-mosi, memuat, kosong, tidak tersedia dan izin menyatakan.
  6. Lab Tes Penggunaan Kebolehcapaian, muatan, rute, binding dan temuan penerap sebelum review.
Kanvas hijau bukanlah keputusan pembebasan.
Administrator Keislaman

Operate a Zendesk-level Pusat Bantuan tanpa konten duplikat

  1. Buat kategori, bagian, artikel, terjemahan, lampiran dan templat di dalam Pusat Bantuan.
  2. Bahasa - bahasa di sana; siput lokal, pencarian, feed, SEO dan artikel krom mengikuti wewenang yang sama.
  3. Dalam Studio, letakkan pencarian pengetahuan, kategori/grid sumber, suapan, topik akordion, artikel, jadual kandungan, komen, komponen berkaitan dan terdahulu/seterusnya.
  4. Konfigurasikan suapan pilihan, popular dan terkini; gunakan cadangan kontekstual dalam aliran tiket.
  5. Pratonton tiada hasil, artikel panjang, lampiran, maklum balas, pantau/langganan dan penyerahan kepada tiket.
  6. Sahkan laluan bahasa yang bersih, canonical/hreflang, data berstruktur dan pembatalan cache selepas penerbitan.
Batas otoritas: sunting kandungan artikel dan bahasa pelanggan dalam Pusat Bantuan. Gunakan Portal Studio hanya untuk menyusun cara pengetahuan ditemui dan dipaparkan.
Administrator Isuter · Identitas dan organisasi

Atur sign-in aman

  1. Buka Organisasi Identiti & Identiti IB → Identitas Dan menjaga setidaknya satu jalur masuk memungkinkan.
  2. Pilih kaedah lalai, dasar pendaftaran, tempoh sesi, penguatkuasaan domain SSO dan tingkah laku penemuan.
  3. Tambah penyedia dengan medan penghalaan visual: jenis, domain, keutamaan, persembahan, keadaan didayakan dan disahkan. Rahsia kekal dalam subsistem identiti.
  4. Untuk SCIM, aktifkan penyediaan, salin titik akhir ruang kerja yang tepat dan putar tokennya. Simpan token satu kali di IDP.
  5. Petakan tuntutan dan keahlian organisasi, kemudian uji penciptaan, kemas kini, keahlian kumpulan dan penyahaktifan dengan penyewa ujian.
  6. Tamu prapaparan, pelanggan, delegasi organisasi dan blokir negara sebelum publikasi.
Jangan sekali-kali menghantar kuki sesi Studio kepada SCIM. Ia ialah API pembawa tanpa sesi yang terikat pada ruang kerja. Putarkan token selepas pendedahan yang tidak disengajakan.
Para Administrator · Perjalanan Tiket

Susun perjalanan sokongan yang lengkap

  1. Pilih bentuk langsung, penyihir, pencarian pertama, hub atau layanan-desk entri.
  2. Cipta borang permintaan bernama dan berversi dengan bahagian serta label medan yang boleh diakses.
  3. Kondisi visual, routing, SLA dan langkah persetujuan; JSON lanjutan hanya untuk perubahan pengembang yang ditinjau.
  4. Atur daftar, detail, benang, garis waktu, lampiran, persetujuan, SLA dan permukaan balasan.
  5. Uji carian tetamu, permintaan pengguna yang log masuk, keterlihatan organisasi, kegagalan muat naik, pemberitahuan e-mel dan pengelakan pengetahuan.
  6. Simpan draf; terbitkan hanya selepas penyesuai laluan dan laluan pemberitahuan lulus semakan awal.
Administrator · Review dan rilis

Bergerak melalui rilis diatur

Draf disimpanDalam semakanDisetujuiDijadwalkan atau diterbitkanAWAS atau terguling kembali
  1. Ajukan peringatan yang diizinkan dengan konteks.
  2. Tambahkan nota rilis dan minta penilaian. Penilai komen pada laluan halaman/nod stabil.
  3. Ahli astroversi memeriksa diff, perjalanan pratinjau, perubahan izin dan bukti.
  4. \"Terbitan atau jadwal melalui pekerja latar belakang\" \"Membiarkan Studio tidak membatalkan pekerjaan yang tahan lama.\"
  5. Pantau kemajuan, kesihatan dan ID korelasi. Hentikan/cuba semula hanya daripada kawalan tugas.
  6. Ketahui rute kritis, identitas, tiket dan pengetahuan.
Kemampuan berbakatTujuan
Pandangan / SuntingPeriksa atau mengubah draf tanpa otoritas pembebasan.
Ulasan / PermintaanAsingkan maklum balas dan kelulusan daripada pengarangan.
Jadwal / Terbitan / Guling BalikKontrol produksi independen.
Identity / SCIM /Memigrasikan / Komponen / DiagnostikOperasi spesialis sensitif terbatas.
Administrator Memigrasi dan memperpanjang

Pindah dengan bukti dan jalan kembali

  1. Pilih cetakan biru penyedia dan buatlah lari kering.
  2. Semak tetapan yang ditemui, nilai yang tidak dipetakan, kiraan kandungan dan tangkapan kesamaan visual.
  3. Peta aman dan jalankan ulang diff terstruktur.
  4. Terapkan untuk draf, hitungan perdamaian dan pratinjau setiap perjalanan yang dilindungi.
  5. Rekodkan penerimaan yang dibenarkan; jangan sekali-kali menulis ganti keluaran terbitan semasa ketika import.
  6. Árford menerbitkan melalui pemerintahan dan menyimpan laporan migrasi, rilis ID dan titik rollback bersama-sama.
Panduan ekstensi pengembang Perfous · Arsitektur

Kontrak Extend, bukan template

Sebuah ekstensi aman mendaftarkan tipe komponen dan skema yang stabil, menyatakan izin dan kebutuhan data, dirender melalui kompiler kanonik, dan persediaan fixtures/tes deterministik. Jangan tanya tabel arbitrari, inject editor JavaScript ke dalam Portal publik, membuat repositori artikel lain, atau bypass gerbang rilis.

Dokumen Portal v2

Halaman mengandung node, slot, properti, pengikatan, pembatalan responsif, kondisi dan data meta aksesibilitas.

Pendaftar Komponen Yos

Satu kontrak schedual Studio, kompiler, dokumentasi, migrasi dan pemeriksaan kematangan.

Pendaftaran Sumber Data

DTO yang terdaftar, baca-sahaja, terskop-izin menggantikan aksi SQL atau dinamis yang sewenang-wenang.

ERender

View dan keluaran publik berbagi kompilasi, sanitisasi, anggaran dan negara runtime.

Pengembang · Kontrak Komponen

Tentukan pakej komponen

Gunakan ID huruf kecil berruang nama dan versi semantik. Berikan kedua-dua nama sifat keserasian yang ditunjukkan kerana pemeriksaan pakej dan pengesahan keselamatan menjalankan semakan secara berasingan.

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

Bentuk Node kin

{
  "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 Æð tetap stabil melintasi suntingan dan migrasi.
  • Properti-propesis flahero menolak bidang yang tidak dideklaraskan dan HTML yang tak aman.
  • Setiap pandangan data-bound mendefinisikan pemuatan, kosong, izin dan keluaran retryable-error.
  • Komponen bekas yang nama slotnya; daun tidak dapat menerima anak - anak yang sewenang - wenang.
  • Tandakan kematangan dengan jujur: dirancang menyekat, beta memberi amaran, GA memerlukan bukti penuh.
Pengembang · Pembangun Data sumber dan pengikatan

Use author-safe DTOs

  1. Pilih ID bertitik sedia ada seperti tickets.mine, knowledge.featured atau customer.profile.
  2. Medan Bind hanya dinyatakan oleh DTO versinya. Sumber tak dikenal gagal dengan data_source.unknown.
  3. Kerahkan konteks Portal yang sudah disahkan; jangan pernah terima identitas ruang kerja/kebiasaan dari suatu properti yang tidak dipercaya.
  4. Batas daftar yang dijepitkan ke1–100 Normalisasi paginasi, lokalitas dan nilai pencarian.
  5. Jika sumber baru tidak dapat dihindari, tambahkan definisi stabilnya, pemetaan aman, izin, perilaku kosong dan perbaikan pralihat bersama-sama.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Sumber data adalah baca sahaja. Mutasi memerlukan tindakan perkhidmatan yang dibenarkan secara eksplisit, pengikatan ruang kerja, pengesahan CSRF/sesi atau bearer, idempotensi apabila perlu dan sampul ralat bertaip.
Pembangun · Keselamatan

Tetap tinggal di dalam batas kepercayaan

SempadanPerilaku yang diperlukan oleh perilaku yang tidak wajar
Ruang kerja¡Osolve dari host/route/session yang dipercaya, kemudian skop setiap baca dan tulis sebelum eksekusi.
HTMLGunakan Portal pembersih/pemaisar daftar ijin. Jangan pernah mengkonsentrasikan atribut yang tidak dipercaya, URLs, CSS script atau skrip.
PratontonMemerlukan jendela sumber berorigin-sama, versi saluran bertanda dan nonce. Abaikan pesan yang tidak dicadangkan.
IdentitasKerah rahasia di luar dokumen. SCIM adalah pembawa-diotentikasi, tak bersimetris dan ruang kerja-bound.
PakejIcardiq Tolak traversal, jalur mutlak, berkas link/special, oversize archive, checksum/signature tidak cocok dan izin tidak diketahui.
KesalahanKembalikan kode stabil, pesan aman, retryability, remediasi dan korelasi ID; log private exceptions server-side.
Pengetahuan tentang pengetahuanBacalah melalui HelpCenterBridge. Jangan pernah membuat atau duplikat artikel Pusat Bantuan dalam sebuah ekstensi.
{
  "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"}
  }
}
Pembangun · Pakej dan migrasi

Periksa, pasang dan tatar secara atom

  1. Zava component.json Di akar ZIP dan menjaga setiap jalur relatif.
  2. Jalankan pemeriksaan dahulu. Pemasang mengehadkan arkib kepada 500 entri dan 25 MB selepas diekstrak; pengesahan keselamatan menambah had yang tersendiri.
  3. Sahkan SHA-256 yang dijangka dan tandatangan pakej dalam proses keluaran.
  4. Pasang ke direktori versi. Jangan pernah memutasikan versi terpasang di tempat.
  5. Siakevikasi properti migrasi untuk melanggar perubahan skema dan menjaga keserasian bidang yang tidak diketahui.
  6. CONCAC Open komponen dalam draf, jalankan setiap negara/viewport/persona fixture dan publikasi melalui governance.
  7. Coulback Cowback mengaktifkan komponen/dokumen yang tidak dapat diubah sebelumnya; mempertahankan bukti kereproduksiannya.
Pembangun · Uji dan rilis

Buktikan ekstensi pada hash rilis yang sama

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

Get sumber adalah perlu, tetapi tidak mencukupi. Lampirkan bukti pangkalan data/migrasi, visual pelayar sebenar, penyedia identiti, pengasingan kebenaran, kebolehcapaian, prestasi, baris gilir/cron, mel/lampiran, sandaran/pemulihan dan pengerahan pada cincangan keluaran tidak boleh ubah yang sama. Bukti wajib yang tidak diketahui mesti menggagalkan keluaran.

  • Unit: skema, sanitisasi, bentuk DTO, kondisi, migrasi dan kegagalan tipe.
  • Kontrak: pemuatan/pengisian/kekosongan/kesalahan/sukses, kematangan, slot, pengikatan dan paritas satu-pengganti.
  • Pelungsur: keyboard, fokus, semantik, RTL, zoom/reflow, pengurangan gerak dan setiap breakpoint.
  • Keselamatan: siasatan merentas ruang kerja, tindakan palsu, serangan pakej, pemalsuan pratonton dan kebocoran rahsia.
  • Operasional: kemajuan tahan lama, cuti/kembali, stop/retry/resume, detak jantung penjadwal dan rollback.
Administrator + Pengembang · Pemulihan

Pencari masalah oleh negara dan korelasi ID

Negara BagianApa yang perlu dilakukan
Hak aksesPermintaan kemampuan yang diberi nama. UI tersembunyi adalah kenyamanan; backend selalu menegakkannya.
ValidasiBuka halaman/node/field yang dilaporkan, perbaiki, lalu jalankan ulang praflight.
KonflikBuat ulang revisi terbaru, bandingkan perubahan dan ulangi dengan sengaja. Jangan paksa menimpa.
Luar talian / boleh dicuba semulaSimpan draf, pulihkan sambungan, cuba semula melalui tindakan dan sahkan keadaan kerja yang kekal.
AYA / Tidak AdaTak pernah menyimpan rahasia atau teks pengecualian pribadi.
Gagal menerbitkanPeriksa output prapenerbangan/kerja, cuba semula hanya peringkat yang boleh dicuba semula, atau undur kepada keluaran sihat yang terakhir.
SCIM 401/403Konfirmasi titik akhir/ruang kerja, token pembawa, keadaan dan rotasi yang diaktifkan; jangan pernah gunakan kuki sesi peramban.
Pengetahuan tentang ilmu pengetahuan adalah basiOverifikasi lokalitas/penyublikasi di Help Center, kemudian inspeksi cache invalidation dan clean localized route.

Panduan ini sudah siap cetak. Gunakan → Cetak Simpan sebagai PDF untuk salinan offline yang terkendali.