Overview
This article provides a comprehensive guide on the publishing process within the catalog management system, emphasizing the importance of "parent items" and "subitems" to ensure changes display correctly on the live site. It details the technical workflow, explaining that content must first be approved before it moves from Sitecore to the AWS-hosted catalog. Key instructions are included for first-time publishing, such as maintaining consistent catalog titles to avoid duplicate URLs and managing navigation visibility. Users are also guided through the publishing wizard settings and advised on expected processing times for site updates.
Notes on Publishing:
- The calendar year item must be published in order to publish your catalog - if the catalog is publishing through for the first time, publish from the calendar item and include subitems! This should also be done if there have been name changes to the calendar item (Example: changing this item to "current")
- When changes are made to single items within sections, especially program subitems (Degree Requirement folders, Requirement Lists, courses) but definitely not limited to, the parent item must be published with subitems included. This ensures the html of the page is rebuilt to include the changes of the subitem changed. If you are not seeing edits made published to the live catalog pages, please check that you are publishing from the parent item and including subitems - parent items need to be published to update/display the subitems within the section
- A catalog or items/sections within the catalog can be published as many times as needed - you cannot over publish these items, if nothing has changed within the catalog item, the item is not processed when published (unless it is the first time being published).
- After the initial publish, a publish of the entire catalog will only publish anything that has been newly approved since the last publish.
- Checking "Publish subitems" means that you are asking the publisher to publish the item you have selected, as well as all of the subitems/child items within the selected item. If you uncheck that checkbox, you are telling the publisher to just publish the selected item and to not process subitems/child items within the item selected.
- It is also important to note that any unapproved items/versions within the catalog, will not publish until they are approved. This means any version or new item still within the catalog workflow will remain unpublished until the item is approved.
- The publish functions in two parts - First, the items are published within Sitecore. Second, the items are published to the hosted AWS catalog site. This is explained with more details within the steps of publishing below. An email notification will be sent to the user who initiated the publish once it has been published to AWS.
-
If the Catalog Title Rename field is updated then republished after a catalog has been published for the first time, a second live catalog at the new URL will exist alongside the initially published catalog.
Example: You publish for the first time and the Catalog title is 2023-2024 General Catalog. You update the Catalog title in the Rename field, title field and Display Name field to be Undergraduate Catalog 2023-2024 and republish. There will now be two existing catalogs at two different URLs:
domain.smartcatalogiq.com/2023-2024/2023-2024-General-Catalog
AND
domain.smartcatalogiq.com/2023-2024/Undergraduate-Catalog-2023-2024
Any updates/edits made will only be displayed on the latter/most recently published catalog.
To avoid this, make sure the Catalog title is correct in all three fields (Title, Display Name, Rename) prior to publishing for the first time to avoid duplications. If there is no way to avoid this, you can reach out to support with a request to remove the initial published catalog. When you make this request, please provide the URL of the catalog you wish to be removed.
How to Publish:
-
Select the item or section you wish to publish. If you are publishing the entire catalog, select the “Calendar Year” item represented by a small calendar icon. Please note: If there are more than one catalogs within the calendar year and you do not wish to publish them all, publish the calendar item without subitems first, then select each catalog you want published and go through the publishing steps. Make sure the "Show in catalog list" checkbox is unchecked for any unpublished catalog you do not want displayed within the drop down list.
-
Under the Publish tab, select “Publish”. (The word, not the globe.)
-
Then select the drop down “Publish Item”.
-
The publishing wizard will launch and there are a series of checkboxes present. The first will automatically be selected - this is indicating the action that will take place when publishing.
-
If you want to include all subitems under the item you have selected for publishing, the "Publish subitems" checkbox needs to be checked. (Please Note: If you are publishing the whole catalog or the parent item of an item you have changed, you want the "Publish Subitems" box checked so the publish will process all of the catalog items within and publish anything newly approved since the last publish). Uncheck this checkbox if you wish to publish the item selected independently without subitems.
-
The first time you publish within the system, you may need to check "English" for the desired publishing language. You will not have to select this again as the Wizard will remember your selections from the previous publish request. Then, click “Publish”
-
You can wait for the item/items to finish publishing and click “Finish”, or you can just close the wizard and it will continue publishing until it is finished. Closing the wizard before the item has finished publishing does not interrupt or interfere with the publishing process. When initiating a publish request, the item is sent to our publishing queue to be published.
When processing the Sitecore publish, the window will count through the catalog items (Please note: If the processing message is "Queued." this means that there is something that is processing prior to the item you sent to the publisher. When the prior submission has completed publishing, the item you sent will be published. "Queued" is simply referring to the item sitting in the queue while the previous submission is completed.):
-
When the job has completed for Sitecore, a brief report will be presented explaining the number of items that have been processed, as well as a message regarding the additional step of publishing to AWS host. By default, all institutions have publishing emails enabled unless otherwise requested. The email notification will include a link to published content.
Please note, this message is informing you that the Sitecore specific publish has been completed. Our catalog websites are now being hosted by AWS and therefore once the Sitecore publish is complete, the item will then publish for the AWS site. When the AWS publish has been completed, your content is live and an email notification will be sent to you with a link to the published content. We encourage you to view the newly published content after clearing your browser cache of cached images/files for all time.
This may add additional time to the publish after the Sitecore publishing completes with the window of data as pictured above. For whole catalogs including subitems, the time can extend to an hour. If it is a section or an item, the time is greatly reduced and only takes a few extra minutes/seconds. If you are publishing a section or item, it is important to remember to publish the parent item of the edited item to rebuild the HTML accurately and update the published AWS pages.
Additional Notes on Publishing:
In some cases there will be other items within the publishing queue, which can add time to your publish. This is indicated on the Publishing Wizard when the request is sent using the word "Queued." In this case, you can close the wizard after clicking publish instead of waiting for it to finish. Once the publish is queued, it will be published and the job completed.
If you are publishing a catalog for the first time and have questions, you can contact Curriculum Strategy Support to initiate this process for you. Initial publishing/publishing a whole catalogs can take a little longer than making publishing updates. Please contact us if you have any questions.
Only items that have the "Show in navigation" checkbox checked are included/displayed within the navigation menu on the live site. If this checkbox is unchecked, the item's title will not be readily accessible via the site's navigation menu. If you are reviewing a catalog and notice titles missing from the navigation menu, this would be the first field to inspect when troubleshooting. You are able to produce a report to show all items where this feature may be disabled by using the Page Properties Tool from the Tool dashboard.
URL will always start with domain.smartcatalogiq.com... - IF you are using any other version of URL, please update to use this format.