Action Step Type: Transmit
The transmit action step type initiates communications between the Agentry Client and Agentry Server. This includes displaying the Client’s built-in transmit dialog where users can select a transmit configuration and begin the transmission. Alternately the transmit step can be defined to begin the transmission automatically and to hide the transmit dialog unless an error is encountered. The transmit step also defines the non-main fetches to be processed, if any.
Each module will contain at least on action with a defined transmit step. Additional actions may defined as needed that include transmit steps for various purposes.
The transmit step can be defined to start transmission between the client and server automatically. The default behavior is to display the Client’s Transmit Dialog, where the user can select a transmit configuration and then start the transmit. When the transmit step is defined to automatically start the transmission, the transmit will begin when the step is executed. The transmit configuration used will be the last one selected by the user; optionally the transmit step can define the transmit configuration to be used.
The transmit step can also be defined to automatically finish the transmit. By default when a transmit is complete, the user must close the Transmit Dialog by clicking the finish button. The transmit step can close this screen automatically when the transmit completes successfully.
If the transmit step is defined to automatically start and finish the transmit, it can also be defined to hide the Transmit Dialog. In this case, the dialog will not be displayed to the user unless an error occurs during the transmission.
The transmit step is where non-main fetches must be selected for processing. The main fetches of a module will always be run when a transmit occurs. A non-main fetch must be explicitly selected in a transmit step and will only be processed when that transmit step is executed.
A transmit step can be defined to skip fetch processing altogether. This can only be defined when the step is first defined to use a transmit configuration for which real-time communications have been defined. The transmit step can then be defined to simply connect the user to the Server, process any pending transactions, and the remain connected to receive push data and/or to allow for background sending. Note that this behavior can negatively impact the push functionality if the push is defined to use exchange data initially generated by a fetch. This exchange data will not exist as the fetch will not be processed.
Transmit Step Attributes
- Step Name: Contains the unique internal name of the step definition. This value must be unique among all step definitions within the same parent action.
- Transmit Config: This attribute can be set to a specific transmit configuration within the application. If a transmit configuration is selected here, the user will not be able to change the transmit configuration when the transmit step is executed.
- On-line/Off-line: This attribute specifies whether to change the on-line state of the client when the transmit step is executed. This will override any selection the user makes on the client for this state. It will also override the on-line state of the client if it is set to Off-line as the result of a disconnect.
- Initiate Asynchronous Transmit Only: This attribute is only available if the Transmit Config attribute is set to a transmit configuration defined to support real-time communications. If this attribute is set to true, no fetches will be processed during the transmit. Pending transactions will be sent to the Server to be processed and complex table and data table definitions will be synchronized.
- Allow user to skip: This attribute allows the user to skip the transmit. This is normally only set when the parent action contains multiple step definitions, including the transmit step. The user may skip the transmit behavior when this attribute is set to true and when the client is in an Off-line state.
- Automatically start transmission: When this attribute is true, the transmission between the client and server will begin automatically when the transmit step is executed. The default is to require the user to click the Start button in the Transmit Dialog to being the transmission.
- Automatically finish transmission: When this attribute is true, the Transmit Dialog will be closed automatically when the transmit has completed successfully. The default is to require the user to click the Finish button in this dialog when the transmission has completed.
- Hide transmission screen: This attribute is available only when the Automatically start transmission and Automatically finish transmission attribute are both true. The Hide transmission screen can then be set to true, which will result in the Transmit Dialog not being displayed when the transmit step is executed. The Transmit Dialog is always displayed if an error occurs during transmission, regardless of this attribute setting.
- Hide Screen Timeout: This attribute is available only if the Hide transmission screen attribute is set to true. This timeout value is set in minutes and seconds. If the transmission takes longer than the duration entered in Hide Screen Timeout, the Transmit Dialog will be displayed to the user indicating the progress of the transmission. This timeout value should be selected based on the typical duration of a transmit for the application.