Support Portal best practices

  • Description

    To get your support issues resolved quickly and efficiently, we recommend that you follow these best practices when you create a support ticket:

    1. Investigate the issue before creating a support ticket.
      Before creating an issue, review Sitecore logs for any errors or warnings. Tools such as the Sitecore Log Analyzer can help you do that.
      Search for specific errors, warning messages, or general questions on the internet, as many solutions are provided on sites such as Sitecore Knowledge Base or shared by Sitecore community.
    2. Report one problem per support issue.
      Only report one problem per support issue with only one reproduction scenario. If you think that two or more issues are related, mention this in the problem description.
    3. Provide scenarios that you can reproduce in a clean environment.
      In most situations, Sitecore Support needs to reproduce the issue in a local environment to find the resolution.
      Providing scenarios that you can reproduce in the clean environment can significantly reduce investigation time and the number of responses and answers needed to fix the issue.
      Alternatively, you can set up your own test environment where you can reproduce the issue and provide Support with remote access to it.
    4. Click Stamp before you enter any text.
      When you create an issue or reply to an existing one, click Stamp before you enter any textThis inserts information about when the reply was created and who created it.

      Stamp Image

    5. Provide information about your Sitecore installation, such as configuration and log files. 
      The How to collect basic information about your Sitecore installation article describes how to collect website configuration details and share them with Sitecore Support.
      This information helps find better answers to your issues, and reduces the resolution time. If this information is not provided with the initial request, Sitecore Support will likely request it from you later, delaying resolution of the issue.
      It is also important to be extra careful to provide information from the exact environment where the issues are observed. Otherwise, this can lead investigations in the wrong direction.
    6. Describe your Sitecore environment architecture.
      In many situations, understanding your Sitecore environment architecture is critical to properly identifying, reproducing, and resolving the issue.  Whenever possible, provide an environment architecture diagram or some other way to explain how your Sitecore instances are set up.
    7. Provide information about the severity of the issue.
      To attend to most important support issues as quickly as possible, Sitecore Support internally prioritizes all support tickets. To do this, the team uses information from the support ticket such as the affected environment, business impact level, and problem description.
      Make sure these fields always contain the correct information about the severity of your issue. For important project milestones, please provide information about expected deadlines whenever possible.
    8. Provide a license that corresponds to the specific project related to the issue.
      For Sitecore partners, you should use your Customer license to open tickets instead of your Partner license. Proper license information allows the Support Team to work on multiple support tickets as a single group, as well as determine the associated support plan. You can find more information on this in the License ID field on the Support Portal article.
    9. Report any exceptions with full details.
      When you report an exception, attach all the information about it in plain text or HTML format. Do not attach a screenshot with the exception stack traces because they normally do not contain the full information about the error.
    10. Attach files to the ticket or upload them to one of the available Sitecore Support file storages. 
      All available options of exchanging files with Sitecore Support are listed in the How to provide files to Sitecore Support article.
      When you need to attach a file smaller than 10MB, review the Attach To A Ticket section of that article.
      To send a file larger than 10MB, you must upload it to the Sitecore Support Box Storage or to the Sitecore Support FTPS Server. Read the Upload To Sitecore Support Box Storage and Upload To Sitecore Support FTPS Server sections of the mentioned article.
      After uploading the file to the server, provide its exact name to the Sitecore Support representative.
    11. Provide feedback using the support satisfaction survey.
      Whenever a support ticket is closed, a satisfaction survey email message is automatically sent to the creator of the ticket. Responses provided via such surveys are reviewed and analyzed very carefully to understand current feedback and discover new ways to improve the support service. When receiving such a survey, please spare a few minutes to provide feedback to the support team and share any relevant details about the current support ticket as well ideas for future improvements.

    Following these simple guidelines will ensure that your ticket is handled in a timely fashion and will most likely result in a quicker resolution.

Applies to:

Sitecore Support Portal 1+

November 19, 2014
December 06, 2018

Keywords: 

  • Support Portal