Cl.Core.Addons.WizardSetup 1.0.1

Acerca de Cl.Core.Addons.WizardSetup

Conjuto de funcionalidades que facilitan la gestión y operación del componente wizard setup. Este paquete permite realizar operaciones CRUD, brindando una integración fluida con la base de datos y los endpoints correspondientes.

¿Qué resuelve?

Este paquete soluciona la gestión de los endpoints requeridos para el manejo eficiente de las operaciones de POST, PATCH, GET, esenciales para el correcto funcionamiento del componente wizard setup. Proporciona las herramientas necesarias para interactuar con la base de datos de forma segura y eficiente, asegurando la persistencia y actualización de los datos vinculados a las configuraciones y sus pasos.

Rutinas

Nota

Para la implementación de las rutinas de creación y actualización es indispensable contar con la siguiente implementación:

En el Program.cs del proyecto, configurar la inyección de dependencias de la siguiente manera:

builder.Services.AddScoped<Cl.Core.Db.IServices, Cl.Core.Db.Services>();
builder.Services.AddScoped<Cl.Core.Structures.Interfaces.Common.ILogManager, Cl.Core.Common.LogManager>();
builder.Services.AddScoped<Cl.Core.Db.ICore, Cl.Core.Db.Core>();
builder.Services.AddScoped<Cl.Core.Structures.Interfaces.Common.ISettings, Cl.Core.Common.Settings>();
builder.Services.AddScoped<Cl.Core.Addons.WizardSetup.IWizardSetup, Cl.Core.Addons.WizardSetup.WizardSetup>();

UpdateConfigurationStepCompletedStatus<Microsoft.EntityFrameworkCore.DbContext> (IEnumerable<Cl.Core.Structures.Classes.WizardSetup.ConfigurationStep>, System.String) : Cl.Core.Structures.Classes.Rebound.CLContext<IEnumerable<Cl.Core.Structures.Classes.WizardSetup.ConfigurationStep>>

Descripción

Actualiza el estado completado del configuration step. Este método se utiliza cuando la aplicación no es multi-compañía.

Parametros

• _configurationSteps (Requerido): Lista de configuration steps que va a ser actualizados de estado completado.
• _dbResourceCode (Requerido): Código de objeto de base de datos que va a ser utilizado para la actualización de estado.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<IEnumerable<ConfigurationStep>> MyFunction(IEnumerable<ConfigurationStep> _configurationSteps)
{
    _logManager.Record($"UPDATING RECORDS...");
    
    var oClContext = WizardSetup.UpdateConfigurationStepCompletedStatus<MainDbContext>(_configurationSteps, "spUptConfigurationStepsStatus");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_UPT_CONFIGURATIONSTEPBYCOMPANY]
@Id INT,
@UpdatedBy NVARCHAR(100),
@IsCompleted BIT
AS
BEGIN
	UPDATE ConfigurationSteps SET
	UpdatedBy = @UpdatedBy,
	IsCompleted = @IsCompleted
	OUTPUT inserted.*
	WHERE Id = @Id;
END

---

UpdateConfigurationStepCompletedStatus<Microsoft.EntityFrameworkCore.DbContext> (IEnumerable<Cl.Core.Structures.Classes.WizardSetup.ConfigurationStepsByCompany>, System.String) : Cl.Core.Structures.Classes.Rebound.CLContext<IEnumerable<Cl.Core.Structures.Classes.WizardSetup.ConfigurationStepsByCompany>>

Descripción

Actualiza el estado completado del configuration step. Este método se utiliza cuando la aplicación es multi-compañía.

Parametros

• _configurationStepsByCompany (Requerido): Lista de configuration steps por compañía que va a ser actualizados de estado completado.
• _dbResourceCode (Requerido): Código de objeto de base de datos que va a ser utilizado para la actualización de estado.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<IEnumerable<ConfigurationStepsByCompany>> MyFunction(IEnumerable<ConfigurationStepsByCompany> _configurationStepsByCompany)
{
    _logManager.Record($"UPDATING RECORDS...");
    
    var oClContext = WizardSetup.UpdateConfigurationStepCompletedStatus<MainDbContext>(_configurationStepsByCompany, "spUptConfigurationStepsStatus");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_UPT_CONFIGURATIONSTEPBYCOMPANY]
    @Id INT,
    @ConfigurationStepId INT,
    @UpdatedBy NVARCHAR(100),
    @IsCompleted BIT,
    @CompanyId INT
