Developer

Object

The object definition supports the mobile application functionality.

An object definition encapsulates a business entity and its related data. An object’s child property definitions give that object its characteristics. An object can also define how its data is retrieved from the back-end system.

The object definition is in essence a container for the properties defined within it. Objects are defined to encapsulate the different business entities in a module in support of the functionality to be provided in the mobile application. The properties then define the data stored within that object.

A special type of object will exist in every module defined within an application project. This is the module main object, named by default MainObject. The intent of this main object is to be the starting point, or top level of the module’s overall object data structure. Via the use of the collection property data type, object instances may be stored within other object instances at run time. This then results in a parent-child relationship within the module’s data structure. At the top of this structure is the module main object.

When a new module is defined, the module main object will be added automatically. Additionally, a prompt is displayed in the New Module Wizard for the definition of another object. The object defined in the New Module Wizard is normally the primary object for the module. The primary object is a term of convenience used to denote the object around which most of the module’s functionality will revolve. This includes the functionality provided to the end user in the form of information and data capture, as well as synchronization processes for the module. Examples of a primary object include a work order object for a work management module, or a message object for a mail module. The module main object will include a single collection property defined to store instances of the primary object.

Object Child Definitions

  • Property: An object property defines a single piece of data for the parent object.
  • Object Read Step: An object read step references a step definition run to retrieve data from a back-end system to populate an object's properties.

Object Attributes

  • Name: This is the unique name of the object. This value must be unique among all objects defined within the same module.
  • Display Name: This is the default name displayed for the object on the Agentry Client.
  • Key Property: The key property for an object is used whenever that object is to be a part of a collection. The value of this property must be a value that uniquely identifies the object and in most cases will be the same value as the key value from the back end system. Note that almost all object definitions are stored in collections and therefore must have this attribute set. The property to be used must be defined before setting this attribute.
  • Transmit Display Property: This attribute specifies the object property value to display to the user on the Agentry Client transmit screen. When an object is being retrieved from the back end system, the property specified here is displayed to the user during its retrieval. By default the value displayed is the object’s key property.
  • Main Object: This attribute specifies whether or not the object is the main object for the module. Each module contains a main object. This attribute is set to true for that object, and to false for all other objects. This attribute is displayed for reference purposes within the Editor and cannot be modified.