Module – Smart Publishing Assistant (SPA)

About the Tool:

A smart tool that acts as a personal assistant for authors to quickly check and fix authoring mistakes (mainly publishing related issues)  associated with a Sitecore item

  • It performs Item and Ancestor Item level checks based on the Rulesets provided
  • Ability to fix all the identified issues in few clicks
  • Checks Indexing

It can be downloaded from Market Place Here.

 

Business Need:

  • Authoring related issues are most common as Sitecore is Content Management heavy (mainly publishing related issues)
  • Support engineers spend around 1 to 2 Hrs per incident to narrow down to the problem and fix the issue

 

Solutions:

  • Select Item to Troubleshoot from Content Tree in Sitecore CMS
  • Click on SPA from Ribbon on Publish Group
  • It will automatically troubleshoot the item on context language
  • Identifies all publishing and indexing related issues at one click
  • Fix all the identified issues on few clicks

 

Key Benefits:

  • Self Remediation feature reduced the incoming incident related to publishing issues by 80%
  • Avg Response Time to Editorial Incidents reduced from 1 Hr to 1 Min

 

Additional Details:

Added this tool to Content Editor Ribbon so that content authors can use this tool and solve the issue by themselves instead of raising an incident which will reduce the incident count.

Tool only available to Admin and the users who belongs to “sitecore\SPAEditors” Role.

Doing the following checks to identify the issue related to Publishing.

 

Item Level Checks:

  • Is Item Publishable?
  • Is Item’s Publishing Date not reached?
  • Is Item’s Unpublishing Date reached?
  • Is Ancestor Item Publishable?
  • Is Ancestor Item Publishing Date reached?
  • Is Ancestor Item Unpublishing Date reached?

Language Specific Checks:

  • Is Ancestor Item having required Language Version?
  • Is Ancestor Item in Final Workflow State?
  • Is Ancestor Item has valid Language Version?
  • Is Ancestor Item available in Web Database?
  • Is Item having required Language Version?
  • Is Item in Final Workflow State?
  • Is Item has valid Language Version?
  • Is Item available in Web Database?

 

Fix will be performed based on the User Permission on the item. How the issues will be fixed can be seen by hovering the icon next to “FixAll” link

We can select multiple languages to troubleshoot the publishing issues of item on selected languages at once if any.

Once we fix all the identified issues related to Publishing it will perform Indexing check, you can also publish the item with subitem/related item from the tool itself on the publishing Tab.

 

Indexing:

  • Validate whether item indexed in Master DB (Authoring DB)
  • Validate whether item indexed in Web DB (Live DB)
  • Option to Re-Index Item
  • Option to Re-Index Tree
  • Supports Lucene, Coveo and SOLR engines

 

Screenshot of the Tool:

SPA_Screenshot

Item Configuration Details: 

Item Name Item Id Field Details
Settings {D054CF2C-121A-42C1-890C-AC3EEAA51F1B}  

EnableFix->Tick if you want to fix the identified issues

 

IsWorkflowEnabled->Tick if item gone through Workflow and want to validate the same

 

IsWorkflowStateMovedtoFinal->Tick  if you want to move the item to final state of the workflow while Fix All the identified issues (User WorkFlowCommandExecute permission will also be considered)

 

ExcludedTemplates->update the template ids by separating it with ‘|’ symbol, so all the items created based on the template specified will not be validated

 

IsCustom -> Leave as unchecked

ErrorMessages {7FDDC5B7-A6BF-4116-B909-9EF530567DDA} Fields to get/set the error messages of different ruleset
ResolutionMessages { 3542A1C9-6E23-4BB9-94EE-71CC0F2230D4} Fields to get/set the resolution messages of different ruleset

 

Logging:

Separate file SPA.log.<<DateTime>>.txt has been used for logging the tool’s info/error.

Log configuration also included in the package itself. No additional configuration required.

SPA_Log

 

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s