Developer

List Tile View

The list tile view field edit type displays an object collection property in a tiled view allowing for add and edit interaction with the collection through the field. For a given object, the properties of that object can be displayed in the list tile view in tiles within that object’s record. The values of a given object can be edited directly in this list, and new object instances can also be added. This field edit type also supports scan filter functionality.

The list tile view will make use of an existing screen set defined to display the same object type as is stored in the collection being listed by the field. As a part of a list tile view’s definition, a screen set is selected to display the objects within the collection. This screen set must be defined to display the same object type as is found in the collection, and must contain a single detail screen. When the list tile view field is displayed, each object instance within the collection will be displayed within the field in a list. Each tile within the list will be shown in the detail screen from the selected screen set. Two screen sets can be used for read-only display of the objects within the collection. One is used for all rows within the list. The selected row screen set can be defined, with a detail screen containing more fields. This will then be the screen set used to display the selected object.

Similar to this behavior is the ability to add and edit objects for the collection from within the tile view. A transaction for the add and edit behaviors must exist, as must a screen set to be used to display the transactions. When an item is selected in the list, the user can click the add icon button. A new tile will be displayed at the bottom of the list. The screen set in which it will be displayed will be the one defined for the add behavior. For an edit, the user can select an object in the list tile view and click the edit icon button. In this case the currently selected tile will change to use the edit screen set, displaying the edit transaction. The user can change the values on the screen. They can then either cancel or accept the changes they have made.

As alternatives to this behavior, an action can be specified for both add and edit behaviors. When the action is executed it will dictate the behavior, displaying the add or edit transaction in the wizard screen set just as with any other action.

Filtering can be enabled or disabled for the entire list tile view field. When enabled, the properties of the object type being listed are selected. The user will then only be able to filter the list on these properties. When a property is selected for this purpose, a Tile Filter child definition is added to the list tile view. Users will then only be able to filter the items in the list on one of the selected property values.

Related to the manual filtering, this field edit type also supports scanner filtering. A tile filter can be defined to support scanner filtering. When a barcode value is scanned in it will be compared to the values of that tile filter’s property. Only those items that match will be listed. The parent field can then be defined to execute an action when a single item in this list matches the scan filter, and a separate action to execute when no items match.

List Tile View Child Definitions

  • Tile Filters: The tile filter is a child definition to a detail screen field with an edit type of list tile view, defining the values upon which the items listed in the parent field can be filtered.
  • Sort Properties: This child definition is a simple list of the object properties by which the list tile view can be sorted at run time on the Agentry Client. When adding a sort property a selection is made from the properties defined in the object type for the collection which the List Tile View field is defined to display.

List Tile View - Collection/Styles Attributes

The list tile view field edit type does not support the following general field attributes:
  • Object/Transaction Property
  • Format
  • Field Style
  • Focused Field Style
  • Change Focus
  • Update Rule
  • Special Value

The list tile view data and style attributes set the basic behavior of the view, including how styles can be applied to the list tile view field.

General Settings
  • Collection: References the object collection property the list tile view is to display. This collection is normally a property of the object definition the parent screen set is defined to display.
  • Include Rule: References a rule definition expected to return a Boolean value and that is evaluated once for and in the context of each object in the collection displayed by the list view. When an include rule is specified, only those objects for which the rule evaluates to true will be listed in the list tile view.
Styles Settings
  • Header Label: The style to apply to the list tile view’s header label. If no header label is defined this attribute has no affect on the screen.
  • Rows: The style to apply to all rows on the list tile view.
  • Alternate Rows: The style to apply to every other row in the list, beginning with the second row.
  • Highlight Rows: The style to apply to a row for the purposes of drawing attention to that row. This style should always be returned via a rule definition that evaluates the object being listed.
  • Selected Rows: The style to apply to the row currently selected by the user in the list control.

List Tile View - Settings Attributes

Selection Settings
  • Allow Multi-Row Select: Specifies if the user can select more than one record in the list at the same time. If multiple items are selected in a list, actions that target the selected object in the list will be executed once for each selected object. The default for selecting multiple objects requires a Ctrl+Click combination (mouse input) or a click and drag operation (stylus input) by the user, depending on the device type. The Enable Single Click option to this attribute may be set to allow multiple records to be selected with a single click by the user. Deselecting a record requires the user to click it again. This feature is normally most useful on touch screen devices, as it allows non-sequential records in the list to be selected. If this option is enabled the attributes related to editing the objects in the list tile view will be disabled. These objects may still be edited as the selected object in the list tile view, but the action must be executed from a control on the same screen as the list tile view field, rather than from within the list tile view itself.
