ConfigPanel - Exchange Object Configuration Settings

Technical Settings Tab

Use the Technical Settings tab to configure basic settings for an exchange object.

• General data fields:

  • Exchange Object: ID of the exchange object, limited to 40 characters

  • Exchange Object Description: Brief description of the exchange object, limited to 60 characters

  • Mobile Application: Specific mobile application to which the exchange object belongs using a dropdown selection field

  • Application Area: Classifies the exchange object based on standard SAP application areas using a dropdown selection field

  • Reference Business Object: Standard SAP business object

  • Exchange Table Name: Name of the table stored in SAP that contains the technical data

  • Exchange Table Description: Brief description of the exchange table

  • Exchange Lock Object: SAP lock object used when updating the exchange table

  • No Exchange Table Update: When checked, the record is not written to the exchange table in SAP when the record is changed

  • Days to Keep History: Number of days the historical data is kept in the exchange table

• Handler Setting field:

  Exchange Object Handler: Name of class handler from the repository that is responsible for updating the exchange table

• Collective Run Settings field:

  Collective Run Mode: Defines conditions to determine if exchange processing can be executed asynchronously as V3 collective run. The mode options are:

  • Dynamic: Collective run mode is determined at runtime by the exchange handler method DETERMINE_EXEC_MODE

  • Not Allowed: Not allowed to switch to collective run mode

  • Activated: Always execute asynchronously in v3 collective run

  • By User Parameter ID: Switch to V3 collective run mode for runtime user with the specified user parameter value set in the user profile

• Activation Setting fields:

  • Active Flag: When checked the exchange object is in an active state. If unchecked, the exchange object performs no actions.

  • Use in Linkage Processing Only: If checked, the exchange object is only allowed during linkage processing. If not checked, the original EFI triggered exchange processing takes place.

Example:

The following screen sample shows that the exchange process is enabled for SIM44_RESERVATION. Any changes to Reservation user data are recorded in the exchange table and transmitted to the client during the next transmit.

Change Detection Field Selection Tab

The Change Detection Field Selection tab allows you to optimize the change detection process for mobile applications. If a value change is detected for any fields within the group, the object identifier is written to the exchange table, indicating that a change has been made. If the Active flag is not checked for a field, any value changes made to that field are not detected or recorded to SAP during the exchange process. By default, all fields are initially checked.

The Exchange Object by Application Area lists all application areas and the exchange objects linked to each application area. Expand the lists by clicking on the arrows to the left of the application area to display the exchange objects associated with it.

• Exchange Object Info fields:

  • Exchange Object: A noneditable field that contains the ID of the exchange object.

  • Exchange Object Description: A noneditable field that contains a brief description of the exchange object.

  • Exchange Object Handler: A noneditable field that contains tha name of class handler from the repository that is responsible for updating the exchange table.

• Exchange Object Field Selector fields:

  • Field Catalog: All fields that can be detected by the class handler when changes are made, grouped by the technical table name of the SAP business object. The field catalog is a noneditable field.

  • Active Flag: When checked, either the table or a field within a table is active. Any value change to the selected field is detected by the class handler.

  • Short Description: Brief description of the table or the field within the table. The short description is a noneditable field.

• Selection Proposal options:

  In a typical installation, it is not desirable to have all fields in all exchange tables checked as active for change detection. Rather, only the fields that are active on the mobile data object that are brought down to the mobile device should also be active in the exchange object.

  Based on mobile data object usage in the mobile application, the Selection Proposal examines the active flags that are checked for the table fields of an exchange object. The Selection Proposal then provides recommendations to the administrator on which fields in the exchange object to check or uncheck.

Change Detection Condition Filter Tab

The Change Detection Condition Filter tab allows you to restrict change detection based on data content. For exchange handlers to support this feature, you first define data filter conditions for which the underlying SAP business object qualifies before the change detection process is triggered. The data filter condition is defined at the table field level and is in the SAP range table format.

• Exchange Object Info fields:

  • Exchange Object: A noneditable field that contains the ID of the exchange object.

  • Exchange Object Description: A noneditable field that contains a brief description of the exchange object.

  • Exchange Object Handler: A noneditable field that contains tha name of class handler from the repository that is responsible for updating the exchange table.

• Exception Settings fields

  :

  • Ignore Data Creation: When checked, new records, data, or both are created are not processed to the exchange table

  • Ignore Data Deletion: When checked, deleted records, data, or both are not processed to the exchange table

  • Ignore Data Update: When checked, updated records, data, or both are not processed to the exchange table

• Defined Filters list:

  The Defined Filters box lists all data filters supported by the class handlers.

