Skip to main content
Version: 4.6.1

Basic Control Segment

Basic Control Segment provides fine-grained, targeted traffic control for specific URLs, pages, or functions within your application. This guide will help you understand, create, and configure Basic Control segments effectively.

What is a Basic Control Segment?​

A Basic Control Segment is a work unit that controls traffic for specific actions or URLs. It provides precise, targeted traffic control for particular pages or functions within your application, allowing you to protect high-traffic endpoints while keeping other parts of your service accessible.

Key Characteristics​

Basic Control vs Section Control:

The fundamental difference is key management - how and when NetFUNNEL returns entry keys:

Control TypeKey ManagementPurposeBest For
Basic ControlKey returned quickly after action completesControls entry speedButton clicks, API calls, page loads, specific URLs/pages
Section ControlKey held until entire section/process completesMaintains fixed concurrent capacityMulti-step processes, checkout flows, payment processing

Basic Control - Quick Key Return:

  • Controls how fast users enter your service
  • Key is returned immediately after the action completes (e.g., page loads, API call finishes)
  • Examples: /checkout page load, /payment endpoint, /signup button click
  • User journey: Action → Wait if needed → Enter immediately → Key returned quickly
  • Perfect for: Single actions, API throttling, page protection, targeted surge points

Section Control - Hold Key Until Complete:

  • Maintains a fixed number of concurrent users in a specific section
  • Key is held throughout the entire multi-step process
  • Key only returned when entire section/process completes (e.g., checkout finished, payment processed)
  • User journey: Start → Enter section → Multiple steps → Complete entire process → Key returned
  • Perfect for: Multi-step processes, checkout flows, maintaining fixed capacity

When to Use Basic Control:

  • You need to protect specific high-traffic pages or endpoints
  • You want different traffic control settings for different pages
  • You have targeted surge points (checkout, payment, sign-up pages)
  • You need precise control over which URLs trigger waiting rooms
  • You use URL-Triggered Integration (UTI) for page-level control
  • You use Code-Based Integration (CBI) for button/API-level control

Integration Methods:

  • URL-Triggered Integration (UTI): Automatic protection for page requests matching trigger rules. Users are redirected to waiting rooms based on URL patterns.
  • Code-Based Integration (CBI): Manual control using nfStart() and nfStop() in your code. You control exactly when waiting rooms appear.

Configuration Overview​

A Basic Control Segment is configured through these main settings:

1. Basic Settings​

What it does: Define your segment's identity - name and unique key

  • Segment Name: Human-readable identifier for your segment
  • Segment Key: Unique identifier used by NetFUNNEL agents (cannot be changed after creation)

Learn more →

2. Entry Status Setting​

What it does: Determines how users are handled when entering controlled areas

  • Waiting Status: Users wait in queue and enter when capacity is available
  • Block Status: Users are prevented from entering (shown block room message)

Learn more →

3. Entry Control Model Settings​

What it does: Selects the traffic entry control model for the segment

  • Dynamic Entry Mode: Flexible queue management based on real-time traffic
  • Fixed Entry Mode: Fixed intervals for accurate queue positions and wait times

Learn more →

4. Waiting Room Application​

What it does: Configures the UI that users see while waiting or blocked

  • Waiting Room: Template shown to queued users
  • Block Room: Template shown to blocked users
  • Live Message: Real-time text updates (max 20 characters)

Learn more →

5. Inflow Setting​

What it does: Controls how many users can access simultaneously

  • Fixed Type: Constant capacity limit (e.g., always 100 users)
  • Variable Type: Dynamically adjusts based on server performance (e.g., 50-300 users)

Setting to 0 moves all users to waiting room (useful for testing).

Learn more →

6. Trigger Rule Setting​

What it does: Defines which URLs/requests trigger traffic control

  • Only for URL-Triggered Integration (UTI)
  • Specify URL patterns, domains, paths
  • Combine multiple conditions with AND/OR logic

Learn more →

7. Post-Queue Redirect Page​

What it does: Configures where users are redirected after queue completion

  • Return to original page: Users return to the page they were visiting
  • Redirect to specific URL: All users are redirected to a configured URL

Learn more →

8. Queue Notification Settings​

What it does: Configures notifications for administrators and waiting users

  • Admin Queue Notification: Email alerts when queues occur
  • Customer Queue Notification: Sound and popup notifications when entry time arrives

Learn more →

9. Advanced Features​

Pre/Post Waiting Room Reservation: Configure pre-waiting and post-waiting rooms with different timing and purposes.

Learn more →

Advanced Timing:

  • Re-request Interval: How often clients check entry availability (1-60 seconds)
  • Timeout: Automatic key return mechanism for unused slots (6-60 seconds)

Learn more →

Queue Position Retention: Restore queue position after disconnection (1 second to 2 hours).

Learn more →

Entry Pass: Allow immediate re-entry without re-waiting (1 minute to 24 hours).

Learn more →

Entry Key Invalidation: Force re-queuing for specific URLs or time periods.

Learn more →

Assign Person in Charge: Assign responsible Operators for segment management.

Learn more →

Creating Your First Segment​

Quick Start​

  1. Navigate to Segment List: Go to your project's segment management
  2. Click Create: Click the '+' button in the top right of the segment list
  3. Select Type: Choose 'Basic Control' in Control Type
  4. Configure: Set up each section according to your needs
  5. Test: Use trigger rule test and monitor real-time metrics

Basic Workflow​

Create Segment
    ↓
Basic Settings (Name, Key)
    ↓
Entry Status (Waiting/Block)
    ↓
Entry Control Model (Dynamic/Fixed)
    ↓
Waiting Room Application (Choose Template)
    ↓
Inflow Setting (Capacity Limit)
    ↓
Trigger Rule (URL Patterns) [UTI only]
    ↓
Post-Queue Redirect (Optional)
    ↓
Queue Notification (Optional)
    ↓
Advanced Features (Optional)
    ↓
Test & Deploy