Configuring check order

Check order is an error-checking process used to determine if a Sync BOD received by the IEC Server is updated. Check order starts by checking the variationID for inbound Sync BODs. The variationID is an attribute containing a version number for the BOD. This version number refers to the identification (ID) of the BOD, for example, the item number for a SyncItemMaster BOD. If a Sync BOD is received, but another Sync BOD for the same noun and identification, having a higher (or the same) variationID, has already been received, the new Sync BOD is disregarded by the IEC server. This is because the data in the BOD is outdated. There is a check order process in the agreement to handle this. You must set up the check order process for inbound Sync BOD mappings to generate custom agreements.

You can set up how to find the BOD ID by using the check order configuration window. This is the primary key for the BOD. You must also set up how to find the variationID (VID) in the BOD. XPaths are used for these settings.

When importing a standard mapping for an inbound Sync BOD from the server, the check order settings are automatically copied from the standard agreement. You must use these settings as basis for custom BODs, as it is difficult to make the correct settings. The IEC server stores variationID values for all primary keys. The check order settings should not be changed, once in production, as this can create inconsistent data.

Note: Check order configuration only applies to inbound Sync agreements.
  1. To access check order, open an inbound Sync BOD mapping and right-click the mapping work area.
  2. Click Configure Check Order.
  3. Select the Include Noun for Primary Key check box to include the BOD noun in the primary key stored in the IEC server. This field is used to separate BODs having different nouns but the same ID.
  4. Specify the default namespace for the BOD in the Default Namespace field.
    The standard namespace for Infor BODs is http://schema.infor.com/InforOAGIS/2.
  5. Specify a default namespace prefix in the Default Namespace Prefix field. This field is used in the check order process to indicate the default namespace in XPaths. Standard value is dns.
  6. Click Add to add a new XPath for the primary key.
    At least two XPaths are used to pinpoint the primary key: the accounting entity and the document ID. The window shows PrimaryKey Retrieval Settings. Specify the XPath for the element or attribute in the PrimaryKey Xpath field. An ID element is repeating to give the possibility to use several alternative IDs. This is indicated by the attribute schemeName. As the original ID should be used for the primary key, the instance of the element without a schemeName attribute should be used. If this functionality is required, specify the name of the attribute that should not exist for the element in the PrimaryKey No Attribute Existing field. Standard value is schemeName.
  7. Click Edit to modify the selected primary key XPath. You can also double-click the XPath to modify it.
  8. Click Delete to delete the selected primary key XPath.
  9. Specify the XPath for the variationID attribute or element in the VID Xpath field. This field must have a value, otherwise the variationID is not found in the BOD.
  10. An ID element is repeating to give the possibility to use several alternative IDs. This is usually indicated by the attribute schemeName. As the variationID for the original ID should be used, the instance of the element without a schemeName attribute should be used. If this functionality is required, specify the name of the attribute that should not exist for the VID element in the VID No Attribute Existing field. Standard value is schemeName.
  11. Click OK.
  12. Right-click the mapping work area and click Validate to validate the changes made.
    Check order settings currently do not have an edit function in SAT.
    You must provide the control properties and check order properties when publishing a custom agreement for the first time. Control properties are applicable to all types of BODs, regardless of direction (inbound/outbound) or verb (Acknowledge, Load, Process, Show, Sync, Update). Check order is only applicable to inbound Sync BODs. The agreement is generated successfully after following these steps. The custom agreement is updated accordingly when the mapping is republished if the control properties or check order settings are updated for a published mapping.