Action Settings
  • Allow Tile Adds: This attribute specifies whether or not users will be able to add a new object to the collection being displayed by the list tile view field from within the field. When this option is selected, the Add Screen Set and Add Transaction attributes must also be set.
  • Allow Tile Edits: This attribute specifies whether or not uses will be able to edit an object within the collection displayed by the list tile view field. When this option is selected, the Edit Screen Set and Edit Transaction attributes must also be set. Allow Tile Edits is disabled if the attribute Allow Multi-Row Select is enabled for the list tile view field.
  • Allow Single Click Action: This attribute specifies whether to allow for an action to be executed when a tile is selected in the list with a single click. If this attribute is set to true, all default behaviors of the list tile view field for a single click of a tile are disabled, as are the related attributes within the definition. This includes the following attributes:
    • Allow Tile Edits
    • Allow Multi-Row Select/Enable Single Click Selection
    • All attributes in the section Edit Actions/Tiles
Screen Sets
  • Row: This attribute specifies the screen set containing the detail screen to display each object contained in the collection being listed in the list tile view field. The screen set selected here will be used for each tile in the list that is not currently selected. The screen set referenced must be defined for the same object type as is contained in the collection being listed by the list tile view. The screen set must also contain a single detail screen used by the same platform as the parent screen of the list tile view.
  • Selected: This attribute specifies the screen set containing the detail screen to display each selected tile in the list tile view field. The screen set selected here will be used only for a selected tile in the list. The screen set referenced must be defined for the same object type as is contained in the collection being listed by the list tile view. The screen set must also contain a single detail screen used by the same platform as the parent screen of the list tile view.
Add Actions/Tiles
  • Add Screen Set: This attribute is enabled when the Allow Tile Adds attribute is set. Add Scree Set is set to the screen set in which the Add Transaction will be displayed within the list tile view field. This screen set is displayed when the user selects clicks the add icon button for the field, allowing the user to add the values for the new object instance.
  • Add Transaction: This attribute is enabled when the Allow Tile Adds attribute is set. Add Transaction is set to the transaction that will capture the values from the user for the new object instance to be added to the collection being displayed by the list tile view field. The transaction will be displayed in the list tile view field, with the tile using the screen set selected in Add Screen Set.
  • Add Action: This attribute is enabled when the Allow Tile Adds attribute is not set. Add Action can be set to the action to execute when the user clicks the add icon button for the list tile view field. This action will be executed, targeting the object selected in Add Target. The purpose of the Add Action attribute is to execute an action that will add a new object instance to the collection being displayed by the list tile view field.
  • Add Target: This attribute is enabled when the Allow Tile Adds attribute is not set. Add Target is set to the object instance that the Add Action should target when executed. In almost all scenarios the Add Target should be set to the parent object of the collection being listed by the list tile view field.
  • Add Shortcut Key: This attribute is set to the shortcut key combination that will allow the user to add an object to the collection being displayed by the list tile view field. The shortcut key will exhibit the same behavior as if the add icon button for the list tile view field were clicked or tapped by the user, meaning either the defined Add Action will be executed, or the defined Add Screen Set and Add Transaction will be displayed in a new tile in the list tile view field.
Edit Actions Tiles
  • Edit Screen Set: This attribute is enabled when the Allow Tile Edits attribute is set. Edit Screen Set is set to the screen set in which the Edit Transaction will be displayed within the list tile view field for the selected tile. This screen set is displayed when the user selects a tile in the list and clicks the edit icon button for the field, allowing the user to edit the values of the selected object instance.
  • Edit Transaction: This attribute is enabled when the Allow Tile Edits attribute is set. Edit Transaction is set to the transaction that will capture the values from the user to modify the object instance selected in the list tile view field. The edit transaction will be displayed in the list tile view field with the tile using the screen set selected in Edit Screen Set.
  • Edit Action: This attribute is enabled when the Allow Tile Edits attribute is not set. Edit Action can be set to the action to execute when the user clicks the edit icon button for the list tile view field. This action will be executed, targeting the object selected in Edit Target. The purpose of the Edit Action attribute is to execute an action that will allow the user to edit the selected object instance in the collection being displayed by the list tile view field.
  • Edit Target: This attribute is enabled when the Allow Tile Edits attribute is not set. Edit Target is set to the object instance that the Edit Action should target when executed. In almost all scenarios the Edit Target should be set to the selected object instance of the collection being listed by the list tile view field.
  • Edit Shortcut Key: This attribute is set to the shortcut key combination that will allow the user to edit the selected object in the list tile view field. The shortcut will exhibit the same behavior as if the edit icon button for the list tile view field were clicked or tapped by the user, meaning either the defined Edit Action will be executed, or the defined Edit Screen Set and Edit Transaction will be displayed in the selected tile of the list tile view field.
Single Click Action - These attributes are enabled only of the attribute Allow Single Click Action is set to true.
  • Single Click Action: This attribute specifies the action to be executed when the user selects a tile in the list.
  • Single Click Target: This attribute specifies the object to be targeted by the Single Click Action when it is executed.

