Naming Convention
The Trimble Connect extension Naming Convention validates file names against predefined rules to ensure consistency across the project.
This help refers to version 1 of the extension. See tab page "About".
Back to topCS TC Extension package
Naming Convention belongs to the Construsoft Trimble Connect Extension package.
Back to topUse for
Validate file names against predefined naming rules and ensure consistency across the project. File names that do not follow the rules are marked, and can then be fixed directly.
Back to topBefore you start
1. Add the extension to the project.
2. Create Components and Rules (see the "Editor tab").
3. Apply the rules to the project folders.
Back to topHelp overview
Naming Convention tab
- Checked files
- File validation status
- Search, filter and column settings
- File name editing
Rules tab
- Assign rules to folders
- Viewing and managing applied rules
- Searching and filtering
Editor tab
- Components
- Rules
Settings tab
- Separator
- Forbidden characters
- File extensions
About tab
- Version
- Documentation
- License Manager
- Store
Naming Convention tab
On the "Naming Convention" tab, the checked files are displayed in a table with details such as file name, path, status, creation and modification dates, and the assigned naming rule. The table provides options to search, filter, and customize the displayed columns.
Use the refresh icon next to "Checked files" to check the files again. The date and time of the last check and the user who performed it are displayed below the table.
| Option | Description | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Search files. | |||||||||||||||||||||||||
| 2 | Use "Filter" to show only content according to specific parameters. The "Advanced filters" dialog window opens. Image
| |||||||||||||||||||||||||
| 3 | Use "Columns" to show only data of your interest.
| |||||||||||||||||||||||||
| 4 |
Use the "Edit" button to modify the file names. Select the corresponding file using the checkbox on the left and click "Edit" in the top-right corner. Select more files to rename multiple at once. Image
In the "File name editor" dialog window, fill in the value of each component of the rule. The separator is inserted automatically and the file names are displayed below the fields. Use "Save" to rename the files.
Alternatively, hover over the file name and click the edit icon that appears next to it to rename the file. Click the link icon to open the file in a new tab. Image
Update the name to match the specified rules. Once the file name matches the defined rules, its status changes from Invalid to Valid.
The file cannot be renamed if a file with the same name already exists in the folder, or if the new name has an invalid extension. | |||||||||||||||||||||||||
| 5 | Status icon |
Image
| ||||||||||||||||||||||||
|
Image
| ||||||||||||||||||||||||||
Rules tab
On the "Rules" tab, applied rules can be viewed and managed, folders can be searched and filtered, columns can be customized, and new rules can be added. Each folder displays its assigned naming rules and formats.
| Option | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Selecting Add rule opens a dialog window.
Image
| |||||||||||||||
| 2 | Table with all applied rules. | |||||||||||||||
| 3 |
Image
| Search project folders and check for applied rules. | ||||||||||||||
|
Image
| Use filter button to show only content according to specific parameters. These parameters can be set in the advanced filters dialog window. Image
| |||||||||||||||
|
Image
| Manage which columns should be visible.
| |||||||||||||||
|
Image
| Remove selected rules. | |||||||||||||||
| 4 | Pagination. | |||||||||||||||
Editor tab
On the "Editor" tab the components and rules can be defined and configured.
Components
| Option | Description | |
|---|---|---|
| 1 | Create new component. | |
| 2 | Enter a component name. | |
| 3 | Select a component type.
Image
| |
| 4 | Enter the component’s value according to the selected type. | |
| 5 | Enter an optional description. | |
| 6 | An example is created automatically based on the selected component type and entered value. | |
| 7 | Select an existing component. | |
| 8 |
Image
| Duplicate component. |
|
Image
| Delete component. | |
| 9 |
Image
| Cancel component creation. |
|
Image
| Save component. | |
Rules
| Option | Description | |
|---|---|---|
| 1 | Create new rule. | |
| 2 | Enter a rule name. | |
| 3 |
Image
Choose from existing components to create a rule. | |
| 4 |
Image
Select the file extensions this rule applies to, as defined on the settings tab. | |
| 5 | An example is created automatically based on the selected component type and entered value. | |
| 6 | Enter an optional description. | |
| 7 | Select an existing rule. | |
| 8 |
Image
| Duplicate rule. |
|
Image
| Delete rule. | |
| 9 |
Image
| Cancel rule creation. |
|
Image
| Save rule. | |
Settings tab
On the "Settings" tab, the separator, forbidden characters, and available file extensions can be configured. These settings define the general rules applied to file naming validation.
General
| Option | Description |
|---|---|
| Separator | Choose a character to use as a separator between the components. The separator will be used when renaming files according to the rules on the Naming Convention tab. Image
|
| Forbidden characters | Enter the characters that should not be allowed in component values (except Regex), then click the plus icon to add them to the list below. To remove a character, click the red cross button next to it. The list contains a default set of forbidden characters. Separator is automatically added to the Forbidden characters. |
| File extensions | Define the file extensions allowed for rules. Enter a file extension and click the plus icon to add it to the list. To remove an extension, click the cross icon next to it. |
|
Image
| Use save button to save the settings. |
About tab
On the "About" tab general information about the extension and the developer can be found.
Version - check the version of the extension.
Documentation - find the instructions about the functionality on the TUA help page.
License Manager - manage your licenses in the License Manager.
Store - get the license for the extension and other tools in the Construsoft eshop!