AS
BEGIN

	IF (SELECT COUNT(*) FROM Companies WHERE Id = @CompanyId) = 0 
	BEGIN
		THROW 50001, 'DBV - The provided company Id does not exist.', 1;
	END

	IF (SELECT COUNT(*) FROM ConfigurationSteps WHERE Id = @ConfigurationStepId) = 0 
	BEGIN
		THROW 50002, 'DBV - The provided configuration step Id does not exist.', 1;
	END

	IF(SELECT COUNT(*) FROM ConfigurationStepsByCompanies WHERE CompanyId = @CompanyId AND ConfigurationStepId = @ConfigurationStepId) > 0
	BEGIN
		UPDATE ConfigurationStepsByCompanies SET
		IsCompleted = @IsCompleted,
		UpdateDate = GETDATE(),
		UpdatedBy = @UpdatedBy
		WHERE CompanyId = @CompanyId AND ConfigurationStepId = @ConfigurationStepId;
	END
	ELSE
	BEGIN
		INSERT INTO ConfigurationStepsByCompanies (CompanyId, ConfigurationStepId, CreatedBy, CreatedDate, IsActive, IsCompleted, UpdateDate, UpdatedBy)
		VALUES(@CompanyId, @ConfigurationStepId, @UpdatedBy, GETDATE(), 1, @IsCompleted, GETDATE(), @UpdatedBy);
	END
END

---

CreateConfiguration<Microsoft.EntityFrameworkCore.DbContext> (Cl.Core.Structures.Classes.WizardSetup.Configuration, System.String) : Cl.Core.Structures.Classes.Rebound.CLContext<Cl.Core.Structures.Classes.WizardSetup.Configuration>

Descripción

Crea un configuración en base de datos

Parametros

• _configuration (Requerido): Configuración que se va a crear en base de datos.
• _createConfigurationDbResource (Requerido): Código de objeto de base de datos que va a ser utilizado para la creación de la configuración.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<Configuration> MyFunction(Configuration _configurationSteps)
{
    _logManager.Record($"CREATING CONFIGURATION...");
    
    var oClContext = WizardSetup.CreateConfiguration<MainDbContext>(_configuration, "spCrtConfiguration");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_CRT_CONFIGURATION]
    @Name NVARCHAR(150),
    @CreatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @Icon NVARCHAR(50) NULL,
    @IsActive BIT
AS
BEGIN
    INSERT INTO [Configurations] (Name, CreatedBy, CreatedDate, Description, Icon, IsActive, UpdatedBy, UpdateDate)
    OUTPUT inserted.*
    VALUES (@Name, @CreatedBy, GETDATE(), @Description, @Icon, @IsActive, @CreatedBy, GETDATE());
END

---

CreateConfiguration<Microsoft.EntityFrameworkCore.DbContext> (Cl.Core.Structures.Classes.WizardSetup.Configuration, System.String, System.String) : Cl.Core.Structures.Classes.Rebound.CLContext<Cl.Core.Structures.Classes.WizardSetup.Configuration>

Descripción

Crea un configuración en base de datos junto con los configuration steps que hayan en el Steps propiedad.

Parametros

• _configuration (Requerido): Configuración que se va a crear en base de datos.
• _createConfigurationDbResource (Requerido): Código de objeto de base de datos que va a ser utilizado para la creación de la configuración.
• _createConfigurationStepDbResource (Requerido): Código de objeto de base de datos que va a ser utilizado para la creación de los configuration steps.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<Configuration> MyFunction(Configuration _configurationSteps)
{
    _logManager.Record($"CREATING CONFIGURATION...");
    
    var oClContext = WizardSetup.CreateConfiguration<MainDbContext>(_configuration, "spCrtConfiguration", "spCrtConfigurationStep");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

Crear configuración

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_CRT_CONFIGURATION]
    @Name NVARCHAR(150),
    @CreatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @Icon NVARCHAR(50) NULL,
    @IsActive BIT
AS
BEGIN
    INSERT INTO [Configurations] (Name, CreatedBy, CreatedDate, Description, Icon, IsActive, UpdatedBy, UpdateDate)
    OUTPUT inserted.*
    VALUES (@Name, @CreatedBy, GETDATE(), @Description, @Icon, @IsActive, @CreatedBy, GETDATE());
