Skip to main content
Version: 4.6.1-saas

Initialization Settings

This document describes Property Variables configuration and additional features available in NetFUNNEL Akamai Agent.

Property Variables​

Property Variables are variables set in Akamai Property that control the behavior of the NetFUNNEL agent.

Required Settings​

NF_CLIENT_ID​

Enter the client ID issued from the NetFUNNEL console.

VARIABLE NAMEINITIAL VALUEDescription
NF_CLIENT_ID{{CLIENT_ID}}Client ID checked in NetFUNNEL console

Configuration method:

  1. Select Property
  2. Click [+Add Variable] in Property Variables
  3. Variable Name: NF_CLIENT_ID
  4. Initial Value: Enter Client ID from NetFUNNEL console
  5. Click [Save]

Additional Features​

Good Bot Exception Handling​

You can exclude specific User-Agent values from agent behavior through Property configuration.

Property Configuration​

  1. Select Property where EdgeWorker is applied
  2. Select NF EdgeWorker in Property Configuration Settings
  3. Click [+Match] in Criteria
  4. Select User Agent, is not one of
  5. Add User-Agent of good bots to exclude (e.g., Googlebot, Bingbot, Slurp, Applebot, facebookexternalhit)
  6. Click [Save] button at the bottom right
  7. Click [Activate] tab at the top
  8. Click [Activate {version} on Production] in Production Network
  9. After Verifying is complete, check the warning message box
  10. Click [Activate {version} on Production]

Automatic Entry Key Return Handling​

NetFUNNEL Akamai agent automatically returns the NetFUNNEL key after entry so that the next waiting user can enter. This feature can be used when you want to return the NetFUNNEL key at the timeout time set in the segment instead of returning it immediately.

Property Variables Configuration​

VARIABLE NAMEINITIAL VALUEDescription
NF_RETURN_KEYtrueWhether to automatically return entry key
  • true (default): The agent automatically returns the NetFUNNEL key when entering after waiting is completed.
  • false: The key is returned at the timeout time set in the segment.

Configuration method:

  1. Click [+Add Variable] in Property Variables
  2. Variable Name: NF_RETURN_KEY
  3. Initial Value: true or false
  4. Click [Save]
  5. Activate Property

Change Waiting Room Domain​

The domain of the NetFUNNEL waiting room page is agent-lib.stclab.com. To change this domain to match your service domain, you need to inform the NetFUNNEL service team of the desired domain and change the Property configuration.

Property Variables Configuration​

VARIABLE NAMEINITIAL VALUEDescription
NF_VWR_PAGE_DOMAINhttp(s)://{CNAME_DOMAIN}Waiting room domain URL

Example: https://wait.stclab.com

Configuration method:

  1. Click [+Add Variable] in Property Variables
  2. Variable Name: NF_VWR_PAGE_DOMAIN
  3. Initial Value: Enter the waiting room domain URL you want to change (e.g., https://wait.stclab.com)
  4. Click [Save]
  5. Activate Property

When storing the key issued by the NetFUNNEL server in a cookie, it is stored based on the current page's domain. If you need to share keys between different subdomains, configure it so that the main domain is stored in the cookie.

Example: Set to .stclab.com so that cookies are shared between pages with different subdomains such as develop.stclab.com and staging.stclab.com.

Property Variables Configuration​

VARIABLE NAMEINITIAL VALUEDescription
NF_COOKIE_DOMAIN.{MAIN_DOMAIN}Cookie domain

Example: .stclab.com

Configuration method:

  1. Click [+Add Variable] in Property Variables
  2. Variable Name: NF_COOKIE_DOMAIN
  3. Initial Value: Enter in main domain format (e.g., .stclab.com)
  4. Click [Save]
  5. Activate Property

Property Activation​

After changing Property Variables, you must activate the Property for the changes to take effect.

  1. Click [Save] button at the bottom right
  2. Click [Activate] tab at the top
  3. Click [Activate {version} on Production] in Production Network
  4. After Verifying is complete, check the warning message box at the top
  5. Click [Activate {version} on Production]