← Усі документи
Портал - Web Studio

Побудувати сміливо. Публікація безпечно.

Практичний посібник для адміністраторів, які формують досвід клієнтів та розробники, які його розширюють. Він документує архітектуру реального студії, регулюється шлях релізу, допоможи володінню Центром, ідентичністю, міграціями, складовими контрактами і відновленням.

Портал Документація v2Адміністратор + РозробникПідприємство випускає робоче покриттяАжурирано 1 серпень 2026
Керівництво адміністратора · Архітектура

Знайте, що у нас є власні студія

Портал студії володіє оболонкою клієнтів: сторінки, розміщення компонентів, брендові токени, адаптивна поведінка, навігація, нижній колонтитул, презентація ідентичності, подорожі квитків та релізи. Центр Допомоги володіє мовами, категоріями, розділами та змістом статті. Студія споживає цей вміст через захищений міст; він ніколи не створює другого магазину статті.

Центр допомоги + квиток на літакПерехідники з експлуатаціїПортал Документація v2Один компілятор і рендерПортал - Preview. com
Норма одного рендерера: Перегляд та публічні сторінки використовують той самий документ/компієнтний договір. Публікація ніколи не переходить до шаблону, що не відповідає вимогам.
Портал Studio · Робочий простір мапа
Жива канваРобочий стіл · Замовник
Портал - WebmoneyЦей документ, який використовується в попередньому перегляді та публічному рендерингу
Інтерфейсна карта: робоча рейка, живе полотно та інспектор цільові ж стабільну сторінку і вибір вузлів.
Адміністратор · Старт

Повна готовність до будівництва глибоко

  1. Відкрито Портал студії → Початок → Готовність.
  2. Підтвердіть адресний портал і відкрийте його в окремій вкладці.
  3. Настроювання логотипу, іконки браузера, сенсорний значок, соціальний образ і колір теми.
  4. Підтвердіть довідкові мови Центру; змінити повноваження мови в Центрі допомоги, не Студія.
  5. Навігація налаштувати та керувати світовим підприємством.
  6. Виберіть подорож і налаштувати принаймні одну заявку.
  7. У разі виникнення принаймні одного безпечного входу в метод, який активно та рецензує особистість.
  8. Якість і встановлення підписаного передогляду рукосми.
  9. Створіть перший регульований реліз після кожного блокуючого елемента.

Відсоток готовності обчислюється з збережених даних робочого простору та стану попереднього перегляду. Вибір маршрутів пункту безпосередньо до панелі керування власними силами.

Адміністратор · Побудувати

Створення сторінок і багаторазових розділів

  1. Відкрито Побудова → Сторінки і виберіть сторінку захищеної системи або створити на замовлення.
  2. Встановити маршрут, назву, режим доступу та локальну поведінку. Захищені шляхи системи не можна видаляти.
  3. Відкрито Комплекти, фільтрувати за допомогою роботи або зрілості і розмістити компонент в сумісному слоті.
  4. Використовуйте інспектор для контенту, зовнішнього вигляду, зв'язування, видимості та доступності.
  5. Використовуйте багаторазові візерунки для повторних структур; зберігати організацію або відмінності брендів в варіантах.
  6. Збережіть проект та навантаження на вправи, порожньою, помилкою, гістьом і підписаними державами в попередньому перегляді.
Бібліотека компонентів · Санітізований інтерфейс карта
Пошук знаньGA · безпечне обслуговування клієнтівКатегорія сіткиGA · Центр допомогитіло статтіGA · переведений DTOФорма запитуGA · версіяЧасовий поясБета · попередженняГрафік роботиПланування · блоки публікуються
Карта інтерфейсу: категорія, сумісність та зрілість видимі до розміщення. Плановані компоненти блок-публікації; компоненти бета вимагають явного лікування релізу.
Адміністратор · Бренд і чуйний

