cs-icon.svg

Nested Reference Publishing Use Cases

Nested Reference Publishing allows you to access and publish all nested references related to an entry with ease. You can publish nested items that are up to 5 levels deep.

The following provides an overview of the structure of nested references:

nested_references_view

In this guide, we’ll go through a use-case to understand how to work with Nested Reference Publishing in Contentstack.

Publishing Nested References with Complex Structure

Consider a scenario where you have nested references with a complex setup. You have workflows, publish rules, and various permissions set for users in your organization.

Now with Nested Reference Publishing enabled for their organization, if the user tries to publish the parent entry, all the nested references will be sent along with the parent entry. The Publish References modal will show a detailed view of the structure of nested references within the selected parent entry.

publish_references_modal

If few of the nested references do not meet the publishing validation criteria, you will see an alert sign across the entry.

Let’s check out a few scenarios where publishing might fail.

Entry is in In-progress State

For Child Entry One - Level 4, you can see a warning sign because the entry is in the in-progress state, i.e., required fields are empty.

in_progress_entry

Since, this entry does not meet the publishing criteria, it will not be sent for publishing and all its nested references will not be considered for publishing either.

Workflow Stage is Incomplete

For Child Entry - Level 7, the workflow stage is incomplete due to which the entry and its nested references (if any) will not be sent for publishing.

incomplete_workflow

Approval(s) Pending

For Child Entry - Level 8, there is a publish rule applied, where the entry needs approval from set approvers for publishing. In this scenario, an alert will be displayed stating "Approval(s) Pending” and once the entry is approved, you will need to re-publish it.

pending_approvals

Now, when you click the Send with References button, this action is considered as a bulk task since the parent and referenced entries are sent together for publishing. You will be able to view the summary of your job in the Publish Queue.

publish_queue

You can also view the details of all the individual entries sent for publishing within this job by clicking the specific job.

entry_details_within_a_job

Bulk Publish Status for Each Entry/Asset in the Publish Queue

Here are some of the statuses that you should see for your entries in your bulk-publish job.

Published

When entry(ies) or asset(s) are published successfully.

Failed

When entry(ies) or asset(s) could not be published due to some error. On hovering over the “info” sign, you will be able to view the reason for failure.

Authorization Denied

When you do not have permission to publish certain entry(ies) or asset(s).

Note: Entries for which you do not have permissions to publish are not displayed within the Publish References modal.

Skipped

When entry(ies) or asset(s) are already published in a specific environment and locale.

Note: The nested reference tree is not displayed for child entries that have already been published. For instance, if a parent entry has a child entry that is already published, the subsequent child entries will not be sent for publishing. However, if you manually publish that published child entry (i.e., force publish), then all its subsequent child entries will be sent for publishing.

Workflow Stage Incomplete

When the workflow stage of entry(ies) has not reached “Done” for a certain environment(s).

Additional Resource: Learn more about cases when reference publishing could fail.

Was this article helpful?
^