Choosing a System Name in the CMS
Learn how to properly assign a system name to your page.
System name for a page is called 'page name' in the CMS
When the CMS asks for a page name, it refers to the system name. System name refers to the page, folder, file, or module name that the system uses to identify it. This is distinct from a page title or display name. Similarly, the system name for folders is called 'folder name.'
All components in the CMS must have a system name. The system name is the filename that shows in the left-hand sidebar of the CMS. It also becomes part of the page URL (web address) when combined with the folders it is in. System names must:
- Be all lowercase
- Use dashes between words instead of blank spaces, underscores or any other special characters
- Be as short as possible
- Single words are best. If you must use multiple words, omit conjunctions like 'and' as well as symbols like '&'
- Do not duplicate words in the folder name. Avoid repetitive paths like: /department/department-contacts
Note: If you use a system name that contains spaces or capitals, the CMS will suggest a compliant system name:
Within a given folder, each component must have a unique system name. You can (and will) have duplicate system names in different folders.
Each folder must have a page named index - this is the default page that will show up when a user navigates to that folder.
Examples:
Acceptable system names | Unacceptable system names |
---|---|
contact | phone-email (unnecessarily long) |
add | add-new-component (unnecessarily long) |
jane-smith | Jane Smith (capitalization, space) |
joe-deli | Joe's_Delicatessen (capitalization, special character, underscore) |
california | california.state.documents (unnecessarily long, special characters) |
When you create a new page or folder, enter the system name in the first field ("Page Name" or "Folder Name"). It will default to the name of the template. Override this with the name of the page. If it's the primary page in a folder, use "index" for the name. If it is any other page or folder, name it something meaningful and short.
Files and images
Files and images you upload to the CMS should also follow the same rules for system names. The system names for files must include an extension (e.g., .pdf, .jpg).
Changing a system name
Changing a system name will change the URL (web address) of a page. This will break links to the page (including bookmarks). Do not change a system name without discussing it with the site manager first.
- Navigate to the page you want to change
- Select the More button
- Choose Rename tab
- Under New Page Name, type in a new system name
- Click Rename
- The file will now be renamed in the CMS. The page will be unpublished from the live site. To have the newly remained content appear on the live site, you mush publish it.