Variable
|
Possible Values
|
Description
|
BodyMaxChars
|
Numeric
|
Example: BodyMaxChars = 200
This parameter limits the length of the %Message% macro and does not override the carrier "Max Chars" setting.
|
Filter
|
File path to and file name of the filter to run
|
Note: pgfilter.exe and pgfilter.dll must reside in the PageGate program directory to use this parameter.
Example: Filter = c:\PageGateData\Filters\yourcarrierfilter.xml
This parameter calls on PageGate's filtering system when using this carrier.
|
FilterDebugFile
|
File path to and file name of the log to write
|
Example: FilterDebugFile = c:\PageGateData\Filters\outboundfilter1.log
When using a filter, you can use this variable to output this specific filter's log to the specific location and file name.
|
From
|
Text
|
Example: From = CAD
This variable overrides the value passed to PageGate by the input modules/APIs. By specifying this variable, you're telling PageGate to use a single, standardized sender's name for all traffic controlled by this template.
|
InterMessageDelay
|
Milliseconds
|
This variable forces PageGate to delay for the specified number of milliseconds (1000 = 1 second) after delivering each message.
|
PauseChar
|
Special Character
|
Example: PauseChar = ~
This parameter tells PageGate to pause for the specified PauseTime before continuing on and should be set to a character that does not show up in your message text.
As an example, you could use the above example to declare that a tilde (~) should create a pause. You could then format the message template of a RawSerial carrier as follows:
~myusername\013~~mypassword\013~%Message%\013
That would tell this carrier that it should connect, wait 1 second, pass a username value and a carriage return, wait 2 seconds, pass the password value and a carriage return, wait 1 second, then pass the message text and a carriage return.
|
PauseTime
|
Milliseconds
|
Example: PauseTime = 1000
This parameter tells PageGate how long to pause when the PauseChar is encountered.
|
RawSerialErrorResponse
|
See Description
|
This parameter scans through response packets for the specified keywords or keyphrases to determine if an error has occurred during communication.
This variable is both case and punctuation sensitive and PageGate will look for an exact match to what you enter.
Multiple search terms may be used and must be separated by a pipe. All values are considered to have wildcards.
For example, this will scan for the word reject but will also match rejecting, rejected, etc:
RawSerialErrorResponse = reject
This would scan for the words fail* or reject*:
RawSerialErrorResponse = fail|reject
This would scan for the word failed* OR the word reject* OR the phrase *object not found*:
RawSerialErrorResponse = failed|reject|object not found
Any response from the TCP host that includes the search term(s) will be treated as a failure.
|
RawSerialResponseTimeout
|
Milliseconds
|
Example: RawTcpResponseTimeout = 1000
This variable forces PageGate to wait for the specified number of milliseconds (1000 = 1 second) for a response to the TCP communication request.
|
RawSerialSuccessResponse
|
See Description
|
This parameter scans through response packets for the specified keywords or keyphrases to determine if a communication attempt has been successfully completed.
This variable is both case and punctuation sensitive and PageGate will look for an exact match to what you enter.
Multiple search terms may be used and must be separated by a pipe.
For example, this would only scan for the word success:
RawSerialSuccessResponse = success
This would scan for the words Acknowledged or acknowledged
RawSerialSuccessResponse = Acknowledged|acknowledged
This would scan for the word success OR the word hijinks OR the word actualization:
RawSerialSuccessResponse = success|hijinks|actualization
Any response from the web server that includes the search term(s) will be treated as a success.
|
StripAlpha
|
True
False
|
Example: StripAlpha = True
Setting this value to true will remove all alphabetical characters from messages delivered through this carrier.
|
StripCharacters
|
See description
|
Example: StripCharacters = |\~
This parameter will remove all instance of any character(s) entered. In the above example, that would strip out all pipes (|), backslashes (\) and tildes (~).
|
StripNonPrintable
|
True
False
|
Example: StripNonPrintable = True
Settings this value to true will remove any non-printable ASCII characters, like carriage returns, line feeds, horizontal tabs and similar, from messages delivered through this carrier.
|
To
|
Recipient ID
|
Example: To = 7818290500
This variable overrides the recipient ID/PIN. By specifying this variable, you're telling PageGate to send all traffic sent by this carrier should only go to the specified ID.
|
UseFilterDll
|
True
False
|
Note: pgfilter.exe and pgfilter.dll must reside in the PageGate program directory to use this parameter.
Example: UseFilterDll = True
Setting this parameter to true tells PageGate to use the filter dll, which is a more efficient method of running the filter.
|