Show TOC

ModuleLocate this document in the navigation structure

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
  • Objects - An object definition encapsulates a business entity and its related data.
  • Screen Sets - The screen set is the main Client user interface definition and defines what definition type its child screens display.
  • Transactions - 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.
  • Actions - An action defines navigation and user interaction for the Agentry Client, bringing the other components of the Client’s UI together.
  • Rules - A rule defines evaluation logic processed on the Agentry Client that returns a single value to the caller of the rule.
  • Fetches - A fetch defines how SAP Mobile Platform Server synchronizes data for a target object collection by referencing the step definitions to perform this task.
  • Steps - A step defines a piece of processing to be performed by SAP Mobile Platform Server with a specific back-end system.
  • Reports - A report defines a printed tabular report format for the contents of an object collection on the Agentry Client.
  • Pushes - 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.
  • Service Events - A service event defines how SAP Mobile Platform Server synchronizes data between two back-end systems, usually based on a change or “event” occurring in one of the systems.
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.
Module Styles Attributes
Screen Set Styles
  • Header: The style to apply to the header when there are multiple screens within an object screen set. Different screen styles help Agentry Client users distinguish between the header area of a multiple screen set and the tabs for that screen.
Screen Styles
  • Tabs: The style to apply to the tab controls representing each screen within an object screen set. This attribute has no effect on screens within a transaction or fetch screen set.
  • Buttons: The style to apply to all button definitions on all module screens. This includes buttons that appear on built-in Agentry Client screens as well as buttons within screen definitions.
  • Focused Buttons: The style to apply to the button that currently has the focus. This includes buttons that appear on built-in Agentry Client screens as well as buttons within screen definitions.
Detail Screen Styles
  • Screen: The style to apply to all detail screens defined within the module. This affects all portions of the screen that do not show any fields or buttons.
  • Fields: The style to apply to all fields that appear on a detail screen.
  • Focused Fields: The style to apply to the detail screen field that currently has the focus.
  • Read-Only Fields: The style to apply to a detail screen field that is defined to be read-only. If not specified, the Fields style is applied.
  • Hyperlinks: The style to apply to detail screen field labels that are defined to be hyperlinks.
  • In Progress Edit Screens: The style to apply to screens in which changes are currently being made and have not yet been applied. This affects screens displayed in List Tile View and Tile Edit fields.
List Screen Styles
  • Screen: The style to apply to all list screens defined within the module. This affects all portions of the screen not displaying a list, header label, detail pane, or button.
  • Header Label: The style to apply to all list screen header labels. If no header label is defined this attribute has no effect on the screen.
  • Column Labels: The style to apply to the column labels on the screen’s list control. This style is applied to the column labels of any screen containing a list control, including both built-in Agentry Client screens as well as list screen definitions, and list view field definitions.
  • Rows: The style to apply to all rows on a list screen. The Hyperlinks optional style overrides the Rows style for cells with hyperlinks. This style is applied to the list items of any screen containing a list control, including built-in Agentry Client screens, list screen definitions, and list view field definitions.
  • Alternate Rows: The style to apply to every other row in a list, beginning with the second row. The Hyperlinks optional style overrides the Alternate Rows style for every other row where there are cells containing hyperlinks.
  • Highlight Rows: The style to apply to a row for the purposes of drawing attention to that row. Do not set this style attribute at the application level. The platform and list screen definition types both contain a Highlight Rows attribute that should be used.
  • Selected Rows: The style to apply to the row or rows currently selected by the user in the list control. The optional Hyperlink style is applied to any cells within the selected row containing a hyperlink.
  • Selected No Focus Row: The style to apply to the row or rows currently selected by the user in the list control, when the input focus is set to some control other than the list control. The optional Hyperlink style is applied to any cells within the selected row containing a hyperlink.
  • Detail Pane: The style to apply to both the foreground (text) and background of a list screen’s detail pane. If no detail pane is defined, this attribute has no effect on the screen.