Skip to main content
Naming conventions page
Sjaak Velthoven avatar
Written by Sjaak Velthoven
Updated over 2 months ago

Administrators will be able to find the Naming conventions page as a sub page to project settings.

The following topics will be described in this article:

Local file naming

With naming conventions you can limit what files are uploaded to a folder depending on the name of the original file. This is very useful if you already have a set of rules for the naming of your local files. You should not need to rename your files so you can upload them to Catenda Hub. If you do not have rules for the naming of your local files the Naming convention is not recommended.

Documents, revisions and original files

Before you get started with this it is important to understand the difference between a Catenda Hub document and a file. You can think of a document (and document revisions) in Catenda Hub as a containers for files. You can upload a file to this container and if you are an administrator change its name.
Filenames are often very different from each other even though they are the same version of the drawing or sheet you want to upload. The naming convention lets you upload similar files to the same document based on a set of rules in the name of the file.

New naming convention

On the top right of the page you will see the New naming convention button.

This is what a new naming convention looks like.

Convention information

Name: The convention name as it will appear when you apply in document settings

Description: The description of the convention as it will appear in document settings

Separator: The character separating every block except the file extension block.

Previews

Previews show the pattern of that the conventions follow on both in your local file system and in the Catenda Hub document structure. These can be different and one can be mapped to the other as you will see


Document name: The way the document in Catenda Hub will look when the file is uploaded

Expected file name: The way files that are allowed to be uploaded are supposed to look

Preview types:

When you hover over the different preview types you will see a detailed explanation of what each preview means.

Text - Variable length: {X}

Text - Fixed length: XXXX

Custom field: {Custom field name}

Separator: When you have three or more blocks you will see the separator you have set

Blocks

The naming convention exists of a series of blocks.

Each blocks represents a part of the name of the file/document.

A convention always has at least two blocks:
1. The name of the file/document.

2. The name of the file/document extension.

Name: The name of the block in the naming convention setup so you can tell them apart

Description: Here you can type in a description of what you expect this block to do

Document identifier:

If you expect a part of the file name that you do not want to see in Catenda Hub you can turn off the document identifier. This part of the file name will still be used for accepting files but will not be visible in the resulting Catenda Hub Document.

On

When the document identifier is toggled on this block identifies the name of the document

Off

When the document identifier is toggled off this block identifies the name of the local file.

Disabled

The document identifier of the extension block is always off as every file has an extension.

Source: What will qualify the identification of the name of the file/document?

Default: Text - This block can contain any character

Custom field: - Limit the types of characters that your block accepts with custom fields

Length: How many characters there can be in this block.

If this field is left blank the block will have a variable length.


Submitting a convention

After submitting a naming convention it can be enabled per folder in document settings.

Did this answer your question?