Errors management

The Tetra4D “Automate” provides 3 different types of information to handle the conversion process.

  • The Tetra4D “Automate” executable returns execution codes,

  • 2 log files are generated during the conversion:

    • Log_File_Name.Log: Short log file

    • Log_File_Name_verb.Log: Verbose log file

Remark:

  • The name of the log file “Log_File_Name.Log” is defined in the command line.

  • The “_verb” suffix is automatically added by Tetra4D “Automate”.

Short log file

The following is the sample of a short log file:

Application : Tetra4D Automate - 2017(2017.1.2) 05-09 23:48:37
-------------------------------
--- Command Line --------------
-------------------------------
C:\Program Files\Tetra4D\Automate\samples\Mode_Manual\\..\..\Automate.exe
-pdfin: C:\Program
     Files\Tetra4D\Automate\samples\Mode_Manual\\..\..\samples\templates\Template_Automate_ViewCompo
     nent.pdf
-libdir: C:\Program Files\Tetra4D\Automate\samples\Mode_Manual\\..\..\.
-3dfilein: C:\Program
     Files\Tetra4D\Automate\samples\Mode_Manual\\..\..\samples\Mode_Manual\01_Components\housing
     front.CATPart
-xmldatafieldsin: C:\Program
     Files\Tetra4D\Automate\samples\Mode_Manual\\..\..\samples\Mode_Manual\01_Components\HousingFron
     t_Import_TITLEBLOCK.xml
-3doptions: C:\Program
     Files\Tetra4D\Automate\samples\Mode_Manual\\..\..\samples\settings\automate_settings_manual.xml
-outfname: C:\Program
     Files\Tetra4D\Automate\samples\Mode_Manual\\..\..\samples\Mode_Manual\10_PDF_Out\Tetra4D_Housin
     gFront_ViewComponent.pdf
-outlog: C:\Program
     Files\Tetra4D\Automate\samples\Mode_Manual\\..\..\samples\Mode_Manual\10_PDF_Out\Tetra4D_Housin
     gFront_ViewComponent.log
-------------------------------
--- Log Summary ---------------
-------------------------------
Date : 06/01/17
Time : 11:54:06
Reading data from file : C:\Program
Files\Tetra4D\Automate\samples\Mode_Manual\\..\..\samples\Mode_Manual\01_Components\housing
front.CATPart
CPU time (sec) : 9.607
-------------------------------
COMMAND_ERRORS : 0
COMMAND_WARNINGS : 0
-------------------------------
READING_ERRORS : 0
READING_WARNINGS : 0
-------------------------------
WRITING_ERRORS : 0
WRITING_WARNINGS : 0
-------------------------------

The short log file presents a summary of the conversion process:

  • Application
    Version and date of the Tetra4D “Automate” software
  • Command line
    Copy of the command line and arguments that have triggered the conversion
  • Log Summary
    Date and time of the conversion (start)
    Name of the file that has been converted
    Duration of the conversion
  • Command errors and warnings
    Errors and warnings related to the command line Remark: The errors that can be identified are: - Syntax errors in command line - Missing file (a specified file has not been found) - Permissions errors (ie: Not possible to write in the output folder) The conversion settings defined in the conversion settings XML file are not validated during that stage.
  • Reading errors and warnings
    Errors and warnings issued during the CAD data reading stage.
  • Writing errors and warnings
    Errors and warnings issued during the PDF writing stage.

See “Tetra4D “Automate” errors” to access to a list of managed errors

Verbose log file

The Verbose log file provides detailed information about the conversion process. See “Tetra4D “Automate” errors” to access to a list of managed errors

Tetra4D “Automate” errors

The below information correspond to the warning and errors that are listed in the LOG files. They are formatted as follows:

[type] [code] - [message]

Type:

The possible values for TYPE are:

  • WAR

    Warning

  • ERR

    Error

