DataExchangeTextFileConfiguration Class |
Models the configuration of a TextFile import/export
Inheritance HierarchySystemObject
Omada.OE.ModelDataExchangeConfigurationBase
Omada.OE.ModelDataExchangeTextFileConfiguration
Omada.OE.ModelDataExchangeConfigurationBase
Omada.OE.ModelDataExchangeTextFileConfiguration
Namespace: Omada.OE.Model
Assembly: Omada.OE.Model (in Omada.OE.Model.dll) Version: 15.0.0.0
SyntaxC#
[SerializableAttribute] public class DataExchangeTextFileConfiguration : DataExchangeConfigurationBase
The DataExchangeTextFileConfiguration type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DataExchangeTextFileConfiguration |
Construct the DataExchangeTextFileConfiguration
|
Properties| Name | Description | |
|---|---|---|
 | ChangedBy |
Entity data version for static cache synchonization
(Inherited from DataExchangeConfigurationBase.) |
| ChangeTime |
Date of last change of the configuration
(Inherited from DataExchangeConfigurationBase.) |
| CreatedBy |
ID of User who created the configuration
(Inherited from DataExchangeConfigurationBase.) |
| CreateTime |
Date when configuration was created initially
(Inherited from DataExchangeConfigurationBase.) |
| DataObjectTypeId |
Provides the DataObjectType of the objects being imported/exported
(Inherited from DataExchangeConfigurationBase.) |
| DataVersion |
Entity data version for static cache synchonization
(Inherited from DataExchangeConfigurationBase.) |
| Direction |
Inbound or outbound
(Inherited from DataExchangeConfigurationBase.) |
| 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.
(Inherited from DataExchangeConfigurationBase.) |
| FailCMDLineOnErrors |
Used for command line usage, where the caller wants the dataexchange to exit with
an error on errors in the message log.
(Inherited from DataExchangeConfigurationBase.) |
| 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.
(Inherited from DataExchangeConfigurationBase.) |
| FirstImportRow |
The first line number to import.
Can be used to avoid importing the header row.
|
| Id |
ID of the configuration
(Inherited from DataExchangeConfigurationBase.) |
| ImportMode |
ImportMode is only used if Direction=In.
(Inherited from DataExchangeConfigurationBase.) |
| 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.
(Inherited from DataExchangeConfigurationBase.) |
| MissingObjectAction |
Determines whether objects are deleted when they are not found in the data source.
Only used when Direction=In
(Inherited from DataExchangeConfigurationBase.) |
| 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.
(Inherited from DataExchangeConfigurationBase.) |
| Name |
The name of the DataExchange configuration
(Inherited from DataExchangeConfigurationBase.) |
| Number |
Number of the configuration taken from a sequence
(Inherited from DataExchangeConfigurationBase.) |
| PerformOnOriginObjects |
Determines whether the MissingObjectAction can be performed on all object or only those
object which are created the this configuration
(Inherited from DataExchangeConfigurationBase.) |
| Separator |
The field separator in a line.
|
| TestMode |
In test mode, the data exchange is run normally, but data is not
committed to the database.
(Inherited from DataExchangeConfigurationBase.) |
| TextFileId |
Must denote a comma-delimited text file.
|
| TimerId |
If defined, the DataExchange is executed on this timer.
(Inherited from DataExchangeConfigurationBase.) |
| Type |
Type of source/target system
(Inherited from DataExchangeConfigurationBase.) |
| UId |
UID of the configuration
(Inherited from DataExchangeConfigurationBase.) |
| 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.
(Inherited from DataExchangeConfigurationBase.) |
| UserImport |
Determines whether its a User import.
Only used when Direction=In
(Inherited from DataExchangeConfigurationBase.) |
Methods| Name | Description | |
|---|---|---|
| FieldMapContainsKeyField |
Returns true if the configuration's keyfield is present in the configuration's fieldmap.
(Inherited from DataExchangeConfigurationBase.) |
| GetSeparatorChar |
Returns the configured field separator
|
| RemoveInvalidFields |
Removes fields from fields collection which
are not available in the provided DataObjectType
(Inherited from DataExchangeConfigurationBase.) |
| 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.
(Inherited from DataExchangeConfigurationBase.) |
Fields| Name | Description | |
|---|---|---|
 | m_changedBy |
ID user user whi performed the last change of the configuration
(Inherited from DataExchangeConfigurationBase.) |
| m_changeTime |
Date of last change of the configuration
(Inherited from DataExchangeConfigurationBase.) |
| m_createdBy |
ID of User who created the configuration
(Inherited from DataExchangeConfigurationBase.) |
| m_createTime |
Date when configuration
(Inherited from DataExchangeConfigurationBase.) |
| m_dataObjectTypeId |
Provides the DataObjectType of the objects being imported/exported
(Inherited from DataExchangeConfigurationBase.) |
| m_dataVersion |
Entity data version for static cache synchonization
(Inherited from DataExchangeConfigurationBase.) |
| 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.
(Inherited from DataExchangeConfigurationBase.) |
| m_id |
ID of the configuration
(Inherited from DataExchangeConfigurationBase.) |
| m_importMode |
ImportMode is only used if Direction=In.
(Inherited from DataExchangeConfigurationBase.) |
| 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.
(Inherited from DataExchangeConfigurationBase.) |
| m_missingObjectAction |
Determines whether objects are deleted when they are not found in the data source.
Only used when Direction=In
(Inherited from DataExchangeConfigurationBase.) |
| 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.
(Inherited from DataExchangeConfigurationBase.) |
| m_name |
The name of the DataExchange configuration
(Inherited from DataExchangeConfigurationBase.) |
| m_number |
Number of the configuration taken from a sequence
(Inherited from DataExchangeConfigurationBase.) |
| m_performOnOriginObjects |
Determines whether the MissingObjectAction can be performed on all object or only those
object which are created the this configuration
(Inherited from DataExchangeConfigurationBase.) |
| m_testMode |
In test mode, the data exchange is run normally, but data is not
committed to the database.
(Inherited from DataExchangeConfigurationBase.) |
| m_timerId |
If defined, the DataExchange is executed on this timer.
(Inherited from DataExchangeConfigurationBase.) |
| m_type |
Type of source/target system
(Inherited from DataExchangeConfigurationBase.) |
| m_uid |
UID of the configuration
(Inherited from DataExchangeConfigurationBase.) |
| 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.
(Inherited from DataExchangeConfigurationBase.) |
| m_userImport |
Determines whether its a User import.
Only used when Direction=In
(Inherited from DataExchangeConfigurationBase.) |
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. (Inherited from DataExchangeConfigurationBase.) |
| IObjectWithDataVersion.GetDataVersion | (Inherited from DataExchangeConfigurationBase.) |
| IObjectWithGuid.GetGuid | (Inherited from DataExchangeConfigurationBase.) |
| IObjectWithId.GetId | (Inherited from DataExchangeConfigurationBase.) |
See Also