Changes
== Interfacing with Proxies ==
## Which property of the object identifies it in the third party system? This is the "external primary key", and it can consist of multiple properties.
# For every type of entity, create a MetaProxy and link it to the MetaClass it is represented by in UBIK.
## Enter the external key for the MetaProxy, which identifies the type in the third party system (i.e., the name or ID of the type of entity in the external system, e.g., "Pump")# Create MetaProxyProperties for every property to synchronize and relate them to the respective MetaProxy.## Set the UBIK property name for the MetaProxyProperty.## Set the external key of the property, i.e., the name or ID of the property in the external system, e.g., "Voltage".## If the property identifies the object in the third party system, mark it as external primary key.## If you want to update the external system when this property changes, set the Export property to true.## If you want to update UBIK when this property changes in the external system, set the Import property to true.## If the property represents a link to another UBIK object, set the reference target MetaProxy representing the UBIK MetaClass for the external system.# Implement the synchronization workflow:## Clarify when UBIK objects should be synchronized to the external system or vice-versa.*** If you want to schedule interface runs regularly, you can use the [[UBIK_Enterprise_Service|{{UBIK}} Enterprise service]].*** If you want changes in {{UBIK}} objects to trigger a synchronization run, you can customize the respective MetaClass programmatically to react to a change or being saved.## If you're not using the Enterprise service, you can use the InterfaceAdministration MetaClass to trigger an execution.## There are the following important execution modes:*** Export: Write the values from the {{UBIK}} object to the proxy instance*** Import: Write the values from the proxy instance to the {{UBIK}} object*** ReadFromExternal: Write the values from the external system to the proxy instance*** WriteToExternal: Write the values from the proxy instance to the external system## You can decide what mode should be executed when triggering the execution.## For every execution mode, there is a method for getting the respective IInterfaceExecutor on the InterfaceAdministration MetaClass - you can customize them programmatically, so that they retrieve your implementation of the IInterfaceExecutor (C#) interface.## For the import and export executors, there are standard implementations you don't have to provide.## For writing to and reading from the external system, you must implement a custom way of communication.
{{Attention|This page is under construction. More detailed instructions will follow.}}
[[Category:Interfacing|Configure Proxies]]