Code and Message:

  • 3 : missing parameter in the command line

  • 4 : can’t find a file from the command line

  • 5 : can’t initialize library

  • 6 : can’t load settings file

  • 18 : the maximum converter instance number on the server has been reached

  • -34 : License option doesn’t allowed the requested function

  • -205 : Cannot initialize library

  • -1000000 : Unexpected PDFLib Error.

  • -1000002 : A 3D is required to save the document.

  • -1000003 : document has not been saved properly.

  • -1000005 : file is already opened in another application.

  • -1000006 : file is locked by another application.

  • -1000009 : Cannot access file.

  • -1000011 : Cannot find a default view in 3D Annotation.

  • -1000015 : Not enough memory.

  • -1000016 : The font is not supported.

  • -1000020 : In a PRC/PDF file, there is a view without a camera; snapshots cannot be created from such views.

  • -1000021 : Tabletopdf or one of its components is missing from your directory.

  • -1000022 : Failed to create the table

  • -1000023 : Failed to create the table because of style entry

  • -1000024 : Resource directory could not be initialized

  • -1000026 : Error while generating the images for the buttons in the view carousel.

  • -1000028 : Failed to create the table

  • -1000029 : Error in text data

  • -1000030 : PDFlib DLL or one of its components is missing.

  • -1000031 : ImageMagick DLL or one of its components is missing.

  • -1000032 : Error retrieving 3D data on page. No 3D annotation was found.

  • -1000033 : Error retrieving 3D data on page. No 3D annotation was found.

  • -1000035 : Error reading text stream.

  • -1000036 : Encoding error converting text stream.

  • -1000037 : Error in slider creation

  • -1000038 : Error in slider creation

  • -1000039 : The slidetable object could not be found

  • -1000040 : The carousel object could not be found

-1000041 : The XML contained into the PDF is not compatible with the library

CAD readers errors

The below information corresponds to the warning and errors that are listed in the LOG files. They are formatted as follows:

[type] [code base format]:[IO parameter]:[base code]:[specific code] - [message]

Type

The possible values for TYPE value are:

  • WAR

    Warning

  • ERR

    Error

Code Base Format

  • CGR

  • CV5

  • PROE

  • UG

  • U3D

  • SLW

  • CAT

  • IDEAS

  • CADDS

  • STEP

  • IGES

  • INV

  • SAT

  • XVL

  • SE

  • JT

  • XT : Parasolid

  • VDA

I/O Parameters

The possible values for Input/Output value are:

  • R

    Reader

  • W

    Writer

Parasolid Specific Errors:

The error information is defined by a “Base Code” and a “Specific Code” values The Base Code possible values are:

  • -1011 : Reader failure
    For this Base Code, the Specific Code values can be:

  • 202: Error in surface creation

  • 218: Failed to keep parsed entities

  • -1099 : Unknown
    For this Base Code, the Specific Code values can be:

  • 201: Unknown density units

Tetra4D “Automate” return codes

The executable returns a code that enable to detect if the process was successful or not. Managing the return code is a first step in handling the conversion process.

Return code: 0

This value shows that the executable was correctly triggered:

  • Command line is correct

  • License was successfully read

  • Conversion settings file has been successfully read
    Remark:
    In this version, the values that are defined in the conversion settings file are not checked.

Remark:

Even if the return code is 0, some warning or errors may have occurred during the PDF generation process. For this reason, the LOG files (SHORT and VERBOSE) must be parsed in order to access to these additional information.

Return code: Positive value (3, 4, 5, 6, 18)

These values show errors that are related to the trigger of the “Automate” executable:

  • 3 : missing parameter in the command line

  • 4 : can’t find a file from the command line

  • 5 : can’t initialize library

  • 6 : can’t load settings file

  • 18 : the maximum converter instance number on the server has been reached

Remark:

These errors stop the execution of the process. These errors are also listed in the LOG files.

Return code: Negative value (-34)

This value is issued if there is a licensing issue (CAD reader license).

  • -34 : License option doesn’t allowed the requested function