HowTo:Configure Proxies - Revision history

LMA: /* Creating proxy instances for your Ubikles */

2024-06-24T15:02:30Z

‎Creating proxy instances for your Ubikles

LMA: /* See also */

2024-06-24T15:01:32Z

‎See also

LMA: /* Creating proxy instances for your Ubikles */

2024-06-24T11:24:13Z

‎Creating proxy instances for your Ubikles

LMA: /* Creating proxy instances for your Ubikles */

2024-06-24T11:13:50Z

‎Creating proxy instances for your Ubikles

NWE at 14:52, 14 June 2023

2023-06-14T14:52:47Z

NWE: /* See also */

2023-06-14T14:52:23Z

‎See also

NWE at 11:33, 26 January 2023

2023-01-26T11:33:47Z

NWE at 15:38, 12 December 2019

2019-12-12T15:38:57Z

NWE at 00:29, 10 December 2019

2019-12-10T00:29:16Z

NWE at 00:28, 10 December 2019

2019-12-10T00:28:13Z

@@ Line 65: / Line 65: @@
 The [[ProxyManager]] provides methods for creating and registering new proxy instances.
 A fully automatic option would be to customize a MetaClass so that a new proxy is automatically created for every new instance (using the ProxyManager). Moreover, you can customize the IInterfaceExecutor implementation for the execution mode "ReadFromExternal" to create proxies for new objects coming from the external system, for example.
-A semi-automatic option is provided for the creation of Document Proxies, e.g., by using the [[DocumentProxy#DocumentBatchProxyCreator|DocumentBatchProxyCreator]].
+A semi-automatic option is provided for the creation of Document Proxies, e.g., by using the [[DocumentProxy#BatchDocumentProxyCreator|BatchDocumentProxyCreator]].
 Of course, you can also create proxy instances manually or based on any custom logic.

@@ Line 78: / Line 78: @@
 * [[InterfaceAdministration]]
 * [[InterfaceExecution]]
 [[Category:Interfacing|Configure Proxies]]

@@ Line 65: / Line 65: @@
 The [[ProxyManager]] provides methods for creating and registering new proxy instances.
 A fully automatic option would be to customize a MetaClass so that a new proxy is automatically created for every new instance (using the ProxyManager). Moreover, you can customize the IInterfaceExecutor implementation for the execution mode "ReadFromExternal" to create proxies for new objects coming from the external system, for example.
-A semi-automatic option is provided for the creation of Document Proxies, e.g., by using the DocumentBatchProxyCreator.
+A semi-automatic option is provided for the creation of Document Proxies, e.g., by using the [[DocumentProxy#DocumentBatchProxyCreator|DocumentBatchProxyCreator]].
 Of course, you can also create proxy instances manually or based on any custom logic.

@@ Line 61: / Line 61: @@
 == Creating proxy instances for your Ubikles ==
-For {{UBIK}} content objects (Ubikles) to be synchronized, a proxy instance must be created and bound to it. Every proxy has a "Target" property linking to the bound Ubikle. There is a class [[ProxyManager]] providing methods for creating and registering new proxy instances. You can further customize a MetaClass so that a new proxy is created for every new instance automatically (using the ProxyManager), or you can create proxy instances manually or based on any custom logic. Further, proxy instances must also be created for objects received from the external system. You can customize the IInterfaceExecutor implementation for the execution mode "ReadFromExternal" to create proxies for new objects coming from the external system, for example.
+For {{UBIK}} content objects (Ubikles) to be synchronized, a proxy instance must be created and bound to it. Every proxy has a "Target" property linking to the bound Ubikle. Furthermore, proxy instances must also be created for objects received from the external system.
 == See also ==

← Older revision		Revision as of 14:52, 14 June 2023
Line 71:		Line 71:
	* [[InterfaceAdministration]]		* [[InterfaceAdministration]]
	* [[InterfaceExecution]]		* [[InterfaceExecution]]
		+
		+	[[Category:Interfacing\|Configure Proxies]]

@@ Line 64: / Line 64: @@
 == See also ==
 * [[Proxy]]
 * [[ProxyMetaProperty]]
@@ Line 70: / Line 71: @@
 * [[InterfaceAdministration]]
 * [[InterfaceExecution]]

← Older revision		Revision as of 11:33, 26 January 2023
Line 62:		Line 62:

	For {{UBIK}} content objects (Ubikles) to be synchronized, a proxy instance must be created and bound to it. Every proxy has a "Target" property linking to the bound Ubikle. There is a class [[ProxyManager]] providing methods for creating and registering new proxy instances. You can further customize a MetaClass so that a new proxy is created for every new instance automatically (using the ProxyManager), or you can create proxy instances manually or based on any custom logic. Further, proxy instances must also be created for objects received from the external system. You can customize the IInterfaceExecutor implementation for the execution mode "ReadFromExternal" to create proxies for new objects coming from the external system, for example.		For {{UBIK}} content objects (Ubikles) to be synchronized, a proxy instance must be created and bound to it. Every proxy has a "Target" property linking to the bound Ubikle. There is a class [[ProxyManager]] providing methods for creating and registering new proxy instances. You can further customize a MetaClass so that a new proxy is created for every new instance automatically (using the ProxyManager), or you can create proxy instances manually or based on any custom logic. Further, proxy instances must also be created for objects received from the external system. You can customize the IInterfaceExecutor implementation for the execution mode "ReadFromExternal" to create proxies for new objects coming from the external system, for example.
		+
		+	== See also ==
		+	* [[Proxy]]
		+	* [[ProxyMetaProperty]]
		+	* [[ProxyManager]]
		+	* [[MetaProperty]]
		+	* [[InterfaceAdministration]]
		+	* [[InterfaceExecution]]

	[[Category:Interfacing\|Configure Proxies]]		[[Category:Interfacing\|Configure Proxies]]

@@ Line 40: / Line 40: @@
 ## 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.
-{{Attention|This page is under construction. More detailed instructions will follow.}}
+== Implementing the synchronization workflow ==
 [[Category:Interfacing|Configure Proxies]]

@@ Line 45: / Line 45: @@
 ##* 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:
+## You can decide what mode should be executed when triggering the 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
 ## 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 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.
+##* 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]]

@@ Line 42: / Line 42: @@
 # 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 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 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
+##* Export: Write the values from the {{UBIK}} object to the proxy instance
-*** Import: Write the values from the proxy instance to the {{UBIK}} object
+##* Import: Write the values from the proxy instance to the {{UBIK}} object
-*** ReadFromExternal: Write the values from the external system to the proxy instance
+##* ReadFromExternal: Write the values from the external system to the proxy instance
-*** WriteToExternal: Write the values from the proxy instance to the external system
+##* 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.