Last updated 11/6/2023 CF



<for a simpler, user-friendly guide to gathering log files with a few automated scripts, look here>


Description:

There are a number of scripts and tools that are shipped in each release of DuraFlex and DuraBolt. Some gather more information than others, so it is important to know what each does.


C:\Navigator\User Resources\Utilities\CleanRIPScreenFolders\CleanRIPScreensFolders.bat

As of the writing of this document, there is an ongoing intermittent issue with a number of files being written to the Line and Euclidean folders contained within C:\Navigator\Renderers\NR_1\SW\Screens. This batch file does two things. First, it deletes all of the contents of C:\Navigator\Renderers\NR_1\SW\Screens\Euclidean and C:\Navigator\Renderers\NR_1\SW\Screens\Line. It then attempts to set the folders to read only. Once the first two folders have been cleared and locked, the additional C:\Navigator\Renderers\NR_1\SWfr-###\Screens folders are cleared out and locked. The script will accommodate up to 17 production RIPs. It should be noted that on duplex systems, this script would need to be run there as well if the problem is occurring. This batch file is intended to be run as Administrator.


C:\Navigator\User Resources\Utilities\CleanXiSpoolFoler\CleanXiSpoolIncoming.bat

As of the writing of this document, there is a rare issue that has been seen on some systems that are running the Navigator Server where C:\ProgramData\Xitron\XiSpool_1\_Incoming will contain temporary files used for processing jobs aren't being deleted by the server. This script automates deleting C:\ProgramData\Xitron\XiSpool_1\_Incoming along with all of the contained files and subfolders before recreating the C:\ProgramData\Xitron\XiSpool_1\_Incoming directory. This batch file is intended to be run as Administrator.


C:\Navigator\User Resources\Utilities\DFEBackRest

BackRest is the backup/restore script that can be used for several HHR-based systems. It will back up the following configuration files if they exist:

  • %AppData%\Xitron\Navigator\XiFlowServer.ini
  • %AppData%\Xitron\Navigator\XiFlowClient.ini
  • %AppData%\Xitron\Navigator\XiWebServer.ini
  • %AppData%\Xitron\Duraflex\DuraflexSpooler.ini
  • %AppData%\Xitron\DuraBoltSpooler\DuraBoltSpooler.ini
  • %AppData%\Xitron\DuraLinkSpooler\DuralinkSpooler.ini
  • %AppData%\Xitron\NX\*.*
  • C:\Program Files (x86)\Common Files\SafeNet Sentinel\Sentinel LDK\installed\109670\*
  • C:\Navigator\Navigator\*.xml
  • C:\Navigator\Navigator\Xiflow.jobs
  • C:\Navigator\Navigator\Config\RenderConfig\*
  • C:\Navigator\Navigator\Config\Media Sizes\Media.lst
  • C:\Navigator\Navigator\Config\Components.json
  • C:\Navigator\Navigator\htdocs\DFE\Resources\CustomInterface.json
  • C:\Navigator\Renderers\NR_1\SW\Config\Calibration\*
  • C:\Navigator\Renderers\NR_1\SW\Config\Profiles\ 
  • C:\Navigator\Renderers\NR_1\SW\Config\Press\ 
  • C:\Navigator\User Resources\Utilities\ODC tools\ODC.ini

It should be noted that this does not back up any custom branding images used in the DFE. It also will not save the archives file, the jobs folder, archived databases, and perhaps most importantly, _template. The _template file is where custom entries are inserted for the Render config to apply when processing jobs through the RIP. These custom entries will not be carried over. Do not use older versions of the _template file with newer releases as there may be some settings or options that didn't exist in previous versions that will cause errors or unexpected output. It will also not merge with the presets installed with newer versions of the Navigator Server. If new settings have been introduced with presets defined in the INI file, the INI file will be overwritten with the previous version when running the BackRest restore process. Upgrade with care. When in doubt, back up the fresh installation of the new version to compare items if you run into any issues.


This script requires Python 3.x.x. If you double-click one of the Python scripts and the script doesn't run, verify that Python 3.x.x is installed. If it is, open a command prompt and change directories to C:\Navigator\User Resources\Utilities\BackRest. Once there, type py -3 backup.py or py -3 restore.py. Py is the python launcher. The -3 indicates to use Python 3. If you are running a MemJet script, then you would use -2 to indicate that Python 2.x is to be used when processing the script.


BackRest can be customized to ignore files. Check the readme.txt for  more information.


C:\Navigator\User Resources\Utilities\FixupShares\FixupShares.bat

This batch file attempts to properly set share permissions for C:\ProgramData\Xitron\XiShare, C:\ProgramData\Xitron\XiSpool_1 and C:\ProgramData\Xitron\SLP to grant full permissions to Everyone.


