Controlling Volume Usage with the VTA > Configuring the SAE Proxy Processor

Configuring the SAE Proxy Processor

To configure the SAE proxy processor:

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

A list of processors appears.

3. Click Enable next to the SAE Proxy Processor to enable the processor.

The SAE Proxy Processor screen appears.

4. There are no fields to configure for the SAE proxy processor, but you must configure actions for the processor. See 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, click 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 screen 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 screen for the action appears.

5. Fill in the fields described in this section.

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 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.

• For the SetUserTimeout function:

• sessionTimeout—Length of timeout. When the session timeout expires, the subscriber is logged out.

• 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.
• substitution.<substitutionName>—Name of a substitution to use when starting the service. If this parameter is omitted, the service is started without substitutions.

• 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.

• 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).

• 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