Support Package Generator 

  0 rating
6/26/2013 5:21:42 AM
2/13/2017 1:41:18 PM

About

The latest version of the Sitecore Support Package Generator tool is only available as a ClickOnce application: http://dl.sitecore.net/updater/sspg


Sitecore customers and partners are often requested to provide various information about their solutions' configuration during support ticket investigations. Adding the ZIP package to your support ticket will help improving the time to resolution.


Sitecore support packages are easy to generate and come in a predefined format that you can edit before you generate the final version. In addition, the tool allows uploading generated packages directly to Sitecore Public FTP server in one click.


Features

The Sitecore Support Package Generator collects the following information about your Sitecore installation:

• Web.config and /App_Config folder contents

• Sitecore, Windows Event and IIS logs

• Sitecore diagnostics data

• Sitecore version information

• Basic license information

• List and copies of assemblies in the /bin folder in the /bin folder

• Global.asax and Global.asax.cs files

• IIS application pool information

• Server and IIS sites information

• .NET Framework files: mscordacwks.dll, sos.dll

• ApplicationHost.config file

• File system permission settings

• All files from /temp/__UpgradeHistory folder

• List of site’s files and their hash codes

• SQL database schema and basic metrics

• SQL database performance benchmark

• Sitecore search indexes



Important! 


•  SSPG supports only full edition of IIS 7 and up and does not work with IIS Express.

•  SSPG requires installed .NET Framework 4.5


Documentation

Documentation
  • Documentation > User Guide
    User Guide

    To start the Sitecore Support Package Generator tool, extract contents of the downloaded archive and run the SSPG.exe file. Package generation process consists of 6 steps.

    Select Sitecore IIS site and click Next to continue.



    Next step allows filling package meta data and specifying generation process settings:

    • Package name (required);
    • Support ticket ID (optional);
    • Log start date for IIS, Sitecore and Windows Event logs collectors (required);
    • Log end date for IIS, Sitecore and Windows Event logs collectors (required);
    • Comments (optional).


    Fill all required fields and click Next to continue.

    Select contents step allows one to select different types of information collectors, which determine what kind of information about Sitecore instance will be included into the generated package. All collectors are split into two groups: Basic information and Advanced information.



    Click Next to continue.

    On the Generate package step you will see a list of collectors and their statuses. When all of them are completed, you will be presented with generation process results per collector and ability to restart any of them by clicking on the grey restart arrow. If any of the collectors fails (Error result) or returns no results (Warning result), you can examine its status message by clicking on the hyperlink in the Details column.



    Click Next to continue.

    On the Review package step you can examine a list of files to be included in the package, remove any of them by clicking on the red minus sign, open text files (currently limited to .config, .xml, .xslt, .txt, .log and .hashes file types) in the Notepad or attach custom files by dragging and dropping them onto the file list.



    Click Next to continue.

    Package generation may take some time — especially if you have selected long-running collectors like C15 (All files for /temp/__UpgradeHistory folder) or C16 (List of site’s files and their hash codes). In this case you’ll have to wait a bit at the last step until the package is completely generated.



    By default settings, a package is generated under Documents system folder. One can move it to any convenient location by clicking on the Move file to another folder link. Also it is possible to open Windows Explorer in the package location by clicking Open the folder link, or open the related support ticket in the default browser by clicking on the correspondent link, if such information was provided on the Enter meta data step. By default, the support packages are generated in ‘<CurrentUser>\Documents\’ folder.



    Clicking on the Finish button will result in a dialog which allows one to generate another package by clicking on Yes button (this option will navigate back to Select site step), exit the tool by pressing No or continue working with it by pressing Cancel.


    0
Back
Release notes
April 07, 2014

The Sitecore Support Package Generator tool version 1.2 rev. 140407 is released.
This is a maintenance release containing bug fixing and dataFolder detection improvements.


March 26, 2014

The Sitecore Support Package Generator tool version 1.2 rev. 140326 is released.
This is a minor update containing XML versionsof some 'human-readable' package files like PackageInfo.txt, HardwareInfo.txt, AssemblyInfo.txt.


March 20, 2014

The Sitecore Support Package Generator tool version 1.2 rev. 140320 is released.
This is a minor update targeted at resolving issue with incorrect DataFolder detection.


February 03, 2014

The Sitecore Support Package Generator tool version 1.2 rev. 140203 is released.
Issues resolved:
• Sporadic System.IO.PathTooLongExceptions during collecting deeply-nested files from Sitecore solution.

Important changes:
• Now the tool uses %AppData%\Roaming\Sitecore\SSPG\ folder instead of Isolated Storage. This allows better handling of long file paths.


December 19, 2013

The Sitecore Support Package Generator tool version 1.2 rev. 131219 is released.
New features:
• Added one new collector — 'All files from /temp/__UpgradeHistory folder'.
• Information collectors were split into two groups — Basic information and Advanced information.
• Information collectors were given short IDs in form of C01-C16. This should allow easier referencing them in text.

Important changes:
• One-Click Generation mode is removed from the tool.


August 29, 2013

The Sitecore Support Package Generator tool version 1.2 rev. 130829 is released.
Issues resolved:
· Windows Event Logs are collected correctly.


June 26, 2013

Released SSPG 1.2 rev. 130625.
New features:
· Added two new collectors — ‘Global.asax and Global.asax.cs files’ (collects mentioned files) and ‘Machine hardware information’ (collects information about machine’s hardware configuration and OS).
· Now generated package can be uploaded directly to Sitecore Public FTP Server.

Important changes:
· Now the tool requires elevated (administrative) privileges to run.
· ‘Add custom files’ step was merged with ‘Review package’ step.· Now the tool’s version is shown near the logo.

Issues resolved:
· Now the tool doesn’t crash in Windows Server 2012 (386477).
· DiffCollector doesn’t crash if one of the analyzed files was locked by another process.
Read more Back
Code examples

Solution screenshots(0)

Upload

Reviews (0)

Sort by: Date Most votes
  • Profile Avatar
    [fullName]

    Level: 0

    x0 x0 x0

    [date]

    [title]

    [text]

    Was this helpful?

    0

Comments (0)

Sort by: Date  Most votes

Leave a Comment

Comment must be field in
Post comment
loader

Write a review

Title can't be empty
Review can't be empty
Post review

Download

Title Description Download Action

Add File