Skip to main content

Byte Portal β€” Admin & Configuration

What it does: Byte Portal is the control plane for all markets and ops teams. It is where everything about the platform is configured β€” from store hours and menus to promotions, taxes, payments, and refunds.

Why it matters: Without Byte Portal, markets cannot go live. Every feature in Byte Helium depends on something being correctly configured in Byte Portal. Misconfiguration in Byte Portal has direct customer impact.

Byte Portal does not author menus

Menu authoring (creating items, descriptions, prices, options) happens in Byte Menu β€” a separate tool outside the Atlas platform. Byte Portal assigns already-published menu versions to markets and channels. It can apply patches and price overrides, but cannot create menu content from scratch.


Feature Table​

FeatureProblem It SolvesWhat It DoesHow It WorksDependenciesPrerequisitesLimitationsImpacted Metrics
Users & Roles (RBAC)Market teams need scoped accessInvites users, assigns roles, enforces scope-based access (market/group/store)SSO + MFA for login; RBAC with policy engine; scope guard blocks out-of-scope accessIdentity Provider, RBAC service, Audit storeIdP configured per marketCustom roles use approved action whitelist only; all actions auditedAccess violation rate, user onboarding time
Store & Group ConfigurationMarkets need to configure their restaurantsManages store admin data, group hierarchies, trading hours, real-time state, and throttling policiesStores linked to POS; groups define inheritance; trading hours timezone-aware; state (open/paused/closed) affects channelsPOS integration, Shared CataloguesStore data seededNo cycles in group hierarchy; state is real-time source of truth for all channelsStore data accuracy, downtime events
Menu Assignment & PatchingMarkets need to control which menu is shown whereAssigns published menu versions to market/store/channel; applies patches, dayparts, and overridesByte Portal consumes Byte Menu published versions; assignments with validity windows; patch templates for price/availability rules; dayparts for time-based availability and pricingByte Menu service, Menu Assignment engineMenu version published in Byte MenuByte Portal does NOT author menus β€” that's Byte Menu. Conflicting patches are blocked. Daypart behavior still depends on the published menu structure supporting the target entities.Menu publish success rate
Promotions ConfigurationMarketing teams need to create and manage offersCreates promotions with eligibility, benefits, schedules, codes, and budgetsPromotion definition β†’ evaluation by Commerce Backend at checkoutCommerce Backend, Promo EnginePromotion configuration completeStacking conflicts resolved by policy; expired budgets auto-block new redemptionsPromotion redemption rate, budget burn rate
Tax ConfigurationFinance teams need to set correct tax ratesDefines tax profiles, categories, rates, rules, and rounding per marketTax profiles assigned to markets; pricing engine applies at checkoutTax engine, Pricing serviceTax profile created and assignedOverlapping rates blocked; must align with local lawTax accuracy, compliance audit pass rate
Payments ConfigurationMarkets need to set up their payment methodsConfigures PSP profiles, payment methods, routing rules, surcharge policies, and risk rulesPSP credentials stored in vault (not in Byte Portal); routing engine uses channel/market rulesPSP, Vault, Routing enginePSP contract in place; credentials in vaultSecrets never exposed in Byte Portal; routing changes must not interrupt payment flowsPayment method availability, routing error rate
Orders & Refunds (Ops)Ops teams need to manage customer issuesSearch orders (PII-redacted), process refunds, manage non-monetary adjustmentsOrder search with role-based PII access; refund validated against policy; optional multi-step approvalOrders service, PSP, Audit storeRefund policy configuredRefund caps, time limits, and approver rules set in policy; permanent deletion not allowedRefund processing time, refund rejection rate
Localisation & Content ManagementMarkets need localised contentManages locales, translation keys, content blocks, announcements, and legal noticesTranslation entries per locale; content blocks scheduled by scope; legal notices versionedCMS, Legal CMS, CMPLocale enabled for marketMissing translations fall back to default localeTranslation coverage, locale enablement rate
Feature Flags & SettingsEngineering and product need controlled rolloutsCreates feature flags with targeting rules; manages system settings hierarchyFlags evaluated at runtime by market/channel/segment; settings inherit global β†’ environment β†’ marketSettings service, Feature flag engineFlag created and targetedBad config rollback via version history or flag kill-switchFlag adoption rate, configuration error rate
Reporting & ExportsTeams need data from the platformDefines reports, saves views, exports data to file or scheduled deliveryReport engine queries data warehouse; exports materialised asynchronously; delivered to S3/FTP/Email/WebhookData warehouse, Export engineReport defined and access grantedLarge exports async with progress tracking; RBAC controls what each role can exportReport usage, export job success rate
Webhooks & IntegrationsThird-party systems need platform eventsManages webhook subscriptions for platform events; monitors delivery and DLQAt-least-once delivery; signed with HMAC/OAuth; DLQ for failed eventsIntegration/Event platformEvent type subscribed; endpoint configuredAt-least-once (not exactly-once); subscribers must handle idempotencyWebhook delivery success rate, DLQ size
Audit & ObservabilityCompliance and ops need visibilityRecords all admin actions with who/what/when; monitors health checks and SLOsStructured audit events; access logs; health checks and alert rules; SLO tracking with error budgetAudit store, Observability platformObservability configuredAudit logs tamper-resistant; modifications not allowedSLO compliance, audit completeness

See it in the wiki

Byte Portal features above map directly to the Admin Portal Guide: