Set up redirects for specific pages of your Scroll Viewport site. With redirects you can:

  • Recover a broken Viewport link (e.g. you deleted an article) by pointing your users to alternative content. This can be useful if you have removed a previously widely shared article from your site and know that many users will end up on a 404 page.

  • Take prominent elements in your site to present ‘teaser content' and direct your users to external URLs (e.g. clicking pinned pages or content source tiles open your external API documentation or support portal).

  • Maintain a stable link for your in-app help (e.g. define a URL like /security and map this to a page in your Scroll Viewport site).

  • In general, customize the user flow in your help center.

Please note that at the moment this feature is limited to creating literal redirects (redirects to specific pages), defining general redirect rules is currently not possible.

Create and Edit a Redirect

You can create and manage redirects for your Scroll Viewport site under Site Settings:

  1. Select your site in your site overview screen (if you have multiple sites).

  2. Click Settings from the top right of the single site overview screen.

  3. Click Manage next to Redirect(s). You will see a list of all redirects that were already created for your site.

  4. Click + New Redirect. The New Redirect form opens:

    Create a Redirect using the New Redirect Form
  5. For the Source field, select a page from the dropdown or directly enter a path from your Viewport site.

  6. For the Target field, you can select a page from the dropdown, directly enter a path from your Viewport site or enter an external URL. We recommend you review the list of disallowed redirects to ensure that the redirect you create will work.

  7. Click Add. You are taken back the list of existing redirects.

  8. Click Save. The Redirect option in Site Settings will state Active Redirect(s).

  9. Click Close.

  10. Click Update site and Go Live to activate your newly created redirect.

Saving or deleting redirects in your site settings won’t affect your live site until you go live with the changes.

How do I use the advanced create mode?

If you use the configuration field in the advanced redirect mode, you will need to make sure to follow a set format and stick to the permitted values.

To setup a new redirect you should always use the following format:

<mode> <source> <target> <type>

For each part of the redirect, choose from the permitted values in the table below. Note that for mode and source , there is currently only one value you can choose from.

Required format:

mode

source

target

type

Permitted values:

literal

(note: the redirect is applied to the given url)

Relative path of the Viewport site URL

  • For internal Viewport site URLs: relative path

  • For external URLs: absolute path

  • permanent

  • temporary

Some helpful tips for creating redirects:

  • To write Viewport URLs you can use /my-content-source/my-article.1234567.html or /my-content-source/1234567.html . Both formats address a page inside as source and target.

  • For protocol-relative links (links that should remain https), you can write //www.example.com as a short-form of https://www.example.com

  • Viewport site URLs that are set as a redirect target can contain query parameters, such as Viewport’s in-app help query ?inAppHelp=true.

Example of allowed redirects

literal /my-path/                   /new-path/                     temporary
literal /my-path/my-page.12345.html //www.myOtherDomain.com/ permanent
CODE

Disallowed Redirects

To prevent that your users enter endless loops of redirects, we have placed the following limitations when creating redirects:

  • source and target value can’t be the same path

Disallowed paths

Redirecting from the site preview, root page or the search of your Viewport site is not possible. They correspond to the following disallowed paths:

  • /_search*

  • /preview*

  • /

Literal Redirect Examples

Here are some examples for how to create literal redirects for a Scroll Viewport site.

Recover a broken link by pointing to the most relevant, still existing content

The following example shows how to permanently redirect an old URL which doesn’t exist anymore because the Confluence page (and related Confluence page ID) has been deleted or changed.

You can redirect this ‘broken link’ to other content that could be relevant to the users who try to access the removed content.

In this case, set the following values:

  • Source: /my-content-source/my-article.1234567.html

  • Target: /my-content-source/my-article.7654321.html

  • Type: permanent. Uses the HTTP response status code “307”.

Since the redirect is from and to page within the Viewport site, we are using relative paths for the URLs you want to redirect.

If you use the advanced mode, the redirect is:

literal /my-content-source/my-article.1234567.html  /my-content-source/my-article.7654321.html permanent
CODE

Use elements on the Viewport landing page to direct users outside of Viewport

You can use the URL of a pinned page or content source to direct your users to the marketplace of your app or to another external location, when they click on these elements in the Viewport landing page.

In this case, set the following values:

  • Source: /my-content-source/my-article.1234567.html

  • Target: //www.example.com. Since the redirect is to an external page, we are using an absolute paths for the redirect target.

  • Type: permanent

If you use the advanced mode, the redirect is:

literal /my-content-source/my-article.1234567.html  //www.example.com permanent
CODE

Maintain a stable link for your in-app help

With Scroll Viewport, you can display a simplified view of your help content within your own app using an iframe. More generally, you might also want to directly link to and open specific articles in your Scroll Viewport site when your users click defined elements in your app or the F1 button.

To ensure that your users reliably end up at the right location in your site (even if the original pages was deleted or the content moved to a different page), define a new URL for your specific article (e.g /in-app-help/my-article) and map this to the corresponding article in your Scroll Viewport site:

In this case, set the following values:

  • Source: /in-app-help/my-article

  • Target: /my-content-source/my-article.1234567.html

  • Type: permanent

Since the redirect is from and to page within the Viewport site, we are using relative paths for the URLs you want to redirect.

The query parameter ?inAppHelp=true does not need to be specified in the redirect. The parameter will always be respected (and simplified view of the page shown) if appended to the target URL.

If you use the advanced mode, the redirect is:

literal /in-app-help/my-article /my-content-source/my-article.1234567.html permanent
CODE

You can now embed the newly defined URL in your app’s source code. Whenever the target location of the in-app help content changes, you can edit the redirect instead of modifying the URL in the source code of your app.