DataExchangeConfigurationBase Class |
Models the configuration of a DataExchange (import and export of DataObjects)
Inheritance HierarchySystemObject
Omada.OE.ModelDataExchangeConfigurationBase
Omada.OE.ModelDataExchangeLDAPConfiguration
Omada.OE.ModelDataExchangeSqlQueryConfiguration
Omada.OE.ModelDataExchangeTextFileConfiguration
Omada.OE.ModelDataExchangeConfigurationBase
Omada.OE.ModelDataExchangeLDAPConfiguration
Omada.OE.ModelDataExchangeSqlQueryConfiguration
Omada.OE.ModelDataExchangeTextFileConfiguration
Namespace: Omada.OE.Model
Assembly: Omada.OE.Model (in Omada.OE.Model.dll) Version: 15.0.0.0
SyntaxC#
[SerializableAttribute] public abstract class DataExchangeConfigurationBase : ICloneable, IObjectWithId, IObjectWithDataVersion, IObjectWithGuid
The DataExchangeConfigurationBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DataExchangeConfigurationBase |
Construct the obhect with an ID, a Direction and a DataObjectType ID.
|
Properties| Name | Description | |
|---|---|---|
 | ChangedBy |
Entity data version for static cache synchonization
|
| ChangeTime |
Date of last change of the configuration
|
| CreatedBy |
ID of User who created the configuration
|
| CreateTime |
Date when configuration was created initially
|
| DataObjectTypeId |
Provides the DataObjectType of the objects being imported/exported
|
| DataVersion |
Entity data version for static cache synchonization
|
| Direction |
Inbound or outbound
|
| DisregardGroupMembership |
When set to true users are always imported.
When set to false the user is only imported when being a member of one of the provided UserGroups (used as a filter).
Attribute is only used when importing Users.
|
| FailCMDLineOnErrors |
Used for command line usage, where the caller wants the dataexchange to exit with
an error on errors in the message log.
|
| Fields |
Contains a collection of fields (fixed fields and properties) which should be
transferred to/from the target system. The field is found on the DataObjectType
provided in DataObjectTypeId.
|
| Id |
ID of the configuration
|
| ImportMode |
ImportMode is only used if Direction=In.
|
| KeyField |
The field (property) which is used to identify the DataObject to determine of it an update or
an insert (like a primary key). Is only used when Direction=In.
|
| MissingObjectAction |
Determines whether objects are deleted when they are not found in the data source.
Only used when Direction=In
|
| MissingReferenceAction |
Determines the behaviour of an import into a Reference property if the
existing values are not found in the data source. The existing values
are either deleted (full sync) or the values in the data source are
added to the DataObject
Only used when Direction=In.
|
| Name |
The name of the DataExchange configuration
|
| Number |
Number of the configuration taken from a sequence
|
| PerformOnOriginObjects |
Determines whether the MissingObjectAction can be performed on all object or only those
object which are created the this configuration
|
| TestMode |
In test mode, the data exchange is run normally, but data is not
committed to the database.
|
| TimerId |
If defined, the DataExchange is executed on this timer.
|
| Type |
Type of source/target system
|
| UId |
UID of the configuration
|
| UserGroupIds |
The attribute is used to synchonize UserGroup memberships. It can
be used as a filter so only users which are member of one of the provided
groups are imported (DisregardGroupMembership=false) or only to synchronize
groupmemberships (DisregardGroupMembership=true).
The users will also be removed from the provided UserGroups if the data source
does not indicate a membership (full synchronization)
Only used when Direction=In and UserImport=true.
|
| UserImport |
Determines whether its a User import.
Only used when Direction=In
|
Methods| Name | Description | |
|---|---|---|
| FieldMapContainsKeyField |
Returns true if the configuration's keyfield is present in the configuration's fieldmap.
|
 | FieldMapContainsKeyField(DataExchangeConfigurationBase) |
Returns true if the configuration's keyfield is present in the configuration's fieldmap.
|
| RemoveInvalidFields |
Removes fields from fields collection which
are not available in the provided DataObjectType
|
| Validate |
Validates that the configuration is in a valid state (to be executed).
Returns true if it is.
If method returns false then 'message' will contain a description of the problem.
|
Fields| Name | Description | |
|---|---|---|
 | m_changedBy |
ID user user whi performed the last change of the configuration
|
| m_changeTime |
Date of last change of the configuration
|
| m_createdBy |
ID of User who created the configuration
|
| m_createTime |
Date when configuration
|
| m_dataObjectTypeId |
Provides the DataObjectType of the objects being imported/exported
|
| m_dataVersion |
Entity data version for static cache synchonization
|
| m_disregardGroupMembership |
When set to true users are always imported.
When set to false the user is only imported when being a member of one of the provided UserGroups (used as a filter).
Attribute is only used when importing Users.
|
| m_id |
ID of the configuration
|
| m_importMode |
ImportMode is only used if Direction=In.
|
| m_keyField |
The field (property) which is used to identify the DataObject to determine of it an update or
an insert (like a primary key). Is only used when Direction=In.
|
| m_missingObjectAction |
Determines whether objects are deleted when they are not found in the data source.
Only used when Direction=In
|
| m_missingReferenceAction |
Determines the behaviour of an import into a Reference property if the
existing values are not found in the data source. The existing values
are either deleted (full sync) or the values in the data source are
added to the DataObject
Only used when Direction=In.
|
| m_name |
The name of the DataExchange configuration
|
| m_number |
Number of the configuration taken from a sequence
|
| m_performOnOriginObjects |
Determines whether the MissingObjectAction can be performed on all object or only those
object which are created the this configuration
|
| m_testMode |
In test mode, the data exchange is run normally, but data is not
committed to the database.
|
| m_timerId |
If defined, the DataExchange is executed on this timer.
|
| m_type |
Type of source/target system
|
| m_uid |
UID of the configuration
|
| m_userGroupIds |
The attribute is used to synchonize UserGroup memberships. It can
be used as a filter so only users which are member of one of the provided
groups are imported (DisregardGroupMembership=false) or only to synchronize
groupmemberships (DisregardGroupMembership=true).
The users will also be removed from the provided UserGroups if the data source
does not indicate a membership (full synchronization)
Only used when Direction=In and UserImport=true.
|
| m_userImport |
Determines whether its a User import.
Only used when Direction=In
|
Extension Methods| Name | Description | |
|---|---|---|
 | ToBool |
Converts object to boolean.
(Defined by ObjectExtensions.) |
| ToDateTime |
Converts object to DateTime.
(Defined by ObjectExtensions.) |
| ToInt |
Converts object to integer.
(Defined by ObjectExtensions.) |
Explicit Interface Implementations| Name | Description | |
|---|---|---|
  | ICloneableClone | Creates a new object that is a copy of the current instance. |
| IObjectWithDataVersion.GetDataVersion | |
| IObjectWithGuid.GetGuid | |
| IObjectWithId.GetId |
See Also