Passar para o conteúdo principal

Naming Convention

Trimble Connect Web
Web
Trimble Connect
Environment
Not environment-specific

Image
Naming Convention icon

 

The Trimble Connect extension Naming Convention validates file names against predefined rules to ensure consistency across the project.

 

Image
Naming Convention tool

 

This help refers to version 1 of the extension. See tab page "About". 

Back to top

CS TC Extension package

Naming Convention belongs to the Construsoft Trimble Connect Extension package.

CS TC Extensions

Back to top

Use 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 top

Before 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 top

Help 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.

Image
Naming tab

 

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.

OptionDescription
1Search files.
2

Use "Filter" to show only content according to specific parameters. The "Advanced filters" dialog window opens.

Image
Advanced filters dialog

 

OptionDescription
1Each condition consists of a column, an operator and a value. Select the column first, then the operator, and enter the value. Use the drag and drop icon on the left to change position of the condition.
2AND / ORThe logical operator between two conditions. Click on the operator to change it.
3
Image
Remove condition
Remove the condition.
4PreviewShows the filter that will be used before it is applied.
5
Image
Add condition
Add another condition.
6
Image
Save preset
Save the current conditions as a preset. Enter the name of the preset and click "Save". A preset with the same name is overwritten.
7Action buttons.

 

3

Use "Columns" to show only data of your interest. 
Options:

  • ID
  • Type
  • Name - this column can't be disabled.
  • Path
  • Status - if a file name does not match the applied rules, its status is marked as Invalid. 
  • Created by
  • Created on
  • Modified on
  • Rule name
  • Rule format
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
File name editor

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
Edit naming convention

 

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.

5Status icon
Image
Valid icon
Image
Invalid status

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.

Image
Rules tab

 

OptionDescription
1

Selecting Add rule opens a dialog window.

 

Image
Add rule

 

OptionDescription
1Select folder(s) to apply rule(s).
2

Select rule(s) to apply to the selected folder(s).
 

Image
Select rules
3
Image
Cancel button
Cancel button.
Image
confirm
Confirm button.

Rules that are in collision with new or already applied rules cannot be applied. Resolve the conflicts before applying the rules.

 

2Table with all applied rules.
3
Image
search folders
Search project folders and check for applied rules.
Image
Filter rules

Use filter button to show only content according to specific parameters. These parameters can be set in the advanced filters dialog window.
 

Image
Advanced filters

 

Image
Columns

Manage which columns should be visible.
Options:

  • ID
  • Folder name - this column can’t be disabled
  • Path
  • Rule name
  • Rule format
  • Example
  • Rule description
  • Description
Image
Remove selected rules
Remove selected rules.
4Pagination.

Editor tab

On the "Editor" tab the components and rules can be defined and configured.

Image
Editor tab

Components

Image
Components

 

OptionDescription
1Create new component.
2Enter a component name.
3

Select a component type.

Choose from:

  • Fixed text 
  • Predefined list
    • Click Add value to add another item to the list. Names must be unique.
Image
predefined list naming convention
  • Date
    • Enter date format - use YYYY, YY, MM, DD, HH, mm, ss.
  • Number
    • Enter a fixed number or a range.
  • Regex
    • Enter a valid regular expression (regex). For example enter [A-Z]{2} for exactly two uppercase letters.
4Enter the component’s value according to the selected type.
5Enter an optional description.
6An example is created automatically based on the selected component type and entered value.
7Select an existing component.
8
Image
Copy button
Duplicate component.
Image
delete rule
Delete component.
9
Image
Cancel button
Cancel component creation.
Image
Save button
Save component.

Rules

Image
rules naming convention

 

OptionDescription
1Create new rule.
2Enter a rule name.
3
Image
Add components

Choose from existing components to create a rule.

4
Image
Extensions

Select the file extensions this rule applies to, as defined on the settings tab.

5An example is created automatically based on the selected component type and entered value.
6Enter an optional description.
7Select an existing rule.
8
Image
Copy button
Duplicate rule.
Image
delete rule
Delete rule.
9
Image
Cancel button
Cancel rule creation.
Image
Save button
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.

Image
Settings tab

General

OptionDescription
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
Separator
Forbidden charactersEnter 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 extensionsDefine 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
Save button
Use save button to save the settings.

About tab

On the "About" tab general information about the extension and the developer can be found. 

Image
About tab naming convention

 

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!

Back to top
Enviar