TickerQTickerQ

Custom Entities

Extend TimeTickerEntity and CronTickerEntity with your own properties.

Add custom properties to job entities — useful for multi-tenancy, tagging, or domain-specific metadata.

Define custom entities

Inherit from the generic TimeTickerEntity<T>:

public class MyTimeTicker : TimeTickerEntity<MyTimeTicker>
{
    public string TenantId { get; set; }
    public string Category { get; set; }
}

CronTicker can also be extended:

public class MyCronTicker : CronTickerEntity
{
    public string TenantId { get; set; }
}

Register with generic AddTickerQ

Use the generic overload so managers and persistence use your custom types:

Program.cs
builder.Services.AddTickerQ<MyTimeTicker, MyCronTicker>(opt =>
{
    opt.AddOperationalStore(ef =>
    {
        ef.UseTickerQDbContext<MyTickerDbContext>(db =>
            db.UseSqlServer(connectionString));
    });
});

Your custom DbContext:

public class MyTickerDbContext : TickerQDbContext<MyTimeTicker, MyCronTicker>
{
    public MyTickerDbContext(DbContextOptions options) : base(options) { }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder); // applies TickerQ base configurations

        // Configure your custom properties
        modelBuilder.Entity<MyTimeTicker>(b =>
        {
            b.Property(x => x.TenantId).HasMaxLength(64);
            b.HasIndex(x => x.TenantId);
        });
    }
}

Inject the typed manager

The managers are now typed to your custom entity:

public class OrderService(ITimeTickerManager<MyTimeTicker> timeTicker)
{
    public async Task Schedule(string tenantId)
    {
        await timeTicker.AddAsync(new MyTimeTicker
        {
            Function  = "process-order",
            ExecutionTime = DateTime.UtcNow.AddMinutes(5),
            TenantId  = tenantId,
            Category  = "orders",
        });
    }
}

When to use

  • Multi-tenancy — add TenantId for tenant isolation
  • Categorization — add Category or Tags for filtering
  • Audit — add CreatedBy, ModifiedBy
  • Priority routing — add custom priority or queue fields

DbContext Setup

Dedicated TickerQ context vs sharing your application's DbContext.

Migrations

Create and apply EF Core migrations for TickerQ tables.

On this page

Define custom entities
Register with generic AddTickerQ
Inject the typed manager
When to use