Linking

PENDING: AAS-520 - Development Global Footer > Copyright & Disclaimers tab - issue with Text not accepting relative paths - only absolute URLs

Linking Rules for Relative Paths vs Absolute URLs

Scenario

Linking Behavior

Scenario

Relative path for an AEM page is used in the following scenarios:

  • When linking to any AEM page within the same language site hosted within AEM (including those pages that may include dynamic Coveo parameters)
  • When linking to any asset (documents, images) hosted within AEM Assets

Linking Behavior

Open in same tab/window

Scenario

Relative path for an AEM page that includes dynamic Coveo parameters (relative path + .html + dynamic Coveo parameters)

  • This functionality requires a development enhancement to existing components to enable this behavior
  • BLOCKER: This functionality has not been enabled within any RTE fields; only working within Text fields where specifically enabled

Linking Behavior

Open in same tab/window

Scenario

Relative path for an AEM Asset

Linking Behavior

Open in new tab/window

Scenario

Absolute URL is used in the following scenarios:

  • When authoring in one of the AVEVA websites hosted on www.aveva.com or www.aveva.cn and adding a link to another language site hosted on www.aveva.com or www.aveva.cn
    • Exception: Footer List component accepts relative paths for a different language site, in addition to accepting absolute URLs
  • When linking to a third party asset 
  • When linking to a third party webpage
    • An AVEVA site that is not hosted on www.aveva.com or www.aveva.cn is considered to be a third party site in terms of AEM authoring rules
      • engage.aveva.com
      • partners.aveva.com
      • softwaresupport.aveva.com
      • etc.

Linking Behavior

Open in new tab/window

Implementation Rules for Default Linking

Ways that AEM pages are referenced in current implementation:

Using Text Field

  • Text Field or RTE Text Link Field within any component
  • Limitations
    • Does not allow relative paths when linking to other aveva.com AEM sites
    • Does not allow relative path when including dynamic Coveo parameters
    • Does not track MediaValet ID

Using Item Browser Field

  • Footer List
    • Child List
    • Fixed List
  • Sitemap List
    • Child List
    • Fixed List
  • Image - Metadata tab
  • List
  • Smart Button

Using External URL field in Card Properties tab of Page Properties

  • Page Properties > Card Properties > External Link Field

Regardless of the scenario, when referencing an AEM page, the default linking rules in the table below should apply.


Default Page Scenario

Linking Behavior When Page Is Referenced in a Component

Default Page Scenario

AEM page

Linking Behavior When Page Is Referenced in a Component

Open in same tab/window

Default Page Scenario

AEM page that has an External Link

External Link should be:

  • A relative AEM Asset path
  • An absolute third party URL

Linking Behavior When Page Is Referenced in a Component

Open in new tab/window

Default Page Scenario

AEM page that has a redirect

Linking Behavior When Page Is Referenced in a Component

Open in same tab/window

Default Page Scenario

AEM page that has a vanity URL

Linking Behavior When Page Is Referenced in a Component

Open in same tab/window

Authoring Links in AEM

Use Case

Language Masters

Live Copy

Published Page

Use Case

AEM local site page

AEM relative path

Language Masters

/content/aveva/language-masters/en/about/careers

/content/aveva/language-masters/de_de/solutions

Live Copy

/content/aveva/en/about/careers

/content/aveva/de-de/solutions

Note that when page is rolled out to Live Copy:

  • /language-masters/ gets stripped out of the path
  • The underscore (_) becomes a hyphen (-) in the language/country portion of path

Published Page

https://www.aveva.com/en/about/careers/

https://www.aveva.com/de-de/solutions/

Note that when Live Copy is published:

  • /content/aveva becomes https://www.aveva.com/en (or whatever the language domain is)
  • The relative path becomes an absolute URL
  • A trailing / is automatically appended at the end of the URL

Use Case

Coveo dynamic parameters with AEM page

AEM relative path + .html + Coveo parameters

Language Masters

/content/aveva/language-masters/en/perspectives.html#f-coveo_contenttype=Blog%20Post

/content/aveva/language-masters/de_de/perspectives.html#f-coveo_contenttype=Blog-Beitrag

Live Copy

/content/aveva/en/perspectives.html#f-coveo_contenttype=Blog%20Post

/content/aveva/de-de/perspectives.html#f-coveo_contenttype=Blog-Beitrag

Note that when page is rolled out to Live Copy:

  • /language-masters/ gets stripped out of the path
  • The underscore (_)becomes a hyphen (-) in the language/country portion of path

Published Page

https://www.aveva.com/en/perspectives/#f-coveo_contenttype=Blog%20Post

https://www.aveva.com/de-de/perspectives/#f-coveo_contenttype=Blog-Beitrag

Note that when Live Copy is published:

  • /content/aveva becomes https://www.aveva.com/en (or whatever the language domain is)
  • The relative path becomes an absolute URL
  • The .html becomes a / in the live URL

Use Case

AEM language site page referencing an AEM language site page in another language

Absolute URL with https at beginning and with trailing / at end

Check option for "Open in New Tab"

Language Masters

https://www.aveva.com/en/legal/

For Footer List component only

Note that a relative path may be used for a different language site

Live Copy

https://www.aveva.com/en/legal/

For Footer List component only

Note that when page is rolled out to Live Copy:

  • /language-masters/ gets stripped out of the path
  • The underscore (_)becomes a hyphen (-) in the language/country portion of path

Published Page

https://www.aveva.com/en/legal/

For Footer List component only

Note that when Live Copy is published:

  • /content/aveva becomes https://www.aveva.com/en (or whatever the language domain is)
  • The relative path becomes an absolute URL
  • A trailing / is automatically appended at the end of the URL

Use Case

Third party URL hosted outside AEM

Absolute URL, ideally with https at the beginning

Check option for "Open in New Tab"

Language Masters

https://investors.aveva.com/

Live Copy

https://investors.aveva.com/

Published Page

https://investors.aveva.com/