Reading Node Configuration

Settings Pattern

Every executor has a settings class that extends BaseNodeExecutorSettings. The base class provides typed reader helpers (ReadConfigByKey, ReadConfigByKeyBool, etc.) backed by the ConfigDataPropertyBag.

// MyNodeSettings.cs
public class MyNodeSettings : BaseNodeExecutorSettings
{
    // Reads string field from config JSON key "recipientEmail"
    public string RecipientEmail => ReadConfigByKey("recipientEmail", string.Empty)!;

    // Reads boolean field
    public bool SendCopyToSender => ReadConfigByKeyBool("sendCopyToSender", false);

    // Reads integer field
    public int? MaxRetries => ReadConfigByKey_Int("maxRetries");

    // Reads an enum field
    public EmailPriority Priority => ReadConfigByEnum("priority", EmailPriority.Normal);

    // Reads a credential ID (integer reference to a stored credential)
    public int CredentialId => int.Parse(ReadConfigByKey("credentialId", "0")!);

    // Validation — return an error message string, or null if valid
    public override string? Validate()
    {
        if (string.IsNullOrWhiteSpace(RecipientEmail))
            return "RecipientEmail is required.";
        return null;
    }
}

Wiring the Settings Class

Override CreateExecutorSettings() in the Config partial class to tell the base which settings type to instantiate:

// MyNodeExecutor.Config.cs
public partial class MyNodeExecutor
{
    // Typed accessor for convenience in ExecuteInternalAsync
    private MyNodeSettings? mySettings => settings as MyNodeSettings;

    // Tells BaseNodeExecutor to use your settings class
    public override BaseNodeExecutorSettings CreateExecutorSettings()
        => new MyNodeSettings();
}

Using Settings in ExecuteInternalAsync

protected override async Task<NodeExecutionResult> ExecuteInternalAsync(
    NodeExecutionContext ctx,
    CancellationToken ct)
{
    // settings is already populated by the time this is called
    var s = mySettings!;

    var recipient = s.RecipientEmail;       // "alice@example.com"
    var maxRetries = s.MaxRetries ?? 3;     // 3 (default if not set)

    // For credentials: resolve via ICredentialResolver (never read raw secret from config)
    var password = await _credentialResolver.GetPasswordAsync(s.CredentialId, ct);

    // ... use recipient, password, etc. ...
}

Available Reader Methods on BaseNodeExecutorSettings