3 minute readApplies to: v4

Collecting Diagnostic Information

Squared Up provides two scripts and may ask you to run one or both of these:

  1. The Squared Up Diagnostics Script Get-SquaredUpDiags.ps1 gathers log files and information about the configuration of your Squared Up instance. The resulting files are added to a zip file which should be sent to Squared Up Support.

  2. The Squared Up Kerberos Script Debug-SquaredUpKerberos.ps1 queries the Kerberos configuration when using single sign-on with Windows authentication. The results are shown on screen and a screenshot of this should be sent to Squared Up Support.

Procedure

  1. On your Squared Up server download the diagnostic script package.

  2. Extract its contents to a suitable location, for example C:\Scripts or the desktop.

  3. Open Windows PowerShell as an administrator (Start Menu > Windows PowerShell, then right-click and select Run As Administrator).

  4. Change location into the directory where you extracted the script, for example:

    cd C:\Scripts

    or

    cd ~\desktop

  5. For the Diagnostics Script:

    1. Type .\Get-SquaredUpDiags.ps1

    2. Next type a or r when prompted to run the script.

    3. Enter your Squared Up support ticket ID, and then the Squared Up v4 application that you need to diagnose.

    Diagnostics sample start of script <>

    1. Please send the resulting ZIP file(s) from C:\ProgramData\SquaredUpDiags to Squared Up Support, along with any helpful screenshots of the errors or issue you are experiencing.
  6. For the Kerberos Script:

    1. Type .\Debug-SquaredUpKerberos.ps1

    2. Next type a or r when prompted to run the script.

    3. Please send a screenshot of the script output to Squared Up Support.

How to include your dashboard packs

Squared Up Support may ask you to include your dashboard packs in the Diagnostics Script for further information.

To include your dashboard packs within the diagnostic zip add -IncludePackages to the end of your script execution, for example:

.\Get-SquaredUpDiags.ps1 -IncludePackages

Diagnostic Script parameters

You can manually specify the PowerShell path to your Squared Up Virtual Directory if the script doesn't determine it correctly by adding -SquaredUpVirtualDirectory to your script execution and specifying the IIS administration path manually.

For example, if the Virtual Directory was under Default Web Site > SquaredUpv4 in IIS the command would be:

.\Get-SquaredUpDiags.ps1 -SquaredUpVirtualDirectory "IIS:\Sites\Default Web Site\SquaredUpv4"

If you want to specify where the resulting ZIP files(s) are saved to add -OutputZipFile and specify a location, for example:

.\Get-SquaredUpDiags.ps1 -OutputZipFile "C:\Users\User\Documents"

The script collects diagnostic information to a SquaredUpDiags subfolder under the temp directory before it is zipped to OutputZipFile. To change the temp directory add -TempDirectory:

.\Get-SquaredUpDiags.ps1 -TempDirectory "C:\Users\User\Documents\Temp"

Where to find log files

Squared Up Ltd. (c) 2018Report an issue with this article