Basic Settings

"Basic Settings" is the fundamental configuration section for Section Control segments, covering segment creation, naming, and essential setup parameters. This guide covers segment creation process, segment naming best practices, and segment key configuration including immutability considerations.

Overview

Basic Settings is where you create and configure your Section Control segments. Think of it as setting up the foundation for your traffic control system. Here, you'll define the essential parameters that will identify and manage your segment throughout its lifecycle.

What You'll Configure

• Segment Name: A human-readable name for easy management
• Segment Key: A unique identifier used by NetFUNNEL agents

Segment Creation

Creating Your First Segment

To create a new Section Control segment:

1. Access Segment List: Navigate to the segment management section in your NetFUNNEL console
2. Click Create Button: Click the '+' button in the top right of the segment list
3. Select Control Type: Select 'Section Control' in Control Type
4. Proceed to Configuration: Continue to the next step for detailed configuration

Segment Creation Process

The segment creation process is straightforward and designed to guide you through the essential setup steps. Once you select Section Control, you'll be taken to the configuration screen where you can define your segment's basic settings.

Configuration Process

Segment Name

Enter a name that is easy to distinguish in the list. This is purely for your management convenience.

Naming Best Practices

Good names that tell you what section they control:

• "Checkout Process"
• "Registration Flow"
• "Booking Section"
• "Payment Processing"

Avoid these confusing names:

• "Segment 1", "Test", "New Segment"
• Names that don't tell you what section the segment controls
• Names that are too generic or temporary

Pro Tip: When you have multiple environments, include that in the name:

• "Checkout Process - Production"
• "Checkout Process - Staging"

Section Control naming guidance:

• Focus on the multi-step process or section being controlled
• Indicate the capacity management aspect (e.g., "Payment Flow" suggests controlled concurrent users)

Segment Key

The Segment Key is automatically assigned and can be modified until creation (cannot be modified after creation).

What is a Segment Key?

Think of a Segment Key as your segment's ID card. When your NetFUNNEL agent talks to the NetFUNNEL server, it uses this key to control how many concurrent users can be in a specific section at the same time.

For Section Control: The key is held throughout the multi-step process (e.g., checkout, registration) and is only returned when the entire section is complete. This maintains controlled capacity within that section.

How Segment Keys Work

Web/JavaScript Integration:

nfStartSection({
    projectKey: "your_project_key",
    segmentKey: "your_segment_key"    // This is your segment key
}, function(response) {
    // Handle the response
    if (response.status === 'Success') {
        // User entered the section
    }
});

Android Integration:

Netfunnel.nfStartSection(
    projectKey = "your_project_key",
    segmentKey = "your_segment_key",  // This is your segment key
    callback = yourCallback,
    activity = this
)

iOS Integration:

Netfunnel.shared.nfStartSection(
    projectKey: "your_project_key",
    segmentKey: "your_segment_key"  // This is your segment key
)

Segment Key Characteristics

• Unique Identifier: No duplicates allowed across all segments
• API Usage: Used for API calls (traffic control code)
• Immutable: Cannot be changed after segment creation
• Case Sensitive: Segment keys are case-sensitive

Default Key Format

When you create a new segment, NetFUNNEL automatically generates a key in the format:

segKey_XXXX

Where XXXX is a 4-digit random number (e.g., segKey_1234, segKey_5678).

Customizing Your Segment Key

You can customize the segment key during creation to make it more meaningful:

Good custom keys:

• "checkout_process"
• "payment_flow"
• "registration_section"
• "booking_control"

Avoid these problematic keys:

• Keys with spaces or special characters
• Keys that are too long or too short
• Keys that don't follow naming conventions

Why Segment Keys Can't Be Changed

Important: Segment Key Immutability

Once a segment is created, its key cannot be modified. This is a deliberate design decision to prevent issues with existing integrations.

The Problem with Changing Keys: If segment keys could be changed after creation, it would create problems for existing integrations:

1. Code Dependencies: Your application code references the segment key
2. Integration Breakage: Changing the key would break existing integrations
3. Unexpected Behavior: Agents might stop working or behave unexpectedly

What to Do If You Need a Different Key: If you need to change your segment key:

1. Create a New Segment: Create a new segment with your desired key
2. Update Your Code: Update your application code to use the new segment key
3. Test Thoroughly: Ensure the new integration works correctly
4. Delete Old Segment: Only delete the old segment after confirming the new one works

Best Practice

Always plan your segment keys carefully before creation. Consider your naming conventions and how they'll fit into your overall traffic control strategy.