Batch+ stand-alone application for running SOLIDWORKS macros in the batch mode

User Interface provides a visual way to configure the batch process.

Batch document (*.bpj) can be saved and loaded from the external files.

A Batch+ document behaves similarly to other file-based applications (e.g. Office, SOLIDWORKS). If it has unsaved changes, it is marked with a * symbol. Additionally, Batch+ has a quick access menu in the document title header.

Once the batch process is run, it creates a job. Multiple jobs can be run in parallel in a single session.

1. Document title with unsaved mark
2. Save document quick access command
3. Run job quick access command

Welcome Screen

The welcome screen is displayed when the application starts or when there are no open documents.

1. New files creation area
2. Open files
3. Recent files list. If a file cannot be opened (e.g. it is corrupted or does not exist), it is automatically removed from the recent files list. The list is limited to 5 files.

Backstage

Backstage panel is available when File command is clicked in the ribbon toolbar.

1. Return to main screen
2. Create new document.
3. Open existing document
4. Save current document
5. Save current document as new file
6. Close active document
7. Manage licenses window
8. Register the software copy or buy license
9. Check for updates or manage auto-check for updates
10. Navigate to help web page
11. Open About dialog

When creating a new document or opening an existing one while there is an active document, the command opens a new window.

Ribbon

Batch document can be configured by accessing the options in the ribbon

Input

User can set the processing scope (files, folders, macros and filters) in this group. Alternatively, files, folders and macros can be added to the scope by dragging and dropping them directly onto the corresponding panels.

1. Add files to existing scope. Multiple files can be selected. This button will open the file browse dialog
2. Add folders to existing scope. Multiple folders can be selected. This button will open the folder browse dialog
3. Add From File. Allows loading list of files and folders from text file. Each line of the file represents the file or folder path
4. Remove files and folders. Removes the selected files or folders from the scope
5. Folder filters. List of filters to use for selecting files from the folder items selected into the scope. You can use a * wildcard, e.g. *.sld* will filter all SOLIDWORKS files (.sldprt, .slddrw and .sldasm) and exclude all other files types. Multiple filters are supported. Click to add new filter. Select and hit Del button to remove filter from the list.
6. Process only top level files or load files from sub-folders
7. Activate and run macros for each configuration or sheet in multi-configuration files or multi-sheet drawings
8. Add macros. Adds macros to the current macro scope
9. Remove macros. Removes selected macros from the current macro scope.
10. The Extract References option additionally includes all referenced documents of the input file. Refer to the Extract References article for more information
11. The Order by Dependencies option orders the input references based on their dependency (from children to parents or vice versa). Refer to the Order By Dependencies article for more information.

Settings

Document settings can be controlled in the settings group.

1. Version of SOLIDWORKS to launch for opening files and running macros
2. Safe startup option - runs SOLIDWORKS in safe mode, bypassing startup options. If this option is selected, no add-ins are loaded into the SOLIDWORKS session
3. Background startup - runs SOLIDWORKS in the background. This option is only available for SOLIDWORKS Professional or higher
4. Silent startup option - runs SOLIDWORKS with popup messages and the splash screen disabled. Suppresses all popup dialogs, such as missing references when opening a file
5. Hidden startup option - hides the SOLIDWORKS window. This can improve performance; however, some of the API might not work properly in this mode
6. Rapid file open option - open files in a rapid mode:
   • For drawings - opens in detailing mode. Some of the APIs might not be available in this mode
   • For assemblies - components are loaded lightweight
   • For parts - currently not supported and will be ignored
7. Invisible mode. Opens all files invisibly. This significantly improves performance; however, some of the API might not be accessible. The macro needs to use its arguments to connect to the target document, as the active model will not be available because the file was opened in invisible mode. Read Model pointer in invisible mode for more information
8. Read Only file open option - open files in read-only mode ensuring it cannot be overwritten
9. Forbid Files Upgrade - prevents upgrading a file that is of an earlier version than SOLIDWORKS. SOLIDWORKS is backward compatible but not forward compatible, which means that files cannot be opened in an older version of SOLIDWORKS. This option checks whether the current session of SOLIDWORKS is newer than the file and rejects the save operation if this is the case. It is recommended to keep this option selected unless upgrading files is explicitly required.
10. Automatically Save Documents - this option will perform the save of the document after each macro run
11. Timeout in seconds for processing a single file
12. Allows the batch process to continue if any of the files fail to process (for example, a file cannot be opened). If this option is not checked, the batch process is terminated once an error appears.
13. Batch size - maximum number of files allowed to be processed within a single session of SOLIDWORKS. Once this maximum is reached, Batch+ automatically restarts SOLIDWORKS and continues processing files. This helps release resources and improve the performance of batch operations.

Job

Jobs can be controlled in the Job group

1. Run new job. Multiple jobs can be run per document
2. Cancel selected job
3. Expand all report items (only applicable if Process Sheets/Configurations option selected)
4. Collapse all report items (only applicable if Process Sheets/Configurations option selected)
5. Export the Report Tab results into the Excel File
6. Export Log Tab results into the Text file

Files And Folders

This panel defines list of files and folders to process. Drag-n-drop files and folders directly to the panel or use input group in ribbon to add items with browse dialogs.

Select items and hit Del button to remove them from the scope.

Use the Open In File Explorer command from the context menu to navigate to the file or folder in Windows File Explorer

Macros

1. Option to enable/disable macro from the current job
2. Path to the macro
3. Optional macro arguments

This panel defines list of macros to run on each file. Drag-n-drop macros directly to the panel or use input group in ribbon to add macros with browse dialogs.

Select items and hit Del button to remove macros from the scope.

Specify the arguments in command line format if the macro supports them. See the Macro+ article for instructions on how to use macro arguments.

Use the Open In File Explorer command from the context menu to navigate to the macro file in Windows File Explorer

Use the Rename command from the context menu to assign a custom name to the macro

Jobs

This list contains all jobs which were run or currently running in the active session. Active jobs can be cancelled by pressing the Cancel button.

1. Job status (active, completed, failed, cancelled, completed with warnings) is displayed as an icon.
2. Progress value
3. Cancel active job

Select job to get more information in the panel below.

Job Information

Job information displays additional information about job once selected in the jobs panel

Summary

1. Job start time in the local time zone
2. Duration of the current job in the format hh:mm:ss
3. Total number of files of the job (if folders are selected - number of files in the folders as per the filter)
4. Number of successfully processed files
5. Number of files which were processed with warning
6. Number of files which failed to be processed
7. Job-level issues. For issues with individual files, refer to the Report tab
8. Status of this job

Displays overview information about a job, such as start time, duration, total number of files, failed and successfully processed files. For the running job this information is dynamically updated.

Report

Contains detailed breakdown for each file and macro. Icon corresponds to the status of the particular item: successfully processed, failed, processed with warnings, or queued to process.

Files or macros that failed to process will have a corresponding icon and a clickable ? link. Click this link to get more information about the error.

Each column of the grid can be sorted to quickly identify failed items if needed.

Log

Journal contains detailed log messages about the progress. Use this log to troubleshoot errors.