END

Crear paso de configuración

Configuración multicompañía

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_CRT_CONFIGURATIONSTEP]
    @Name NVARCHAR(150),
    @CreatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @ConfigurationURL NVARCHAR(MAX),
    @ConfigurationId INT,
    @IsActive BIT
AS
BEGIN
    INSERT INTO ConfigurationSteps(Name, Description, ConfigurationURL, ConfigurationId, CreatedDate, CreatedBy, UpdateDate, UpdatedBy, IsActive)
    OUTPUT inserted.*
    VALUES (@Name, @Description, @ConfigurationURL, @ConfigurationId, GETDATE(), @CreatedBy, GETDATE(), @CreatedBy, @IsActive);
END

Configuración no-multicompañía

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_CRT_CONFIGURATIONSTEP]
    @Name NVARCHAR(150),
    @CreatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @ConfigurationURL NVARCHAR(MAX),
    @ConfigurationId INT,
    @IsCompleted BIT,
    @IsActive BIT
AS
BEGIN
    INSERT INTO ConfigurationSteps(Name, Description, ConfigurationURL, ConfigurationId, CreatedDate, CreatedBy, UpdateDate, UpdatedBy, IsActive, IsCompleted)
    OUTPUT inserted.*
    VALUES (@Name, @Description, @ConfigurationURL, @ConfigurationId, GETDATE(), @CreatedBy, GETDATE(), @CreatedBy, @IsActive, @IsCompleted);
END

---

CreateConfigurationStep<Microsoft.EntityFrameworkCore.DbContext> (Cl.Core.Structures.Classes.WizardSetup.ConfigurationStep, System.String) : Cl.Core.Structures.Classes.Rebound.CLContext<Cl.Core.Structures.Classes.WizardSetup.ConfigurationStep>

Descripción

Crea en base de datos un configuration step.

Parametros

• _configurationStep (Requerido): Configuration step con la información que se va a crear en base de datos.
• _createConfigurationStepDbResource (Requerido): Código de objeto de base de datos que va a ser utilizado para la creación de los configuration steps.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<ConfigurationStep> MyFunction(ConfigurationStep _configurationStep)
{
    _logManager.Record($"CREATING CONFIGURATION...");
    
    var oClContext = WizardSetup.CreateConfigurationStep<MainDbContext>(_configurationStep, "spCrtConfigurationStep");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

Configuración multicompañía

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_CRT_CONFIGURATIONSTEP]
    @Name NVARCHAR(150),
    @CreatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @ConfigurationURL NVARCHAR(MAX),
    @ConfigurationId INT,
    @IsActive BIT
AS
BEGIN
    INSERT INTO ConfigurationSteps(Name, Description, ConfigurationURL, ConfigurationId, CreatedDate, CreatedBy, UpdateDate, UpdatedBy, IsActive)
    OUTPUT inserted.*
    VALUES (@Name, @Description, @ConfigurationURL, @ConfigurationId, GETDATE(), @CreatedBy, GETDATE(), @CreatedBy, @IsActive);
END

Configuración no-multicompañía

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_CRT_CONFIGURATIONSTEP]
    @Name NVARCHAR(150),
    @CreatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @ConfigurationURL NVARCHAR(MAX),
    @ConfigurationId INT,
    @IsCompleted BIT,
    @IsActive BIT
AS
BEGIN
    INSERT INTO ConfigurationSteps(Name, Description, ConfigurationURL, ConfigurationId, CreatedDate, CreatedBy, UpdateDate, UpdatedBy, IsActive, IsCompleted)
    OUTPUT inserted.*
    VALUES (@Name, @Description, @ConfigurationURL, @ConfigurationId, GETDATE(), @CreatedBy, GETDATE(), @CreatedBy, @IsActive, @IsCompleted);
END

---

GetConfigurations<Microsoft.EntityFrameworkCore.DbContext> (System.String, System.String, System.Boolean) : Cl.Core.Structures.Classes.Rebound.CLContext<IEnumerable<Cl.Core.Structures.Classes.WizardSetup.Configuration>>

Descripción

Obtiene todos las configuraciones registradas y sus pasos.

Parametros

