Transmit Configuration

The transmit configuration defines how the application on the Agentry Clients can communicate with the Agentry Server. It can define what application-level data definitions to synchronize and the address and port number of an Agentry Server. It also defines whether to log a user out of the Server when a transmit has completed, or to keep them connected to provide real-time communications functionality.

The areas of the communications behavior include:
  • The Agentry communications protocol to be used.
  • What actions to take, if any, in the event of a communications error.
  • Whether or not data tables and complex tables should be synchronized.
  • Address and port numbers for the Agentry Server and Midstation.
  • Whether or not the client should remain logged in for real-time communications.
  • Various aspects of using a modem, such as the Windows Network connection to use, what to do if not currently connected, and other related behaviors.

A transmit configuration is defined for an available communications method on the client device. As an example, if a wireless LAN connection will be available to client devices in the deployment, a transmit configuration for this connection should be defined. If a wireless WAN connection is also available, a transmit configuration should also be defined for this connection type.

Each transmit configuration defined in the application will be listed in the built-in screen called the Transmit Dialog on the Agentry Client. For this reason it is important to consider the proper setting for each transmit dialog’s Display Name, as it is this value that will be listed to the user.

Within the transmit configuration’s attributes is the Connect Type. This attribute can be set to one of three options:
  • Agentry Next Generation Encryption Layer, or ANGEL.
  • Midstation
  • Unencrypted Network Connection

Each of these connection types perform communications using the TCP/IP protocol. The connection type refers to the type of connection in the context of the application to be used when the transmit configuration is selected by the user on the client application.

Syclo recommends the ANGEL connection for all applications developed going forward. Applications developed using versions of the Agentry Mobile Platform prior to 4.4 being upgraded to the latest platform should be modified so that all transmit configurations use the ANGEL connect type. The Midstation and unencrypted Network Connection types are still available for the purposes of backwards compatibility and will be deprecated in a future release of the platform.

Transmit Configuration Attributes

General Settings:
  • Name: This is the unique name of the transmit configuration. This value must be unique among all transmit configurations defined for the application.
  • Display Name: This is the text displayed to the user on the Agentry Client for the transmit configuration in the Client’s Transmit Dialog.
  • Connect Type: This is the communications protocol the Agentry Client is to use when synchronizing with the Agentry Server The options here are ANGEL or Unencrypted Network Connection. This attribute will not be definable in a future release of Agentry and all transmit configurations will use the ANGEL protocol.
  • Group: This is the group into which the transmit configuration is organized within the application. This designation is provided for organizational purposes, and there are two options available by default: Fast and Slow. A new group can be created by entering a name in this field. It will then be available in this same drop down for all transmit configurations within the same application project.
  • Failover to: This attribute can be set to any other transmit configuration within the application. When set the Agentry Client will switch to the selected transmit configuration if it is unable to connect the Agentry Server using the first transmit configuration.
  • Check Data Tables: This attribute specifies whether or not the data tables within the application should be synchronized when the transmit configuration is used. This is normally unchecked for transmit configurations intended for slower connection types.
  • Check Complex Tables: This attribute specifies whether or not the complex tables within the application should be synchronized when the transmit configuration is used. This is normally unchecked for transmit configurations intended for slower connection types.
Server Address Settings:
  • Address: This attribute can be set to the IP address or network name of the host system for the Agentry Server. When set to default, the host will be the one entered by the user on the Client during the initial transmit.
  • Port: This attribute can be set to the port number of the Agentry Server with which the Client is to connect using the transmit configuration. This is normally set to allow for multiple Agentry Servers running on the same host system, or to allow access through a firewall between the Client and Server.

Transmit Configuration - Session Attributes

