Difference between revisions of "Activity:RegisterObjectForExport (Activity)"

Register Object for Export
Name	RegisterObjectForExport
Purpose	Register an object for interface (create proxy object)
Category	Data Exchange
Returns	True if successfull
Version	2.1+

Latest revision as of 10:05, 4 November 2015

The RegisterObjectForExport Activity creates a new proxy instance of a specified UBIK content object (target) and sets the export state to Queued for Export.

[edit]

Description
Example

Description

Arguments

Argument	Type	Direction	Purpose
UBIKObject	BaseClass	The target to create the proxy object for
MetaProxy	MetaProxy	In	The MetaProxy to create the proxy instance
Proxy	Proxy	In	The created proxy instance
Result	Boolean	Out	True if proxy instance has been created

Usage

This activity creates a new proxy instance (of the given MetaProxy) for the specified target object. If created successfully, the export state is set to Queued for export.

This activity does not automatically save changes. If you want to persist the newly created proxy instance, you need i.e. a subsequent SaveObject activity!

Example

Register an UBIK object for interface:

Argument	Value
UBIKObject	Connect this argument with a variable for an UBIK object
MetaProxy	Connect this argument with a variable for a MetaProxy
Proxy	Connect this argument with a variable for a Proxy (out)

@@ Line 1: / Line 1: @@
+The RegisterObjectForExport Activity creates a new [[Proxy|proxy instance]] of a specified UBIK content object (target) and sets the export state to '''Queued for Export'''.
+=Description=
 {{ActivityInfoBox
 | title = Register Object for Export
@@ Line 9: / Line 12: @@
 | version = 2.1+
 }}
-The RegisterObjectForExport Activity creates a new [[Proxy|proxy instance]] of a specified UBIK content object (target) and sets the export state to '''Queued for Export'''.
-==Arguments==
+===Arguments===
 {| class="wikitable sortable" | width = "50%"
 |-
 ! Argument !! Type !! Direction !! Purpose
 |- align="left"
-| UBIKObject {{BaseClass}} || In || The target to create the proxy object for
+| UBIKObject || [[BaseClass]] || The target to create the proxy object for
 |- align="left"
 | MetaProxy|| [[MetaProxy]] || In || The MetaProxy to create the proxy instance
@@ Line 22: / Line 24: @@
 | Proxy|| [[Proxy]] || In || The created proxy instance
 |- align="left"
-| Result|| {{Boolean}} || Out || True if proxy instance has been created
+| Result|| {{Boolean_MSDN}} || Out || True if proxy instance has been created
 |}
-==Usage==
+===Usage===
 This activity creates a new proxy instance (of the given MetaProxy) for the specified target object. If created successfully, the [[Proxy#Export_states|export state]] is set to '''Queued for export'''.
+{{Attention|This activity does not automatically save changes. If you want to persist the newly created proxy instance, you need i.e. a subsequent [[Activity:SaveObject_(Activity)|SaveObject activity]]!}}
-{{Attention|This activity does not automatically save changes. If you want to persist the newly created proxy instance, you need i.e. a subsequent [[Activity SaveObject|SaveObject activity]]!}}
+=Example=
+Register an UBIK object for interface:
-==Example==
-Load the MetaClass named ''PUMP'', and create a new instance from it:
 {| class="wikitable" | width = "50%"
 |-
 ! Argument!! Value
 |- align="left"
-| MetaClass|| <source lang = "vbnet">UBIKObject.Environment _
+| UBIKObject|| Connect this argument with a variable for an UBIK object
-.GetSystemMetaClass(UBIK.Kernel.SystemObjects.METACLASS) _
+|- align="left"
-.AllInstances("PUMP")</source>
+| MetaProxy || Connect this argument with a variable for a MetaProxy
+|- align="left"
+| Proxy || Connect this argument with a variable for a Proxy (out)
 |}
+<!-- DO NOT REMOVE THIS -->{{Activity/End}}<!-- DO NOT REMOVE THIS -->
 ==See also==
 * [[Workflow Designer]]
-* [[SaveObject (Activity)]]
+* [[Activity:SaveObject (Activity)]]
-[[Category:Workflows]] [[Category:Activities]]
+[[Category:Activities|RegisterObjectForExport (Activity)]]