Parameters for XMPP

Top  Previous  Next

These variables control how PageGate interacts with XMPP chat systems. We recommend setting these parameters at either the Carrier or Connector level.

 

Click here for more information on how PageGate uses XMPP chat systems.

 

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 sending messages through this carrier. This allows for the sorting and modification of both outbound messages and replies and is an integral part of two-way messaging.

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 = ALERTS

 

This parameter overrides any sender information passed in by the interfaces and APIs.

 

By specifying this variable, you're telling PageGate to use a single, standardized sender's name for messages delivered through this carrier.

InterCommandDelay

Milliseconds

Example: InterCommandDelay = 500

 

This variable inserts a pause, in milliseconds, in between each command used in the protocol negotiation with the chat server. This is used to make sure PageGate doesn't send commands faster than the chat server's command shell can receive them and is not required in most cases.

InterMessageDelay

Number of Milliseconds

Example: InterMessageDelay = 1500

 

This variable inserts a pause, in milliseconds, in between each message delivery attempt.

ReplyFilter

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\replyfilter.xml

 

This parameter calls on PageGate's filtering system using the "Check for Messages" routine to retrieve chat messages from the XMPP server. This allows for the sorting and modification of both outbound messages and replies and is an integral part of two-way messaging.

ReplyFilterDebugFile

File path to and file name of the log to write

Example: FilterDebugFile = c:\PageGateData\Filters\replyfilterlog1.log

 

When using a filter, you can use this variable to output this specific filter's log to the specific location and file name.

StripAlpha

True

False

Example: StripAlpha = True

 

Setting this value to true will remove any alphabetical character from messages delivered through this carrier. For example, if you tried to send the message 'Alert on node 127.0.0.1', the only thing delivered would be '127.0.0.1'

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

A Phone Number

Example: To = 7818290500

 

This parameter forces all traffic to go to the specified ID, overriding any interface or recipient values.

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.