Show TOC

Transmit ConfigurationLocate this document in the navigation structure

The transmit configuration defines how the application on an Agentry application communicates with the server. It can define what application-level data definitions to synchronize, whether to log out a user from the server when a transmit has completed, or to keep the connection to provide real-time communications functionality.

The decisions to make when defining a transmit configuration include:
  • What actions to take, if any, in the event of a communications error.
  • Whether or not data tables and complex tables are synchronized.
  • Whether or not the client remains logged in for real-time communications.
  • How the application behaves if using a modem, what to do if not currently connected, and when to close the connection.

Define a transmit configuration for all available communications methods on the client device. For example, if a wireless LAN connection is available to client devices in the deployment, define a transmit configuration for this connection. If a wireless WAN connection is also available, define a transmit configuration for this connection.

Development Workflow
  1. In the application project, create a text file called TransmitConfigurations.ini.
  2. Modify the file to include a section for each transmit configuration to override called [<TransmitConfigurationName>], and any override attributes. Include the file when you publish the project for production. See Publishing to Production in Developer > Agentry App Development.
  3. In Management Cockpit, import the project ZIP file on the server.
  4. In Management Cockpit, select the application and navigate to App Specific Settings. Under Configuration, make sure the Transmit Configuration File setting points to this file location.
  5. Restart the application on each server to initiate the changes.
Note
  • For a production workflow, coordinate Management Cockpit activities with the Administrator.

  • Make changes to the TransmitConfigurations.ini file in the development environment, not on SAP Mobile Platform Server, and publish a new ZIP file in Management Cockpit. Do not modify the file on the server, or it will be overwritten when you upgrade the server.
  • Restart each server in a cluster to distribute the changes.
TransmitConfigurations.ini

Within the TransmitConfigurations.ini file there is one section for each transmit configuration defined within the application, denoted as [<TransmitConfigurationName>], 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
synchronousRetryAttempts=5
synchronousRetryPeriod=30
serverInactiveTimeoutOverride=300

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

When using this override file for multiple Agentry applications, each server should have its own version of this file with its required configuration settings unique to that server instance.

Transmit Configuration Attributes

For additional information about the definition attributes, see Configuring the Transmit Configuration File for Agentry Applications in Administrator > Application Administration .

Table 1: General Settings
Setting Description
Name The unique name of the transmit configuration. This value must be unique for all transmit configurations defined for the application.
Display Name 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 clear to the application end user.
Connect Type WebSockets over HTTPS, which is the communications protocol used when synchronizing with SAP Mobile Platform Server.
Group The group into which the transmit configuration is organized within the application. Two default options are provided, Fast and Slow, or you can create a new group by entering a name in this field. It is then available in the drop-down list for all transmit configurations within the same application project.
Failover to If the Agentry application is unable to connect to the server using the first transmit configuration, you can select a failover transmit configuration. You can set to this attribute to any other transmit configuration within the application.
Check Data Tables Specifies whether the data tables within the application are synchronized when the transmit configuration is used.
Note Consider not selecting this attribute for transmit configurations intended for slower connection types.
.
Check Complex Tables Specifies whether complex tables within the application are synchronized when the transmit configuration is used.
Note Consider not selecting this attribute for transmit configurations intended for slower connection types.
Table 2: Server Address Settings
Setting Description
Address Disabled for WebSockets.
Port Disabled for WebSockets.
Transmit Configuration - Session Attributes
Table 3: Session Settings
Setting Description

Track Transmit Events

Whether to track transmit events.

Stay Logged In Select to indicate that the client user remains logged in and the application remains 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. The serverInactiveTimeoutOverride is now used during stay connected, and during an actual transmit.
Prompt on Log In Select to display a prompt when the connection between the application and the server is lost, and the application attempts to reconnect.
Prompt on Log Out Select to display a prompt when the Agentry application is logged out of the server.
Inactive Timeout 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.
When Off-line If the connection to the server is lost, indicates whether to stay offline or attempt to reconnect at the specified interval.
Attempts If you select to reconnect when offline, indicate the number attempts to reconnect. If the reconnect attempts fail, how 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.

Reconnect Attempt Period

If online, the period of time in seconds the client should try to reconnect.

Retry Period

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

keepAlivePeriod Disabled for WebSockets.

Synchronous Retry Period

How often to retry a synchronous transmit in seconds.

Synchronous Retry Attempts

Number of retries to make in a synchronous transmit.

Synchronous Play Success Sound

Whether to play a sound on synchronous success.

Synchronous Play Failure Sound

Whether to play a sound on synchronous failure.

Synchronous Failure Sound

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

Synchronous Success Sound

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

Table 4: Background Sending
Setting Description
Allow background sending from client Enables background sending of pending transactions from the application to the server as soon as they are applied.
Note You must set this attribute before you can set the other Background Sending attributes for the transmit configuration.
Retry Period If background sending is enabled, specifies the amount of time in hours, minutes, and seconds to wait between failed attempts to send a transaction.
Retry Attempts If background sending is enabled, specifies the number of attempts at sending a transaction over background sending.
Table 5: Push
Setting Description
Allow server to push data to client Select to allow the server to push data to the application. A Pushes module definition must exist for the application. Users connecting to the server are logged in as Push Users.
Note You must set this attribute before you can set the other Push attributes for the transmit configuration.
Retry Period If Allow Server to Push Data to Client is selected, specifies how long the server waits before attempting to resend data for a push when a failure occurs.
Attempts If Allow Server to Push Data to Client is selected, specifies how many attempts to push data to the application when a failure occurs.
Client Port Disabled for WebSockets.
Transmit Configuration - Modem Connection Attributes
Table 6: Modem Settings
Setting Description
Check for Modem Connection Select to specify whether that the Agentry application checks for a modem connection when using the transmit configuration prior to beginning the transmit.
Note You must set this attribute before you can set the other Modem Connection attributes for the transmit configuration.
Connection Name Two options:
  • Any Dial-up Connection requires that the user establishes the network connection manually outside the mobile application before beginning the transmit. In this case, the remaining modem connection attributes are disabled.
  • Name of any Windows network connection configured on the client device. This option uses the settings of the specified connection to establish the modem connection to the network.
If Not Connected Specifies that the application attempts 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.
Connect Prompt Provides a message or instructions to the user on the client prior to attempting to create a modem connection. Leave blank if no message is required.
Prompt User for Dial-up Username If selected, 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.
Prompt User for Dial-up Password If selected, prompts the user to enter a password for the network connection. If this option is not selected, the Agentry application password is used.
Modem Init Wait Specifies the amount of time in milliseconds to wait for the client device’s modem to initialize before beginning the dial-up process.
Post-connect Wait 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.
Close Connection 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.

Remind to Turn On Modem

Whether to remind user to turn on modem.

Remind to Turn Off Modem

Whether to remind user to turn off modem.