List Tile View - Filter/Sort Attributes

General Settings
  • Fixed Sort Property: Specifies the property definition within the object type being listed by which to sort the objects in the list tile. The Order option to this attribute is set to specify the sort order, either ascending or descending. For the list tile view it is recommended that this attribute be set, as the list tile view cannot be sorted by the user. If a Fixed Sort Property is not set, the order of the objects in the list will be the order in which they are stored in the collection.
  • Enable Groups: Enables or disables the group and indexing behavior available in iOS Agentry Clients. When selected, the defined Fixed Sort Property is used to group the objects listed in the List Tile View field. Tiles will be sorted based on this selection and grouped by those with the first x number of characters (defined in No. Chars option) sorted relative to each other and exclusive to those in other groups. If the Fixed Sort Property is a string property, the No. Chars option is enabled where the number of characters to group on is defined. For numeric types, grouping is based on the first (highest order) digit. This value should be less than the maximum length of the selected string property. When Enable Groups is set to true, the attribute Allow Filter is disabled.
  • Show Group Index: This attribute is only available when Enable Groups is selected. When set to true, this attribute will result in the display of a group index on the right side of the List Tile View field. The user can select one of the items in this list to filter the List Tile View to only the matching items.
  • Allow Sort: This attribute enables or disables sorting of the List Tile View’s tiles on the Agentry Client by the user. When enabled, a button is displayed on the top of the list tile view field that displays a sort dialog when clicked by the user. The user can select a property within the object type being listed and the sort order of either ascending or descending. This attribute is disabled if a Fixed Sort Property is defined.
  • Initial Sort Property: This attribute allows for the selection of property to sort the list tile view field on during its initial display on the Agentry Client. If a property is selected for initial sorting, the option Order is available to define whether or not the initial sort order should ascending or descending. This attribute is not available unless Allow Sort is set to true.
  • Allow Filter: Specifies whether or not the user can filter the items in the list tile view. A filter icon is displayed for the list tile view field when enabled. The user can click this icon to select filter options. Only those properties for which tile filters have been defined within the list tile view field can be selected by the user in the displayed filter dialog.
  • Shortcut Key: This attribute specifies the shortcut key combination the user can enter on the Agentry Client to display the filter dialog for the list tile view field. This attribute will have no affect if Allow Filter is not set.
Header
  • Header Label: Specifies the header text for the list tile view. A common use for this header label is the total number of objects displayed in the list vs. the total number of objects in the collection, which may be different when a filter is enabled. The format strings used for this purpose are %DisplayedCount and %TotalCount.

List Tile View - Scanner Attributes

The scanner attributes for a list tile view affect only those list tile view fields defined for a detail screen that is used by a scanner platform within the screen set and only when the screen set is displayed on a client device with a barcode scanner. At least one tile filter must be defined within the list tile view to support scan filtering.

Single Match
  • Use Edit Row: This attribute specifies whether or not to use the defined edit behavior for the single object that matches the scan filter settings. When set, the selected object will be edited via either the defined Edit Action, or the defined Edit Screen Set and Edit Transaction in the List Tile View Settings attributes. If this attribute is set, the Single Match Action attribute will be disabled.
  • Single Match Action: Specifies what action is executed when a scanned barcode value uniquely matches an object in the list tile view. The target of the action will always be the object instance found to match. This attribute will be disabled if the Use Edit Row attribute is set.
No Match
  • Use Add Row: This attribute specifies whether or not to use the defined add behavior of the list tile view field. When set, defined Add Action will be executed, or the defined Add Screen Set and Add Transaction in the LIst Tile VIew Settings attributes will be displayed in a new tile added to the list. If this attribute is set, the No Match Action attribute will be disabled.
  • No Match Action: Specifies what action is executed when the scan filter criteria does not match any records in the list. The target of the action is the parent object to the collection property displayed by the list tile view. This attribute will be disabled if the Use Add Row attribute is set.
Label
  • Label Types: Specifies what barcode types are accepted by the Agentry Client. If no Label Type is specified, all types supported by the client device’s scanner will be supported. To restrict the label types, enter the name of each label type to support, separated by a comma. Barcodes not listed will not be processed by the Agentry Client.
  • Minimum Value: The minimum number of characters accepted by the Agentry Client from the device scanner. If the value scanned in contains fewer characters, it will be ignored.
  • Maximum Value: The maximum number of characters to be accepted by the Agentry Client from the device scanner. If the value scanned in contains more characters, it will be ignored.
  • Shortcut Key: This attribute allows a shortcut key combination to be defined to activate the device’s barcode scanner. This should be set to a key combination not already defined as a shortcut for any other items on the current screen or any system-level shortcut keys.