• Rule Editor fields:

  • Filter Name: Name of the filter as defined in the class handler method. This information is defined by the class handler developer and is not editable.

  • Reference Table Name: Technical name of the SAP database table where this filter is applied. This information is defined by the class handler developer and is not editable.

  • Reference Field Name: Technical name of the SAP database table field where this filter is applied. This information is defined by the class handler developer and is not editable.

  • Data Filter Rule Key: Internal technical key used by the framework at runtime

  • Range Value: Use the following values to set the range:

    • Sign: Value for the SAP range table column SIGN

    • Option: Value for the SAP range table column OPTION

    • Low Value: Value for the SAP range table column LOW

    • High Value: Value for the SAP range table column HIGH

    • Active Flag: When checked, the rule is active

• Rule List table:

  The Rule List table displays a list of rules that have been defined.

  • Rule No.: Number of the rule that is defined, in chronological order

  • Rule Type: Rule type, automatically assigned by the rule type selected in the DOF Rule Type field

  • Rule Value: Internal rule value saved by SAP

  • Active Flag: When checked, the rule is active

Data Segment Settings Tab

The Data Segment Settings tab defines data segment requirement details for the specific exchange object. Data segment setting is optional for any given xchange object. If no data segment setting is defined, an exchange object is always called by the EFI event trigger if the exchange object is assigned to the EFI in the EFI Assignment Configuration settings.

By defining data segment settings, additional criteria is applied when determining whether an exchange object is called by an EFI event trigger. Even when an exchange object is assigned to the EFI in the EFI Assignment configuration settings, the exchange object is only called by the EFI event trigger when the data segment requirements are met.

Linkage Settings

The Linkage Settings tab allows the exchange objects that are linked together to communicate with each other. The communication is one-directional, with the exchange object sending information to the object(s) listed in the Linked Exchange Objects List. When there is a value change to the exchange object, that value change information is passed on to the linked exchange objects. The linked exchange objects then go through additional processes related to the value change.

• Exchange Object Info fields:

  • Exchange Object: A noneditable field that contains the ID of the exchange object.

  • Exchange Object Description: A noneditable field that contains a brief description of the exchange object.

  • Exchange Object Handler: A noneditable field that contains tha name of class handler from the repository that is responsible for updating the exchange table.

• Linkage Settings field:

  With the Linkage Hierarchy, you can go ‘n’ levels deep with linked objects. Any node changes triggers changes to the lower-level nodes linked to the parent node. These relationships are defined in the Linked Exchange Objects list.

  For example, the exchange object <APP>_MEASURING_POINT is linked to the following exchange objects:

  • <APP>_FLEET

  • <APP>_EQUIPMENT

  • <APP>_FUNC_LOCATION

  If the Measuring Point data changes, then the linked exchange objects also change.

  Maximum Linkage Hierarchy Level:

• Linked Exchange Objects list:

  • Add Linkage button: Use this button to add a new linked exchange object. Click Add Linkage and use the fields in the Linkage Detail section to add information.

  • Delete Linkage button: Use this button to delete a linkage. To highlight the row you want to delete, click the rectangle to the left of the Target Exchange Object cell and click Delete Linkage.

  • Target Exchange Object: Displays the target exchange object selected in the Linkage Detail section.

  • Linkage Type: Displays either an A for asynchronous or an S for synchronous, selected in the Linkage Detaill section.

  • Active Flag: When checked in the Linkage Detail section, the linkage between exchange objects is active.

• Linkage Detail fields:

  • Target Exchange Object: The exchange objects that are linked to the exchange object listed in the Exchange Object Info section.

  • Linkage Type: Currently, Synchronous is the only option available. When a value change occurs to the exchange object, notification to the linked exchange object is performed in real-time.

  • Exclude Data Creation / Update / Deletion: The linkage for a source exchange object to a target exchange may be limited by the action done on the source object. The possible actions are Create, Update, and Delete. By checking any of these three ‘exclude’ boxes, the linkage is not triggered for that action.

  • Active Flag: When checked, the linkage between the exchange object and the target exchange object is active.

Push Settings Tab

If the exchange object is part of a push instance, you must configure the object in the Push Settings tab before the object can appear in the Source Object dropdown menu of the push scenario definition.

• Exchange Object Info fields:

  • Exchange Object: A noneditable field that contains the ID of the exchange object.

  • Exchange Object Description: A noneditable field that contains a brief description of the exchange object.

  • Exchange Object Handler: A noneditable field that contains the name of class handler from the repository that is responsible for updating the exchange table.

• Push Settings field:

  Push Relevant: When checked, the exchange object is listed as a selection in the Source Object dropdown list in the Push Scenario Definition screen.