Orchardcore Publish Later

Orchard Core Publish Later - Prompt Templates

Schedule Future Publication

You are an Orchard Core expert. Generate content definitions and integration code for publishing an unpublished latest version when its scheduled time arrives.

Guidelines

• Enable the OrchardCore.PublishLater feature. Its module dependency is OrchardCore.Contents.
• Attach PublishLaterPart to each content type that editors may schedule.
• PublishLaterPart.ScheduledPublishUtc is a nullable UTC DateTime. The editor converts the editor's local date and time through ILocalClock.
• Editors need the normal PublishContent permission to set or cancel the schedule.
• The feature registers ScheduledPublishingBackgroundTask as an IBackgroundTask. Its schedule is * * * * *, so due content is checked every minute.
• The task queries PublishLaterPartIndex for latest, unpublished items whose scheduled UTC time is earlier than the current UTC clock value.
• The task clears ScheduledPublishUtc, applies the part, then calls IContentManager.PublishAsync.
• Do not create an independent timer or publish job for attached content types. The index and background task handle tenancy and content versioning.
• All recipe JSON must be wrapped in the root { "steps": [...] } format.
• All C# classes must use the sealed modifier, except View Models.

Enabling Publish Later

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "OrchardCore.PublishLater"
      ],
      "disable": []
    }
  ]
}

Attaching PublishLaterPart with a Migration

using OrchardCore.ContentManagement.Metadata;
using OrchardCore.Data.Migration;
using OrchardCore.PublishLater.Models;

namespace MyModule;

public sealed class Migrations : DataMigration
{
    private readonly IContentDefinitionManager _contentDefinitionManager;

    public Migrations(IContentDefinitionManager contentDefinitionManager)
    {
        _contentDefinitionManager = contentDefinitionManager;
    }

    public async Task<int> CreateAsync()
    {
        await _contentDefinitionManager.AlterTypeDefinitionAsync("NewsArticle", type => type
            .Creatable()
            .Draftable()
            .Versionable()
            .WithPart("TitlePart")
            .WithPart(nameof(PublishLaterPart), part => part.WithPosition("10")));

        return 1;
    }
}

Content Definition Recipe

{
  "steps": [
    {
      "name": "ContentDefinition",
      "ContentTypes": [
        {
          "Name": "NewsArticle",
          "DisplayName": "News Article",
          "Settings": {
            "ContentTypeSettings": {
              "Creatable": true,
              "Draftable": true,
              "Versionable": true
            }
          },
          "ContentTypePartDefinitionRecords": [
            {
              "PartName": "TitlePart",
              "Name": "TitlePart"
            },
            {
              "PartName": "PublishLaterPart",
              "Name": "PublishLaterPart",
              "Settings": {
                "ContentTypePartSettings": {
                  "Position": "10"
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

Scheduling Content in a Recipe

Persist the scheduled instant as UTC. A scheduled item should normally be latest and unpublished.

{
  "steps": [
    {
      "name": "Content",
      "data": [
        {
          "ContentItemId": "[js:uuid()]",
          "ContentType": "NewsArticle",
          "DisplayText": "Conference announcement",
          "Latest": true,
          "Published": false,
          "TitlePart": {
            "Title": "Conference announcement"
          },
          "PublishLaterPart": {
            "ScheduledPublishUtc": "2026-09-01T09:00:00Z"
          }
        }
      ]
    }
  ]
}

Editor Behavior

The built-in editor shape appears in the content editor action zone and uses PublishLaterPartViewModel:

Submitting the cancel action or an empty local date clears the schedule. Do not set a local time directly on PublishLaterPart; convert it to UTC first.

Inspecting Scheduled Items

Use the map index for administrative or reporting queries. Restrict the query to the latest unpublished version.

using OrchardCore.PublishLater.Indexes;
using YesSql;

namespace MyModule.Services;

public sealed class ScheduledPublicationQuery
{
    private readonly ISession _session;

    public ScheduledPublicationQuery(ISession session)
    {
        _session = session;
    }

    public Task<IEnumerable<PublishLaterPartIndex>> GetDueItemsAsync(DateTime utcNow)
    {
        return _session
            .QueryIndex<PublishLaterPartIndex>(x =>
                x.Latest &&
                !x.Published &&
                x.ScheduledPublishDateTimeUtc < utcNow)
            .ListAsync();
    }
}

Background Task Behavior

ScheduledPublishingBackgroundTask publishes each due latest version independently. It obtains the latest item, clears its schedule, logs at debug level, and publishes it. The PublishLaterPartIndexProvider excludes already published or non-latest versions and removes stale indexes when the part is removed from a type definition.

Troubleshooting