Pre-Release Information

Note: Spartacus 2.x is no longer maintained. Please upgrade to the latest version.

This document describes what is included in the latest pre-release of TUA Spartacus libraries, such as next and rc libraries.

Last updated November 25, 2020 by Deborah Cholmeley-Jones, Solution Owner, TUA Spartacus

For an overview of what is included in a specific release, see Release Information.

For detailed release notes, see the TUA Spartacus repository .

Release 2.0.0-next.2 - November 25, 2020

The 2.0.0-next.2 library has been published! We are happy to announce our second Spartacus for TUA pre-release.

In the 2.0.0-next.2 pre-release version, support for both - TUA 2007 and TUA 2011 is provided. In addition to supporting composite pricing and price alteration discounts, priority pricing is now available, as well as support for 1.x spartacus features that were delivered in previous releases, with the exception of 1.3 features, which is planned next.

Installing SAP Commerce for use with TUA Spartacus

Installation instructions are very similar to Installing SAP Commerce for use with TUA Spartacus, except the following instructions that describe how to install and configure SAP Commerce (release 2005) with Telco & Utilities Accelerator (release 2007 or release 2011, latest patch) for use with a TUA Spartacus storefront. In these instructions, SAP Commerce and Telco & Utilities Accelerator are installed on your local computer, so localhost is used in the browser URLs.

The installation procedure includes steps for creating and using a b2c_telco_spa recipe that makes use of the TUA Spartacus Sample Data (b2ctelcospastore), but you can use your own sample data or recipe as long as it includes the cmsocc, commercewebservices, acceleratorocc extensions and TUA module.

Some of the steps in this procedure are derived from the documentation for installing SAP Commerce using recipes. For more information, see Installing SAP Commerce Using Installer Recipes in the SAP Help Portal.

  1. Unzip the SAP Commerce and Telco & Utilities Accelerator zip archives.

    Note: Use the latest patches for SAP Commerce Cloud version 2005 and Telco & Utilities Accelerator version 2007 or Telco & Utilities Accelerator version 2011.

  2. Download the TUA Spartacus Sample Data Store Extension.

    The TUA Spartacus Sample Data Store Extension is the extension provided in the following zip files:

    • For TUA 2007: b2ctelcospastore_2007.zip.
    • For TUA 2011: b2ctelcospastore_2011.zip.

  3. Unzip the b2ctelcospastore_2007.zip archive for version 2007 or b2ctelcospastore_2011.zip archive for version 2011.

  4. Move the b2ctelcospastore folder from extracted b2ctelcospastore_2007 folder or b2ctelcospastore_2011 folder to <sap-commerce-folder>/hybris/bin/modules/b2c-telco-accelerator.

    The b2ctelcospastore folder can be stored anywhere in the modules folder. The b2c-telco-accelerator folder is chosen as it contains other TUA sample data.

  5. In the sap-commerce-folder>/installer/recipes folder, create a copy of the b2c_telco folder.

  6. Rename the copy of the b2c_telco folder to b2c_telco_spa.

  7. In b2c_telco_spa, the build.gradle file should have the following content:

     apply plugin: 'installer-platform-plugin'
 apply plugin: 'installer-addon2-plugin'
 def pl = platform {
     localProperties {
         property 'kernel.events.cluster.jgroups.channel', 'disable'
         property 'datahub.publication.saveImpex', ''
         property 'commerceservices.default.desktop.ui.experience', 'responsive'
         property 'kernel.autoInitMode', 'update'
         property 'installed.tenants', 'junit, api, foo'
     }
     afterSetup {
         ensureAdminPasswordSet()
     }   
        
         extensions {
             extName 'acceleratorcms'
             extName 'adaptivesearchbackoffice'
             extName 'adaptivesearchsolr'
             extName 'addonsupport'
             extName 'b2ctelcobackoffice'
             extName 'b2ctelcofulfillmentprocess'
             extName 'b2ctelcospastore'        
             extName 'b2ctelcotmfwebservices'
             extName 'b2ctelcowebservices'      
             extName 'b2ctelcoocc'
             extName 'cmsocc'
             extName 'acceleratorocc'
             extName 'b2ctelcocommercewebservicescommons'
             extName 'commerceservicesbackoffice'
             extName 'solrfacetsearchbackoffice'
             extName 'solrserver'
             extName 'subscriptionbackoffice'
             extName 'yacceleratorcore'
             extName 'commercewebservices'         
             extName 'cmsbackoffice'
             extName 'cmswebservices'
             extName 'previewwebservices'
             extName 'smarteditwebservices'
             extName 'cmssmarteditwebservices'
             extName 'permissionswebservices'     
             extName 'cmssmartedit'       
             extName 'customersupportbackoffice'        
             extName 'personalizationwebservices'
             extName 'previewpersonalizationweb'
             extName 'personalizationcmsweb'
             extName 'personalizationsmartedit'
             extName 'personalizationservicesbackoffice'
             extName 'personalizationcmsbackoffice'
             extName 'personalizationservices'
             extName 'personalizationfacades'     
             extName 'acceleratorservices'
             extName 'assistedservicefacades'   
             extName 'rulebuilderbackoffice'
             extName 'couponbackoffice'
             extName 'droolsruleengineservices'
             extName 'couponfacades'
             extName 'couponservices'   
             extName 'integrationmonitoringbackoffice'    
     }
 }
 task setup () {
     doLast {
            
         pl.setup()
         copy {
             from "${installerHome}/recipes/b2c_telco/logback.xml"
             into "${suiteHome}/hybris/bin/platform/tomcat/lib"
         }
         copy {
             from "${installerHome}/recipes/b2c_telco/sbg_properties"
             into "${suiteHome}/hybris/bin/platform/tomcat/lib"
             exclude "**/*.txt"
         }
     }
 }
 task buildSystem(dependsOn: setup) {
     doLast {
         pl.build()
     }
 }
 task initialize (dependsOn: buildSystem) {
     doLast {
         pl.initialize()
     }
 }
 task start () {
     doLast {
         pl.start()
     }
 }
 task startInBackground () {
     doLast {
         pl.startInBackground()
     }
 }
 task stopInBackground {
     doLast {
         pl.stopInBackground()
     }
 }

    1. Open a terminal or command prompt window inside the sap-commerce-folder>/installer folder.

    2. Set up the recipe using the following commands:

    For Windows:

     install.bat -r b2c_telco_spa -A local_property:initialpassword.admin=Y0urFav0r!tePassw0rd

    For Unix:

     ./install.sh -r b2c_telco_spa -A local_property:initialpassword.admin=Y0urFav0r!tePassw0rd

    For more information, see Installing SAP Commerce for use with TUA Spartacus.

