Get Diagnostic Files (GDF) Utility

The Advanced Store system supports the use of the Get Diagnostics File (GDF) script to gather relevant log data and system configuration details from a target system. The script can be run on a POS terminal or any of the Enterprise Servers where the issue is encountered. The files obtained from the GDF script can help support personnel in determining the cause of an issue in order to resolve it. The log data can be compressed into a .zip file.

The GDF script can be run using one of the following methods:

  • Running the tool
  • Using the command line

Requirements

In order for the GDF script to properly run, the following requirements must be met:

  • Windows Management Framework 5.1 must be installed.
  • The user running the script must be an Administrator.
  • If the system with the reported issue is the Database Server, install the Utilities using the NCR DSR Enterprise Server.msi installer.

Running the tool

This task uses the following file.

File nameFolder

GetDiagFiles.ps1

  • On the In-Store Server or the POS terminal

    %PROGRAMFILES%\NCR\AdvancedStore\POS

  • On the Enterprise Servers

    %PROGRAMFILES(X86)%\NCR\DSREnterprise\Utilities

To run the GDF script using the tool, follow these steps:

  1. Right-click GetDiagFiles.ps1 on the POS terminal or Enterprise Server with the reported issue and select Run with PowerShell. The application displays a PowerShell window.
    Note

    If the GDF script is run on the system for the first time, an execution policy acknowledgment is required. Enter Y to proceed.

  2. Enter Y for each command line:
    1. Gather installed software information
    2. Gather machine detailed information
    3. Gather rabbitmq log files
      Note

      This command line is only available to systems that have the RabbitMQ Server application installed.

    4. Compress data into .zip file

    The script gathers the data, copies it to the compressed file, and displays a prompt to exit the window.

  3. Press Enter. The application closes the PowerShell window and displays the folder where the .zip file is located.
    Note

    By default, the compressed file is saved in the following folder: C:\AS-GDF

The file is saved with the following name format:

[YYYYMMDD]-[HHMMSSMMM]-[Computer Name]-LogFiles.zip

Where [YYYYMMDD]-[HHMMSSMMM] is the date and time the diagnostic files were gathered and [Computer Name] is the hostname of the computer where the GDF script was run.

Example

20181126-232030660-AS-IP-POS3-LogFiles.zip

Using the command line

To run the GDF script using command lines, follow these steps:

  1. Open a PowerShell window on the system with the reported issue.
  2. Go to the location of the GetDiagFiles.ps1 file.
    Example

    Enter cd "%PROGRAMFILES%\NCR\AdvancedStore\POS"

  3. Enter the following command:

    powershell -NoProfile -ExecutionPolicy Bypass -Command .\GetDiagFiles.ps1

  4. Enter Y for each command line:
    1. Gather installed software information
    2. Gather machine detailed information
    3. Gather rabbitmq log files
      Note

      This command line is only available to systems that have the RabbitMQ Server application installed.

    4. Compress data into .zip file

    The script gathers the data, copies it to the compressed file, and displays a prompt to exit the window.

  5. Press Enter. The application closes the PowerShell window and displays the folder where the .zip file is located.