B2C Entry Points

A request, a job or a hook can enter your code in five different ways, and each one is declared in its own place: pipeline XML, controller scripts, hooks.json, steptypes.json and the api.json of a custom API. B2C Entry Points collects all of them from your linked cartridges into one searchable tool window with a tab for each kind, and every row opens the code that runs it

A tab per kindSearch every tabMore actionsOpen the code

STstorefrontSandbox 01version2

Cart.jshooks.jsonscript.js

1'use strict';

2

3var RESTResponseMgr = require('dw/system/RESTResponseMgr');

4var points = require('*/cartridge/scripts/loyalty/points');

5

6exports.getPoints = function () {

7 var memberId = request.getSCAPIPathParameters().get('memberId');

8 RESTResponseMgr.createSuccess(points.balance(memberId)).render();

9};

10exports.getPoints.public = true;

11

12exports.redeemPoints = function () {

13 var memberId = request.getSCAPIPathParameters().get('memberId');

14 RESTResponseMgr.createSuccess(points.redeem(memberId)).render();

15};

16exports.redeemPoints.public = true;

B2C Entry Points

points

Pipelines0Controllers0Hooks1Step Types1Custom APIs2

int_loyalty2loyaltyv12GETv1/members/{memberId}/pointsgetPointsPOSTv1/members/{memberId}/points/redeemredeemPoints

4 matches

Open Implementation

Open in hooks.json

Copy Hook Name

storefrontint_loyaltycartridgerest-apisloyaltyscript.jsGlobal scopeLFUTF-8

Open the tool window

Click B2C Entry Points on the right tool window bar. You can also open it from:

• Navigate › B2C Entry Points
• Tools › Salesforce B2C Commerce › B2C Entry Points
• More › Tool Windows › B2C Entry Points

The menu items open the tool window with the search field focused, so you can start typing right away. They show up once a cartridge is linked, see Cartridges & Modules

To jump to an entry point without opening the tool window, press Shift twice and use the B2C Entry Points tab of Search Everywhere. It lists the same entries and opens the same code

What it lists

The tool window has a tab for each kind of entry point, with its total next to the name. Each tab holds a tree of its own that keeps its expanded folders and scroll position, and the tool window opens on the tab you picked last. The status line at the bottom counts every kind, for example "143 entry points in 5 cartridges"

Cartridges follow the order of your linked cartridges. Folders you expand stay expanded when the tree refreshes

Search

Type in the field at the top. Names match the way they do in Search Everywhere, so cart-rem finds Cart-RemoveProduct. The search also looks at the details of each row:

The search covers every tab at once. While you search, each tab shows its number of matches, folders without a match are hidden and the status line counts all the matches. When the tab you are on has no match, the first tab that has one opens. Matched text is highlighted in every row. Each tab shows up to 400 matches and then a "N more, refine the search" row

Open the code

Every row opens the code that runs, not only the file that declares it. When the plugin can't find that code, it opens the declaration instead

Context menus

Right-click a row for the actions that fit it

Copy Endpoint Path copies the path with the API name, for example /loyalty/v1/members/{memberId}/points/redeem

Toolbar

You rarely need Refresh. The tree updates on its own half a second after you change a controller, a pipeline, a hooks.json, steptypes.json or package.json, or a file under rest-apis. While the tool window is hidden it waits and refreshes the next time you open it

Where the entries come from

Every entry point comes from the plugin's own indexes. The IDE builds and updates them together with its other indexes, like the ones for Java or JavaScript. Nothing runs outside the IDE and Node.js is not needed. The indexes read the same declarations as the VS Code extension, so both editors list the same entry points. The same indexes draw the Code Vision lenses above routes, hooks, step types and custom APIs

While the IDE is indexing, the tree shows "Collecting entry points..." and the lenses are hidden. Both fill in when indexing finishes

Troubleshooting

Related