• _requestConfigurationDbResource (Requerido): Código de objeto de base de datos que será utilizado para consultar las configuraciones.
• _requestConfigurationStepsDbResource (Requerido): Código de objeto de base de datos que va a ser utilizado para la creación de los configuration steps.
• _sendCompanyIdParameter (Opcional): Indica si debe enviar el ID de la compañía que se encuentra en el item del contexto CompanyKey.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<IEnumerable<Configuration>> MyFunction()
{
    _logManager.Record($"REQUESTING CONFIGURATION...");
    
    var oClContext = WizardSetup.GetConfigurations<MainDbContext>("spSltConfigurations", "spSltConfigurationSteps");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

Obtener configuraciones

CREATE VIEW [dbo].[CL_D_CL_MLT_PMS_SLT_CONFIGURATIONS]
AS
    SELECT
        c.CreatedBy,
        c.CreatedDate,
        c.Icon,
        c.Description,
        c.Id,
        c.IsActive,
        c.Name,
        c.UpdateDate,
        c.UpdatedBy
    FROM [Configurations] c
GO

Obtener pasos de configuraciones

Configuración multcompañía

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_SLT_CONFIGURATIONSTEPS]
@CompanyId INT, 
@ConfigurationId INT
AS
BEGIN
    SELECT
        cs.ConfigurationId,
        cs.ConfigurationURL,
        cs.CreatedBy,
        cs.CreatedDate,
        cs.Description,
        cs.Id,
        cs.IsActive,
        cs.Name,
        cs.UpdateDate,
        cs.UpdatedBy,
        csc.IsCompleted
    FROM ConfigurationSteps cs
    JOIN ConfigurationStepsByCompanies csc ON cs.Id = csc.ConfigurationStepId AND csc.CompanyId = @CompanyId
    WHERE cs.ConfigurationId = @ConfigurationId;
END

Configuración no-mutilcompañíá

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_SLT_CONFIGURATIONSTEPS]
@ConfigurationId INT
AS
BEGIN
    SELECT
        cs.ConfigurationId,
        cs.ConfigurationURL,
        cs.CreatedBy,
        cs.CreatedDate,
        cs.Description,
        cs.Id,
        cs.IsActive,
        cs.Name,
        cs.UpdateDate,
        cs.UpdatedBy,
        cs.IsCompleted
    FROM ConfigurationSteps cs
    WHERE cs.ConfigurationId = @ConfigurationId;
END

---

GetConfigurations<Microsoft.EntityFrameworkCore.DbContext> (System.String, System.String, System.Int32) : Cl.Core.Structures.Classes.Rebound.CLContext<IEnumerable<Cl.Core.Structures.Classes.WizardSetup.Configuration>>

Descripción

Obtiene todos las configuraciones registradas y sus pasos.

Parametros

• _requestConfigurationDbResource (Requerido): Código de objeto de base de datos que será utilizado para consultar las configuraciones.
• _requestConfigurationStepsDbResource (Requerido): Código de objeto de base de datos que va a ser utilizado para la creación de los configuration steps.
• _companyId (Requerido): Identificador de la compañía de donde se van a consultar los pasos.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<IEnumerable<Configuration>> MyFunction(int _companyId)
{
    _logManager.Record($"REQUESTING CONFIGURATION...");
    
    var oClContext = WizardSetup.GetConfigurations<MainDbContext>("spSltConfigurations", "spSltConfigurationSteps", _companyId);
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

Obtener configuraciones

CREATE VIEW [dbo].[CL_D_CL_MLT_PMS_SLT_CONFIGURATIONS]
AS
    SELECT
        c.CreatedBy,
        c.CreatedDate,
        c.Icon,
        c.Description,
        c.Id,
        c.IsActive,
        c.Name,
        c.UpdateDate,
        c.UpdatedBy
    FROM [Configurations] c
GO

Obtener pasos de configuraciones

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_SLT_CONFIGURATIONSTEPS]
@CompanyId INT, 
@ConfigurationId INT
AS
BEGIN
    SELECT
        cs.ConfigurationId,
        cs.ConfigurationURL,
        cs.CreatedBy,
        cs.CreatedDate,
        cs.Description,
        cs.Id,
        cs.IsActive,
        cs.Name,
        cs.UpdateDate,
        cs.UpdatedBy,
        csc.IsCompleted
    FROM ConfigurationSteps cs
    JOIN ConfigurationStepsByCompanies csc ON cs.Id = csc.ConfigurationStepId AND csc.CompanyId = @CompanyId
    WHERE cs.ConfigurationId = @ConfigurationId;
