OData Complex Table Synchronization Components
When a complex table is defined to use an OData system connection, its synchronization components consist of three HTTP request child definitions: Update Request, Rebuild Request, and Deleted Request.
Each request has the same overall structure and attributes, which includes the URL for the request and the request method. Likewise, the request argument and response mapping child definitions also contain the same attributes. The difference between these requests is when they are sent to the back end system, and what the data they are expected to return is used for in relation to the complex table.
The update request definition is sent to the back end during normal synchronization. This request is expected to return data for the complex table representing records to be added or replaced on the Agentry Client. Therefore, it should contain one child data mapping definition for each field in the complex table.
The rebuild request is sent to the back end system when the complex table is in a rebuild state. This request is expected to return the data for all records that should be stored in the complex table on the client. The rebuild state means the complex table on the client is going to be cleared of all records before the request is sent. This request should contain child data mapping definitions for each field in the complex table.
Complex Table HTTP Request Child Definitions
- Request Arguments: This definition encapsulates an argument to be passed with the request to the back end system. Includes the ability to use data within the mobile application with the argument.
- Response Mappings: This definition encapsulates the XML data returned by the HTTP request. The specific values are extracted from the XML return data using XPaths defined within each response mapping. Attributes are also set to map the extracted values to data structures within the mobile application.
Complex Table HTTP Request Attributes
- Name: The name of the request, set automatically based on the parent complex table name and the request type. May be modified as needed.
- URL: The URL to the specific CGI or other process being called by the HTTP request to synchronize the complex table.
- Method: The HTTP request method for the request. May be one of GET, POST, HEAD, or PUT.