What is umbracoUrlName?
The umbracoUrlName property is a reserved property alias in Umbraco CMS that enables you to set a custom URL name for a content node.
It helps improve URL structures and maintain consistency without altering the content node’s actual name in the Umbraco backoffice.
Key Features:
-
Allows for clean and readable URLs.
-
Useful for SEO optimization.
-
Fully integrated into the Umbraco routing pipeline.
-
Built-in feature that does not require additional plugins or custom code.
Example Use Cases:
-
Simplifying URLs for SEO purposes (e.g., changing "/shop-laptops-category" to "/laptops").
-
Defining alternative URL names for multilingual content.
-
Shortening long URLs while keeping meaningful node names in the backoffice.
Practical Example: Changing a URL for a Product Page
Imagine you have a content node named "DELL Alienware M18", which by default generates a URL like:
/store/dell-alienware-m18/
DELL Alienware M18 product page in Umbraco store
However, for SEO and marketing purposes, you prefer a more descriptive and SEO-friendly URL that better reflects the product, like:
/store/dell-alienware-m18-gaming-laptop/With umbracoUrlName, you can easily achieve this without changing the content node’s title.
New umbracoUrlName Textstring property in the product document type
Step 1: Add the umbracoUrlName Property to the Document Type
To use umbracoUrlName, add it as a property to your document type.
1. In the Umbraco Backoffice, navigate to the Settings section.
2. Locate the relevant Document Type (e.g., "Product Page").
3. Add a new property in the Document Type editor:
- Property Name: Custom URL Name (can be any name)
- Alias: umbracoUrlName
- Editor Type: Textstring
- Tooltip: Enter the full node name exactly as you want it to appear in the URL. Leave empty to use the default node name. Example: 'DELL Alienware M18 Gaming Laptop' instead of 'DELL Alienware M18' for a more descriptive, SEO-friendly URL.
4. Save and close the Document Type editor.
💡 Pro Tip: Provide a clear description for editors.
New umbracoUrlName for a Content Node: DELL Alienware M18 Gaming Laptop
Step 2: Apply umbracoUrlName to a Content Node
-
Navigate to the Content section in Umbraco Backoffice.
-
Select the node where you want to change the URL (e.g., "DELL Alienware M18").
-
Find the Custom URL Name field (created in Step 1).
-
Enter your preferred node name, e.g., DELL Alienware M18 Gaming Laptop.
-
Save and publish the node.
Now, instead of /store/dell-alienware-m18/, the page URL will be /store/dell-alienware-m18-gaming-laptop/.
New SEO friendly page URL is /store/dell-alienware-m18-gaming-laptop/
Step 3: Verify the URL Change
-
Navigate to your eCommerce website and try accessing the new URL (e.g., /store/dell-alienware-m18-gaming-laptop/).
-
Check that the page loads correctly.
-
Use Umbraco’s Redirect URL Management panel to ensure old URLs redirect properly to the new ones.
New redirect for original URL is visible in Umbraco’s Redirect URL Management panel
Troubleshooting Common Issues
Custom URL Not Working
-
Ensure the property alias is exactly umbracoUrlName.
-
Verify that the node is published.
-
Check if there are conflicting URL segments with other pages.
Changes Not Reflected on the Website
-
Clear the Umbraco cache and re-publish the node.
-
Verify if any custom routing rules override the URL settings.
SEO Best Practices When Using umbracoUrlName
-
Keep URLs short and descriptive.
-
Avoid changing URLs frequently to maintain link consistency.