SystemOnboardingController Class |
Namespace: Omada.OE.Solution.OIM.AppLogic.SystemOnboarding
public class SystemOnboardingController : SOBControllerBase
The SystemOnboardingController type exposes the following members.
Name | Description | |
---|---|---|
![]() | SystemOnboardingController(String) |
Constructor
|
![]() | SystemOnboardingController(ControllerBase) |
Constructor
|
![]() | SystemOnboardingController(SqlConnection, SqlTransaction, Int32) |
Constructor
|
Name | Description | |
---|---|---|
![]() | ConnectionString |
Connection string for the database.
Can be null.
(Inherited from ControllerBase.) |
![]() | DbCommandTimeout |
DbCommandTimeout is applied to SqlCommand objects created using CreateSqlCommand().
The DbCommandTimeout value is (normally) passed on to other controllers created by the controller.
If DbCommandTimeout is Zero then the DB default will be used as timeout.
(Inherited from ControllerBase.) |
![]() | DbConnection |
Consider using CreateCommand() instead of accessing DbConnection directly.
DbConnection and DbTransaction are either specified when constucting the controller or
the controller constructs them itself (by using ConnectionString) when calling DoInConnection or DoInTransaction.
If the caller specified DbConnection and DbTransaction when constucting the controller then the caller is responsible for the management of the connection.
(Inherited from ControllerBase.) |
![]() | DbTransaction |
Consider using CreateCommand() instead of accessing DbTransaction directly.
DbConnection and DbTransaction are either specified when constucting the controller or
the controller constructs them itself (by using ConnectionString) when calling DoInConnection or DoInTransaction.
If the caller specified DbConnection and DbTransaction when constucting the controller then the caller is responsible for the management of the connection.
(Inherited from ControllerBase.) |
![]() | Factory |
Factory class for creating controller instances.
(Inherited from ControllerBase.) |
![]() ![]() | SystemIDInvalidCharRegex |
Name | Description | |
---|---|---|
![]() | BuildCacheKey |
Builds a cache key for use with GetFromCacheIfPresent.
The cache key is not hashed because we have experienced a collision using GetHashCode()
ie. the cache keys are quite long and there is a price in dictionary size in memory
and in dictionary lookups.
(Inherited from ControllerBase.) |
![]() | CheckObjectOperationSecurity |
Checks that the active user is allowed to perform an CRUD operation on a specific configuration object.
(note: except that a Create operation is not for a specific object).
Throws a SecurityException if not.
Method can be used for all configuration objects that are represented by a ConfigurationObjectType (except those that have a compound key).
Method checks auth role security as well as whether it is allowed to modify builtin/feature package objects.
(Inherited from ControllerBase.) |
![]() | CheckObjectSaveOperationSecurity |
Checks that the active user is allowed to Create a new - or Update an existing configuration object.
Throws a SecurityException if not.
Method can be used for all configuration objects that are represented by a ConfigurationObjectType (except those that have a compound key).
Method checks auth role security as well as whether it is allowed to modify builtin/feature package objects.
(Inherited from ControllerBase.) |
![]() | ConvertId(Int32, ConfigurationObjectType) |
Converts the integer id of an object to its transport-safe unique id (UId).
(Inherited from ControllerBase.) |
![]() | ConvertId(String, ConfigurationObjectType) |
Converts a string representation of an integer or Guid id to an integer id.
(Inherited from ControllerBase.) |
![]() | ConvertId(Guid, ConfigurationObjectType, Boolean) |
Converts the transport-safe unique id (UId) of an object to its integer id.
(Inherited from ControllerBase.) |
![]() | ConvertIds(IEnumerableGuid, ConfigurationObjectType) |
Converts the transport-safe unique ids (UId) of a number of objects to integer ids.
(Inherited from ControllerBase.) |
![]() | ConvertIds(IEnumerableInt32, ConfigurationObjectType) |
Converts the integer ids of a number of objects to their transport-safe unique ids (UId).
(Inherited from ControllerBase.) |
![]() | CreateCommand(SQLBuilder) | (Inherited from ControllerBase.) |
![]() | CreateCommand(String) | (Inherited from ControllerBase.) |
![]() | CreateSqlBulkCopy |
Create a new SqlBulkCopy instance using the connection, transaction and timeout values from the controller
(Inherited from ControllerBase.) |
![]() | DeleteRegisteredSystem |
Deletes a registered system.
Following systems can be deleted:
Primary systems
Systems from single instance collectors
Offline generic systems
Systems were no import has been done yet (ODWBUSIKEY is emtpy)
Note: when deleting a primary system will the system category system and data connection ALSO be deleted
|
![]() | DoInConnection(ControllerBaseActionWithNoResult) |
Executes an action that doesn't return a result. If no current connection exists, it will establish a connection to the database and close it afterwards.
An existing connection will be reused. Inside the action, the connection is available as DbConnection.
(Inherited from ControllerBase.) |
![]() | DoInConnection(ActionSqlConnection, SqlTransaction, Boolean) |
Executes an action that doesn't return a result. If no current connection exists, it will establish a connection to the database and close it afterwards.
Connection and Transaction are passed to delegate, to allow passing to other controllers
An existing connection will be reused. Inside the action, the connection is available as DbConnection.
To ensure a new connection set forceNew to true.
(Inherited from ControllerBase.) |
![]() | DoInConnectionT(ControllerBaseActionWithResultT) |
Executes an action and returns the result.
If no current connection exists, it will establish a connection to the database and close it afterwards.
An existing connection will be reused. Inside the action, the connection is available as DbConnection.
(Inherited from ControllerBase.) |
![]() | DoInTransaction(ControllerBaseActionWithNoResult) |
Executes an action (that doesn't return a result) in a transaction.
If no current connection and/or transaction exists, it will establish it and commit and close it afterwards.
An existing connection/transaction will be reused.
Inside the action, the connection is available as DbConnection and
the transaction as DbTransaction.
(Inherited from ControllerBase.) |
![]() | DoInTransactionT(ControllerBaseActionWithResultT) |
Executes an action in a transaction and returns the result.
If no current connection and/or transaction exists, it will establish it and commit and close it afterwards.
An existing connection/transaction will be reused.
Inside the action, the connection is available as DbConnection and
the transaction as DbTransaction.
(Inherited from ControllerBase.) |
![]() | DoInTransactionT(FuncSqlConnection, SqlTransaction, T, Boolean) |
Executes an action in a transaction and returns the result.
Connection and Transaction are passed to delegate, to allow passing to other controllers
If no current connection and/or transaction exists, it will establish it and commit and close it afterwards.
An existing connection/transaction will be reused. Set forceNew to true to ensure new connection and transaction
Inside the action, the connection is available as DbConnection and
the transaction as DbTransaction.
(Inherited from ControllerBase.) |
![]() | DoInTransactionUnlessPostponedDueToPreviousDefaultResultT |
The method can postpone a SQL transaction implemented by action if the method returns a default number, eg. 0.
If the the action method throws a SQL transitent error, then the next call to action is also postponed.
(Inherited from ControllerBase.) |
![]() | DoUnlessPostponedDueToPreviousDefaultResultT |
The method can postpone a method invocation if the previous call returned a default number, eg. 0.
(Inherited from ControllerBase.) |
![]() | ExecScalarResultQueryT |
Executes a query with a scalar result.
(Inherited from ControllerBase.) |
![]() | ExecuteMutexOperation(String, Action, Boolean) | (Inherited from ControllerBase.) |
![]() | ExecuteMutexOperationT(String, FuncT, Boolean) | (Inherited from ControllerBase.) |
![]() | ExpireCacheItem | (Inherited from ControllerBase.) |
![]() | GenerateImportThresholdId |
Generates ID for a threshold, the id is to be used when sending configuration to the threshold service
|
![]() | GetCollectorConfiguration |
Returns all system onboarding values required by the collector
|
![]() | GetDataConnectionForSystem(Int32, Boolean) |
This function will return the DataConnection data object for a system
If the data connection doesnt not exists will it create a new (id createIfMissing=true)
Function will update the SYSONB_DATACONNECTION property on the system object if it was missing
|
![]() | GetDataConnectionForSystem(DataObject, Boolean) |
This function will return the DataConnection data object for a system
If the data connection doesnt not exists will it create a new (id createIfMissing=true)
Function will update the SYSONB_DATACONNECTION property on the system object if it was missing
|
![]() | GetDbUTCNow | (Inherited from ControllerBase.) |
![]() | GetDerivedSystems |
Returns a list of possible derived systems for an umbrella system
|
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultIntegerList, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultAppIdentity, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultBoolean, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultIListGuid, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultListGuid, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultListInt32, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultGuid, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultInt32, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultTimeZoneInfo, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresentT(String, ControllerBaseActionWithResultListT, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresentT(String, ControllerBaseActionWithResultT, ControllerBaseCacheOptions) |
Retrieves some data from the cache or (if it is not there) executes an action and stores the result in the cache.
Caching is not applied if the IgnoreCacheContext is used (depending on the parameter for it).
Note: caching should only be used with great care as there are a number of potential issues involved in using it!
(Inherited from ControllerBase.) |
![]() | GetNewRowIdentity | (Inherited from ControllerBase.) |
![]() | GetObjectDataVersion |
Gets the data version of an object.
(Inherited from ControllerBase.) |
![]() | GetOnboarderdDerivedSystems |
Gets onboarded derived systems from the primary system.
|
![]() | GetSystemCategory |
Returns the system category dataobject for the system
|
![]() | GetSystemCategoryId |
this method is abstraction which implementation is subject to change when final design is in place
|
![]() | GetSystemContentType |
Return the content type (HRData, Access Data, Both) the system or category contains
|
![]() | GetSystemObjectFromString |
Looks up a system object
|
![]() | GetSystemRelatedObjects |
this functions looksup all the data objects whic is related to a system in system onboarding
|
![]() | GetSystems |
Get a list of the systems which is part of the system onboarding
|
![]() | GetSystemStatus |
this methods returns an overall system status
0 if system is idle
1 if odw is importing or exporting data
2 if rope is calculating
3 if rope failed to calculate identites
4 if import/export package failed
5 if one or more export objects failed
|
![]() | IncrementDataVersion | (Inherited from ControllerBase.) |
![]() | IncrementObjectDataVersion(IEntityObject) |
Increments the data version of an entity object.
The data version is incremented in the db as well as on the object itself.
Method is used to update the data version of an object when an aggregated object is created/modified/deleted.
The purpose is to ensure that the id-based cache (in AppIdentity) is updated properly.
(Inherited from ControllerBase.) |
![]() | IncrementObjectDataVersion(Int32, EntityObjectType) |
Increments the data version of an entity object in the db.
Method is used to update the data version of an object when an aggregated object is created/modified/deleted.
The purpose is to ensure that the id-based cache (in AppIdentity) is updated properly.
(Inherited from ControllerBase.) |
![]() | IsUserSolutionAdministrator |
Returns true is the authenticated user is considered administrator of system onboarding
|
![]() | IsUserSystemOwner(Int32) |
Returns true if the authenticated user is a system owner of the specified system
|
![]() | IsUserSystemOwner(ListInt32, Boolean) |
Returns true if the authenticated user is a system owner of all the specified systems
|
![]() | ParseThresholdIdAndGetInfo |
Returns object for thresholdId with parsed values
|
![]() | ParseThresholdInterval |
Parses a "hh:mm:ss" to timespan
|
![]() | PopulateTempTableT |
Creates a temporary db table with a single column and populates it with values.
(Inherited from ControllerBase.) |
![]() | PostponeTransientErrorT |
If the action throws a transient sql error, the exception is eaten.
An entry is written to the log with level Information.
The entire exception is written to the log with level Debug.
(Inherited from ControllerBase.) |
![]() | RegisterNewSystem(Int32, Int32, String, String, Boolean, Int32, SystemContent, String, String, Boolean, String) |
Registers a new system
|
![]() | RegisterNewSystem(NullableInt32, NullableInt32, String, String, Boolean, Int32, Int32, String, String, Boolean, String) |
Registers a new system
|
![]() | ReprocessAllIdentities |
Use with care
This method will execute the 'spAddAllToQueue' stored procedure in the RoPE database
|
![]() | ReprocessFailedIdentities |
Re-queues all failed identities
|
![]() | RequiresThresholdMigration |
Determines if the system requires a threshold migration
|
![]() | SetGeneralSettings |
Changed the general settings of a registered system.
Allows changing system name, system ID and content.
Note that changes cannot occur if data is already present in ODW (checked with SystemHasImportedData() help function).
System category name and SC_IDENT is also changed if only one system instance exists (checked with OC_SINGLEINSTANCE property).
|
![]() | SystemHasImportedData |
Checks if a system has been part of a dataware house import
Currently it checks if ODWBUSIKEY is empty or not
If empty it will connect to the warehouse and check if the category is present in ODWSourceSystem
|
![]() | TransferUIdsToIdsLoadOption |
Converts/transfers one or more specified uids in a loadoptions object to ids.
The purpose is to enable caching as IEntityObjectsLoadOptions.IdList only works with ids (and not uids).
(Inherited from ControllerBase.) |
![]() | UpdateImportThresholdValues |
Updates thresholds on the system
|
![]() | UpdateOnboardingValues |
This function will save configuration values for a particular onboarding section
If the section contains parameters from several scopes (data objects) then each configuration will be updated
|
![]() | UpdateSystemNotification |
Sets the SOBONB_NOTIFICATION property
|
![]() | ValidateDataVersionT |
Validates that the data version of an object corresponds to the data version in the DB.
Method is used for validation before saving an object.
(Inherited from ControllerBase.) |
Name | Description | |
---|---|---|
![]() ![]() | SystemIDInvalidIDs |
the list is used to prevent forbidden names
|
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.) |