Skip to main content
Kofax

Controlsuite : How to enable XPS Job Submitter logs for DRC I-Queue troubleshooting

Article # 3042896 - Page views: 41

Question:

How is it possible to trace the process of releasing a job from the i-Queue and its conversion to the Printer driver in Controlsuite?

Answer:

When a job is released or sent via i-Queue direct, the print job uses the EQXOSJobsubmitter.exe application to re-Spool the print job converting the file format from XPS to the Printer driver associated with the device (e.g. PCL6). It submits back through the print spooler using the Microsoft API.

In the Workstation client of Controlsuite Equitrac 6.2 and XPS Job Submitter logs can be enabled for DRC I-Queue and I-Queue Direct client troubleshooting:

  1. On the workstation make a backup of the following file: C:\Program Files\Kofax\Equitrac\Document Routing Engine\EQXPSJobSubmitter.exe.config
  2. Open the file in a text editor  (e.g. notepad run as Administrator) - here is the default file:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <startup>
    
    <!--<supportedRuntime version="v4.0" />-->
  <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5"/></startup>
  <appSettings>
    <!--<add key="TraceFile" value="\\ProgramData\\Kofax\\ControlSuite\\Logs\\EQXPSJobSubmitter.log" />-->
    <add key="EnableDiagnostics" value="false"/>
  </appSettings>
  <runtime>
    <generatePublisherEvidence enabled="false"/>
  </runtime>
</configuration>
  1. Uncomment (remove from the end) the line that starts  <!--<add key by removing the <!-- at the start of the line and the --> on the end
  2. Change value of line <add key="EnableDiagnostics" value="false"/> to true   (Note : Case Sensitive)
  3. Save the file

It should now look like this:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <startup>
    
    <!--<supportedRuntime version="v4.0" />-->
  <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5"/></startup>
  <appSettings>
    <add key="TraceFile" value="\\ProgramData\\Kofax\\ControlSuite\\Logs\\EQXPSJobSubmitter.log" />
    <add key="EnableDiagnostics" value="true"/>
  </appSettings>
  <runtime>
    <generatePublisherEvidence enabled="false"/>
  </runtime>
</configuration>
 
  1. Restart the EQ Shared Engine service
  2. The XPS Job Submitter logs will now be written to whenever a job is printed. Either send a job to i-Queue direct or Release a stored job sent to the i-queue
  3. Recreate the issue, collect the logs, along with Diagnostic DRC and Equitrac Shared Engine logs see: ControlSuite : How to collect Workstation Client DRC logs manually - Kofax
  4. Disable the logs by restoring the file backed up in step 1.  Failure to do so may fill up the disk with logs.
  5. Restart the EQ Shared Engine service

   

Note: For Controlsuite 1.0 and 1.1, the install location is C:\Program Files\Nuance\Equitrac\Document Routing Engine\EQXPSJobSubmitter.exe.config and log directory will be different.

Applies to:  

Product Version
ControlSuite 1.2
ControlSuite 1.3
ControlSuite 1.x