Skip to main content
Version: 4.5.2.5-onprem

Section Control Segment

Section Control Segment provides traffic control for multi-step processes and application sections that require maintaining a fixed number of concurrent users. This guide will help you understand, create, and configure Section Control segments effectively.

What is a Section Control Segment?​

A Section Control Segment is a work unit that controls traffic for multi-step processes or entire application sections. It maintains a fixed number of concurrent users within a protected section, holding entry keys until the entire process completes.

Key Characteristics​

Section Control vs Basic 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

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

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

When to Use Section Control:

  • You have multi-step processes (checkout, registration, multi-page flows)
  • You need to maintain a fixed number of concurrent users in a section
  • You want to control traffic for entire process flows, not just individual pages
  • You have processes where users navigate through multiple pages/steps
  • You use Code-Based Integration (CBI) only (URL-Triggered Integration not supported)

Integration Method:

  • Code-Based Integration (CBI): Manual control using nfStartSection() and nfStopSection() in your code. You control exactly when the protected section starts and ends.

Configuration Overview​

A Section 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. 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)

Note: Section Control waiting rooms do not display "Estimated Wait Time" due to variable user residency times in multi-step processes.

Learn more →

4. Inflow Setting​

What it does: Controls how many users can access simultaneously

  • Fixed Type: Constant capacity limit (e.g., always 100 users)

Section Control supports Fixed Type only. Variable Type is not supported because processing time in Section Control reflects user residency time, not server load.

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

Learn more →

5. Advanced Features​

Advanced Timing:

  • Re-request Interval: How often clients check entry availability (1-60 seconds)
  • Alive Notice Re-request Interval: How often the Agent sends "I'm still active" signals (1-60 seconds)
  • Alive Notice Expiration: Maximum duration users can remain active (1-3600 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 Key Invalidation: Force re-queuing for specific 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 'Section Control' in Control Type
  4. Configure: Set up each section according to your needs
  5. Test: Monitor real-time metrics and verify multi-step process behavior

Basic Workflow​

Create Segment
    ↓
Basic Settings (Name, Key)
    ↓
Entry Status (Waiting/Block)
    ↓
Waiting Room Application (Choose Template)
    ↓
Inflow Setting (Capacity Limit - Fixed Type)
    ↓
Advanced Features (Optional)
    ↓
Implement nfStartSection() and nfStopSection()
    ↓
Test & Deploy

Documentation Structure​

This documentation is organized into these sections:

Essential Configuration​

Basic Settings: Segment creation, naming conventions, segment key management

Entry Status Setting: Configure waiting vs block behavior for users

Waiting Room Application: Choose and customize waiting room templates

Inflow Setting: Set capacity limits (fixed type only)

Extended Features​

Advanced - Timing: Fine-tune re-request intervals, alive notice settings, and timeout behavior

Advanced - Queue Position Retention: Preserve queue positions after disconnection

Advanced - Entry Key Invalidation: Force re-queuing under specific time conditions

Advanced - Assign Person in Charge: Assign responsible Operators