Click or drag to resize

UserIDGeneratorParameters Class

Parameter class for identity/user id generation
Inheritance Hierarchy
SystemObject
  Omada.OE.Solution.OIM.ModelUserIDGeneratorParameters

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

The UserIDGeneratorParameters type exposes the following members.

Constructors
  NameDescription
Public methodUserIDGeneratorParameters
Default constructor
Top
Properties
  NameDescription
Public propertyBlacklistedValues
Contains a number of blacklisted values like for ex. "ASS" or "FUCK".
Public propertyDataSourceIdForDuplicateCheck
UId of Data Source object which contains query used for check of uniqueness The datasource must contain a parameter "userId" which should be used to compare the generated userid agains the external data source in the query e.g: SELECT 1 FROM users where username = @userId If the data source query returns a result, the generated identity id is NOT unique
Public propertyLength
Specifies the length of the generated userid. The prefix and postfix are not considered for the length.
Public propertyMaxNumberOfTries
Number of attempts to create the identity id before throwing exception
Public propertyNames
Collection of IdentityIdName objects used to generate the identity id
Public propertyNegativeCharacters
All characters from this collection will be skipped when generating the identity id
Public propertyPositiveCharacters
If not empty - Only characters in this collection will be used when generating the identity id
Public propertyPostfix
The postfix (in uppercase) will be postfixed to the generated userid.
Public propertyPostfixNumber
If true, a number using the offset in the PostfixNumberOffset parameter will be postfixed to the generated user id. E.g. if the generated user id is "MVA" and the offset is 200 the final user id will be "MVA200" and "MVA201" for subsequent user ids (if the generated user id is "MVA") When the generated user id differes from any previous generated user id, the offset number will be reset
Public propertyPostfixNumberOffset
Offset to postfix the generated user id with
Public propertyPostfixSequence
If true a sequence number will be postfixed to the generated userid.
Public propertyPostfixSequenceId
Specifies the id of a sequence in OIM that will be used for generating postfixes. Is only used if PostfixSequence is true.
Public propertyPostfixSequenceLength
Minimum length of the postfixed sequence number. Example: if the PostfixSequenceLength is 4 and a sequence number of 147 is generated the value "0147" is postfixed. Is only used if PostfixSequence is true.
Public propertyPrefix
The prefix (in uppercase) will be prepended to the generated userid.
Public propertySeparator
Character which will be appended after each string property value, e.g. to generate an id like "firstname.lastname"
Public propertySubstitutionRules
Contains a set of substitution rules. Any occurences of the strings will be substituted with the substitution-string. Example: if the letter "Æ" should be substituted with "AE" this combination should be added. Casing is disregarded - ex. "æ" means both "æ" and "Æ".
Public propertyToLowerCase
Convert all characters to lowercase
Public propertyUserDataObjectTypeIds
The ids of the "user" data object types must be added here. The data objects of these types will be checked to find whether a generated userid is unique.
Public propertyUserIdPropertyId
Id of the value property w. data type 'text' that holds the userid on the specified data object types.
Top
Methods
  NameDescription
Public methodAddNegativeCharString
Add a string of characters to the list of negative characters White spaces will be removed
Public methodAddPositiveCharString
Add a string of characters to the list of positive characters White spaces will be removed
Public methodComplyDefaultSubtitutionRule
The function converts illegal characters defined in the default subtitution rule to illegal characters, such as Å to A etc.
Public methodValidateParameters
Validate parameters
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
See Also