Best Practice for Background Task Settings Admin UI in OrchardCore

[Jcea321]

I am building a background task in OrchardCore that needs user-configurable inputs like a connection string and cron
expression. The default OrchardCore background task admin UI only allows editing the schedule and enabling/disabling the task, but I need to capture additional fields specific to my task. What is the best practice in OrchardCore for
creating an admin form where users can input and save these custom settings for a background task?

[Piedone]

Your logic being a background task doesn't really affect how settings can be (are recommended to be) managed. The easiest is probably to use Custom Settings: https://docs.orchardcore.net/en/latest/reference/modules/CustomSettings/

[weirdyang]

I think it would be best to use SiteSettings, you can create a page that is accessible via the admin menu then persist the data to the database. Then in your task get the settings like so

                
                private readonly ISiteService _site;
...
                MySettings settings = _site.GetSiteSettingsAsync()
                    .As<MySettings>();

The email and github modules are good references:
https://github.com/OrchardCMS/OrchardCore/blob/e9d622f5838f40869d704d27f5a3faa6a56f1538/src/OrchardCore.Modules/OrchardCore.Email.Smtp/Drivers/SmtpSettingsDisplayDriver.cs

[hishamco]

Nothing prevents you to use a CustomSettings like @Piedone refer too, or you could use site settings to configure your custom settings. But again they are a custom settings :)