Administrator

Configuring the Transmit Configuration File for Agentry Applications

To override transmit values for an application, you can create a transmit configuration file. This can be useful when you are running multiple Agentry applications on SAP Mobile Platform Server.

Production Workflow

  1. (Administrator) Work with developers to create a text file called TransmitConfigurations.ini in the application project.
  2. (Developer) In the text file, for each transmit configuration to override, create a section called [<TransmitConfigurationName>]. Place any override attributes in each section as is appropriate. Include the file when you publish the project to production. See Publishing to Production in Developer > Agentry App Development.
  3. (Administrator) Import the project ZIP file to the server.
  4. (Administrator) In Management Cockpit, select the application and navigate to Application-Specific Settings. Under Configuration, make sure the value of Transmit Configuration File points to this ZIP file location.
  5. (Administrator) To initiate the changes, restart the application on each server.

TransmitConfigurations.ini

The TransmitConfigurations.ini file has one section for each transmit configuration that is defined in the application, where <TransmitConfigurationName> is the name of the definition within the application project. Each section can contain override values for any and all attributes within a given transmit configuration definition.

The following example shows several options that are valid within each section of the TransmitConfigrations.ini override file. The value for stayLoggedIn overrides the general attribute Stay Logged In.
 [<TransmitConfigurationName>]
stayLoggedIn=true
retryPeriod=30
retryAttempts=5
onlineRetryAttempts=5

serverInactiveTimeoutOverride=300

All other attributes within the transmit configuration definition can be overridden using the proper key and value pair. Any attributes that are not overridden in TransmitConfigurations.ini are sent to Agentry Clients as they are defined in the application project.

If you have multiple Agentry applications, each server should have its own version of TransmitConfigurations.ini that includes overrides for the required configuration settings that are unique to that server instance.

TransmitConfigurations.ini Attributes

For information about definition attributes, see Developer > Agentry App Development > Agentry Language Reference > Application Level Definitions Overview > Transmit Configuration.

Table 14: General Settings
Override Item Setting Acceptable Values Description
  Name   Name of the transmit configuration, which must be unique for all transmit configurations defined for the application.
displayName Display Name Any printable text Each transmit configuration defined in the application is listed in the Transmit Dialog on the Agentry application, so choose an appropriate Display Name that is meaningful to the application end user.

connectType

Connect Type

WebSockets over HTTPS

Communications protocol used when synchronizing with SAP Mobile Platform Server.

xmitConfigGroup Group Transmit Configuration Group Name Group into which the transmit configuration is organized within the application. There are two default options, Fast and Slow, or you can create a new group by entering a name in this field. Any group name you enter here becomes available to all transmit configurations within the same application project.
failoverTo Failover to Name of other transmit configuration definition. You can select a failover transmit configuration to be used if an Agentry application cannot connect to a server using the first transmit configuration. You can assign this attribute to any other transmit configuration within the application.
checkDataTables Check Data Tables true/false Specifies whether the data tables within the application are synchronized when the transmit configuration is used. .
checkComplexTables Check Complex Tables true/false Specifies whether complex tables within the application are synchronized when the transmit configuration is used.
keepAlivePeriod Keep Alive Period Value in seconds (the default is 0, meaning no keep-alive messages)
Determines how often a keep alive message is sent by either the client or the server. Keep alive messages are sent only for transmit configurations that are defined to "stay connected", which means that either background sending, and/or pushes must be enabled.
  • If pushes are enabled, the server sends the keep alive message to the client. For example, when keepAlivePeriod=45, the server sends a keep alive message to the client every 45 seconds.

  • Otherwise, if only background sending is enabled, the client sends keep alive messages to the server. For example, when keepAlivePeriod=60, the client sends a keep alive message to the server every 60 seconds.

  • If set to the default value of 0, no keep alive messages are sent.

Table 15: Session Attributes
Override Item Setting Acceptable Value Description

trackXmitEvents

Track Transmit Events

true/false

Whether to track transmit events.

stayLoggedIn Stay Logged In   Keep the client user logged in and the application connected to the server to support real-time communications within the mobile application, which includes background sending and push behaviors. Set this attribute when an Agentry application requires a constant network connection to the back-end data.
promptOnLogin Prompt on Log In true/false Display a prompt when the connection between the application and the server is lost, and the application attempts to reconnect.
promptOnLogout Prompt on Log Out true/false Display a prompt when the Agentry application is logged out of the server.
serverInactiveTimeoutOverride Inactive Timeout Duration value in number of seconds. Specifies the time limit, in seconds, to keep the application connected to the server, both when there is no data transmission activity between the client and server, and during an actual transmit. If you experience frequent disconnects, increase this number.
attemptOnlinePeriod When Off-line

