Portal Configuration
Manage visuals and voice without modifying code.
Portal Overview
Use the ModelNex Portal to change messaging, voice, and experience themes without shipping a code deploy.
This separation lets product, design, and operations teams iterate on the user experience while engineers keep the runtime stable.
Trigger and Start Policy
Portal controls when a workflow or tour becomes eligible and how it first appears to the user.
| Prop | Type | Description |
|---|---|---|
first_visit |
trigger |
Matches when userProfile.isNewUser === true. |
return_visit |
trigger |
Matches when userProfile.isNewUser === false. |
feature_unlocked |
trigger |
Matches when the flow featureKey is present in userProfile.features or userProfile.tourFacts.features. |
manual |
trigger |
Never auto-surfaces. Use it for explicit launches from buttons, commands, or checklist actions. |
prompt_onlyopens the ModelNex chat bubble and asks the user in-chat before starting.immediate_startlaunches the experience as soon as the trigger matches.manual_onlykeeps the experience available for explicit launch only.
For customer-facing activations, prompt_only now surfaces as a plain-language ask inside the chat bubble.
Blocking modals are best reserved for review and preview flows that explicitly request modal presentation.
Modal Configuration
Configure modal presentation when you intentionally want a blocking invite for preview, review, or high-focus experiences.
| Prop | Type | Description |
|---|---|---|
title & description |
string |
Primary invite copy shown before a workflow begins. |
buttonText & cancelButtonText |
string |
Primary and secondary CTA copy. |
backgroundColor & textColor |
hex |
Explicit color overrides for brand alignment. |
If you want the least disruptive production behavior, prefer prompt_only and let the chat bubble ask in-line instead of interrupting with a modal.
Voice Personalization
Adjust voice and language so the guide matches your product tone, market, and accessibility requirements.
| Prop | Type | Description |
|---|---|---|
language |
string |
BCP-47 locale such as en-US or fr-FR. |
ttsVoice |
string |
The underlying TTS voice or model used for playback. |
ttsPrefetchLeadMs |
number |
Lead time for preloading voice chunks before playback. |
Experience Themes
Theme a workflow differently depending on whether it is exploratory onboarding, task coaching, or a strict operational flow.
| Prop | Type | Description |
|---|---|---|
tone |
string |
Interactive style such as guide, coach, or operator. |
accentColor |
hex |
Flow-wide or step-level highlight color for important UI targets. |
AI Patterns
Patterns map your technical selectors to semantic meanings so the agent reasons about your product in domain language.
| Prop | Type | Description |
|---|---|---|
Pattern Matching |
string |
Exact matches or wildcards for data-testid values. |
Semantic Description |
string |
Natural-language meaning of the element or action. |
Behavioral Category |
string |
Action category such as navigation, creation, or destructive. |