Click or drag to resize

DataExchangeLDAPConfiguration Class

Models the DataExchange towards a LDAP directory
Inheritance Hierarchy
SystemObject
  Omada.OE.ModelDataExchangeConfigurationBase
    Omada.OE.ModelDataExchangeLDAPConfiguration

Namespace:  Omada.OE.Model
Assembly:  Omada.OE.Model (in Omada.OE.Model.dll) Version: 15.0.0.0
Syntax
C#
[SerializableAttribute]
public class DataExchangeLDAPConfiguration : DataExchangeConfigurationBase

The DataExchangeLDAPConfiguration type exposes the following members.

Constructors
  NameDescription
Public methodDataExchangeLDAPConfiguration
Constuct the DataExchangeLDAPConfiguration object
Top
Properties
  NameDescription
Public propertyChangedBy
Entity data version for static cache synchonization
(Inherited from DataExchangeConfigurationBase.)
Public propertyChangeTime
Date of last change of the configuration
(Inherited from DataExchangeConfigurationBase.)
Public propertyCreatedBy
ID of User who created the configuration
(Inherited from DataExchangeConfigurationBase.)
Public propertyCreateTime
Date when configuration was created initially
(Inherited from DataExchangeConfigurationBase.)
Public propertyDataObjectTypeId
Provides the DataObjectType of the objects being imported/exported
(Inherited from DataExchangeConfigurationBase.)
Public propertyDataVersion
Entity data version for static cache synchonization
(Inherited from DataExchangeConfigurationBase.)
Public propertyDirection
Inbound or outbound
(Inherited from DataExchangeConfigurationBase.)
Public propertyDisregardGroupMembership
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.)
Public propertyFailCMDLineOnErrors
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.)
Public propertyFields
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.)
Public propertyId
ID of the configuration
(Inherited from DataExchangeConfigurationBase.)
Public propertyImportMode
ImportMode is only used if Direction=In.
(Inherited from DataExchangeConfigurationBase.)
Public propertyKeyField
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.)
Public propertyLDAPFilter
Used for filtering the objects when reading from LDAP. Only used when Direction=In.
Public propertyLDAPParentNode
The root node in the directory from which the objects are read/written
Public propertyLDAPPassword
Username for authentication towards LDAP
Public propertyLDAPServerName
DNS name of server
Public propertyLDAPServerPort
LDAP TCP port, typically 389
Public propertyLDAPUserName
Username for authentication towards LDAP
Public propertyMissingObjectAction
Determines whether objects are deleted when they are not found in the data source. Only used when Direction=In
(Inherited from DataExchangeConfigurationBase.)
Public propertyMissingReferenceAction
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.)
Public propertyName
The name of the DataExchange configuration
(Inherited from DataExchangeConfigurationBase.)
Public propertyNumber
Number of the configuration taken from a sequence
(Inherited from DataExchangeConfigurationBase.)
Public propertyPerformOnOriginObjects
Determines whether the MissingObjectAction can be performed on all object or only those object which are created the this configuration
(Inherited from DataExchangeConfigurationBase.)
Public propertyTestMode
In test mode, the data exchange is run normally, but data is not committed to the database.
(Inherited from DataExchangeConfigurationBase.)
Public propertyTimerId
If defined, the DataExchange is executed on this timer.
(Inherited from DataExchangeConfigurationBase.)
Public propertyType
Type of source/target system
(Inherited from DataExchangeConfigurationBase.)
Public propertyUId
UID of the configuration
(Inherited from DataExchangeConfigurationBase.)
Public propertyUserGroupIds
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.)
Public propertyUserImport
Determines whether its a User import. Only used when Direction=In
(Inherited from DataExchangeConfigurationBase.)
Top
Methods
  NameDescription
Public methodFieldMapContainsKeyField
Returns true if the configuration's keyfield is present in the configuration's fieldmap.
(Inherited from DataExchangeConfigurationBase.)
Public methodRemoveInvalidFields
Removes fields from fields collection which are not available in the provided DataObjectType
(Inherited from DataExchangeConfigurationBase.)
Public methodValidate
Validates that a parent node is provided when direction is out (export)
(Overrides DataExchangeConfigurationBaseValidate(String).)
Top
Fields
  NameDescription
Protected fieldm_changedBy
ID user user whi performed the last change of the configuration
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_changeTime
Date of last change of the configuration
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_createdBy
ID of User who created the configuration
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_createTime
Date when configuration
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_dataObjectTypeId
Provides the DataObjectType of the objects being imported/exported
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_dataVersion
Entity data version for static cache synchonization
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_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.)
Protected fieldm_id
ID of the configuration
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_importMode
ImportMode is only used if Direction=In.
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_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.)
Protected fieldm_missingObjectAction
Determines whether objects are deleted when they are not found in the data source. Only used when Direction=In
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_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.)
Protected fieldm_name
The name of the DataExchange configuration
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_number
Number of the configuration taken from a sequence
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_performOnOriginObjects
Determines whether the MissingObjectAction can be performed on all object or only those object which are created the this configuration
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_testMode
In test mode, the data exchange is run normally, but data is not committed to the database.
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_timerId
If defined, the DataExchange is executed on this timer.
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_type
Type of source/target system
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_uid
UID of the configuration
(Inherited from DataExchangeConfigurationBase.)
Protected fieldm_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.)
Protected fieldm_userImport
Determines whether its a User import. Only used when Direction=In
(Inherited from DataExchangeConfigurationBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBool
Converts object to boolean.
(Defined by ObjectExtensions.)
Public Extension MethodToDateTime
Converts object to DateTime.
(Defined by ObjectExtensions.)
Public Extension MethodToInt
Converts object to integer.
(Defined by ObjectExtensions.)
Top
Explicit Interface Implementations
See Also