Support and Documentation

URL management

URLs identify the location of resources on a website by specifying both the domain name and the specific path to an asset. You set the domain at the site level when you create the site. At the site level, you can also specify both vanity URLs and wildcard URLs. At the asset level, you can manage the path.

Asset-Level URL management

You set the path part of the URL in the URLs widget, which appears in the content edit pages of an asset. You can set the following types of URLs in the URLs widget.

Table 6. Types of URLs

Type of URL

Description

Permalink

Permanent link that never expires. Another asset on your site cannot have the same permalink. Do not change permalinks after the initial publishing of content. If you want to change a URL, add an alias to the asset, or add a redirect to the new asset that is replacing the old asset. See Permalinks for assets for additional information.

Alias

Alternative link to the asset. You can delete the alias from an asset and use it on another asset.

Redirect (Permanent)

URL from which browsers are permanently redirected. Browsers redirect to the asset with the permalink. For example, if the permalink is /ice-cream-toppings, and you had a link to a previous article /toppings, then you would set /toppings as the redirect URL. Browsers would then redirect from /toppings to /ice-cream-toppings. See Redirect URLs for assets for additional information.

A permanent redirect causes the server to send an HTTP status code 301 to the browser. It also instructs search engines to replace the older permalink in their listings with the new permalink.

Redirect (Temporary)

A temporary redirect is similar to a permanent redirect, but a temporary redirect causes the server to send an HTTP status code 307 to the browser. It also instructs search engines to temporarily replace the older URL in their listings with the new permalink. However, the search engines continue to scan the site at the old permalink and will deliver that page after you delete the temporary redirect. See Redirect URLs for assets for additional information.



Permalinks for assets

When you create an asset, you must assign it a permalink to make the asset accessible on a website. A permalink must be unique on the site where the item resides. A permalink should not be changed or deleted, even if the link is erroneously named or if the item becomes obsolete. In such cases, you can apply an alias or redirect URL to handle the issue.

As a best practice, your organization should define a permalink scheme to better manage the ever-increasing volume of content on your websites. The scheme should define the structure of the path in a way that is meaningful to your organization. For example, you could use paths based on headlines for article types, such as /deadly-gamma-ray-burst-headed-for-tinas-pizzeria. To provide more information about resources on your website, you could use additional URL segments.

Auto-generating permalinks

Brightspot can automatically generate permalinks for those content types that have this feature.

Procedure. To auto-generate a permalink:
  1. Search for and open the item in the content edit page..

  2. In the URLs widget, set Generate Permalink. (If you do not see the Generate Permalink checkbox, you need to manually create a permalink; for details, see Assigning URLs to assets.)

    urls-widget-no-url-set.png
  3. Review the permalink automatically generated from the headline field. You can change the permalink by changing the text in the slug field (if available).

  4. In the Editorial Toolbar, save or publish the item.

In the example below, the permalink is derived from the headline field in the content edit form.

automatically-generated-permalink.svg
Assigning URLs to assets

Using the URLs widget, you can manually assign one or more URLs to an asset.

Procedure. To manually assign a URL to an asset:
  1. Search for and open the item in the Content Edit Page.

  2. In the URLs widget, click |mi-add_circle_outline|.

  3. Type the URL in the field. URLs start with a slash (/) and have no ending slash, such as /love-olive-pizza.

    urls-widget.png
  4. Using the table Types of URLs, select the type of URL.

  5. Repeat steps 2–4 to add additional URLs.

Note

In a multi-site environment, you can use the URLs widget to publish to multiple sites.

URLs in a multi-site environment

In a multi-site environment, the URLs widget includes a list option to select a site. Brightspot publishes the asset to the site set in this option using the URL you provide.

urls-multisite-1.png

As shown in the following example, you can publish an asset to multiple sites with the URLs widget. If you set Global, Brightspot publishes to all sites.

Publishes to Stargazers site only
Figure 38. Publishes to Stargazers site only


Publishes to Stargazers and Asteroid Hunters sites
Figure 39. Publishes to Stargazers and Asteroid Hunters sites


Publishes to all sites
Figure 40. Publishes to all sites