Not all localizations use "Everyone" in spite of Microsoft stating otherwise. It may be necessary to find the Everyone group.


This batch file is intended to be run as Administrator.


C:\Navigator\User Resources\Utilities\GetDuraFlexVersions\GetDuraFlexVersions.py

getFileVersion.cmd and getProductVersion.cmd are called by GetDuraFlexVersions.py. They do not need to be run separately.

This script will list the versions of the DuraFlex components that are installed. This is helpful in determining what version of DuraFlex is installed when the end user isn't certain, or you have little to no information to go on.


This script requires Python 3.x.x. If you double-click one of the Python scripts and the script doesn't run, verify that Python 3.x.x is installed. If it is, open a command prompt and change directories to C:\Navigator\User Resources\Utilities\GetDuraFlexVersions. Once there, type py -3 GetDuraFlexVersions.py. Py is the python launcher. The -3 indicates to use Python 3. If you are running a MemJet script, then you would use -2 to indicate that Python 2.x is to be used when processing the script.


C:\Navigator\User Resources\Utilities\LogJam\LogJam.py

LogJam.py is configured via LogJam.ini. The LogJam.ini file that ships with the script itself will gather the following:

  • $RIP1$\SW\clrip_0.log
  • $RIP1$\SW\clrip_1.log
  • $RIP1$\SW\clrip_2.log
  • $RIP1$\SW\clrip_3.log
  • $RIP1$\SW\clrip_4.log
  • $RIP1$\SW\clrip_5.log
  • $RIP1$\SW\clrip_6.log
  • $RIP1$\SW\clrip_7.log
  • $RIP1$\SW\clrip_8.log
  • $APPDATA$\Xitron\DuraFlex\DuraFlexSpooler.log
  • $RIPMANAGER$\Utilities\Logs\XiEvents.log
  • $RIPMANAGER$\Utilities\Logs\XiService.log
  • C:\ProgramData\Xitron\SLP\Logs\XiMonitor.log

Read LogJam.pdf for a longer explanation on what this utility does and how to configure it.


This script requires Python 3.x.x. If you double-click one of the Python scripts and the script doesn't run, verify that Python 3.x.x is installed. If it is, open a command prompt and change directories to C:\Navigator\User Resources\Utilities\LogJam. Once there, type py -3 LogJam.py. Py is the python launcher. The -3 indicates to use Python 3. If you are running a MemJet script, then you would use -2 to indicate that Python 2.x is to be used when processing the script.


C:\Navigator\User Resources\Utilities\LogJam\LogJamRemote.py

This script is used in conjunction with C:\Navigator\User Resources\Utilities\LogJam\LogJam.py. Read LogJam.pdf for information on how to configure and use.


This script requires Python 3.x.x. If you double-click one of the Python scripts and the script doesn't run, verify that Python 3.x.x is installed. If it is, open a command prompt and change directories to C:\Navigator\User Resources\Utilities\LogJam. Once there, type py -3 LogJamRemote.py. Py is the python launcher. The -3 indicates to use Python 3. If you are running a MemJet script, then you would use -2 to indicate that Python 2.x is to be used when processing the script.


C:\Navigator\User Resources\Utilities\Multi Renderer Configuration Tool\MultiRenderer.hta

Information to come.


C:\Navigator\User Resources\Utilities\Postflight\Postflight.py

Postflight creates a report in the form of an HTML file. It is intended to be run while the system is running right after an error has occurred in the system. If the error caused the Navigator Server to crash, relaunch it, then execute this script. It gathers information on the last RIPped job, the RIP logs, a summary of errors and warnings from the most recent RIPped job and XfDebug.log, PC information, software versions, security details, configuration data, XiflowClient.ini, XiflowServer.ini, an partial logs for the server, spectrophotometer, XiEvents, XiService, XiSpooler, RIP logs, JslConfigs.xml and XfDebug.log. 


This script does not gather those logs in their entirety. Use LogJam.py or Make_DF-DB_Log_Archive_Rxx.bat depending on which logs you need. This script provides an easy way to look for more common errors so that you can determine the nature of an error and how best to proceed without needing to open each individual log or gather other system information.


This script requires Python 3.x.x. If you double-click one of the Python scripts and the script doesn't run, verify that Python 3.x.x is installed. If it is, open a command prompt and change directories to C:\Navigator\User Resources\Utilities\Postflight. Once there, type py -3 Postflight.py. Py is the python launcher. The -3 indicates to use Python 3. If you are running a MemJet script, then you would use -2 to indicate that Python 2.x is to be used when processing the script.


C:\Navigator\User Resources\Utilities\Scripts\CrashDump registry settings.reg