-1: Stay offline

1+: Attempt to work online every [1+] seconds

If the connection to the server is lost, indicates whether to stay offline or attempt to reconnect at the specified interval.
onlineRetryAttempts Attempts Number of attempts to connect to server. If you select to reconnect when offline, indicate the number of attempts to reconnect. If the number of reconnect attempts fail, the way the application responds depends on the Transmit Configuration attributes you defined. For example, the application can display a prompt or switch to the failover transmit configuration.

reconnectAttemptPeriod

Reconnect Attempt Period

Duration value, in number of seconds

If online, indicates how often the client should try to reconnect.

retryPeriod

Retry Period

Duration value, in number of seconds

If the connection to the server is lost, indicates how long to attempt to reconnect.

synchronousPlaySuccessSound

Synchronous Play Success Sound

true/false

Whether to play a sound on synchronous success.

synchronousPlayFailureSound

Synchronous Play Failure Sound

true/false

Whether to play a sound on synchronous failure.

synchronousFailureSound

Synchronous Failure Sound

string

Identifies the file name for the failure sound to play, if enabled. If left blank, a default error beep is used.

synchronousSuccessSound

Synchronous Success Sound

string

Identifies the file name of the success sound to play, if enabled. If left blank, a default "OK" beep is used.

Table 16: Background Sending
Override Item Setting Acceptable Values Description
backgroundConnection Allow background sending from client true/false

Whether to allow Agentry clients to send transactions in the background. When background sending is enabled, clients remain logged into the server, and send completed transactions in the background while a user continues to work online. When a user works offline, transactions are sent when a connection is available.

retryPeriod

Retry Period

Duration in number of seconds

If background sending is enabled, specifies the amount of time, in seconds, to wait before attempting to resend a failed message.

retryAttempts

Retry Attempts

Number of background sending attempts to connect to server

If background sending is enabled, specifies the number of times the client should attempt to resend a failed message.

Table 17: Push
Override Item Setting Acceptable Values Description
  Allow server to push data to client None
Allow the server to push data to the application. A definition for the Pushes module must exist for the application. Users connecting to the server are logged in as push users.

retryPeriod

Retry Period

None

If "Allow server to push data to client" is selected, this attribute specifies how long the server waits before attempting to resend data for a push when a failure occurs.

attempts

Attempts

None

If "Allow server to push data to client" is selected, specifies how many attempts to push data to the application when a failure occurs.

Table 18: Modem Settings
Override Item Setting Modem Attribute Description
networkConnectionCheck Check for Modem Connection true/false Whether the Agentry application checks for a modem connection when using the transmit configuration prior to beginning the transmit.
networkConnectionName Connection Name Name of Windows network connection. Two options:
  • Any dial-up connection requires a user to establish the network connection manually outside the mobile application before beginning the transmit. The remaining modem connection attributes are disabled.
  • Name of any Windows network connection that is configured on the client device. This option uses the settings of the specified connection to establish the modem connection to the network.
connectNetwork If Not Connected true/false Specifies that the application attempt to create a connection using the specified Windows network connection when there is no current connection. If this option is not selected, the remaining modem connection attributes are disabled.
networkConnectionPrompt Connect Prompt Any printable text. Carriage returns not allowed. Text auto-wrap on the client. Provides instructions to the user on the client prior to attempting to create a modem connection. Leave blank if no message is required.
dialUsernamePrompt Prompt User for Dial-up Username true/false Prompts the user to enter a user name for the network connection, which is used as the login name for the network connection once the modem’s hand-shaking processes are successful. If this option is not selected, the Agentry application login is used.
dialPasswordPrompt Prompt User for Dial-up Password true/false Prompts the user to enter a password for the network connection. If this option is not selected, the Agentry application password is used.
modemInitWait Modem Init Wait Duration value, in milliseconds Specifies the amount of time, in milliseconds, to wait for the client device’s modem to initialize before beginning the dial-up process.
postConnectWait Post-connect Wait Duration value, in milliseconds Specifies the amount of time, in milliseconds, to wait after the network connection is made before beginning the transmit process between the client and server.
closeConnectionPeriod Close Connection Duration value, in seconds. Specifies when to close the modem connection once no more data is being transmitted between client and server:
  • Never
  • If the connection is idle for the specified number of minutes and seconds.

remindToTurnOnModem

Remind to Turn On Modem

true/false

Whether to remind user to turn on modem.

remindToTurnOffModem

Remind to Turn Off Modem

true/false

Whether to remind user to turn off modem.