Developer

Platform

Platform is one of the Agentry Client user interface definitions.

A platform definition defines how a screen set’s screens appear on a specific device type. A platform is defined to use one or more screens within the same parent screen set. There are different platform types, each corresponding to a different type of client device. The platform affects the placement of buttons and the form factor of the screens it uses.

The most important attribute to the platform definition is the Platform type. A given screen set can contain one or more platform definitions. At least one platform must be defined before screens can be added to the screen set. During publish, at least one screen must be used by at least one platform within the screen set, or the publish cannot proceed.

A platform can use more than one screen within the same screen set. A screen can be used by more than one platform as well. At runtime, when a screen set definition is sent to a client, the platform definition for the client’s device type determines which screens that client receives.

Platform Attributes

Table 16: General Settings
Attribute Description
Platform Type The device platform definition for the specified screen set. The specified platform affects the form factor and behavior of the screens.
Caption Title text displayed in the window on the Client at runtime for the screen set, which can be different for different platforms. You can set this statically or via a rule definition for more dynamic text. A rule returns a string value and is evaluated in the context of the object displayed by the screen set.
Screen Rule Select an existing rule or create a new rule to apply to the screen set for this platform definition. Rules specified in this field return a string set to the name of one of the screens in the screen set. In this case, any Tile Display controls referencing this screen set display only the screen returned by the rule.
Size (Applies to Windows desktop, laptop, and tablet operating systems) Specifies the initial display size of the screens it uses. For other Platform Types, all screens used by the platform are displayed in the full screen size of the device type. This attribute can be overridden by the application definition’s Screen Size attribute.
Button Placement Specifies where to display the buttons for all screens that the platform uses: Bottom, Top, Left, or Right.
List Navigation Determines whether the object displayed by the screens can be changed via navigation buttons drawn automatically on the Client. If selected, a user can change the object displayed in the current screen set based on a list of objects in the previous screen in the navigational flow. In this previous list, the previous or next item in the list is selected and the action executed to display the current screen set is executed again. This attribute has no effect on platforms for the module main screen set or for platforms within screen sets displaying a transaction or fetch. This behavior is applicable when the previous screen was a list screen, or when it was a detail screen containing a list view or list tile view field.
Screen Navigation By default, the screens display as tabs on the Client at runtime. If you select this option, the screens display a menu button containing the caption value of each screen definition to allow the user to select different screens. For the Screen Navigation option, when a user taps on a screen caption, a slide menu list appears instead of tabs.
Max Number of Tabs

The number of tabs displayed on the client, before a More tab is added to list the remaining screen names in a menu.

(Applies to iOS desktop, laptop, and tablet operating systems) Select Auto to automatically insert the More tab, based on the room available on the particular device.

Built-in Margins (Applies to iOS desktop, laptop, and tablet operating systems) By default, the built-in iOS screen margins and rounded corners for the field border are displayed. Deselect this option to eliminate the margin and border.
The following attributes are only valid for platforms of type iPad or Android and support the display of a popup screen using the platform’s screens.
Table 17: Platform Screen Type
Attribute Description
Screen Types
  • Full Screen creates standard screens on the Client.
  • Overlay View creates popup screens that overlay the screen from which the user navigated. These screens can be used for both read-only information as well as for data capture. When Overlay View is selected, the Height and Width attributes are enabled to specify the size of the overlay screen.
Height The vertical size of the overlay screen in pixels.
Width The horizontal size of the overlay screen in pixels.

Platform Style Attributes

The style attributes of a platform specify the styles applied to different aspects of the screens used by the platform. Style definitions must exist before these attributes can be set. The final appearance of the screen is affected by the overall application of styles according to the style hierarchy. There are three groups of style elements for the platform: Screen Styles, Detail Screen Styles, and List Screen Styles. Screen styles affect all screens used by the platform regardless of screen type. Detail screen and list screen styles affect only those screens of the corresponding type.

