RunJob Method

Summary

Runs a job.

Syntax

C++/CLI

Java

Python

public void RunJob( 
   DocumentConverterJob job 
)

public:  
   void RunJob( 
      DocumentConverterJob^ job 
   )

public void runJob(DocumentConverterJob job)

def RunJob(self,job):

Parameters

job

The DocumentConverterJob to run. This parameter cannot be null. Use CreateJob to create a valid

DocumentConverterJob object.

Remarks

RunJob will block the current thread till the method returns. To run a job asynchronously, use RunJobAsync.

When this method returns, DocumentConverterJob.Status will contain the status of the job and whether it was successful (DocumentConverterJobStatus.Success), completed but with errors (DocumentConverterJobStatus.SuccessWithErrors) or was aborted by the user or due to recoverable errors (DocumentConverterJobStatus.Aborted).

If errors did occur, then DocumentConverterJob.Errors will contain a list of error description values.

The above is correct when the value of DocumentConverterOptions.JobErrorMode is set to DocumentConverterJobErrorMode.Continue (the default) which catches all the exceptions and adds them to the error list. If the mode was set to DocumentConverterJobErrorMode.Abort then exceptions are not caught by the engine and instead delegate up to the calling code as usual.

To use this method, initialize a new DocumentConverterJobData object with the job's parameters (input file name or document, pages, output format, output file name, annotations, etc.), then use CreateJob to create the DocumentConverterJob object passed as job to this method. Finally, call RunJob passing the DocumentConverterJob.

If tracing is enabled using DocumentConverterDiagnostics.EnableTrace, then logging and debugging messages will be sent to any trace listener while the job is running.

The JobStarted event will occur once right after RunJob is called. Then one or more JobOperation events will occur while the job is running with information on the various operations being performed. Finally the JobCompleted will fire once when the job is completed (successfully or not) and right before this method returns.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
using Leadtools.Document; 
using Leadtools.Caching; 
using Leadtools.Annotations.Engine; 
using Leadtools.Ocr; 
using Leadtools.Document.Converter; 
using Leadtools.Annotations.Rendering; 
 
public void DocumentConverterJobsRunJobExample() 
{ 
   using (DocumentConverter documentConverter = new DocumentConverter()) 
   { 
      var inFile = Path.Combine(ImagesPath.Path, @"Leadtools.doc"); 
      var outFile = Path.Combine(ImagesPath.Path, @"output.tif"); 
      var format = RasterImageFormat.Tif; 
      var jobData = DocumentConverterJobs.CreateJobData(inFile, outFile, format); 
      jobData.JobName = "conversion job"; 
 
      var job = documentConverter.Jobs.CreateJob(jobData); 
      documentConverter.Jobs.RunJob(job); 
 
      if (job.Status == DocumentConverterJobStatus.Success) 
      { 
         Console.WriteLine("Success"); 
      } 
      else 
      { 
         Console.WriteLine("{0} Errors", job.Status); 
         foreach (var error in job.Errors) 
         { 
            Console.WriteLine("  {0} at {1}: {2}", error.Operation, error.InputDocumentPageNumber, error.Error.Message); 
         } 
      } 
   } 
}

 
import static org.junit.Assert.assertTrue; 
 
import java.io.File; 
import java.io.FileOutputStream; 
import java.io.IOException; 
import java.net.URI; 
import java.util.concurrent.Executors; 
import java.util.logging.ConsoleHandler; 
import java.util.logging.Handler; 
import java.util.logging.Level; 
import java.util.logging.Logger; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
 
import leadtools.*; 
import leadtools.annotations.rendering.AnnJavaRenderingEngine; 
import leadtools.caching.FileCache; 
import leadtools.codecs.*; 
import leadtools.document.DocumentFactory; 
import leadtools.document.DownloadDocumentOptions; 
import leadtools.document.LEADDocument; 
import leadtools.document.LoadDocumentOptions; 
import leadtools.document.LoadFromCacheOptions; 
import leadtools.document.UploadDocumentOptions; 
import leadtools.document.converter.DocumentConverter; 
import leadtools.document.converter.DocumentConverterEmptyPageMode; 
import leadtools.document.converter.DocumentConverterJob; 
import leadtools.document.converter.DocumentConverterJobData; 
import leadtools.document.converter.DocumentConverterJobError; 
import leadtools.document.converter.DocumentConverterJobErrorMode; 
import leadtools.document.converter.DocumentConverterJobStatus; 
import leadtools.document.converter.DocumentConverterJobs; 
import leadtools.document.writer.DocumentFormat; 
import leadtools.document.writer.DocumentWriter; 
import leadtools.ocr.OcrEngine; 
import leadtools.ocr.OcrEngineManager; 
import leadtools.ocr.OcrEngineType; 
 
 
public void documentConverterJobsRunJobExample() { 
   DocumentConverter documentConverter = new DocumentConverter(); 
   String LEAD_VARS_ImagesDir = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String inFile = combine(LEAD_VARS_ImagesDir, "Leadtools.pdf"); 
   String outFile = combine(LEAD_VARS_ImagesDir, "output.tif"); 
 
   RasterImageFormat format = RasterImageFormat.TIF; 
   DocumentConverterJobData jobData = DocumentConverterJobs.createJobData(inFile, outFile, format); 
   jobData.setJobName("Conversion Job"); 
 
   DocumentConverterJob job = documentConverter.getJobs().createJob(jobData); 
   documentConverter.getJobs().runJob(job); 
   assertTrue(job.getStatus() == DocumentConverterJobStatus.SUCCESS); 
   if (job.getStatus() == DocumentConverterJobStatus.SUCCESS) { 
      System.out.println("Success!"); 
   } else { 
      for (DocumentConverterJobError error : job.getErrors()) { 
         System.out.println(error.getError().toString()); 
      } 
   } 
}

Requirements

Target Platforms

Reference

DocumentConverterJobs Class

DocumentConverterJobs Members

Leadtools.Document.Converter Namespace

Using LEADTOOLS Document Converter

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document.Converter Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document.Converter Namespace

Assemblies