When publishing to multiple sites, you can use the same permalink across multiple sites because each site has a different domain name. In the above example, a single permalink is set, /extraterrestrials, for both Asteroid Hunters and Stargazers. The resulting fully qualified URLs are unique because of the sites' different domain names.

Table 7. Fully qualified URLs with the same permalinks

Site

Fully qualified URL

Asteroid Hunters

http://www.asteroidhunters.com/extraterrestrials

Stargazers

http://www.stargazers.com/extraterrestrials



Alternatively, you can set site-specific permalinks on an asset. In the following example, there are different permalinks for the Asteroid Hunters site and the Stargazers site.

urls-widget-multi-permalinks.png
Table 8. Fully qualified URLs with different permalinks

Site

Fully qualified URL

Asteroid Hunters

http://www.aseroidhunters.com/extraterrestrials

Stargazers

http://www.stargazers.com/outer-space-creatures



Note

An asset that can be published to multiple sites is not automatically accessible in Brightspot to editors working in those sites. For example, in the URLs widget, an asset can have a URL for the Stargazers site, but in the Sites widget, the Stargazers site can be denied access to the asset. For more information, see Assigning permissions to content on multiple sites.

Redirect URLs for assets

Redirects protect against web links that reference obsoleted (moved, deleted, or consolidated) content on your site. Redirect URLs map source links to target links, where source links are URLs to obsoleted assets, and target links are URLs to new, replacement assets. Redirects can be either permanent (301 redirects) or temporary (307 redirects).

You can add redirect URLs at the asset level; in the content edit page of a target asset, map source permalinks for one or more obsolete assets to the target permalink.

Administrators are also able to redirect URLs at the site level using either vanity URLs or wildcard URLs.

A prerequisite for setting a redirect URL is that the URL itself no longer exist on the obsolete asset. This is accomplished in one of the following ways:

Redirecting an asset request to a target permalink

You can add redirect URLs in the content edit page of the target asset, that is, the asset that you want to use in place of an obsolete asset. For example, if Article A is obsolete and you want links to Article A to be redirected to Article B, then you set the redirect in the content edit page for Article B.

Procedure. To add redirect URLs:
  1. Obtain the URL of the obsolete asset.

  2. In the URLs widget, click |mi-add_circle_outline|.

  3. From the drop-down list, select Redirect (Permanent) or Redirect (Temporary).

  4. In a multi-site environment, from the drop-down list, select the site to which you want the redirect URL to apply. Selecting Global applies the redirect URL to all of your sites.

  5. In the text box, type the redirect URL in the field. The redirect URL specifies one of the following:

    • The permalink of an asset you deleted.

    • A permalink you deleted from an asset.

    URLs start with a slash (/) and have no ending slash.

    For example, if an obsoleted article had a permalink of /toppings, you would specify /toppings as the redirect URL. As shown in the following screen shot, the /toppings link would be redirected to the asset with the permalink of /ice-cream-toppings.

    urls-widget-redirect.png
  6. Repeat steps 2–5 to set additional redirects to this asset.

  7. In the Editorial toolbar, save or publish the asset.

If you get a message about fixing field errors, you probably specified a permalink that has not been removed from the obsolete asset.

Vanity URL redirects
Wildcard URLs and wildcard URL redirects

A wildcard URL is a partial URL with asterisks, which serve as placeholders for additional path segments that are calculated by the Brightspot backend, or by another application that is integrated with Brightspot. For example, you could set a wildcard URL on a Gallery page, from which users can select and view videos from within the page. When a user selects a particular video, identified by a unique number, Brightspot uses the number to calculate the specific URL of the Gallery page with the embedded video.

A wildcard URL takes one of the following forms: <examplePath>/* or <examplePath>/**, where:

  • <examplePath> is the starting path of the URL, for example, gallery/videos.

  • <examplePath>/* indicates that <examplePath> can be followed by no more than one path segment, for example, /gallery/videos/15.

  • <examplePath>/** indicates that <examplePath> can be followed by multiple path segments, for example, /gallery/videos/hockeyclips/15.

Deleting URLs for assets
Procedure. To delete a URL:
  1. Search for and open the item in the content edit page.

  2. In the URLs widget, click |mi-remove| corresponding to the URL that you want to delete.

  3. Complete your site's workflow and publish the item.