Building the TUA Spartacus Storefront Using 2.x Libraries

Note: Ensure that you meet the following front-end and back-end requirements:

  • Angular CLI: 9.1.0 or later, < 10.0.0
  • node.js: 12.18.2 or later, < 13.0. The most recent 12.x version is recommended
  • yarn: 1.15 or later

To create a new Angular application with the name mystore, follow the procedure:

  1. Open a terminal or command prompt window at the location of your choice.

  2. Using the Angular CLI, generate a new Angular application with the following command:

    ng new mystore --style=scss

    When prompted if you would like to add Angular routing, enter n for ‘no’.

    The mystore folder and the new app are created.

  3. Access the newly created mystore folder with the following command:

     cd mystore

Setting up a Storefront Manually

Although we recommend using Schematics, there might be situations when you want to build your application from scratch.

The dependencies in this procedure are required by the TUA Spartacus storefront.

  1. Inspect the mystore/src/app/app.module.ts file for any changes you want to make for your setup. For example, you might want to change the baseUrl to point to your server and the basesite to corresond with the WCMS site. You likely also want to specify the compatibility version by changing features.level, as the default might not be the latest version.

    To make use of the modules shipped with tua-spa library, the app.module.ts must have the following structure:

    
 import { BrowserModule } from '@angular/platform-browser';
 import { NgModule } from '@angular/core';
 import { AppComponent } from './app.component';
 import { translationChunksConfig, translations } from '@spartacus/assets';
 import { ConfigModule } from '@spartacus/core';
 import { TmaB2cStorefrontModule, tmaTranslations } from '@spartacus/tua-spa';


 @NgModule({
 declarations: [
     AppComponent
 ],
 imports: [
     BrowserModule,
     TmaB2cStorefrontModule.withConfig({
     backend: {
         tmf: {
         baseUrl: 'https://localhost:9002',
         prefix: '/b2ctelcotmfwebservices/v2/',
         },
         occ: {
         baseUrl: 'https://localhost:9002',
         prefix: '/occ/v2/'
         },
         tmf_appointment: {
         baseUrl: 'http://localhost:8080',
         prefix: '/tmf-api'
         }
     },
     context: {
         urlParameters: ['baseSite', 'language', 'currency'],
         baseSite: ['telcospa']
     },
     i18n: {
         resources: translations,
         chunks: translationChunksConfig,
         fallbackLang: 'en'
     },
     features: {
         level: '2.0'
     }
     }),
     ConfigModule.withConfig({
     i18n: {
         resources: tmaTranslations
     }
     }),
 ],
 providers: [],
 bootstrap: [AppComponent],
 })
 export class AppModule { }

  2. Replace the entire contents of mystore/src/app/app.component.html with <cx-storefront>Loading...</cx-storefront> with:

    <cx-storefront>Loading...</cx-storefront>

  3. Open mystore/package.json using a text editor.

  4. Add the following dependencies to the end of the dependencies section of package.json.

     "@angular/localize":"^9.1.0",    
 "@angular/service-worker": "~9.1.0",
 "@ng-bootstrap/ng-bootstrap": "6.0.0",
 "@ng-select/ng-select": "^4.0.0",
 "@ngrx/effects": "~9.0.0",
 "@ngrx/router-store": "~9.0.0",
 "@ngrx/store": "~9.0.0",
 "@spartacus/assets": "~2.0.4",
 "@spartacus/core": "~2.0.4",
 "@spartacus/storefront": "~2.0.4",
 "@spartacus/styles": "~2.0.4",
 "@spartacus/tua-spa": "~2.0.0-next.2",
 "bootstrap": "^4.2.1",
 "chart.js": "^2.9.3",
 "express": "^4.15.2",
 "i18next": "^19.3.4",
 "i18next-xhr-backend": "^3.2.2",
 "material-design-icons": "^3.0.1",
 "ng2-charts": "^2.3.2",
 "ngx-infinite-scroll": "^8.0.0",
 "ngx-spinner": "^9.0.1",
  "jquery": "^3.5.1"

    Note: Make sure to add a comma to the end of the last dependency statement listed in this section. For example, the last statement in your new app might be "zone.js": "~0.10.2" so you need to add a comma after 0.10.2".

  5. Make sure that the following import is found in the mystore/src/styles.scss:

    @import '~@spartacus/styles/index';
