Module

The module definition is a grouping of definitions providing functionality that logically belongs together. The module’s attributes and child definitions define the majority of the behavior and functionality exhibited on the Agentry Client at runtime.

The modules of an application contain the functionality related to the user interface on the Agentry Client, data storage and structures, data synchronization, and data capture. The child definitions of a module also have access to all application-level definitions.

An application project must contain at least one module. When multiple modules are defined for an application, users will be required to select which module to work with when logging into the Agentry Client application. They will be able to switch from one module to another using the Agentry Client’s View menu, which will list the defined display name for each module within the application.

The module’s child definitions are primarily intended to work with other definitions within the same module. Cross-module functionality can be defined using actions within one module that may execute actions of another module within the same application.

Module Child Definitions

• Action - An action defines navigation and user interaction for the Agentry Client, bringing the other components of the Client’s UI together.
• Fetch - A fetch defines how the Agentry Server synchronizes data for a target object collection by referencing the step definitions to perform this task.
• Object - An object definition encapsulates a business entity and its related data.
• Push - A push defines when it is necessary to push an object in real time from the back end system to the Agentry Client and how that object’s data is retrieved.
• Report - A report defines a printed tabular report format for the contents of an object collection on the Agentry Client.
• Rule - A rule defines evaluation logic processed on the Agentry Client that returns a single value to the caller of the rule.
• Screen Set - The screen set is the main Client user interface definition and defines what definition type its child screens display.
• Service Event - A service event defines how the Agentry Server synchronizes data between two back end systems, usually based on a change or “event” occurring in one of the systems.
• Step - A step defines a piece of processing to be performed by the Agentry Server with a specific back end system.
• Transaction - A transaction definition defines what data is captured on the Client, how that data affects a target object instance on the Client, and how the captured data is processed by the Agentry Server.

Module Attributes

• Name - This is the unique name of the module. This value must be unique among all modules defined within the application.
• Display Name - This is the text displayed to the users on the Agentry Client application at runtime. This value appears in the Agentry Client’s Module Selection Screen to represent the module and also appears in the View menu of the Agentry Client as a menu item.
• Preserve Objects - This attribute specifies whether or not the objects within the module will be preserved when a new user logs into the Agentry Client on the same device as a previous user. If checked, the objects will be preserved from one user to the next. If left unchecked, a user change will result in the objects being removed prior to synchronizing object data for the new user.
• Image: Specifies the image definition to associate with the module definition. This image is then displayed for the module in the Agentry Client’s Module Selection Screen displayed after login for multi-module applications.
• Successful Login Action: Specifies an action defined within the module to be executed after a user successfully logs into the application. The action executed here targets the module main object. For multi-module applications where more than one module defines a Successful Login Action, the order in which those actions are executed is undefined.
• Application Exit Action: Specifies an action defined within the module to be executed just prior to exiting the application. The action executed here targets the module main object. For multi-module applications where more than one module defines an Application Exit Action, the order in which those actions are executed is undefined.