Generic Protocol Providers

The following table describes the settings for Generic Protocol Providers.

Generic Provider Details

Setting

Description

Name

Name of the service provider.

Description

Description of the provider.

Maximum Retries

Number of times to resend a notification before potentially using an alternate service provider; allowable values are from 0 to 10.

Retry Interval

Amount of time in seconds to wait between retries.

Maximum Session Size

Number of notifications per connection/session.

Split long message

Controls whether notifications that exceed the number of characters specified by the Split size setting are split into multiple smaller messages or sent as a single message.

Split size

Determines the maximum number of characters per message sent to this Protocol Provider. This setting applies only if the Split long message check box is selected.

Maximum message length

If enforced by this provider, the maximum number of characters allowed per notification. For more information, see Setting Maximum Message Length.

Maximum Pin Length

If enforced by this provider, the maximum number of characters allowed in a PIN. If the PIN is longer than the maximum PIN length, the leading characters are truncated.

Executable Path

Path to the application executable that is to act as a Protocol Provider.

Note: The path cannot exceed 50 characters in length.

Wait Time

Amount of time in seconds to wait for the application to finish processing.

List of Arguments

Any arguments or switches to be passed to the executable when running the protocol provider application.

Arguments can be in one of two forms:

$<value>: the argument is replaced by the corresponding value, in double quotes, from the presentation script’s @content object. For example, $username would be replaced with the contents of the $content.username variable in double quotes (e.g., “bsmith”).

The fixed exceptions are $message, which is replaced by the actual message, and $pin, which is replaced by the actual Device PIN.

<value>: arguments not prefaced by the dollar sign ($) are passed directly to the executable (e.g., command line switches).

Note: If the Generic provider returns a value of zero, the notification is treated as successful. Any other value is treated as an error.