Utilities:Batch Creator

From OptiTexHelpEn

Contents 1 Batch Mode 1.1 User interface overview 1.1.1 Batch command list 1.1.2 Parameters List 1.1.3 Menus 1.2 Create a Batch File 1.3 Edit/Load a Batch File 1.4 Multiple File Option 1.4.1 Create a Multiple/Repeat section 1.5 Create a Template File 1.5.1 Create a Template Variable 1.5.2 Edit/View Template Variable Name 2 Templates Mode 2.1 User Interface Overview 2.1.1 Main 2.1.2 Menus 2.2 Generate Batch Files From Templates 3 Setting in Registry 4 Using The Batch Creator On Multiple Marker File 5 Related Subjects

[edit] Batch Mode

• The Batch Mode is the standard mode to create/edit batch files.

[edit] User interface overview

[edit] Batch command list

1. Menu
2. Batch command list (to generate in BTF file)
3. Drop down list with all Batch command available for current application (Marker or PDS)
4. Current application

[edit] Parameters List

1. Selected Batch
2. Selected Parameter
3. When checked, the parameter will be part of batch file, otherwise the parameter will not be added to the command.
4. Batch command description

[edit] Menus

• File
  • 'New' - Clear the batch list
  • 'Open' - Open a saved batch file
  • 'Save' - Save the current batch file
  • 'Save as' - Save as a new file name
  • 'Exit' - Exit batch creator
• Edit
  • 'Copy Command' - Copy Selected batch Command from list to clipboard
  • 'paste Command' - Paste batch command from clipboard to selected cell in batch list
  • 'Cut Command' - Copy Selected batch Command from list to clipboard and delete for current cell.
  • 'Insert Command' - Insert a blank cell above the current selected cell
  • 'Delete Command' - Delete current cell
  • 'Set/Unset To template Variable' - Set current selected parameter to a template variable
  • 'Edit template Variable Name' - Edit selected template variable name
• Option
  • 'PDS Command' - Switch to PDS commands
  • 'Marker Command' - Switch to Maker commands
  • 'Switch to templates' - Switch to template mode
• Help
  • 'About' - Display about box

[edit] Create a Batch File

• To create a batch file, select the batch commands to add in the list.
• For each command added to the list, a list of parameter relevant to this command will appear on the parameter panel.
• There are two type of parameter :

1. Mandatory parameter :those parameter must be set to the value needed.
   

   

   Mandatory Parameter
2. Optional parameter : Optional parameter are displayed next to a check box, to activate and generate the optional parameter, check it.
   

   

   Active optional Parameter
   

   

   Non active optional Parameter

[edit] Edit/Load a Batch File

• You can load any batch file created ether manually or using the batch creator using the Open command under File menu item.

[edit] Multiple File Option

• Multiple file option, is a "hidden feature" to allow multiple handling of file that need to be processed with the same batch routine.
• This feature works only with @OPEN marker file command, in the future it will be extended to other commands.

[edit] Create a Multiple/Repeat section

• Choose open marker command, click on the browse button and select multiple files using CTRL or SHIFT hot-key(you must have all files in the same directory)

• Select the routine batch command operation.

• Save Batch
• The file generated will include a repeat of the commands for each file opened, see example bellow:

@OPEN  /FILE=C:\Program Files\OptiTex 9\PDS and Mark Examples\Marker examples\2001.dsp
@REPORT  /FILE=C:\Program Files\OptiTex 9\PDS and Mark Examples\Marker examples\2001
@CLEAR 

@OPEN  /FILE=C:\Program Files\OptiTex 9\PDS and Mark Examples\Marker examples\Dress.dsp
@REPORT  /FILE=C:\Program Files\OptiTex 9\PDS and Mark Examples\Marker examples\Dress
@CLEAR 
	
@OPEN  /FILE=C:\Program Files\OptiTex 9\PDS and Mark Examples\Marker examples\Nest++Car Seat.dsp
@REPORT  /FILE=C:\Program Files\OptiTex 9\PDS and Mark Examples\Marker examples\Nest++Car Seat
@CLEAR
... 

Remarks

• each time the @OPEN, @EXIT or @EOF command are used, it reset the routine.
• File name used within the routine are always the same as the open file, for instance when using the excel report command, the report file name will be <DSP file name> , without extention .
• File name extension can be define by the user, by typing the extension in the filename textbox (without the dot), since it is obsolete when working on multiple file (max length is 3 letters). If the save filename field is not activated, the same filename as opened will be used .(with the exception of DSP file that will change to a xxx--<Number>.DSP format)

[edit] Create a Template File

• A template file is a batch file with some parameter defined as variable.
• Template batch are used when a user needs to have the same series of batch command with some parameter set to different values each time.
• When a batch list contain one template variable or more it will be saved with TMP extension

[edit] Create a Template Variable

• To set a template variable ,
  • Select a parameter
  • Click on "Set/unset as template variable" or Right click on it
  • Enter a name for the variable
  • Press enter key
  • the template name is then displayed in the menu bar

[edit] Edit/View Template Variable Name

• A parameter set as variable is displayed with Blue text when not selected.

• To edit a template name click on edit "template variable button"

[edit] Templates Mode

• Template mode is used to Create batch files from template files.

[edit] User Interface Overview

[edit] Main

1. List of template file loaded.
2. File name to save BTF file, this Batch file will be generated with the variable values inserted in the variable table.
3. Generate batch Button, Create the BTF file with all value inserted.
4. Variable Table, include all parameter set as variables in Template (TMP) file.
5. Template mode, can be PDS or Marker.

[edit] Menus

• File
  • 'New' - Clear the Template list
• Option
  • 'PDS Command' - Switch to PDS Template mode
  • 'Marker Command' - Switch to Maker Template mode
  • 'Switch to templates' - Switch to batch mode
• Help
  • 'About' - Display about box

[edit] Generate Batch Files From Templates

• Load template (in template mode).
• Select a TMP file in the template file column using the browse button.
• The variable list will be loaded in the variable table.
• Set variable value.
• Set a file name to save the batch to in "Save as" column.
• press Generate, this will create a batch file using var value from the bottom table.

[edit] Setting in Registry

• Settings are saved in the Registry under :

HKEY_CURRENT_USER\Software\OptiTex\Optibatch

[edit] Using The Batch Creator On Multiple Marker File

[edit] Related Subjects

• PDS:Batch Commands
• Marker:Batch Commands