Skip to content

Home > User Interface > Batch Processing > Batch Processing User Interface

Batch Processing User Interface

The Batch Processing interface may be opened from the Tools menu by selecting the Batch processing item.

The Batch Processing User Interface includes a table which displays the current list of batch jobs, control buttons placed on the right hand side of the form, and a status bar located at the bottom of the form.

Control buttons

Close

Closes the Batch Processing form. Running jobs will be automatically aborted when closing the form. A warning message would therefore display in this case asking for confirmation before aborting running jobs. The list of batch jobs defined in the Batch Jobs form is saved before the form is closed and remains therefore available when re-opening the form.

Load Files

Add files into the list of batch jobs. Pressing the Load Files button displays the Select Files form. The type of files to be added may be selected through the filter available within the Select Files form. Multiple selection of files is available by holding the SHIFT and/or the CTRL keys. Click Select to actually add the files into the list of batch jobs. Job Types and Priority are set by default depending on the file extension and could be changed once the files have been added.

Hint : Files may be added to the list of batch jobs through drag and drop without need to go through the Load Files button. Select the files from the Windows Explorer and drag them over the Batch Processing form. Drag and drop may also be used with Batch Queue files (*DBQ).

Remove Files

Removes selected batch jobs from the list of batch jobs. Multiple selection of batch jobs is available by holding the SHIFT and/or the CTRL keys. Batch jobs cannot be removed from the list while they are running.

Load Queue

Loads predefined list of batch jobs (batch jobs queue). Batch jobs queues are defined through batch jobs queue files (*.DBQ files). These files are text files that may be generated either with the GUI or with any text editor.

Note

Generating Queue files with the GUI.

Queue files may be automatically created by the GUI for every Analyses Sets included in your DSK model file. To this purpose, right-click on the Analyses Set from the Model Browser and selects the item labelled Generate Queue file. A Queue file will be automatically created which will include all batch jobs instructions to run the analyses (LOG files) and perform batch post-processing of Predefined Results (DSS files). The names of the Queue files generated with the GUI default to the name of the Analyses Set with the DBQ file extension. These text files may then be modified using any text file editor or Excel.

Note

Queue file format (*.DBQ files)

Queue files are text files containing 3 columns and as many rows as there are batch jobs included in the Queue. Each row in the file correspond to a single batch job. Rows may also include *break instructions which may be useful with multi-threaded processing of batch jobs. Columns must be separated with tabulations.

The columns must be as follow :

  • First column : Complete path and name of the file
  • Second column : Job type
  • Third column : Process priority

Queue file example :

C:\PRINCIPIA\DeepLines\Analysis01.log   Run Analysis   Normal
C:\PRINCIPIA\DeepLines\Analysis02.log   Run Analysis   Normal
C:\PRINCIPIA\DeepLines\Analysis03.log   Run Analysis   Normal
*break
C:\PRINCIPIA\DeepLines\Analysis01.dss   Post-process   Normal
C:\PRINCIPIA\DeepLines\Analysis02.dss   Post-process   Normal
C:\PRINCIPIA\DeepLines\Analysis03.dss   Post-process   Normal
*break
C:\PRINCIPIA\DeepLines\Analysis01.dss   Export to Excel   Normal
C:\PRINCIPIA\DeepLines\Analysis02.dss   Export to Excel   Normal
C:\PRINCIPIA\DeepLines\Analysis03.dss   Export to Excel   Normal

Save Queue

Saves the current list of batch jobs into a Queue file (.DBQ). Queue files contain a list of predefined batch jobs that may be reloaded with the Load Queue* button. Queue files are text files which can be modified at will with any text editor.

Run

Starts processing of batch jobs included in the list of batch jobs. The number of threads used to run the batch jobs may be defined within the optional settings available from the Options button. The Run button automatically switches to a Pause button when pressed.

Pause

Pauses processing of batch jobs. Paused batch jobs will stop only upon completion. A warning message displays in the bottom of the Batch Processing form stating that running jobs are being paused. The Pause button automatically switches back to a Run button when running batch jobs are actually stopped.

Abort

Aborts running batch jobs. The status of running batch jobs will be automatically switched to the Aborted status.

Reset Status

Sets the status of all batch jobs to Pending. Running batch jobs must be completed or aborted before their status can be set back to Pending.

Move up

Moves selected batch jobs one row up in the list. Selected batch jobs may also be moved up by right-clicking onto the list of batch jobs and selecting the Move up item from the pop-up menu.

Move down

Moves selected batch jobs one row down in the list. Selected batch jobs may also be moved down by right-clicking onto the list of batch jobs and selecting the Move down item from the pop-up menu.

Export to Cmd

Create a cmd file from the selected job types and files. This cmd file can be run outside DeeplinesGUI from a window explorer by double clicking on it. On clicking on the Export to Cmd button, a dialog box will open and invite you to choose a recording folder and name for the cmd file.

Options

Displays optional settings applicable to the Batch Processing form. Optional settings in particular include the number of threads to be used to process the list of batch jobs, in case multi-threading is activated.

Path to FE engine executable

The paths and names of the FE engine executable files are reported in the header of the form for information and selection.

  • Since V5R5, the list of executables is composed of all executables defined in the settings of all DSK files already opened.

  • Before V5R5, only the executable defined as "default" in the DSK settings was available.

    Note

    It shall be noted that the Batch mode keeps track of the selected executable at the moment when the command line is created. That means that a Batch job may be composed of command lines associated with different executables. To be modified the command line must be deleted and created again once the correct executable is selected..

Status bar

The status bar is located at the bottom of the Batch Processing form. The content of the status bar is refreshed automatically as the batch processing progresses. This status bar reports information on the status of your batch jobs, as follows:

  • Progress %: The overall progress of your batch jobs. This is based on the number of batch jobs that have been gone through compared to the total number of batch jobs included in the List of Batch Jobs table.

  • Total: The total number of batch jobs included in the List of Batch Jobs table.

  • Completed: The number of batch jobs included in the List of Batch Jobs table that are successfully completed.

  • Running: The number of batch jobs included in the List of Batch Jobs table that are currently running.

  • Pending: The number of batch jobs included in the List of Batch Jobs table that are currently pending.

  • Failed: The number of batch jobs included in the List of Batch Jobs table that are currently failed.

  • Aborted: The number of batch jobs included in the List of Batch Jobs table that are currently aborted.

  • File not found: The number of batch jobs included in the List of Batch Jobs table for which the input file was not found (i.e. missing input files).