You can select style attributes for the platform definition by selecting the style from a list, or by returning the name of a style to apply from a rule definition. Rules evaluated for style attributes are expected to return a string value containing the name of the style to apply, and are evaluated in the context of the object displayed by the parent screen set. If no styles are defined, the default styles from the actual client device platform are used.

Table 18: Screen Set Styles
Attribute Description
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.
Table 19: Screen Styles
Attribute Description
Tabs The style to apply to the tab controls representing each screen within an object screen set. Has no affect on screens within a transaction or fetch screen set.
Buttons The style to apply to all button definitions for screens used by the platform.
Focused Buttons The style to apply to the button that currently has the focus.
Table 20: Details Screen Styles
Attribute Description
Screen The style to apply to the screen as a whole, which affects all portions of the screen not displaying a field or button.
Fields The style to apply to all fields displayed on the screen.
Focused Fields The style to apply to the field that currently has the focus.
Read-Only Fields The style to apply to read-only fields.
Hyperlinks The style to field labels defined to be hyperlinks.
In Progress Edit Screens The style that is used when the screen set is referenced by a Tile Edit control. In that case, once a field is changed, the in-progress edit style is applied. For example, the background could change colors so the user knows the data has changed and should be saved or canceled.
Table 21: List Screen Styles
Attribute Description
Screen The style to the list screen as a whole, which affects all portions of the screen not displaying a list, header label, detail pane, or button.
Header Label The style to apply to the list screen’s header label, if a header label exists.
Column Labels The style to apply to the column labels on the screen’s list control.
Rows The style to apply to all rows on the list screen. The Hyperlinks optional style overrides this style for cells with hyperlinks.
Alternate Rows The style to apply to every other row in the list, beginning with the second row. The Hyperlinks optional style overrides this style for cells with hyperlinks.
Highlight Rows The style to apply to a row for the purposes of drawing attention to that row. Return this style using a rule definition that evaluates the object being listed. The Hyperlinks optional style overrides this style for cells with hyperlinks.
Selected Rows The style to apply to the row currently selected by the user in the list control. The Hyperlinks optional style overrides this style for cells with hyperlinks.
Selected No Focus Rows The style is used for list items that are selected, yet the list control displaying those items is not in focus. For example, a screen could have multiple list controls with one list in focus; however, it still needs to be clear which items have been selected in both lists. The Hyperlinks optional style overrides this style for cells with hyperlinks.
Detail Pane The style to apply to both the foreground (text) and background of the list screen’s detail pane, if one exists.

Platform Button Attributes (Wizard Buttons)

This tab only appears for platforms using Transaction Screen sets. Platforms defined within a screen set displaying a transaction or fetch include an additional set of attributes related to the buttons displayed on screens. Screens within this type of screen do not contain button definitions, but rather contain buttons added to each screen automatically by the Client based on the action that displayed the parent screen set and the position of each screen within the screen set.
Table 22: Wizard Button Attributes
Attribute Description
Cancel Action Details The label for cancel buttons that cancel the action currently being executed.
Previous Screen Details The label for buttons that allow users to navigate to the previous screen in the current screen set.
Previous Record Details The label for buttons that allow users to navigate to the previous transaction instance. This button is displayed on the first screen of a screen set when being displayed by an action with looping behavior.
Next Screen Details The label for buttons that allow users to navigate to the next screen in the current screen set.
Next Screen (no back up) Details The label for buttons that allow users to complete the current instance of a wizard in a loop and start the next iteration; or to move from one wizard to the next when multiple wizards are displayed by the action.
Complete Action Details The label for buttons displayed on the last screen of a screen set, when there are no additional screen sets displayed by the action and when the current screen set is not being displayed in a loop.
Complete Action Details The label for buttons displayed on the last screen of screen set being displayed in a loop and that ends that loop.

Platform Screens List

The Properties view for a platform definition within the Agentry Editor includes a Screens tab. This tab lists all screens within the same parent screen set of the platform, from which you can select which screens to use for the platform definition. The screens listed here are children of the screen set.