Introduction

This article describes how to set up and access the PWA sitemaps generated by Intershop Commerce Management, which are located in the $IS_SHARE/sites/... directory.

References

• Concept - XML Sitemaps
• Concept - URL Rewriting
• Cookbook - XML Sitemaps
• Cookbook - URL Rewriting

Apply PWA Changes

Update the PWA Project

Apply all changes from the PWA Pull Request #918 by cherry picking or by updating the PWA to 1.4+ to be able to access generated PWA sitemaps from the ICM server via REST.

Add Environment Variable 'ICM_BASE_URL' to NGINX Container

Making the sitemap files available requires NGINX proxy functionality. The environment variable 'ICM_BASE_URL' has to be specified for the NGINX container and points to the ICM backend installation, e.g. 'https://jxdemoserver6.intershop.de'.

nginx:
  ...
  environment:
+   ICM_BASE_URL: 'https://jxdemoserver6.intershop.de'
    ...

Apply ICM Adjustments

Configure Domain Splitting

The ICM server that generates the PWA sitemaps requires an additional domain splitting configuration for the PWA host to ensure that the sitemap links are generated correctly:

+ <domainsplitting name="main PWA host for en_US and USD"> 
+   <hosts> 
+     //Specify the PWA Host 
+     <host>jxdemoserver3.intershop.de</host> 
+   </hosts> 
+   //For Multi-Site (e.g. inSPIRED-inTRONICS-Site and inSPIRED-inTRONICS_Business-Site), define a domainsplitting configuration for each site. 
+   <site>inSPIRED-inTRONICS-Site</site> 
+   <shortpathpattern>/${locale:(de|en)}${path}</shortpathpattern> 
+   <server-group>WFS</server-group> 
+   <currency>USD</currency> 
+   <appurlid>rest</appurlid> 
+   <replacements> 
+     <replacement type="locale"> 
+       <compact>de</compact> 
+       <expand>de_DE</expand> 
+     </replacement> 
+     <replacement type="locale"> 
+       <compact>en</compact> 
+       <expand>en_US</expand> 
+     </replacement> 
+   </replacements>
+ </domainsplitting>

nginx:
  ...
  environment:
    ...
    MULTI_CHANNEL: | 
      .+:
        - baseHref: /en
          channel: inSPIRED-inTRONICS-Site
          lang: en_US

<domainsplitting name="main PWA host for en_US and USD"> 
  ...
  <replacements> 
    ...
    <replacement type="locale"> 
      <compact>en</compact> 
      <expand>en_US</expand> 
    </replacement> 
  </replacements>
</domainsplitting>

+ <domainsplitting name="main PWA host for en_US and USD"> 
+   <hosts> 
+     <host>jxdemoserver3.intershop.de</host> 
+   </hosts> 
+   <site>inSPIRED-inTRONICS-Site</site> 
+   <shortpathpattern>${path}</shortpathpattern> 
+   <server-group>WFS</server-group> 
+   <currency>EUR</currency> 
+   <appurlid>rest</appurlid> 
+ </domainsplitting>

nginx:
  ...
  environment:
    ...
    MULTI_CHANNEL: | 
      .*jxdemoserver3.intershop.de
        channel: inSPIRED-inTRONICS-Site
        lang: de_DE

Enable REST Application-Specific Webserver Configuration

To specify application-specific or domain-specific properties, create a new .properties file (e.g. url.properties) in the corresponding $IS_SHARE/system/config folder and specify the WebServerURL and WebServerSecureURL of the PWA host(s) in it:

intershop.WebServerURL=http://jxdemoserver3.intershop.de:80
intershop.WebServerSecureURL=https://jxdemoserver3.intershop.de:443

The same can be applied on a domain-specific basis.

intershop.WebServerURL=http://jxdemoserver3.intershop.de:80
intershop.WebServerSecureURL=https://jxdemoserver3.intershop.de:443

Restart the Application Server

The domain splitting and Web Server URL configurations require a restart of the application server.

This step can be skipped by enabling the following CheckSource properties:

intershop.urlrewrite.CheckSource=true
intershop.configuration.CheckSource=true

Enable URL Rewriting for the inSPIRED-inTRONICS-Site

To enable URL rewriting for the inSPIRED-inTRONICS-Site: 

1. Open Intershop System Management
2. Go to Site Management | <Site> | General.
3. Check URL Rewriting.
4. Click Apply.

Enter External Base URL for PWA Application in ICM

To set the External Base URL for the PWA application:

1. Open Intershop Commerce Management.
2. Switch to the channel.
3. Go to Applications | <PWA-Application> | General.
4. Enter the External Base URL.
5. Click Apply.

Generate PWA Sitemap Files

To generate PWA sitemap files: 

1. Go to Catalogs | Product Data Feeds.
2. Click New.

3. Enter a name and an ID.

   Note

   The name of the sitemap must start with: sitemap_

4. Click Apply.
5. Switch to the Target tab.
6. Provide File Name, e.g. sitemap_pwa.xml and set Application to Progressive Web App.
   
7. Make additional configurations if required.
8. Click Apply.

Copy All Generated Sitemap Files (Workaround for Specific ICM Versions)

To make the sitemaps available via REST, up to ICM 7.10.26.19-LTS, 7.10.32.10-LTS and 7.10.36.0 it is necessary to copy the generated sitemaps from:

/eserver1/share/sites/inSPIRED-inTRONICS-Site/units/inSPIRED-inTRONICS/syndication/sitemaps/sitemap_pwa

to:

/eserver1/share/sites/inSPIRED-inTRONICS-Site/1/static/en_US/sitemaps/pwa/

Once the sitemaps can be retrieved via a REST request to the ICM server, the PWA is able to get the sitemaps.

GET https://jxdemoserver6.intershop.de/INTERSHOP/static/WFS/inSPIRED-inTRONICS-Site/rest/inSPIRED-inTRONICS/en_US/sitemaps/pwa/sitemap_pwa.xml

Access Sitemap Files via PWA

GET https://jxdemoserver3.intershop.de/en/sitemap_pwa.xml

GET https://jxdemoserver3.intershop.de/en/sitemap_pwa-product-0.xml.gz