@import '~@spartacus/tua-spa/storefrontstyles/index';

  6. From the terminal window, within mystore, install the dependencies by running the following command:

    yarn install

  7. Start the angular client app. From the terminal window, within mystore start the application by running the following command:

    yarn start

  8. Make sure your backend server is up and running (SAP Commerce with TUA). When the backend server is properly started, point your browser to http://localhost:4200/telcospa/en/USD/.

Note:

(1) Using ~ instructs yarn to use the latest patch version (x.y.z); whereas, using ^ instructs yarn to use the latest minor version (x.y.0).

(2) If you are updating an existing app, and changing dependencies, it is recommended to delete the node_modules folder before running the install command.

For more information on setting up TUA Spartacus 2.0.0-next.2, see Building the TUA Spartacus Storefront Using Libraries.

As always, feedback appreciated! Contact us through Slack or submit an issue.

Release 2.0.0-next.1 - October 28, 2020

The 2.0.0-next.1 library has been published! For more information, see Release Information.

We are happy to announce support for the TUA 2007 release.

You can set up TUA Spartacus 2.0.0-next.1 by following the instructions from Building the TUA Spartacus Storefront Using Libraries.

The following features are included as part of this pre-release:

Composite Pricing

Composite Pricing brings forth a new way for handling operational processes for service providers that is clearer and more efficient. The underlying TUA data model has been enhanced to support the hierarchical structure of composite prices in a TM Forum compliant manner. Product Offering Prices are now hierarchical; that is, they can be grouped together and they are also re-usable. For more information, see Composite Pricing in the TUA Help portal.

Price Alteration Discounts

The Price Alteration Discounts works on top of the Composite Pricing data model and enables the ability to offer fixed-price and percentage discounts at any level in the composite price structure, and for any type of charge including one-time charges, recurring charges and usage-based charges. With price alteration discounts, customers can see discounts upfront before placing their order. For more information, see Price Alteration Discounts in the TUA Help portal.

Pre-Release Libraries for 2.0 and Earlier

Pre-release libraries are no longer actively updated for versions 1.0 and earlier, as the final release of these libraries was already published. Pre-release libraries are still available but the final versions should be used.

Questions

If you have technical questions, you can get in touch with us on Stack Overflow. For non-technical questions, you can reach us on our Slack workspace. Feedback welcome!