Traffic Control with Web Agent API Integration

After you've completed the agent integration, add the API code to the control target to enable traffic control.

Basic Control

Functions

NFStart

• Location : Applies it to the HTML code of items such as buttons or actions that appear on the page.
• Feature : Enables the VWR on the Web page where you want to control traffic.
• Terminate point : Exits when the function's callback function is called.
  • At this point, we use the end of wait (NFStop) function to return the key provided to the visitor when the entry target page loads.
• Parameters: In the code, enter the API parameters associated with each segment you created in the NetFUNNEL console.
  • projectKey : Unique key of the project that registered in the NetFUNNEL for traffic control.
    • Get this parameter from the NetFUNNEL console sidebar.
  • segmentKey : Unique key of the segment that registered in the NetFUNNEL for traffic control.
    • Get this parameter from the basic control menu in the NetFUNNEL console.
• Sample code

/*
* @param {object} projectKey, segmentKey
* @param {Function} success callback
*/
NFStart({
projectKey: '{Project Key}',
segmentKey: '{Segment Key}'
}, function(response){
// TODO : Implement page navigation logic.
// Example : window.location.href = '{Enter URL after basic control Wait}';
});

NFStop

• Location : Applies when the service page loads after the entry is made.
• Feature : When a visitor enters the traffic control target, you receive a return of the key you provided with the NFStart function during the waiting time.
• Parameter : N/A
• Sample code

/*
* @param {object} empty
* @param {Function} success callback
*/
NFStop({}, function(response) {
// No additional logic or implementation is required in this callback function.
});

Path Control

Functions

NFStartSection

• Location : Entry point to the start url of path control 
• Feature : Enables the VWR on the start page(HTML) where you want to enforce waiting for traffic that stays on a path of the page (start page to end page).
• Terminate point : Exits on the page that returns the key using the path control stop function (NFStopSection). 
• Paremeters : In the code, enter the API parameters associated with each segment you created in the NetFUNNEL console.
  • projectKey : Unique key of the project that registered in the NetFUNNEL for traffic control.
    • Get this parameter from the NetFUNNEL console sidebar.
  • segmentKey : Unique key of the segment that registered in the NetFUNNEL for traffic control.
    • Get this parameter from the path control menu in the NetFUNNEL console.
• Sample code

/* 
* @param {object} projectKey, segmentKey 
* @param {Function} success callback 
*/
NFStartSection({ 
projectKey: '{Project key}', 
segmentKey: '{Segment key}' 
}, function(response){ 
// TODO : Implement logic to navigate to the start page of a path control.
// Example : window.location.href = '{Enter URL after path control Wait}';
});

NFStopSection

• Location : Applies when entering the end page of the path control.
• Feature : Used to return the key after entering the end page of a path control.
• Paremeters : In the code, enter the API parameters associated with each segment you created in the NetFUNNEL console.
  • projectKey : Unique key of the project that registered in the NetFUNNEL for traffic control.
    • Get this parameter from the NetFUNNEL console sidebar.
  • segmentKey : Unique key of the segment that registered in the NetFUNNEL for traffic control.
    • Get this parameter from the path control menu in the NetFUNNEL console.
• Sample code

/*
* @param {object} projectKey, segmentKey
* @param {Function} success callback
*/
NFStopSection({
projectKey: '{{Project key}',
segmentKey: '{Segment key}'
}, function(response){
// No additional logic or implementation is required in this callback function.
});

Application Testing

To verify that the NetFUNNEL Web Agent has been successfully applied, please follow the steps below.

1. Set the limited inflow of the basic/path control segment to '0'.
2. Request an entry within the web page.
3. Check if a waiting room appears on the screen. (VWR check)
4. Check if there is a numerical change in the corresponding segment in the basic control menu of NetFUNNEL console.
   • Recommended for viewing in Classic View mode.