Переглядайте реальні подорожі, не один щасливий екран

  1. Підбір гостя, підписаний квиток, супровід векселя, організація або знання ручної роботи.
  2. Переключити людей, організацію, роль та допомогу
  3. Перевірте мобільний, великий мобільний, планшет, ноутбук, робочий стіл, широкі та ультраширокі точки прориву.
  4. Перевірте успадковані, перевантажені та скидання значень; не потрібно розбиття точок дублювання.
  5. Запуск клавіатури, RTL, знижена емоція, завантаження, порожній, недоступний і дозвільний стан.
  6. Використовуйте випробувальну лабораторію для доступності, завантаження, маршруту, обов'язкові та рендерні висновки до огляду.
Зелене полотно не є рішенням про звільнення. Виконується підсвітка, огляд стану, можливості та докази випускають рішення, чи може публікуватися Портал.
Адміністратор · Досвід

Оперте центр допомоги Zendesk-level без дублікатів

  1. Створення категорій, розділів, статей, перекладів, вкладення та шаблони у Центр допомоги.
  2. Увімкнути мови там; локалізовані стропи, пошук, подача, SEO та стаття хромувати слідують за тим же органом.
  3. In Studio, place knowledge search, category/resource grids, feeds, topic accordion, article, table of contents, feedback, related and previous/next components.
  4. Налаштуйте показані, популярні та останні корми; використовуйте контекстні пропозиції в потоках квитків.
  5. Перегляд невідповідностей, довгих статей, вкладення, зворотний зв'язок, годинник/платно та квиток.
  6. Перевірити чисті маршрути, канонічний/хрефланг, структуровані дані та недійсність кешу після публікації.
Об'єднаний орган: редагувати контент та мови клієнтів в Центрі допомоги. Використовуйте портал Studio тільки для того, щоб композиціюувати, як знання виявляються і відображаються.
Адміністратор · Ідентифікатор та організації

Налаштувати знак безпечно

  1. Відкрито Ідентифікатор та організація → Ідентифікація і тримати принаймні один ввімкнений шлях.
  2. Виберіть метод за замовчуванням, реєстраційна політика, тривалість сеансу SSO_-domainforce and відкриття поведінки.
  3. Додайте провайдера з візуальними маршрутами: тип, домени, пріоритет, презентацію, ввімкнено та перевірений стан. Секрети залишаються у підсистемі ідентичності.
  4. Для SCIM, увімкнути надання, скопіювати точну кінцеву точку робочого простору та обертати токен. Зберігайте одноразовий токени в IdP.
  5. Заяви на картографію та членство в організації, потім створюйте тести, оновлення, членство групи та деактивація з тестовим завіренням.
  6. Перегляд гостя, клієнт, делеговані організації та заблоковані стани перед публікаціюм.
Ніколи не надішліть студійні файли cookie SCIM. Це без сеансу, робочий простір-підбирач API. Повертати токен після випадкового впливу.
Адміністратор · Переклад квитків

Налаштуйте повну подорож підтримки

  1. Виберіть прямий вигляд, майстер, пошук-перший, hub або сервіс-desk запис.
  2. Створіть назву, виправданий бланк з розділами та доступні етикетки поля.
  3. Створіть візуальні умови, маршрутизація, SLA та затвердження кроків; розширений JSON призначений для перегляду змін розробника тільки.
  4. Налаштуйте список, деталь, нитка, часовий ряд, вкладення, затвердження, SLA та відповідь поверхонь.
  5. Тестування гостьового пошуку, підписаних запитів, видимість організації, відмова завантаження, повідомлення електронної пошти та дефлекція знань.
  6. Заощаджуйте проект, опишіть тільки після маршрутного адаптера і пропустіть повідомлення.
Адміністратор · Огляд та реліз

Перемістити через обмежений реліз