General Settings:
  • Stay Logged In: This attribute controls whether the client user will remain logged in and the Agentry Client will remain connected to the Agentry Server. The purpose of setting this attribute is to support real-time communications within the mobile application, which includes Background Sending and Push behaviors. This requires a constant network connection be available to the Client’s. This attribute must be set for any of the other Session attributes to be enabled for the transmit configuration.
  • Prompt on Log In: This attribute applies when a the connection between the Agentry Client and Agentry Server is lost, and when the transmit configuration is defined to attempt to reconnect. A prompt can be displayed to the user in this situation when the connection is re-established, or hidden from the user based on this attribute setting.
  • Prompt on Log Out: This attribute controls whether or not the user is prompted when the Agentry Client is logged out of the Agentry Server. When set to false, no prompt is displayed. This only applies when the connection for the transmit configuration is lost and the transmit configuration is set to stay logged in.
  • Inactive Timeout: This attribute specifies the time limit, in hours, minutes, and seconds, the Agentry Client should remain connected to the Agentry Server with no activity. Activity is defined as the transmission of data between the Client and Server.
  • When Off-line: This attribute controls whether or not the Agentry Client should attempt to reconnect to the Agentry Server when the connection has been lost. If the Client should reconnect, the duration of time to wait before attempting to reconnect is set in minutes and seconds.
  • Attempts: This numeric attribute is set only when the When Off-line attribute is set to reconnect. The attempts attribute defines how many attempts to make before failing. If the number of attempts is tried without success, the behavior of the Agentry Client is dictated by the transmit configuration’s Failover to attribute, as well as the Prompt on Log In/Log Out attributes.
Background Sending:
  • Allow: This attribute enables background sending of pending transactions on the Agentry Client. When this attribute is enabled the Client will attempt to send transactions to the Agentry Server in the background as soon as they are applied.
  • Retry Period: This attribute specifies the amount of time in hours, minutes, and seconds to wait between failed attempts to send a transaction in the background.
  • Attempts: This specifies the number of attempts to make at sending a transaction in the background before failing.
Push Session:
  • Allow: This attribute enables Server Push functionality. This functionality also requires the definition of a push within a module of the application. When enabled, users connecting the server using the transmit configuration will be logged in to the Agentry Server as a Push User. This also opens the Agentry Client to receiving push data.
  • Retry Period: This attribute specifies how long the Agentry Server should wait before attempting to re-send data for a push when a failure occurs.
  • Attempts: This attribute specifies how many attempts the Agentry Server should make to re-push data before failing.
  • Client Port: This attribute specifies the port upon which the Agentry Client listens for push communications from the Server. The default port is 7001.

Transmit Configuration - Modem Connection Attributes

  • Check for Modem Connection: This attribute specifies whether or not the Agentry Client should check for a modem connection when the transmit configuration is used. If true, this check is made prior to beginning the transmit. This attribute must be true for any of the remaining modem attributes to be enabled.
  • Connection Name: This attribute can be set to the name of any Windows network connection configured on the client device. It can also be set to Any Dial-Up Connection. In the case of the former, it will use the settings of the named connection to establish the modem connection to the network. If set to “Any Dial-Up Connection,” the user will be required to establish the network connection manually outside the mobile application before beginning the transmit. In this case, the remaining modem connection attributes are not enabled.
  • If Not Connected: This attribute specifies whether the Agentry Client should attempt to create a connection using the Windows network connection named in Connection Name when there is no current connection. If this is set to false, the remaining modem connection attributes are disabled.
  • Connect Prompt: This attribute is set to the message to display to the user prior to the Agentry Client attempting to create a modem connection. If this attribute is left blank, no message will be displayed to the user prior to creating the connection. Normally the contents of this message prompt the user to connect a phone line or perform similar actions in order for the connection to be made.
  • Username: This attribute prompts the user to enter a user name for the network connection. This will be used as the login name for the network connection once the modem’s hand shaking processes are successful. If this is set to false, the users Agentry Client login will be used.
  • Password - This attribute prompts the user to enter a password for the network connection. If this attribute is set to false, the users Agentry Client password will be used.
  • Modem Init Wait: This attribute specifies the amount of time in milliseconds the Agentry Client should wait for the client device’s modem to initialize before beginning the dial-up process.
  • Post-connect Wait: This attribute specifies the amount of time in milliseconds the Agentry Client should wait after the network connection has been made before beginning the transmit process between the Client and Agentry Server.
  • Close Connection: This attribute specifies whether the connection made by the transmit configuration should be closed if no data has been transmitted between the Agentry Client and Agentry Server for the specified amount of time. The attribute can be set to Never, meaning the connection will not be closed, or to the minutes and seconds to wait before closing the connection.
Parent topic: Application Level Definitions Overview