END

---

GetConfigurations<Microsoft.EntityFrameworkCore.DbContext> (System.String) : Cl.Core.Structures.Classes.Rebound.CLContext<IEnumerable<Cl.Core.Structures.Classes.WizardSetup.Configuration>>

Descripción

Obtiene todos las configuraciones registradas.

Parametros

• _requestConfigurationDbResource (Requerido): Código de objecto de base de datos que sera utilizado para consultar las configuraciones.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<IEnumerable<Configuration>> MyFunction()
{
    _logManager.Record($"REQUESTING CONFIGURATION...");
    
    var oClContext = WizardSetup.GetConfigurations<MainDbContext>("spSltConfigurations");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

CREATE VIEW [dbo].[CL_D_CL_MLT_PMS_SLT_CONFIGURATIONS]
AS
    SELECT
        c.CreatedBy,
        c.CreatedDate,
        c.Icon,
        c.Description,
        c.Id,
        c.IsActive,
        c.Name,
        c.UpdateDate,
        c.UpdatedBy
    FROM [Configurations] c
GO

---

GetConfigurationsSteps<Microsoft.EntityFrameworkCore.DbContext> (System.Int32, System.String, System.Boolean) : Cl.Core.Structures.Classes.Rebound.CLContext<IEnumerable<Cl.Core.Structures.Classes.WizardSetup.ConfigurationStep>>

Descripción

Obtiene todos las configuraciones registradas.

Parametros

• _configurationId (Requerido): Representa el identificador de la configuración a la cual estan relacionados los pasos.
• _requestConfigurationDbResource (Requerido): Código de objecto de base de datos que sera utilizado para consultar las configuraciones.
• _sendCompanyIdParameter (Opcional): Indica si debe enviar el ID de la compañía que se encuentra en el item del contexto CompanyKey.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<IEnumerable<ConfigurationStep>> MyFunction(int _configurationId)
{
    _logManager.Record($"REQUESTING CONFIGURATION...");
    
    var oClContext = WizardSetup.GetConfigurations<MainDbContext>(_configurationId, "spSltConfigurations");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

Configuración multcompañía

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_SLT_CONFIGURATIONSTEPS]
@CompanyId INT, 
@ConfigurationId INT
AS
BEGIN
    SELECT
        cs.ConfigurationId,
        cs.ConfigurationURL,
        cs.CreatedBy,
        cs.CreatedDate,
        cs.Description,
        cs.Id,
        cs.IsActive,
        cs.Name,
        cs.UpdateDate,
        cs.UpdatedBy,
        csc.IsCompleted
    FROM ConfigurationSteps cs
    JOIN ConfigurationStepsByCompanies csc ON cs.Id = csc.ConfigurationStepId AND csc.CompanyId = @CompanyId
    WHERE cs.ConfigurationId = @ConfigurationId;
END

Configuración no-mutilcompañíá

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_SLT_CONFIGURATIONSTEPS]
@ConfigurationId INT
AS
BEGIN
    SELECT
        cs.ConfigurationId,
        cs.ConfigurationURL,
        cs.CreatedBy,
        cs.CreatedDate,
        cs.Description,
        cs.Id,
        cs.IsActive,
        cs.Name,
        cs.UpdateDate,
        cs.UpdatedBy,
        cs.IsCompleted
    FROM ConfigurationSteps cs
    WHERE cs.ConfigurationId = @ConfigurationId;
END

---

GetConfigurationsSteps<Microsoft.EntityFrameworkCore.DbContext> (System.Int32, System.String, System.Int32) : Cl.Core.Structures.Classes.Rebound.CLContext<IEnumerable<Cl.Core.Structures.Classes.WizardSetup.ConfigurationStep>>

Descripción

Obtiene todos las configuraciones registradas.

Parametros

• _configurationId (Requerido): Representa el identificador de la configuración a la cual estan relacionados los pasos.
• _requestConfigurationDbResource (Requerido): Código de objecto de base de datos que sera utilizado para consultar las configuraciones.
• _companyId (Requerido): Identificador de la compañía de la cual se va a obtener la información de los steps.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<IEnumerable<ConfigurationStep>> MyFunction(int _configurationId)
{
    _logManager.Record($"REQUESTING CONFIGURATION...");
    
    var oClContext = WizardSetup.GetConfigurations<MainDbContext>(_configurationId, "spSltConfigurations");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_SLT_CONFIGURATIONSTEPS]