Проект збереженийВ оглядіЗатвердженоГрафік роботи або опублікованийПереглянуто або розкочується назад
  1. Виконувати затвердження та тестування лабораторії. Виправлення результатів блокування; визнання дозволених повідомлень з контекстом.
  2. Додати випуск ноти та огляд запиту. Коментар рецензентів на стабільну сторінку / шляхах безводних.
  3. Затвердження перевіряють дифу, попередню подорож, зміни дозволу та докази.
  4. Ви можете замовити послугу з підбору персоналу або графіку.
  5. Стоп/ретрита тільки від контрольних завдань.
  6. Перевірити критичні маршрути, ідентичність, квитки та знання. Повернути до незмінного попереднього релізу при необхідності.
МожливістьМета
Перегляд / редагуванняПеревірка або зміна проектів без повноважень вивільнення.
Огляд / ЗатвердженняВідокремити відгуки та затвердження від автора.
Розклад / Публікація / РоллбекНезалежні виробничі елементи.
Ідентифікатор / SCIM / Міграція / Компоненти / ДіагностикаОбмеження чутливих спеціалістів.
Адміністратор · Міграція та розширення

Зігніть з доказами і назад

  1. Виберіть постачальника синтека і створити сухий пробіг.
  2. Переглядайте відкриті налаштування, незрівняні значення, кількість вмісту та захоплення візуальної пари.
  3. Повна безпечна картографування і перевипуск структурованого дифуду.
  4. Застосувати до проекту, розвідувальних та прев’ю кожного захищеного подорожі.
  5. Запис авторизованого прийняття; не перезаписати поточний опублікований випуск при імпорті.
  6. Попри те, що уряд і зберегти звіт про міграцію, випустити ID та розкачати точку разом.
Керівництво по розширенню розробника · Архітектура

Розширені контракти, не шаблони

A safe extension registers a stable component type and schema, declares permissions and data needs, renders through the canonical compiler, and supplies deterministic fixtures/tests. Do not query arbitrary tables, inject editor JavaScript into the public Portal, create another article repository, or bypass the release gate.

Портал Документація v2

Сюжети містять стабільні вузли, слоти, властивості, обов'язки, чуйні перенади, умови та метадані доступності.

Реєстр компонентів

Один контракт живить студію, компілятором, документацією, контрольним та строковим навантаженням.

Реєстр даних

Допускається розміщення з дозволом на DTOS заміну довільного SQL або динамічних дій.

Один рендер

Перегляд та збір публічних даних, дезінфекція, бюджети та штати runtime.

Розробник · Component Contract

Визначення компонентного пакету

Використовуйте нижню назву, що знаходиться в полі, ідентифікацію та визначення безпеки.

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

Форма без

{
  "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"}
}
  • Іденти залишаються стабільними у редагуванні та міграції.
  • Властивості відхилити нерозголошення полів і небезпечних HTML.
  • Кожен вид даних визначає завантаження, порожній, дозвіл та ретривалий вихід.
  • Складові контейнерів ім'я своїх слотів; листя не можуть приймати довільні діти.
  • Відзнаки зрілості чесно: планові блоки, бета попереджає, ГА вимагає повного доказу.
Розробник · Джерела даних та обов'язки

Використовуйте дозвіл-безпечні ДТО

  1. Виберіть існуючий пунктовий ідентифікатор, такий як tickets.mine, knowledge.featured або customer.profile.
  2. Визначені джерела не здаються data_source.unknown.
  3. Пройдіть вже сформований контекст Порталу, ніколи не приймаємо робоче місце / ідентичність користувача від ненадійного майна.
  4. List limits are clamped to 1–100. Normalize pagination, locale and search values.
  5. Якщо нове джерело неможливе, додайте його стабільну визначення, безпечне копіювання, дозвіл, порожня поведінка та налаштування попереднього перегляду.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Джерела даних прочитано на сайті. Мутации вимагають явної авторизованої дії, обов'язки робочого простору, CSRF/session або валідації носія, idempotency, де потрібна і типована конвертація помилок.
Розробник · Security

Перебування в межах довіри

