Publish transaction states
The Publishing Queue provides feedback about the status of a publish transaction. A publish state indicates the stage in the publish transaction.
A publish transaction is an individual package that is being published. One publish action, (for example, republishing a Component) may result in several publish transactions if the publish action results in the Component being published on more than one Page.
The state of the publish transaction changes when it is scheduled, put in the message queue, in progress by the publisher, is finished/failed, or is undone:
- Scheduled for publish
- Scheduled for deployment
- Waiting for publish (queued)
- Waiting for deployment
- In progress (processed by the publisher service, transport service, or Deployer)
- Throttled
- Success
- Warning
- Failure
- Waiting for Undo
- Undoing
- Undone
- Undo Failed
You can view the publish state of a publish transaction by viewing the Publishing Queue. For more information, refer to Viewing and filtering the Publishing Queue.
The state of a publish transaction is based on the stage in the publishing process that has started. The following table shows the stage of the publish transaction and the corresponding state when the publish time is immediate.
| Step | Description | Publish transaction status |
|---|---|---|
| 1 | A User publishes an item. The Content Manager resolves the Publication Targets and creates a Publish Transaction for each combination of Publication and Publication Target. | Waiting for publish |
| 2 | The publisher picks up the publish transaction from the queue and renders and resolves the item. | In Progress |
| 3 | The Transport service sends rendered information and metadata to the Content Deployer with a Deploy command. | If the transport cannot be completed because there are more items waiting to be deployed than the configured window size, the status is set to If the transport is not successful, the status is set to If the transport is successful, but errors occurred while generating publishable content, the status is set to If the transport is successful, the status remains |
| 4 | The Content Deployer deploys the content. | If the deploy is not successful, the status is Failed. |
The following table shows the stage of the publish transaction and the corresponding state when the publish time is scheduled.
| Stage | Description | Publish transaction state |
|---|---|---|
| 1 | A User publishes an item. The Content Manager resolves the Publication Targets and creates a Publish Transaction for each combination of Publication and Publication Target. The Content Manager schedules the publish action. | Scheduled |
| 2 | The scheduled render time arrives. The Content Manager sends the item to the Publisher. | Waiting for publish |
| 3 | The publisher picks up the publish transaction from the queue and renders and resolves the items. | In progress |
| 4 | The transport service sends the rendered information and metadata to the Content Deployer with a wait command. | Waiting |
| 5 | The deploy command is scheduled. | Scheduled for deployment |
| 6 | The scheduled deploy time arrives. | Waiting for deployment |
| 7 | The publisher retrieves the publish transaction from the queue. | In progress |
| 8 | The Transport Service sends rendered information and metadata to the Content Deployer with a Deploy command. | If the transport cannot be completed because there are more items waiting to be deployed than the configured window size, the status is set to If the transport is not successful, the status is set to If the transport is successful, but errors occurred while generating publishable content, the status is set to If the transport is successful, the status remains |
| 9 | If the transport was successful, the Content Deployer deploys the content. | If the deploy is successful, the status is Success. If the deploy is not successful, the status is Failed. |
The following table shows the stage of the publish transaction and the corresponding state when an already published item is undone (typically, this is done form an Automatic Activity in a Workflow Process). Note that Content Delivery must be set up to handle Undo operations.
| Stage | Description | Publish transaction state |
|---|---|---|
| 1 | An Automatic Activity in a Workflow Process instance queues a request to undo a publish transaction. The undo operation is queued. | Waiting for Undo |
| 2 | The queue reaches the undo operation. | Undoing |
| 3 | The undo operation is performed, and the publish operation is undone. | If the undo is successful, the status is Undone. If the undo is not successful, the status is Undo Failed. |