@CompanyId INT, 
@ConfigurationId INT
AS
BEGIN
    SELECT
        cs.ConfigurationId,
        cs.ConfigurationURL,
        cs.CreatedBy,
        cs.CreatedDate,
        cs.Description,
        cs.Id,
        cs.IsActive,
        cs.Name,
        cs.UpdateDate,
        cs.UpdatedBy,
        csc.IsCompleted
    FROM ConfigurationSteps cs
    JOIN ConfigurationStepsByCompanies csc ON cs.Id = csc.ConfigurationStepId AND csc.CompanyId = @CompanyId
    WHERE cs.ConfigurationId = @ConfigurationId;
END

---

UpdateConfiguration<Microsoft.EntityFrameworkCore.DbContext> (Cl.Core.Structures.Classes.WizardSetup.Configuration, System.string) : Cl.Core.Structures.Classes.Rebound.CLContext<Cl.Core.Structures.Classes.WizardSetup.Configuration>

Descripción

Actualiza una configuración en base de datos.

Parametros

• _configuration (Requerido): Configuración con la información que se va a actualizar en base de datos.
• _updateConfigurationDbResource (Requerido): Código de objecto de base de datos que sera utilizado para actualizar la configuración.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<Configuration> MyFunction(Configuration _configuration)
{
    _logManager.Record($"REQUESTING CONFIGURATION...");
    
    var oClContext = WizardSetup.UpdateConfiguration<MainDbContext>(_configuration, "spUptConfigurations");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_UPT_CONFIGURATION]
    @Id INT,
    @Name NVARCHAR(150),
    @UpdatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @Icon NVARCHAR(50) NULL,
    @IsActive BIT
AS
BEGIN
    UPDATE [Configurations] SET
        Name = @Name,
        UpdatedBy = @UpdatedBy,
        Description = @Description,
        IsActive = @IsActive,
        Icon = @Icon,
        UpdateDate = GETDATE()
    OUTPUT inserted.*
    WHERE Id = @Id;
END 

---

UpdateConfiguration<Microsoft.EntityFrameworkCore.DbContext> (Cl.Core.Structures.Classes.WizardSetup.Configuration, System.string, System.string) : Cl.Core.Structures.Classes.Rebound.CLContext<Cl.Core.Structures.Classes.WizardSetup.Configuration>

Descripción

Actualiza una configuración en base de datos y sus pasos que vayan en la Steps propiedad.

Parametros

• _configuration (Requerido): Configuración con la información que se va a actualizar en base de datos.
• _updateConfigurationDbResource (Requerido): Código de objeto de base de datos que sera utilizado para actualizar la configuración.
• _updateConfigurationStepsDbResource (Requerido): Código de objeto de base de datos que sera utilizado para actualizar los configuration step.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<Configuration> MyFunction(Configuration _configuration)
{
    _logManager.Record($"REQUESTING CONFIGURATION...");
    
    var oClContext = WizardSetup.UpdateConfiguration<MainDbContext>(_configuration, "spUptConfigurations", "spUptConfigurationStep");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

Actualizar configuración

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_UPT_CONFIGURATION]
    @Id INT,
    @Name NVARCHAR(150),
    @UpdatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @Icon NVARCHAR(50) NULL,
    @IsActive BIT
AS
BEGIN
    UPDATE [Configurations] SET
        Name = @Name,
        UpdatedBy = @UpdatedBy,
        Description = @Description,
        IsActive = @IsActive,
        Icon = @Icon,
        UpdateDate = GETDATE()
    OUTPUT inserted.*
    WHERE Id = @Id;
END 

Actualizar paso de configuración

Configuración multicompañía

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_UPT_CONFIGURATIONSTEP]
    @Id INT,
    @Name NVARCHAR(150),
    @UpdatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @ConfigurationURL NVARCHAR(MAX),
    @ConfigurationId INT,
    @IsActive BIT
AS
BEGIN
    UPDATE ConfigurationSteps SET
        Name = @Name,
        UpdatedBy = @UpdatedBy,
        Description = @Description,
        ConfigurationURL = @ConfigurationURL,
        ConfigurationId = @ConfigurationId,
        IsActive = @IsActive,
        UpdateDate = GETDATE()
    OUTPUT inserted.*
    WHERE Id = @Id;
