Introduction
The introduction of consistent file naming conventions in a project is one of the most important foundations for an efficient and organised way of working. Particularly in large projects where many different team members and departments collaborate, well-structured file naming enables quick identification, easy retrieval, and efficient management of documents.
In this article, we explain in detail how to create, customise, and manage file naming conventions in your project to ensure a smooth workflow. We also cover best practices that should be considered when creating your conventions.
What Are File Naming Conventions?
File naming conventions are rules that define how files should be named within a project. These conventions help to identify documents clearly and consistently, preventing confusion and ensuring that everyone involved always knows what each file represents. A well-defined file naming convention helps ensure that documents and information are stored in a structured manner and can be retrieved at any time.
An example of a file naming convention could be:
- ProjectName_YYYYMMDD_Type_Revision
Example: ConstructionProject_20260312_ArchitecturalDrawing_Rev1.pdf
In this case, the file names contain the following information:
- Project Name: The name of the project or an abbreviation
- YYYYMMDD: The date on which the document was created or edited
- Type: The type of document (e.g. architectural drawing, calculation report)
- Revision: A version number used to distinguish between different revisions of the document
How to Create File Naming Conventions
Creating file naming conventions is a crucial step in project configuration. This process ensures that all team members use the same standard when saving documents and files. Here is how to create new conventions:
1. Navigate to Project Configuration
To create a file naming convention, you need to go to the Project Configuration section of your project. In most systems, this can be accessed via the project dashboard.
2. Go to Settings
In the Project Configuration section, you will find the File Naming Conventions section. This is where you can create and manage all file naming rules relevant to the project.
3. Create a New Convention
To create a new convention, select the "Create New Convention" option. A form will generally open in which you can define various parameters for your new convention. You should consider the following:
- Name Structure: How should the file name be structured? Define the order of the various parameters, such as project name, date, document type, and version.
- Placeholders and Variables: Many systems allow placeholders (e.g.
%ProjectName%,%Date%,%Version%) to be used to automatically insert specific information into file names. - Automation: Define whether and how the file naming convention should be automatically applied to newly uploaded files.
4. Save and Apply
Once you have configured all the desired settings, save the convention. The convention will then be available in your project and can be used by all team members when adding new files.
After Creating the File Naming Convention
After creating a file naming convention, you can create any number of blocks or entries that define the specific requirements for the file name. These blocks define how the file should be named by specifying the various parameters that make up the file name.
The following options are available:
① Dropdown
A dropdown menu allows you to define a predefined list of options from which the user can choose when naming a file. This is particularly useful when certain parts of the file name always have the same set of possible values. Example: A block for the document type could contain a dropdown list with options such as "Report", "Drawing", and "Presentation".
② Text
A text block allows you to define custom text that is inserted directly into the file name. Here you can specify which words or abbreviations should be used to identify particular document types or categories. Example: If all reports should begin with the prefix "Report_", this can be entered as a text block.
Separator
Separators are used to distinguish different segments of the file name from one another, keeping the structure clear and readable. Here you can specify a separator such as an underscore ("_") or a hyphen ("-"). Example: Between the project name and document type, the file name could look like this: ProjectName_DocumentType_FileName.
Regex (Regular Expression)
Regular expressions (Regex) can be used to define complex patterns for the file name structure. Regex makes it possible to establish highly precise rules, for example to ensure that the date always follows the YYYYMMDD format or that a specific version number is used correctly. Example: A Regex block could be used to enforce the correct format for the date or version.
Fixed Text
Fixed text can be used to insert fixed terms or abbreviations into file names. This is useful when you want certain standard words or identifiers to always be included in every file name. Example: A fixed text block could contain "_Project", so that every document automatically includes the suffix "_Project".
File Extension
Specifying a file extension ensures that the file name ends with a specific extension required for the file type. This ensures that every file has the correct extension (e.g. .pdf, .docx, .xlsx). Example: If the file extension block is set to ".pdf", the system automatically ensures that the file name ends with this extension.
How to Manage Existing File Naming Conventions
After creating file naming conventions in your project, they must be continuously monitored and adjusted where necessary. Here are the steps you should follow to manage the conventions:
1. Adjusting File Naming Conventions
Over time, the requirements for file naming conventions may change. For example, if new document types are added or the structure of a project changes, the conventions may need to be adjusted.
- Adjusting the structure: You can adjust the structure of an existing file naming convention by adding new parameters or removing existing ones.
- Changing the rules: If you find that certain rules are not efficient or lead to misunderstandings, you can modify them.
2. Applying Conventions to Existing Files
You may introduce a new file naming convention and want to apply it to files that already exist. Many systems provide the option to perform a batch process in which the file names of all relevant files are renamed according to the new convention.
3. Automating File Naming Conventions
Many tools offer the option to apply file naming conventions automatically. When you upload a file, the system automatically checks whether the file naming convention has been followed. If not, the system can issue a warning or automatically correct the file name.
To enable automation, you must activate the relevant option in the system settings and select the file naming convention to be used.
4. Deactivating or Deleting a Convention
If a file naming convention is no longer required, you can deactivate or delete it. Make sure that all affected files are renamed before deactivating or deleting the convention to avoid inconsistencies.
Best Practices for Creating File Naming Conventions
A well-designed file naming convention should have clear, consistent, and easy-to-understand rules. Here are some best practices to help you create and manage file naming conventions:
- Use clear and understandable parameters
The parameters used should be easy for all team members to understand. For example, if you include the date in the file name, make sure everyone understands that the YYYYMMDD format is being used. - Avoid special characters and spaces
Avoid using special characters such as "/", "", ":", "?" or spaces. These characters can cause problems, particularly when files are used across different operating systems. - Include version numbers
In many projects, documents are updated regularly. Include a version number in the convention to distinguish between different revisions. For example: "_V1", "_V2", "_RevA", etc. - Keep it short and concise
The file name should be as short as possible while still containing all important information. Long and complex names can be difficult to manage. - Use consistent abbreviations
If you use abbreviations, make sure they are understandable to everyone involved. Consistent abbreviations help prevent misunderstandings. - Regularly review and adjust the conventions
Regularly check whether the file naming convention is still up to date or whether adjustments are required. Particular attention should be paid to changes that occur during the course of the project.
Conclusion
Introducing file naming conventions is an important step towards organising your project files and making them accessible to everyone involved. With the right structure, you can ensure that your files can be found quickly and identified unambiguously.
If you need support with creating or managing these conventions, please feel free to contact our Support team at any time.
Contact:
support@build-big.ch