TRENZ.EL.ElApi 1.0.0

El.ElApi

This package contains supportive developer tooling for an easyLogic 3.15 feature. An easyLogic development license is required.

See https://docs.ela.easylogic.de for usage details.

Changes

1.0

This release is intended to be used with easyLogic 3.15.2 and newer.

It supports:

• simple progress (small inline progress bar)
• descriptive progress (a larger progress bar with an optional title and description of the current step)
• ASP.NET Core 3.1, 6.0, and 7.0

Basic usage

In an ASP.NET Core project,

• add this as a NuGet package references.
• your Configure method (or top-level method) needs to end something like:

// add this _before_ routing
app.UseElApiDiscovery();

app.UseRouting();

app.UseEndpoints(endpoints =>
{
    endpoints.MapControllers();

    endpoints.MapHub<ProgressHub>("/hubs/progress"); // add this inside `UseEndpoints`
});

A controller should follow an ELA-compatible naming convention. (If it does not, you may need to fully specify the URL.) For example, the class can be declared like:

[Area("_Default")]
[Route("ELAPI/[area]/[controller]/[action]")]
public class dMyInvoiceController : ControllerBase
{
    private readonly IHubContext<ProgressHub> _HubContext;

    public dMyInvoiceController(IHubContext<ProgressHub> hubContext)
    {
        _HubContext = hubContext;
    }
}

If used on a container of the type MyInvoice, easyLogic will automatically expand the correct route.

Finally, a method body should look like:

[HttpPost]
public async Task<IActionResult> MyButtonAction([FromBody] ContainerWithProgressRequest request)
{
    var progress = ELSimpleProgress.Create(request.SessionID, _HubContext);

    using var eldata = await ELDatas.OpenAsync(/* some connection string */, request.UserID);

    return Ok();
}

Inside, you can use eldata to access the database, and progress to send progress information back to the client. UserID is also set, so you can use server messages as well.