Download Shopper Information in SFRA

When you implement an SFRA-based storefront, consider providing your shoppers with a mechanism to download their data. The plugin_datadownload cartridge provides a sample implementation of this capability.

In the sample implementation, registered users see a Download My Data button on the My Account page. When a shopper clicks this button, SFRA downloads a JSON file to the shopper’s browser. This file contains the following information:

Profile
Address
Payment instruments
Orders
Wish lists
Gift registries
Shopping lists

The JSON file illustrates the type of information to provide to your shoppers. Your business can provide different data in a different format. To use the sample implementation, uploading the plugin_datadownload cartridge into your instance and add the cartridge to your cartridge path.

Sample JSON File

This sample file shows the type of information to provide to the shopper.

1{
2  "profile": {
3    "birthday": "1988-10-21T00:00:00.000Z",
4    "companyName": "",
5    "customerNo": "D00000001",
6    "email": "janedoe@mycompany.com",
7    "fax": "",
8    "firstName": "Test1",
9    "gender": "Female",
10    "jobTitle": "",
11    "lastLoginTime": "2018-02-14T20:07:31.074Z",
12    "lastName": "Doe",
13    "lastVisitTime": "2018-02-14T20:07:31.074Z",
14    "phoneBusiness": "",
15    "phoneHome": "",
16    "phoneMobile": "",
17    "preferredLocale": "",
18    "previousLoginTime": "2015-05-18T20:43:17.000Z",
19    "previousVisitTime": "2015-05-18T20:43:17.000Z",
20    "salutation": "",
21    "secondName": "",
22    "suffix": "",
23    "taxID": null,
24    "taxIDMasked": null,
25    "taxIDType": null,
26    "title": "",
27    "male": false,
28    "female": true,
29    "nextBirthday": "2018-10-21T00:00:00.000Z"
30  },
31  "addressbook": [
32    {
33      "address1": "104 Presidential Way",
34      "address2": null,
35      "city": "Woburn",
36      "companyName": null,
37      "countryCode": "us",
38      "firstName": "Test1",
39      "fullName": "Test1 User1",
40      "id": "Home",
41      "jobTitle": null,
42      "lastName": "User1",
43      "phone": "781-555-1212",
44      "postalCode": "01801",
45      "postBox": null,
46      "salutation": null,
47      "secondName": null,
48      "stateCode": "MA",
49      "suffix": null,
50      "suite": null,
51      "title": null
52    },
53    {
54      "address1": "91 Middlesex Tpke",
55      "address2": null,
56      "city": "Burlington",
57      "companyName": null,
58      "countryCode": "us",
59      "firstName": "Jane",
60      "fullName": "Jane Doe",
61      "id": "Work",
62      "jobTitle": null,
63      "lastName": "Doe",
64      "phone": "781-555-1212",
65      "postalCode": "01803",
66      "postBox": null,
67      "salutation": null,
68      "secondName": null,
69      "stateCode": "MA",
70      "suffix": null,
71      "suite": null,
72      "title": null
73    }
74  ],
75  "wallet": [],
76  "orders": [],
77  "productList": {
78    "whishlists": [],
79    "giftregistries": [],
80    "shoppinglists": []
81  },
82  "thirdpartydata": {}
83}

Implementation Details

The sample implementation provides a Download my data button in the accountDashboard.isml template.

1<div class="row mb-3 clearfix hidden-sm-down">
2	<div class="col">
3		<div>
4			<a href="${URLUtils.url('Account-DataDownload')}" class="btn btn-outline-primary pull-right"
5			   role="button" aria-pressed="true">
6				${Resource.msg('button.download.data', 'datadownload', null)}
7			</a>
8		</div>
9	</div>
10</div>

When the shopper clicks the button, the Account-DataDownload route is called. This route is implemented in Account.js.

1'use strict';
2
3var server = require('server');
4server.extend(module.superModule);
5
6var userLoggedIn = require('*/cartridge/scripts/middleware/userLoggedIn');
7
8server.get('DataDownload',
9    server.middleware.https,
10    userLoggedIn.validateLoggedIn,
11    function (req, res, next) {
12        var customer = req.currentCustomer.raw;
13        var dataDownloadHelper = require('~/cartridge/scripts/dataDownloadHelper');
14        var site = require('dw/system/Site');
15
16        var fileName = site.current.name
17            + '_' + customer.profile.firstName
18            + '_' + customer.profile.lastName
19            + '.json';
20
21        var profileData = dataDownloadHelper.getProfileData(customer);
22
23        res.setHttpHeader(res.base.CONTENT_DISPOSITION, 'attachment; filename="' + fileName + '"');
24        res.setContentType('application/octet-stream');
25        res.print(profileData);
26
27        next();
28    }
29);
30
31module.exports = server.exports();

This route relies on the helper script dataDownloadHelper.js, which provides several helper functions, such as getWallet(profile), getWishlists(customer, ProductListMgr), and so on. The helper script exports getProfileData, which calls the helper functions, constructs the JSON string, and returns the result to the shopper’s browser.

1exports.getProfileData = function (profile) {
2    var ProductListMgr = require('dw/customer/ProductListMgr');
3    var downloadJSONObj = {};
4
5    downloadJSONObj.profile = getProfile(profile);
6    downloadJSONObj.addressbook = getAddressBook(profile);
7    downloadJSONObj.wallet = getWallet(profile);
8    downloadJSONObj.orders = getOrders(profile);
9    downloadJSONObj.productList = {
10        whishlists: getWishLists(ProductListMgr),
11        giftregistries: getGiftregistries(ProductListMgr),
12        shoppinglists: getShoppingLists(ProductListMgr)
13    };
14
15    downloadJSONObj.thirdpartydata = {};
16    return JSON.stringify(downloadJSONObj, null, 2);
17};