END

Configuración no-multicompañía

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_UPT_CONFIGURATIONSTEP]
    @Id INT,
    @Name NVARCHAR(150),
    @UpdatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @ConfigurationURL NVARCHAR(MAX),
    @IsCompleted BIT,
    @ConfigurationId INT,
    @IsActive BIT
AS
BEGIN
    UPDATE ConfigurationSteps SET
        Name = @Name,
        UpdatedBy = @UpdatedBy,
        Description = @Description,
        ConfigurationURL = @ConfigurationURL,
        ConfigurationId = @ConfigurationId,
        IsActive = @IsActive,
        IsCompleted = @IsCompleted,
        UpdateDate = GETDATE()
    OUTPUT inserted.*
    WHERE Id = @Id;
END

---

UpdateConfigurationStep<Microsoft.EntityFrameworkCore.DbContext> (Cl.Core.Structures.Classes.WizardSetup.ConfigurationStep, System.string) : Cl.Core.Structures.Classes.Rebound.CLContext<Cl.Core.Structures.Classes.WizardSetup.ConfigurationStep>

Descripción

Actualiza un configuration step en base de datos.

Parametros

• _configurationStep (Requerido): Configuration step con la información que se va a actualizar en base de datos.
• _updateConfigurationStepsDbResource (Requerido): Código de objeto de base de datos que sera utilizado para actualizar los configuration step.

Tipos genericos

• Context (Requerido): El tipo de contexto de base de datos utilizado en la operación. Este debe ser una instancia de DbContext.

Ejemplo

public CLContext<Configuration> MyFunction(ConfigurationStep _configurationStep)
{
    _logManager.Record($"REQUESTING CONFIGURATION...");
    
    var oClContext = WizardSetup.UpdateConfigurationStep<MainDbContext>(_configurationStep, "spUptConfigurationStep");
    
    _logManager.Record($"REQUESTE COMPLETED");
    
    return oClContext; 
}

Procedimiento almacenado a utilizar:

Configuración multicompañía

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_UPT_CONFIGURATIONSTEP]
    @Id INT,
    @Name NVARCHAR(150),
    @UpdatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @ConfigurationURL NVARCHAR(MAX),
    @ConfigurationId INT,
    @IsActive BIT
AS
BEGIN
    UPDATE ConfigurationSteps SET
        Name = @Name,
        UpdatedBy = @UpdatedBy,
        Description = @Description,
        ConfigurationURL = @ConfigurationURL,
        ConfigurationId = @ConfigurationId,
        IsActive = @IsActive,
        UpdateDate = GETDATE()
    OUTPUT inserted.*
    WHERE Id = @Id;
END

Configuración no-multicompañía

CREATE PROCEDURE [dbo].[CL_D_CL_MLT_PMS_UPT_CONFIGURATIONSTEP]
    @Id INT,
    @Name NVARCHAR(150),
    @UpdatedBy NVARCHAR(100),
    @Description NVARCHAR(MAX),
    @ConfigurationURL NVARCHAR(MAX),
    @IsCompleted BIT,
    @ConfigurationId INT,
    @IsActive BIT
AS
BEGIN
    UPDATE ConfigurationSteps SET
        Name = @Name,
        UpdatedBy = @UpdatedBy,
        Description = @Description,
        ConfigurationURL = @ConfigurationURL,
        ConfigurationId = @ConfigurationId,
        IsActive = @IsActive,
        IsCompleted = @IsCompleted,
        UpdateDate = GETDATE()
    OUTPUT inserted.*
    WHERE Id = @Id;
END

---

Configuraciones

Multicompañía

A continuación se va a mostrar como configurar la aplicación para la implementación de este nuget, cuando la aplicación es multicompañía:

1. Agregar entidad EF Cl.Core.Structures.Classes.WizardSetup.ConfigurationStepsByCompany.
2. Ignorar propiedad IsCompleted de entidad Cl.Core.Structures.Classes.WizardSetup.ConfigurationStep al llamar el siguiente método de extensión "modelBuilder.IgnoreWizardPropertyForMultiTenant();" en el método OnModelCreating de context de base de datos.
3. Agregar la siguiente propiedad "isMulticompany" en true al appsettings.json. (NOTA: Agregar esto requiere que agregue el parametro @CompanyId al objeto de base de datos definido en la propiedad spGetDBResource del appsettings.json)