БунарПоведінка
Робочий простірВирішуйте з перевіреного хосту/ромату/сесії, потім об'єм кожного читання та пишуться перед виконанням.
HTML_Використовуйте Сатифікатор порталу / аналізатор. Ніколи не скопіювати ненадійні атрибути, URLs, CSS або скрипт.
РецензіяВимагати одноголовне вікно, підписане версія каналу і неспроможність. Ігнорувати повідомлення нескольчено.
ЗручністьKeep secrets outside documents. SCIM is bearer-authenticated, sessionless and workspace-bound.
ПакетиВідхилити траверсал, абсолютні доріжки, посилання/спеціальні файли, перезавантажити архіви, контрольно-транспортні засоби та нездатні дозволи.
ПомилкаПовернути стабільний код, безпечне повідомлення, ретривалість, переспрямування та кореляційний ідентифікатор; лог приватні винятки сервера-за межами.
ЗнанняЧитать через HelpCenterBridge. Не забудьте автори або дублікати статті Центру допомоги в розширенні.
{
  "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"}
  }
}
Розробник · Пакет і міграції

Інспектування, установка та модернізація атомно

  1. Пути component.json при корені ZIP і зберігайте кожен шлях родича.
  2. Запуск інспекції першим. Встановлюємо архіви капелюшок на 500 записи та записи 25 MB Видобуток; перевірка безпеки забезпечує незалежні ліміти.
  3. Перевірити очікуваний SHA-256 та підпис пакету в процесі випуску.
  4. Встановити до редакції каталогу. Не мутуйте встановлену версію в місці.
  5. Забезпечити міграції майна для розбиття схемних змін та збереження невідомих полів сумісності.
  6. Відкрийте компонент у проекті, запустіть кожну державу/експорт/особистісну фіксацію та публікуйте через управління.
  7. Rollback активує попередній незмінний компонент/видання документів; зберігає свої докази відповідей.
Розробник · Тести та реліз

Проведіть розширення на той же реліз

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

Джерела залом необхідно, не достатні. Прикріпити базу даних/міграцію, візуальний реальний брови, ідентичність-провідувач, авторизація-ізоляція, доступність, продуктивність, чергування/крон, поштову пошту/розгортання, резервне копіювання/відновлення та розгортання доказів до того ж імітованого релізу hh. Невідомо необхідні докази повинні бути невдалими.

  • Блок: schema, санітарія, DTO форма, умови, міграції та типовані збої.
  • Договір: завантаження/порожнення/корпора/настройка, зрілість, слоти, зв'язки та одностороння парність.
  • Браузера: клавіатура, фокус, семантика, RTL, збільшення / переповнення, зменшення руху і кожен пункт прориву.
  • Безпека: крос-платформні зонди, ковані дії, пакунки, попадання попереднього перегляду та секретний виток.
  • Операції: міцний прогрес, залишок/повернення, зупинки/відведення/розум, графік роботи серця і розгортання.
Адміністратор + Розробник · Recovery

Виправлення несправностей державним та кореляційним ідентифікатором

АДЩо робити
ПроживанняЗапит на ім'я можливості. Прихована UI зручність; задня завжди її виконує.
ВведенняВідкрийте сторінку, яку ви можете переглянути.
КонфліктПеревантажити останні версії, порівняти зміни та повторювати навмисно. Ніколи не змусимо перезаписувати.
Оффлайн / їстівнийЗберігати проект, відновити підключення, перейматися через дію і перевірити міцний стан роботи.
Жири / 1.00Скопіюйте ідентифікатор кореляції та часовий збір для підтримки. Ніколи не вставте секрети або текст приватного винятку.
Не вдалосяОгляньте попередній набір / продуктивність, тільки переробні стадії або закочуйте назад до останнього здорового релізу.
SCIM 401/403Підтвердіть кінцеву точку / робоче місце, ведмедя токена, ввімкнений стан і обертання; ніколи не використовуйте cookie-файл для сеансу браузера.
Знання – стеблВизначте місцеве / публічне право в Центрі допомоги, потім перевірте недійсність кешу та чистий локалізований маршрут.

Цей посібник є друком. Використовуйте Друк → Зберегти як PDF для контрольованої офлайн-копії.