KBA-01634: Workstation Logs

Question:

How do I get log files on a user workstation?

Answer:

First you need to set up logging on the user’s workstation (or verify that logging has already been set up).  Instructions on different for V2020+ and for versions before V2020.

How to set up logging in V2020+

  1. On the user’s workstation, in Spitfire, select My Settings.
  2. Go to the Client Session Information tab and click Set Up Device.  If a confirmation window appears, click Run.
  3. Click the Logging Configuration button.
  4. If the following are not already checked, click the checkboxes for

    1. Dashboard Logging
    2. BFA Tool Logging
    3. Budget Period Distribution Logging
    4. SOV Billing Tool Logging
      Note: Decide if you need logging for the other options. See Additional Information below.
  5. Click OK.

How to get a log file in V2020+

  1. On the user’s workstation, in Spitfire, select My Settings (as shown above).
  2. Go to the Client Session Information tab and click Log Files.

  3. Find the log file. If you sort by date, the file you want will likely be the top file.  The file will end with .log.
  4. Copy the log file to an email and sent it to Support.
    1. If you get the following message, take the steps below.

      1. Open the “tray” on your bottom taskbar, located near the date and time.
      2. Right-click on the Spitfire icon.
      3. Select Close sfPMS Link Helper.

      4. You should now be able to copy or move the log file.

How to set up logging prior to V2020:

  1. In sfDash, click on the gear and then Configure Local Options:  Configure Local OptionsHint: in older version of sfPMS, look for FILE | Configure in the sfDash Window menu.
  2. In the Dashboard Configuration dialog, change to the Logging tab
  3. On the Logging tab, check the options you need. Typically you want Dashboard logging, and perhaps the BFA or SOV log.  Support will likely let you know which logs are needed.
  4. Click OK to close the dialog.
  5. Close sfDash and re-launch. Many of these options only take effect on launch.

How to get a log file prior to V2020:

  1. On your workstation, navigate to C:\Spitfire.
  2. Look for the log file you need.  The file will end with .log.  If you sort by date, the file will likely be the first one.

Additional Information:

In each case, only the most recent log is kept.  Reproduce the problem or error and then send the log to Support.

  • Dashboard Logging – The log contains the client side information about checking files in and out, monitoring while they are edited, opening BFA and other tools etc. The file is called something like sfDash_your-sitename-com_sfPMS@1.log or sfLink@1.log.
  • BFA Logging – The log contains client side information about activity within BFA Excel sessions. [Prior to V2020, the file is called something like sfBFA_1.log.] 
  • SOV Logging – The log contains client side information about activity within SOV Excel sessions. [Prior to V2020, the file is called something like sfSOV_1.log.]
  • Batch Upload Tool – This is an activity log from the (seldom used) tool that uploads batches of image and/or PDF files.
  • Budget Period Distribution – This is an activity log from the Period Distribution Excel tool.
  • Update Logging – This is a diagnostic log from when the client pulls updates to the various client side tools.

 


KBA-01634; Last updated: October 1, 2020 at 13:03 pm ;
Keywords: logging, turn on logs, log files, get log file, log files