SOLIDQ
Task based queuing for
SOLIDWORKS
Special Variables
Special variables allow for dynamic information to be specified for evaluation during task execution. A typical use case for special variables is to define a file name when exporting a file.
| Special Variable | Evaluates | Example |
|---|---|---|
| File Directory | The folder that the SOLIDWORKS document resides in | C:\SOLIDWORKSData |
| File Name | The file name of the SOLIDWORKS document | MyPart |
| File Extension | The file extension of the SOLIDWORKS document | .sldprt |
| Active Configuration Name | The name of the active configuration in the SOLIDWORKS document (note that Drawings do not have configurations) | Default |
| BOM Part Number | The BOM part number for the active configuration. Will respect the selection Document Name, Configuration Name, User Specified Name or Link To Parent Configuration* (*derived configurations only) as set in configuration properties - bill of materials options |
MyPart, Default, UserName, ParentConfig |
| Custom Property | Evaluates a specified custom property in the SOLIDWORKS document | - |
| Date / Time | Evaluates the date and time at which the task is run, the user can specify the format, see MSDN | 2020-02-20 15-23 |
| Unique Number | Evaluates to a unique number based on conditions. For example when defining a directory to export to the number will be incremented until the path is unique, i.e. if the path evaluated to the existing directory C:\Folder but the Unique Number special variable was appended, then the path would evaluate to C:\Folder1, C:\Folder2 etc until a directory that does not exist is identified |
- |
Custom Property
It is possible to use special variables to link to a custom property, there are a number of options when doing this as described below.
| Parameter | Description |
|---|---|
| Property Name | The name of the custom property for which to retrieve the value |
| Configuration Specific | If checked then the configuration specific custom properties will be searched for the property name |
| Use Active Configuration | If checked then the active configuration will be used |
| Configuration Name | The name of the configuration from which to retrieve the custom property |
| Use non-configuration specific property if not found | If the configuration specific property does not exist, or the value is blank then the non-configuration specific property shall be used instead |
Preview
It is possible to preview some special variables using the preview button. If there are no files in the queue then dummy data is used for document related special variables. If files exist in the queue then the first file in the queue is used to show document related special variables, such as File Directory, Name and Extension. The Active Configuration Name and Custom Property special variables will only be evaluated at run time and as such dummy information is used in the preview.
An example of preview evaluation is provided below
Evaluated with not files in the queue (dummy data):
Evaluated with a file in the queue:
