Contact Us
Contact our corporate or local offices directly.
The Advanced and Basic versions of the Folder Structure settings dialog
The Folder Structure settings dialog provides controls to manage and configure the properties of the folder structure of generated files.
The Folder Structure settings dialog is accessed by right-clicking on a Folder Structure in the Output Containers region of an OutJob file then choosing Properties.
Use this region to setup the location for this output container. You can specify a base path, include a folder related to the container, and specify the container's file name.
Enable the following output types if you want to auto-load the related outputs into CAMtastic. The enabled output types will be auto-loaded into a new CAMtastic document whenever a batch generation is performed.
Click to toggle between the Advanced and Basic versions of the dialog.
Setting up the folder structure is the same in either the Folder Structure settings dialog or PDF settings dialog. In the dialog, click in the first region to open a drop-down. Select (Release Managed) or (Manually Managed). If (Manually Managed) is selected, you can either search for the desired folder or enter the desired name in the textbox.
Select the other folder names in the same way, clicking each region and using the drop-down to specify the folder name, etc.
Setting the Custom Folder Name to =OutputName.
The user-defined output name is built up by concatenating the required elements. The concatenation process obeys the following rules:
Element | Function | Example | Returns |
---|---|---|---|
= (equals) | Indicates that the following string is an expression that must be interpreted. | =ProjectName | DB31 for the example project named DB31.PrjPcb |
+ (plus) | Used to concatenate the elements required in the output name. | =ProjectName + '-' + ProjectRevision + '.PDF' | DB31-07.PDF for the example project named DB31.PrjPcb |
' ' (single quotes) | Used to include a fixed string anywhere within the output name. Illegal characters are listed below. | ='AcmeEngineering' +_+ ProjectName + '.PDF' | AcmeEngineering_DB31.PDF for the example project named DB31.PrjPcb |
The following characters are not permitted in user-defined output names:
< > : " \ | ? *
If there is a syntax error in an expression, for example, an unbalanced quote such as =ProjectName+.PDF'
instead of =ProjectName+'.PDF'
, this will give the result #NAME
. When you see this, look carefully for missing quotes or invalid or mistyped special strings.
User-defined Project-level parameters and variant parameters are supported. Project parameters are defined on the Parameters tab of the Project Options dialog (Project » Project Options). Variant parameters can be defined for each variant in the Variant Management dialog (Project » Variants).
Parameter names cannot include spaces. For example, the parameter PartNumber can be used, however, the parameter Part Number can not.
Special Strings is the term used in Altium Designer to define interpreted strings. Most of these strings can be interpreted on screen by placing a text string with a value of =SpecialStringName, for example =CurrentDate. They are always interpreted during output generation.
Currently supported Special Strings that can be used in Output filenames include:
Special String | Returns |
---|---|
CurrentDate | The current date, as retrieved from the Operating System, in the ISO 8601 format yyyy-mm-dd . Example: 2016-01-25 |
CurrentTime | The current time, as retrieved from the Operating System, in the format hh_mm . Example: 14_55 . |
DataSource | The Data Source used for this Output in the Output Job file. |
OutputName | The user-defined name of this Output in the Output Job file. Only functions when the Separate File for Each Output option is selected in the Output file naming settings. |
ProjectName | Displays the actual name of the project, excluding the extension. |
VariantName | The name of an assembly variant defined for this project in the Variant Management dialog. The value used depends on the Variant chosen in the Output Job for the Output whose filename is being defined. |
ProjectParameterName | The value of the Project Parameter named <ProjectParameterName>. |
VariantParameterName | The value of the Variant Parameter named <VariantParameterName>. |
For collated output files, only those special strings that are not restricted to a specific output can be used. For example, OutputName cannot be used for a collated output file as it applies to a specific output in the Output Job file. VariantName and DataSource also cannot be used. Use of one of these special strings in a collated output file will result in the actual string being used as the filename.
If the expression fails to be analyzed, save then close and reopen the Output Job file to refresh the expression analysis engine.
Contact our corporate or local offices directly.