These Windows Registry entries are able to be added to the Windows Registry by double-clicking the

C:\Navigator\User Resources\Utilities\Scripts\CrashDump registry settings.reg file while logged in as a local Administrator account. It is only necessary to add the registry entries one per machine. The registry entries are to enable the creation of debug dumps for the following EXEs:

  • XiflowServer.exe
  • MakeThumbnail.exe
  • Thumbnailer.exe
  • XFDebugLog.exe
  • XiCaNT.exe
  • XiLaunch.exe
  • XiSettings.exe
  • XiThumbnailer.exe
  • XiflowClient.exe
  • XiEvents.exe
  • XiService.exe
  • XiSpooler.exe
  • XiWebServer.exe
  • DuralinkSpooler.exe
  • DuraflexSpooler.exe
  • DuraBoltSpooler.exe
  • clrip.exe


C:\Navigator\User Resources\Utilities\Scripts\Scripts - Dropbox.url

This is a direct download link from the Xitron DropBox account for the most recent version of the files located in C:\Navigator\User Resources\Utilities\Scripts. These scripts are updated periodically to include or exclude certain data depending on need. Always launch this and pull the most recent versions of the scripts in this folder. It is not necessary to add the registry entry file from the ZIP file that is downloaded if it has already been run once. Unzip the folder in a location of your choosing. It is not necessary to run these scripts from within the C:\Navigator\User Resources\Utilities\Scripts folder. All scrips are intended to be run as Administrator.

DropBox Folder

Direct Download Link


C:\Navigator\User Resources\Utilities\Scripts\Create_New_Navigator_Backup_Rxx.bat

The purpose of this script is to make a backup of the entire Navigator installation. The batch file can be edited to change the output directory for the system archive. When you run the script licensing information, %AppData%\Xitron, C:\ProgramData\Xitron and C:\Navigator (excluding the jobs and archive folders). The default destination folder for the backups will be C:\_NavigatorBackups. When the script is run you are prompted to enter in the description of the installation. This is purely to name the folder that the backup will reside in along with what is needed to restore the installation.


The intended uses for this are:

  • For OEMs or customers to take a snapshot of their system in its entirety once the system is installed, configured and in a functional state.
  • For OEMs or customers to take a snapshot of their system prior to an update.
  • For OEMs and customers to take a snapshot of their system after they make long-term changes to their system that needs to persist if the system later needs to be restored. An example of this would be adding ICC profiles. Another example would be system changes that need to persist.
  • For OEMs or customers to make an archive of their existing system to send to Xitron or MemJet support for analysis.
    • After backing up a broken system, you can restore one of the previous backups of the system when it was working to keep production going.

This script must be run as Administrator. It is intended to be run when the Navigator Server and off of its associated applications are not running. The script will force-quit any of the applications that it finds open. As such, exiting cleanly is preferred over a force-quit.


C:\Navigator\User Resources\Utilities\Scripts\Make_DF-DB_Log_Archive_Rxx.bat

This is the most comprehensive log gathering script in this list. The default location for logs to be collected to is C:\NavigatorLogs. It will gather the following:

  • Log files
  • Archived log files
  • Crash reports
  • Crash dumps
  • Symbols files
  • Configuration files
  • Jobs and Archives databases
  • LDK Licensing files
  • LDK Licensing information reports
  • Networking information
  • System information
  • Running processes list
  • SLP Configuration and logs
  • ICC/ICM files
  • Zip, 7z, RAR, TAR and GZ files
  • Action lists
  • Preflight profiles
  • Python scripts
  • Batch files
  • Text files
  • XML files
  • DFE, NCE, DCE and other htdocs folders
  • Core Event Viewer logs in native format
  • Print Controller logs
  • Windows Event Viewer Logs

Since logs are generally only pulled if we are investigating an issue, it's possible that there could be weeks or months worth of .log files located in any of the following folders and subfolders contained within C:\Navigator, C:\ProgramData\Xitron and %AppData%\Xitron. The script will compress any log files in Archived Logs folders prior to creating the large .7z file that contains all of the logs. This is to save time by not having to recompress archived logs each time this script is run. It can also save a significant amount of space.


This script must be run as Administrator. It is intended to be run when the Navigator Server and off of its associated applications are not running. The script will force-quit any of the applications that it finds open. As such, exiting cleanly is preferred over a force-quit.


Because of the sheer number of files this script will collect, the resulting .7z file will be quite large. If you have limited bandwidth, it may be possible to open the .7z file and remove older or irrelevant information. Older logs can offer insight into how long a problem has been occurring or offer other clues as to what the issue is. Unless you have to delete older log files, please leave them included in this archive.


Files can be uploaded to https://xitron.com/f/uploads. If this is for a specific ticket number, please include that in the name field.