• View PDF: Configuring Actions for the SAE Proxy Processor  

Configuring Actions for the SAE Proxy Processor

You can configure actions that the SAE proxy processor performs on events. For example, you can set up an action to start or stop a service.

To configure actions for the SAE proxy processor:

1. In the VTA Configuration Manager navigation pane, select Edit.
2. Under Current Configuration, select Actions.

   A list of actions appears. For example:

   
3. To add an action, enter a name for the action in the New Quota VTA Actions field, and click Create.

   The action configuration area appears.

   
4. Select SAEProxy in the Processor field, and click Save. (If SAEProxy does not appear in the drop-down list, enable the SAE proxy processor.)

   An expanded configuration area for the action appears.

   
5. Fill in the fields described in this section.

StartBehavingService Fields

Processor

• Processor for which you are configuring the action.

• Value—SAEproxy (If SAEProxy does not appear in the drop-down list, enable the SAE proxy processor.)

• Default—No value

Function

• Function calls that the SAE proxy processor invokes.

• Value
  • SetInterimInterval—Sets the interim interval for the service by using the interimInterval attribute in the event. Before this function is called, the CalculateInterim function of the database engine processor must be called.
  • SetServiceTimeout—Sets the service session timeout for the subscription.
  • SetUserTimeout—Sets the subscriber session timeout of the current subscriber to the corresponding VTA event.
  • StartService—Starts the specified subscription to the service with the specified substitutions.
  • StopService—Stops the specified subscription to the specified service.

• Default—No value

Parameter Name

• Parameters to pass to the processor.

• Value
  • For the SetServiceTimeout function:
    • SubscriptionName—Name of the subscription. Default subscriptions have the same name as the service. This parameter is optional when a service-tracking event is being processed. If this parameter is omitted, the current service session is stopped.
    • SessionName—Name of the service session. If the subscriptionName is omitted, this parameter is ignored. If this parameter is omitted, the default service session is used.
    • SessionTimeout—Length of the service session timeout. When the session timeout expires, the service session is stopped.
    • CurrentSubscriberOnly—Specifies whether the function is applied to the current subscriber only or to all subscribers who have the same subscriber ID.
  • For the SetUserTimeout function:
    • SessionTimeout—Length of timeout. When the session timeout expires, the subscriber is logged out.
    • CurrentSubscriberOnly—Specifies whether the function is applied to the current subscriber only or to all subscribers who have the same subscriber ID.
  • For the StartService function:
    • SubscriptionName—Name of the subscription. Default subscriptions have the same name as the service.
    • SessionTimeout—Length of the service session timeout. If this parameter is omitted, the default is no timeout.
    • SessionName—Name of the service session. If this parameter is omitted, the default service session is used.
    • CurrentSubscriberOnly—Specifies whether the function is applied to the current subscriber only or to all subscribers who have the same subscriber ID.
    • Substitution.<substitutionName>—Name of a substitution to use when starting the service. If this parameter is omitted, the service is started without substitutions.

    • Persistent—Specifies whether a service session is persistent. If you use the SRC-VTA to activate a service with the persistent option, this service is subsequently activated by the SAE every time the subscriber connects to the network. This option provides efficiency because the SRC-VTA does not need to make a decision to activate the service on subsequent logins and because applications such as deep packet inspection (DPI) can more efficiently activate a group of services at login.
  • For the StopService function:
    • SubscriptionName—Name of the subscription. Default subscriptions have the same name as the service. If this parameter is omitted, the current service session is stopped.
    • SessionName—Name of the service session. If the subscriptionName parameter is omitted, this parameter is ignored. If this parameter is omitted, the default service session is used.
    • Reason—Reason for the termination. When the service is stopped, the termination cause is sent to the billing system so it can differentiate between service stops. If this parameter is omitted, no termination cause is provided to the billing system.
    • CurrentSubscriberOnly—Specifies whether the function is applied to the current subscriber only or to all subscribers who have the same subscriber ID.

    • Persistent—Specifies whether a service session is persistent. If you use the SRC-VTA to activate a service with the persistent option, this service is subsequently activated by the SAE every time the subscriber connects to the network. This option provides efficiency because the SRC-VTA does not need to make a decision to activate the service on subsequent logins and because applications such as DPI can more efficiently activate a group of services at login.

• Example—Quota

Parameter Content

• Values for the parameters.

• Value
  • For the subscriptionName parameter:
    • Name of the subscription in the format <serviceName>%<subscriptionId>.
  • For the sessionName parameter:
    • Name of the service session.
  • For the sessionTimeout parameter:
    • Length of the service session timeout in seconds. If the session timeout is set to 0, the service session is stopped immediately.
  • For the substitution parameter:
    • Name of a substitution to use.
  • For the reason parameter:
    • Integer that identifies the termination cause. Possible values are defined in RFC 2866—RADIUS Accounting (June 2000).
  • For the CurrentSubscriberOnly parameter:
    • Set to true to apply to current subscriber only. If you do not set this parameter, true is the default behavior.
    • Set to false to apply to all subscribers who have the same subscriber ID.

  • For the persistent parameter:
    • Set to true to cause the session to be persistent. We recommend that you set this value to true for service sessions that are started in the DPI environment.
    • Set to false to specify that the session is not persistent and the service is activated or deactivated for the current subscriber session only.

• Example—Quota

Abort On Error

• Disables or enables and sets the processing in response to an error.

• Value
  • Break—Stop processing the current event.
  • Continue—Continue with the next action, if any, in the same event handler.
  • Next Event Handler—Continue with the next event handler (if any).

• Default—No value