This page provides Business administrators a user guide for the Foundation microservice for the Infosys Equinox Commerce platform.

Page Contents

Getting Started

Overview

Accessing the Foundation Console

 

Infosys Equinox or your systems integrator will create one or more businesses with the appropriate configurations and microservices enabled for your company, during implementation.

The Foundation microservice gives business admins the ability to manage business and microservices settings as well as to create and manage stores for the business.

For a detailed overview of the Foundation microservice, see the Foundation Microservice Overview.

Business On-Boarding Workflow

Once a company has received its Infosys Equinox Commerce deployment, business admins are tasked with setting up the commerce infrastructure for the business. This process will vary based on the setup and needs for each business, below is a possible onboarding workflow for a business admin with a new implementation of Infosys Equinox Commerce:

  • Planning
    • Identify the store or stores to be created and gather their relevant details (for example, type, name, locales, and currencies supported, etc.).
    • Identify the microservices required for each store and whether each store will use a separate instance of each microservice or whether stores will share the same instance of one or more microservices (for example, cart and checkout, orders, inventory).
    • Identify company employees who will serve as editors and managers for each microservice.
  • Collection Management
    • Create collections within a business and configure these collections for each store per Infosys Equinox Commerce microservice (for example, promotion, inventory, customer, etc.)
  • Store Management
    • Create and configure store(s).
    • Associate the appropriate collection of each microservice with the appropriate store(s).
  • Authorization Management
    • Create Infosys Equinox Commerce accounts for microservice editor and manager roles (for example, Catalog Editors, Catalog Managers, Customer Service Representatives (CSRs), etc.)

For example, say Business X has four stores (for example, XS1, XS2, XS3, and XS4) with a separate and distinct catalog, price list, and promotion data and configurations. However, all four stores may use the same cart, order, and customers (user) microservice configurations. In this case, the following collections will need to be created for Business X:

image alt text

Service Glossary

  • Business – the parent of a store or set of stores. The basic use of a business is to manage common sets of users, catalogs, and other services for the stores associated with the business.
  • Business Admin – a role that manages business settings, creates and manages stores, and enables microservice(s) for a business.
  • Collection – provides a set of properties that control the behavior of the microservice when launched. Allows Business Admins to set up different information for each store so that a Business can have multiple stores, each with its own configuration for a specific microservice.
  • Microservice – a self-contained application that is the building block of a loosely coupled services architecture consisting of other microservices. The Infosys Equinox Commerce platform version 8.0 includes the following microservices:
    • Foundation
    • Accounts (B2B)
    • Address
    • Authorization
    • Cart
    • Catalog
    • Customers (Users)
    • Feeds
    • Inventory
    • Lists
    • Loyalty
    • Merchandising
    • Notification
    • Orders
    • Payment
    • Pricing
    • Promotions
    • Ratings and Reviews
    • Search
    • Shipping
    • Subscription
    • Tax
  • Store – represents a specific physical location or online store of a business.
  • Storefront – a consumer-facing website that presents products, content, and promotions across multiple channels such as desktop, tablet, and mobile.

Accessing the Foundation Console

top | Configuring Search Parameters

Infosys Equinox’s cloud-based solution (SaaS) offers the option to enable multi-factor authentication (MFA) at the Business instance level for admin users. By default, all admin users are required to enter an email ID and password to log in. But with MFA, the admin users can be required to pass an additional security check with a unique and random OTP (One Time Password) code sent via email or SMS.

To access the Foundation console, 

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox): 
    image alt text
    If the MFA has not been enabled, the All Businesses page appears:If the MFA has been enabled, a random and unique OTP code is sent to the Admin user’s email address or SMS number. For example,
  2. Enter the unique OTP from the email or SMS to access the system:

If an incorrect OTP is provided, the system blocks access and displays a verification error message:

After reaching a configurable failed retry threshold, the admin user is redirected back to the login screen to enter a valid email address and password again before the system will send a new OTP for verification.

Note: MFA is configurable to include things like the number of failed retry attempts, the number of times a code can be sent, etc. Additionally, it can be configured to accept verification via email, SMS, or both.

Configuring Search Parameters

Accessing the Foundation Console | All Businesses Page

In the Foundation landing page, you can search the businesses based on Business Name, Business ID, Default Locale, Default Currency, and/or Business Status, modify the search fields as needed, and select the number of pre-defined rows per screen.

Searching for Business(es)

To search for business(es),

  1. Click the Business Name, Business ID, Default Locale, Default Currency, and/or Business Status drop-down list in the header to open an entry field to provide search criteria.
    Note: For displaying a predefined number of businesses per screen, see Selecting Predefined Rows.
  2. Enter the desired search criteria in the search field:
  3. Click the Go button.
    The business(s), which matches the search criteria appears:

Modify Searchable Fields

To modify the searchable fields,

  1. Click the vertical ellipse available at the beginning of the search field.
  2. Select or deselect the items to add or remove the searchable fields in the header:
  3. Click the Go button.
    The selected searchable fields appear in the header:

Selecting Predefined Rows

By default, 10 businesses per screen will appear, but the number of businesses per screen can be modified as follows:

  1. Click the row select option at the bottom-left of the page.

    Foundation_Business_RowSelect
  2. Select the desired number of rows:
    Foundation_Business_RowSelectInputs
    A list of businesses appears as per the row selection:
    Foundation_Business_RowSelectResult

Managing Businesses

Configuring Search Parameters| Revision History

In the All Businesses page, you can:

Note:

  • Pagination option appears in all screens that contain the businesses’ information.
  • To navigate to the next page, click the page number.

Creating a New Business

For creating a business, see the video given below or refer to the step-by-step instructions.

To create a new business,

  1. In the All Businesses page, click the Add a Business button.
    The Create Business page appears:
  2. Enter/select the following required information:
    Field Description
    Business Name* 

    Enter a name that describes the business.

    Storage Service Link

    Enter the cloud storage location for system files. For example, https://s3.amazonaws.com.infosysequinox.stage.store.atfingertips.com
    Note: This field is not in use. It is used for reference purpose only.

    CDN Link

    Enter the Content Delivery Network link. For example, https://d16rliti0tklvn.cloudfront.net
    Note: This field is not in use. It is used for reference purpose only.

    Default Locale

    Select the default locale of the business. 
    Note: This field is not in use. It is used for reference purpose only.

    Default Currency

    Select the default currency of the business.
    Note: This field is not in use. It is used for reference purpose only.

    Events

    Enable or disable the event management system for the business. This field is mainly used for the SaaS business model. If enabled, it creates business-specific secrets and enables the API gateway.

    Sample Data

    Enable this flag to set up the business with sample data (for a B2C/B2B store and the applicable microservices). All the background data is set up for the business via feeds. Once completed, you will have a sample storefront setup readily for the business.
    Note: If you disable this flag, you need to set up the business data manually.

    Business Logo

    Upload the business logo.

    Note: Fields marked with * are mandatory.
  3. Click the Create button to save the newly created business. The Business Overview page appears with the following tabs:
  • Note: Once the business has been created, on the All Businesses page you can view or edit the created business details.

Editing a Business

To edit a business, perform the following steps:

In the All Businesses page, click a particular business:
Foundation_Select_Business

The Business Overview page appears with the following tabs:

Business Overview Page

In the Business Overview page, you can:

Editing Business Information

To edit the business information,

  1. In the Business Information tab, update the required business details:
  2. Click the Save button to save the updated business details.

Enabling or Disabling Microservices

In the Available Microservices page, a super admin user can enable the required microservices opted by the client.

Note:

  • The disabled microservice(s) cannot be associated with the stores within the business.
  • If the client opts for a third-party service instead of the enabled service, the super admin can uncheck the service.

To enable or disable the microservices available under the business,

  1. In the Business Overview page, click the Available Microservices tab:
    Foundation_All_Businesses
  2. Select the desired microservice(s) for your business.
    Foundation_Available_Microservices_Save
    Note: Only the selected microservice will be available for use within the business.
  3. Click the Save button.

Managing Keys and Credentials

When you create a business, two or three sets of security keys and credentials will be created for the business instance, automatically. In the Keys & Credentials tab, a business admin can view:

image alt text

Note: API Gateway Keys and RabbitMQ Credentials will be hidden if the Events slider is disabled under the Business Information tab.

Business Secret Keys
Overview

To invoke all Infosys EquinoxAPI(s), you need to use x-auth-token. The business secret key is the key, which allows you to generate x-auth-token (JWT token). Each business will have its own business secret key. This business secret key restricts other business(es) to access its data.

When the business requires refreshing the business secret key, the business admin can contact the Infosys Equinox Commerce admin. The Infosys Equinox Commerce admin creates a new business secret key. An email is sent to the business admin about the new business secret key creation. In addition, the newly created business secret key is displayed in the Business Secrets Keys section. A business can have a maximum of two active business secret keys. The Infosys Equinox Commerce admin can terminate the old business secret key if the business requires.

Viewing Business Secret Keys

To view a business secret key, in the Business Secret Keys section, click Show against Business Secret Keys:

The business secret key is displayed:

Note: To refresh or terminate the business secret key, contact Infosys Equinox Commerce admin.

API Gateway Keys
Overview

All Infosys Equinox API request(s) in Infosys Equinox Cloud must go through the API gateway with the API gateway key. The API gateway key is used for metering and throttling in the API gateway and authenticate the API(s) at the API gateway layer. Each business will have its own API gateway key, which must be used in its request.

When the business requires refreshing the API gateway key, the business admin can contact the Infosys Equinox Cloud admin. The Infosys Equinox Cloud admin creates a new API gateway key for the business. An email is sent to the business admin about the new API gateway key creation. The newly created API gateway key is displayed in the API Gateway Keys section. A business can have any number of active API gateway keys. An Infosys Equinox Cloud admin can terminate the API gateway key(s) if the business requires.

Viewing API Gateway Keys

To view an API gateway key, in the API Gateway Keys section, click Show against API Gateway Keys.

The API gateway key(s) and its creation date are displayed.

Note:

  • A business is allowed to use any of the available API gateway keys in this list.
  • To refresh or terminate the API gateway key, contact Infosys Equinox Cloud admin.
RabbitMQ Credential
Overview

A business admin can view the login credential in the RabbitMQ Credentials section and use this login credentials to configure the RabbitMQ for consuming the events in the Infosys Equinox Cloud or Enterprise.

Viewing Login Credential

To view the credential, in the RabbitMQ Credentials section, click Show against Credential:

The login credential is displayed.

Configuring Custom Properties

In the Advanced tab, business admins can add and/or view custom properties to customize the implementation.

Foundation_Additional_Properties

To add a custom property,

  1. In the Advanced tab, click the Add Properties button.
  2. Enter a property name and its value:Foundation_Additional_Properties_Inputs
  3. Click the Save button to save the added custom property:
    Foundation_Additional_Properties_Save
    Note: To add another custom property, click the Add Properties button again.

Managing Stores 

In the All Stores page, you can:

Foundation_Stores

Note:

  • To view the pages specific to the roles such as business admin or store ops, use the Go to menu available at the top-right side of the All Stores page.
  • Pagination option appears in all screens that contain the stores’ information.
  • To navigate to the next page, click the page number.

Configuring Search Parameters for a Store

Searching for Store(s)

To search for Store(s),

  1. Click the Store Name, Store ID, Store Type, Store Status, and/or Default Locale drop-down option in the header to open an entry field to provide search criteria.
  2. Enter the desired search criteria in the search field, and then click the Go button:
    The Store(s), which matches the search criteria appears.

Modifying Searchable Fields

To modify the searchable fields,

  1. Click the vertical ellipse available at the beginning of the search field.
  2. Select or deselect the items to add or remove the searchable fields in the header:
    The selected searchable fields appear in the header:

    Note: To reset the search field in the header, click the Reset button.

Selecting Predefined Rows

By default, 10 stores per screen will appear, but the number of categories per screen can be modified as follows:

  1. Click pages drop-down option located at lower left in the All Stores page.
  2. Select 10 Rows25 Rows, or 50 Rows from the drop-down list.
  3. Click the Go button. The selected rows of categories appear on the screen.
    Note: To reset the search field in the header, click the Reset button.

Creating a Store

A Business Admin can create a store. By default, the Store Ops is shown in All Stores page. 

For creating a store, see the video given below or refer to the step-by-step instructions.

To create a store, perform the following steps:

  1. Click Go to in the upper right of the screen.
  2. Select Business Admin to view the Business Admin’s All Stores page.
  3. Click the Add a Store button on the All Stores page. The Create Store page appears:
    Foundation_CreateStore
  4. Enter/select the following required information:
    Field Description
    Store Name*

    Enter a name that describes the store.

    Store ID

    This field is generated automatically.

    Time Zone*

    Select the time zone of the store.

    Store Type*

    Select the type of store, it can be:

    • Business to Business to create a B2B store.
    • Business to Customer to create a B2C store.
    Locales*

    Select a list of locales of the store.

    Default Locale*

    Select the default locale of the store.

    Ship To Regions*

    Select a list of regions, where the items can be shipped.

    Default Ship To Region*

    Select the default ship-to-region of the store.

    Currencies*

    Select a list of currencies of the store.

    Default Currency*

    Select the default currency of the store.

    Status

    When the status of a store is made inactive, the store will not be picked up by the business.

    Select:

    • Active to activate the store.
    • In-Active to deactivate the store. Later, you can change the status to ‘Active’ if required.
    Auto-associate collections

    Enable this toggle to create the collections for all the applicable microservices and associate them with the store automatically. 
    Note: When this toggle is disabled, you need to create the collections and associate them with the store manually.

    Note: Fields marked with * are mandatory.
  5. Click the Create button to create a store.

Store Overview Page

View the Store Overview page by clicking a particular store.

Foundation_EditStore

Note: Click the Edit button against a particular store to edit it. For more details, see edit a store.

The Store Overview page appears:

Foundation_StoreOps_StoreOverview

In the Stores Overview page, you can:

Editing a Store

To edit a store,

  1. Click the Edit Store button on the Store Overview page.
    Foundation_StoreOps_EditStore.png
    The Store detail page appears:
    Foundation_ViewStore
  2. Make necessary changes as required under the Store Info tab.
  3. Click the Save button.
    Note: To discard the changes, click the Cancel button.

Associating Microservice Collections with a Store

Before associating microservice collections with a store, you need to configure the collections. To configure the collections, see Managing Collections of a Microservice.

For associating microservice collections with a store, see the video given below:

To associate microservice collections with a store,

  1. In the Store Overview page, click the Service Association tab.
    Foundation_AssociateStore
    The Service Association tab of the Store Overview page appears:
    Foundation_ServiceAssociation
  2. Click the edit icon against a particular microservice to change the collection association.
    Foundation_ServiceAssociationPen
  3. Select a collection, to which you want to associate the store.
    Foundation_ServiceAssociation_Collection
    Configure service-wise specific instructions:
    Pricing:
    You can associate a Pricing Collection with one or more shipping regions. If you are associating more than one shipping region, you need to associate each shipping region with a price list or price rule. A price list or price rule varies for each region. For more information, refer to the sections given below:
  4. Click the Associate button to associate the collection with the store.
  5. Click the Save button after associating the required microservice collections with the store.

Foundation_ServiceAssociationSave

Associating a Pricing Collection with a Price List or Price Rule

To associate a Pricing Collection with a price list or price rule,

  1. In the selected collection, select the required price list under the Pricelist Name column.
    Note: You can use the search option to find a specific price list.
  2. Enable the Enable Price Rule toggle if you want to add a price rule for the selected collection.
  3. In the selected collection, select the required price rule under the Price Rule Name column.
    Note:

Associating a Pricing Collection with Multiple Shipping Regions

To associate a Pricing Collection with multiple shipping regions,

  1. In the Store Info tab, select the required shipping regions.
    The locales of the selected shipping regions are listed for the Pricing in the Service Association tab:
    Note: For more information, refer to Editing a Store.
  2. Go to the Service Association tab, click the Add button to add the remaining shipping region(s).
     Another Pricing collection row appears in the Service Association tab.
  3. Select a locale of the shipping region to be associated in the newly added Pricing collection row.
    Note:

Adding Store Specific Properties

In the Advanced tab of the Store Overview page, the Business Admins can add and/or view custom properties to customize the implementation.

To add custom properties:

  1. Click the Advanced tab on the Store Overview page.Foundation_ServiceAssociation_Advanced
  2. In the Advanced tab of the Store Overview page, click the Add Properties button.
    Foundation_Store_Additional_Properties
  3. Provide a property name and its value. Foundation_Store_Additional_Properties_InputsFor example, you can give any one of the below properties:
    Property Key Description
    siteURL Specifies the React storefront URL to be launched to use the Act on Behalf feature in the Customers service. The format is https://<<DomainName>>.infosysequinox.ommerce.com/
    guestUserProfileEnabled

    Specifies whether a guest user session is created for each request from the storefront or not. The value can be:

    • true – Indicates a guest user session is created for each request from storefront.
    • false – Indicates a guest user session is created for the storefront. In this case, a common session ID is created and stored in the cache which enables to retrieve for each request.
    The default value is true.
  4. Click the Save button to save the custom properties.
    Note: You can add more custom properties by repeating the above procedure.

Updating StoreFront Orchestration Specific Properties

In the SF Orchestration Properties tab of the Store Overview page, business admin can update and/or view the below storefront orchestration specific properties:

Service Property Key Description
Customers Allow customer deletion Specifies whether the customer deletion is allowed or not. When this toggle is enabled, a CSR can be allowed to delete a customer account. 
Retention period for customer deletion Specifies the retention period of the customers before deleting them.
Google Places API Key Holds the Google places API key which is used to access the Google Places APIs.
Inventory Enable Inventory Check Specifies whether the inventory check is allowed or not.
Include Out Of Stock Specifies whether the out-of-stock products are shown on the storefront site (for example, in the PLP, PDP pages) or not. Enable this toggle to show out-of-stock products on the storefront site.

Foundation_SFO_Properties

To update the storefront orchestration specific properties:

  1. In the SF Orchestration Properties tab of the Store Overview page, make the required updates in the available SFO properties.
    Foundation_SFO_PropertiesPage
  2. Click the Save button to update the storefront orchestration specific properties.

Managing Store Operations

To launch a Store Ops page,

  1. In the All Stores page, click a particular store:

    It displays the Store Overview page:
    Foundation_StoreOps
    Note: To edit the store details, see Editing a Store.
  2. Click the Store Ops button on the Store Overview page.
    The Store Ops page appears:
  3. In the Store Ops page:

Indexing and Publishing the Store Data

Infosys Equinox Commerce allows you to:

Initially, you need to index the store data in the authoring environment and then publish them in the live environment to bring the changes to the storefront.

You need to refer to the following sections to understand the prerequisites required before running the feed and steps required for indexing or publishing the data.

Indexing the Store Data

The Catalog, Pricing, and Merchandising data should be indexed in the store’s SOLR collections to obtain the product/SKU details to the storefront.

Depending on your business requirements, in Infosys Equinox Commerce, you can opt for any one of the following indexing types:

Full Indexing

Infosys Equinox Commerce allows you to run full indexing when you want to index the entire catalog and pricing or merchandising data available in the respective collections associated with the store.

You can run full indexing for:

  • Catalog and Pricing – to index the entire product and SKU details along with the pricing information.
  • Merchandising – to index the entire categories and site navigation details.
Full Indexing the Catalog and Pricing Data

Prerequisites

Before you run full indexing for catalog and pricing, ensure you have a valid catalog and pricing data in the collection’s default project.

Note: For successful indexing, there must be an active product(s) containing at least one active SKU with valid pricing information.

Scenarios for Not Indexing a Product

A product will NOT be indexed in the following scenarios:

  • If the status of the product is inactive.
  • If the current date does not fall between the start and end date and time of product and/or SKUs. It is considered as expired.
  • If the product does not have any active SKUs associated with it.
  • If there is NO pricing information for ANY of the SKUs associated.

Steps for Full Indexing Catalog and Pricing Data

To run a full indexing feed on the catalog and pricing data,

  1. In the Store Ops page, click the Refresh/Publish Data dropdown.
    A list of indexing and publishing options appears.
  2. Select the option Full Indexing – Catalog & Pricing only in the Refresh/Publish Data dropdown.
  3. Click the Go button.
    The Refreshing Data popup appears.
  4. Click the Proceed button to trigger the full indexing process of catalog and pricing data.
    Note:
    • To ignore indexing the data, click the Cancel button.
    • Once the full indexing process is triggered, you will get a success message.
    • Once the feed is triggered successfully, the progress of the feed can be viewed in the Feed History page. For more information, see Viewing a Feed History.
Full Indexing the Merchandising Data

Prerequisites

Before you run full indexing for merchandising, ensure you have valid merchandising data in the collection’s default project.

Note: For successful indexing, there must be active categories containing valid milestones.

Scenarios for Not Indexing a Category

A category will NOT be indexed in the following scenarios:

  • If the status of the category is inactive.
  • If the category does not have any active milestones associated with it
  • If the category does not have any valid milestones (milestones applicable for the current period) associated with it.
  • If the category is NOT mapped to any of the valid site navigation milestones.

Steps for Full Indexing Merchandising Data

To run a full indexing feed on the merchandising data,

  1. In the Store Ops page, click the Refresh/Publish Data dropdown.
    A list of indexing and publishing options appears.
  2. Select the option Full Indexing – Merchandising only in the Refresh/Publish Data dropdown.
  3. Click the Go button.
    The Refreshing Data popup appears.
  4. Click the Proceed button to trigger the full indexing process of merchandising data.
    Note:
    • To ignore indexing the data, click the Cancel button.
    • Once the full indexing process is triggered, you will get a success message.
    • Once the feed is triggered successfully, the progress of the feed can be viewed in the Feed History page. For more information, see Viewing a Feed History.
Delta Indexing

Infosys Equinox Commerce allows you to run delta indexing when you want to index only the changes made in the catalog or pricing data available in the respective collections associated with the store. Here, the changes are made after the previous delta indexing or full indexing.

You can run the delta indexing for:

  • Catalog Data – to index only the changes made in the catalog data.
  • Pricing Data – to index only the changes made in the pricing data.
Delta Indexing the Catalog Data

Prerequisites

Before you run delta indexing for catalog, ensure you have a valid updated catalog data in the collection’s default project.

When this feed is triggered, any changes made to the existing products and/or SKUs and newly added products and/or SKUs will be indexed.

Scenarios for Not Indexing a Product

A product will NOT be indexed in the following scenarios:

  • If the status of the product is inactive.
  • If the product does not have any active SKUs associated with it.
  • If there is NO Pricing information available in the associated SKUs.

Steps for Delta Indexing the Catalog Data

To run a delta indexing feed on the catalog data,

  1. In the Store Ops page, click the Refresh/Publish Data dropdown.
    A list of indexing and publishing options appears.
  2. Select the option Delta Indexing – Catalog only in the Refresh/Publish Data dropdown.
  3. Click the Go button.
    The Refreshing Data popup appears.
  4. Click the Proceed button to trigger the delta indexing process of catalog data.
    Note:
    • To ignore indexing the data, click the Cancel button.
    • Once the delta indexing process is triggered, you will get a success message.
    • Once the feed is triggered successfully, the progress of the feed can be viewed in the Feed History page. For more information, see Viewing a Feed History.
Delta Indexing the Pricing Data

Prerequisites

Before you run delta indexing for pricing, ensure you have a valid updated pricing data in the collection’s default project.

Steps for Delta Indexing the Pricing Data

To run a delta indexing on the pricing data,

  1. In the Store Ops page, click the Refresh/Publish Data dropdown.
    A list of indexing and publishing options appears.
  2. Select the option Delta Indexing – Pricing only in the Refresh/Publish Data dropdown.
  3. Click the Go button.
    The Refreshing Data popup appears.
  4. Click the Proceed button to trigger the delta indexing process of pricing data.
    Note:
    • To ignore indexing the data, click the Cancel button.
    • Once the delta indexing process is triggered, you will get a success message.
    • Once the feed is triggered successfully, the progress of the feed can be viewed in the Feed History page. For more information, see Viewing a Feed History.

Publishing the Store Data

Infosys Equinox Commerce allows you to publish the Catalog, Pricing, Merchandising, Promotions, Foundation, Accounts, and Search data from the authoring environment to the production environment. 

Depending on your business requirements, in Infosys Equinox Commerce, you can opt for any one of the following publishing types: 

Full Publishing the Store Data

This option publishes the complete store data [such as Catalog, Pricing, Merchandising, Promotions, Foundation, Accounts (applicable for B2B), and Search] from the authoring environment to the production environment.

Prerequisites

Before you run the full publish feed, you need to ensure the following:

  • Availability of a valid Catalog, Pricing, Promotions, and Merchandising data in the respective collection’s default project. However, the Accounts and Foundation data are published directly to the production environment. 
  • Index the data ONLY in the authoring environment’s SOLR server before publishing it to the production environment.

Steps for Full Publishing the Store Data

To publish the complete store data,

  1. In the Store Ops page, click the Refresh/Publish Data dropdown.
    A list of indexing and publishing options appears.
  2. Select the option Full Publish in the Refresh/Publish Data dropdown.
  3. Click the Go button.
    The Publish Store Data popup appears.
  4. Click the Proceed button to trigger the full publishing process of the store data.
    Note:
    • To ignore publishing the data, click the Cancel button.
    • Once the full publishing process is triggered, you will get a success message.
    • Once the feed is triggered successfully, the progress of the feed can be viewed in the Feed History page. For more information, see Viewing a Feed History.
    • For re-triggering a failed publish feed, see Retriggering a Failed Publish Feed.
    • Full publish process triggers the publishmaster feed. The publishmaster feed triggers the following applicable feeds:
      • catalogpublish
      • searchpublish
      • merchandisepublish
      • promotionspublish
      • pricepublish
      • accountpublish
      • foundationpublish
        These feeds publish the data from the respective services to the production environment.
Full Publishing the Promotions Data

This option publishes the complete store data of the Promotions microservice from the authoring environment to the production environment.

Prerequisites

Before you run the full publish feed, you need to ensure the following:

  • Availability of a valid Promotions data in the respective collection’s default project. 
  • Index the data ONLY in the authoring environment’s SOLR server before publishing it to the production environment.

Steps for Full Publishing of the Promotions Data

To publish the promotions data,

  1. In the Store Ops page, click the Refresh/Publish Data dropdown.
    A list of indexing and publishing options appears.
  2. Select the option Promotion Full Publish in the Refresh/Publish Data dropdown.
  3. Click the Go button.
    The Publish Store Data popup appears.
  4. Click the Proceed button to trigger the full publishing process of the store data.
    Note:
    • To ignore publishing the data, click the Cancel button.
    • Once the full publishing process is triggered, you will get a success message.
    • Once the feed is triggered successfully, the progress of the feed can be viewed in the Feed History page. For more information, see Viewing a Feed History.
    • For re-triggering a failed publish feed, see Retriggering a Failed Publish Feed.
    • The full publish process of the promotions data triggers the publishmaster feed. The publishmaster feed triggers the promotionspublish feed. The feed publishes the data from the Promotions microservice to the production environment.
Delta Publishing the Store Data

This option publishes ONLY the latest changes made to the store data [such as Catalog, Pricing, Merchandising, Foundation, Accounts (applicable only for B2B), and Search] from the authoring environment to the production environment.

Prerequisites

Before you run the delta publish feed, you need to ensure the following:

  • Availability of a valid Catalog, Pricing, and Merchandising data in the respective collection’s default project. However, the Accounts and Foundation data are published directly to the production environment. 
  • Index the data ONLY in the authoring environment’s SOLR server before publishing it to the production environment. 

Steps for Delta Publishing the Store Data

To publish only the recent changes from the store data,

  1. In the Store Ops page, click the Refresh/Publish Data dropdown.
    A list of indexing and publishing options appears.
  2. Select the option Delta Publish in the Refresh/Publish Data dropdown.
  3. Click the Go button.
    The Publish Store Data popup appears.

  4. Click the Proceed button to trigger the delta publishing process of the store data.
    Note:
    • To ignore publishing the data, click the Cancel button.
    • Once the delta publishing process is triggered, you will get a success message.
    • For re-triggering a failed publish feed, see Retriggering a Failed Publish Feed.
    • Once the feed is triggered successfully, the progress of the feed can be viewed in the Feed History page. For more information, see Viewing a Feed History.
    • Delta publish process triggers the publishmaster feed. The publishmaster feed triggers the following applicable feeds:
      • catalogpublish
      • searchpublish
      • merchandisepublish
      • pricepublish
      • accountpublish
      • foundationpublish
        These feeds publish the data from the respective services to the production environment.

Launching the Admin Console via the Store Operations Page

To launch the admin console of a microservice, click a particular service.
Save Metadata

Configuring Collections for Microservices

In the Business Overview page, click Microservices in the left navigation panel. It shows All Microservices page:

Foundation_MicroservicesPage

The All Microservices page can be used to navigate to collections of a microservice.

Note:

  • If a microservice does not appear in All Microservices page, it indicates it has not been added for the Business.
  • If a microservice appears in All Microservices page but does not have an arrow, it indicates it has been disabled for the Business and cannot be configured.

Navigating to Collections of a Microservice

To navigate to the collections of a microservice, click a microservice:

Foundation_MicroservicesPageArrow

It shows the collections management page of the microservice:

Foundation_Microservices_Collections

Note:

  • Pagination option appears in all screens that contain the collections’ information.
  • To navigate to the next page, click the page number.

Managing Collections of a Microservice

In the collections management page of a microservice, you can:

For managing collections of a microservice, see the video given below or click the above links for step-by-step instructions:

Creating a Collection for the Microservice

To create a collection,

  1. In the collections management page of the microservice, click the Create Collection button:
    Foundation_Microservices_CollectionsCreate
    The Create Collection page appears.
  2. Enter/select the following required information:

    Field Description
    Collection Name*

    Enter the name of the collection.

    Collection Description*

    Enter a description that describes the collection.

    Status

    Enable or disable the status of the collection. You can:

    • enable the toggle to activate the collection. It allows picking the collection by a business.
    • disable the toggle to deactivate the collection. It does not allow picking the collection by a business.
    Collection Properties

    Update the values of the collection properties.

    Note: Fields marked with * are mandatory.
  3. Click the Create button to create the collection.Foundation_Microservices_CollectionsCreatePage

Note: To know about the collection properties of the microservice, refer to Available Collection Properties.

Configuring a Collection of the Microservice

To configure a collection:

  1. In the collections management page of the microservice, click the Configure button against a collection
    Foundation_Microservices_CollectionsConfigure
    Note: You can open the Feeds dashboard of the respective microservice by clicking the Feeds button.
    The Configure Collection page appears.
  2. Update the required information.Foundation_Microservices_CollectionsUpdate
  3. Click the Save button to configure the collection.

Launching the Admin Console via the Collections Management Page

To launch the admin console, in the collections management page of the microservice click the Launch button against a collection:
Foundation_Microservices_CollectionsLaunch
Note: You can open the Feeds dashboard of the respective microservice by clicking the Feeds button.

The admin console page of the microservice appears:

Foundation_Microservices_CollectionsLaunchPage

Available Collection Properties

Below is the list of available collection properties, by service.

MICROSERVICE LINK
Accounts Collection Properties
Address Collection Properties
Authorization Collection Properties
Cart Collection Properties
Catalog Collection Properties
Customers (User) Collection Properties
Inventory Collection Properties
Lists Collection Properties
Loyalty Collection Properties
Merchandising Collection Properties
Notification Collection Properties
Order Collection Properties
Payment Collection Properties
Pricing Collection Properties
Promotions Collection Properties
Search Collection Properties
Shipping Collection Properties
Subscription Collection Properties
Tax Collection Properties

Managing Teams

In the Team page, a user can be invited and. or role is assigned to a user.

In the Team page you can:

Note:

  • Pagination option appears in all screens that contain the teams’ information.
  • To navigate to the next page, click the page number.

Inviting User(s) as a Business Admin

To invite user(s) as a business admin, 

  1. Click the Team in the left navigation pane.
  2. Click the Invite Members button.
  3. In the Email Address section, enter the required email address(es).
  4. Enable the Business Admin.
    image alt text
  5. Click the Send Invite button.
    The following confirmation message is displayed on the screen:
    image alt text
    The Business Admin receives an email for creating an Infosys Equinox Commerce account.
  6. Click the ACTIVATE button in the email.
    image alt text
  7. In the User Registration form, enter the necessary details and click the Register button.
    After successful registration, the Business Admin can log in to the Infosys Equinox Commerce console by entering the registered email ID and password. The console displays only those business(es) for which that Business Admin has privileges to access and manage.

Inviting User(s) as a Business User

To invite user(s) and assign them the roles, 

  1. Click the Team in the Left Navigation panel.
  2. Click the Invite Members button.
    The Invite User page appears:
    image alt text
  3. In the Email Address section, enter the required email address(es).
  4. In the Role section, select an appropriate role that is associated with the microservice.
    For example, selecting the role ROLE_PROMOTION_EDITOR provides the user with editor role in the Promotion Admin console.
  5. In the Store section, select the required store.
    Note: To add multiple roles for a store, click image alt text and repeat the above steps 4 and 5.
  6. Click the Send Invite button.
    The following confirmation message is displayed on the screen:
    image alt text
    The Business User receives an email for creating an Infosys Equinox Commerce account.
  7. Click the ACTIVATE button in the email.
    image alt text
  8. In the User Registration form, enter the necessary details and click the Register button.
    After successful registration, the Business User can log in to the Infosys Equinox Commerce console by entering the registered email ID and password. The console displays only those business(es) for which that Business User has privileges to access and manage.

Managing Feeds

You can manage the feeds of the Catalog, Pricing, Merchandising, and Promotions microservice via the Feeds dashboard. Each feed can contain multiple feed jobs. Each feed job can contain multiple schedules.

Note: You can also view the feeds of a specific microservice collection, from the collections management page. For more details, see Managing Collections of a Microservice.

With the Foundation Feeds dashboard, you can:

Viewing the Job Schedules of a Feed Job

To view the job schedules of a feed,

  1. In the Foundation homepage, click Feeds in the left navigation panel.
    image alt text
    The Feeds page is displayed:
    image alt text
  2. Click on a feed to view the feed details and feed jobs.
    image alt text
    Note: If you want to view the running details of a feed job, click History of a feed job.
  3. Click on a feed job to view the job details and schedules.
    image alt text
    The feed job details and schedules are displayed:
    image alt text

Viewing Running Details of a Feed Job

To view the running details of a feed job,

  1. Navigate to the Job Details and Job Schedules page. For more information, refer to View the Job Schedules of a Feed.
  2. Click History in the left navigation panel:
    image alt text
    The history of running job schedules with History IdRun Request IdStatusStart Time, and End Time are displayed:

Editing a Feed Job

You can edit a feed job using the edit icon on the Job Details page.

To edit a feed job,

  1. Navigate to the Job Details and Job Schedules page. For more information, refer to View the Job Schedules of a Feed.
  2. Click the edit icon:

    The feed job details appear:
  3. Edit the details.
    The following table provides the field description to edit a feed job:
    Field Description
    Name Update the name of the feed job.
    Description Update the description of the feed job.
    Status Change the status to any one of the following:
    • ACTIVE – active feed jobs will be triggered
    • INACTIVE – inactive feed jobs will not be triggered
    Max Run Time Update the maximum running time (in seconds) of the feed job. The feed will be terminated if it exceeds the maximum running time limit.
    + Add Job Params Click the + Add Job Params button to add another job parameter with a Property Key and Property Value.
    Note: This property key-value pair impacts the configuration of the active job execution.
  4. Click the Save button to save the updated feed job details.

Edit or Retrigger a Job Schedule

To edit or retrigger a job schedule,

  1. Navigate to the Job Details of a feed. For more information, refer to View the Job Schedules of a Feed.
  2. Click on the desired job schedule:image alt text The schedule details are displayed:
    Note: To retrigger the schedule, click the Retrigger button.
  3. Click the edit icon.
  4. Edit the details.
    The following table provides the field description to edit a feed job schedule:
    Field Description
    Name Update the name of the job schedule.
    Description Update the description of the job schedule.
    Status Change the status to any one of the following:
    • ON DEMAND – the feed job is triggered immediately if it is scheduled to run the feed.
    • INACTIVE – the feed will not be triggered.
    • SCHEDULED – the feed job will be triggered repeatedly in a given interval of time. The time interval is specified in the field Repeat Interval.
    Feed Interval Specify the period between feed schedules (in seconds). The feed Start Time is updated based on Feed Interval.
    Repeat Interval Update the frequency interval in seconds. The feed will be triggered repeatedly by this interval.
    Last Run Time Update the last running time of the feed job.
    Max Run Time Update the maximum running time (in seconds) of the feed job. The feed will be terminated if it exceeds the maximum running time limit.
    Start Time Update the start time of the feed job.
    End Time Update the end time of the feed job.
    + Add Job Params Click the + Add Job Params button to add another job parameter with a Property Key and Property Value.
    Note: This property key-value pair impacts the configuration of the active job execution.
  5. Click the Save button to save the updated job schedule details.

Working with Feeds

The feeds that run within the Infosys Equinox Commerce platform is shown in the Feed History page.

In the Feed History page, you can:

Searching for Feed(s)

To search for feed(s):

  1. Click Feed History in the Left Navigation panel.
  2. Click the Feed Name, Service, Collection ID, Request ID, Start Time (UTC), End Time (UTC), Status and/or Service drop-down options in the header to open an entry field to provide search criteria.
  3. Enter the desired search criteria in the search field, and then click the Go button:
    The feed(s) that matches the search criteria appears.
    Note: To reset the search field in the header, click the Reset button.

Viewing Feeds

To view feed(s), click the Feed History tab in the left panel.
A list of feeds with their status appears in the Feed History page:

The status of the feeds are as follows:

Status Description
LAUNCHING Indicates the feed is initiated.
RUNNING Indicates the feed is in progress.
CANCELLED Indicates the feed is canceled.
COMPLETE Indicates the feed is completed.
FAILED Indicates the feed is failed.
ERROR Indicates an error in the feed.
UNKNOWN Indicates the status of the feed is unknown.

Viewing a Feed Details

To view particular feed details,

  1. Click the Feed History tab in the left panel.
    A list of feeds appears in the Feed History page:
  2. Click a particular feed history.
    The Feed Details page appears as shown below:

    Note:
    • To go back to the feed history, click the Feed History tab or click Feed History in the breadcrumb.
    • If you want to view the publishmaster feed, you can click and view the following feed details and status: catalogpublish, searchpublish, merchandisepublish, pricepublish, accountpublish, and foundationpublish.
    • For re-triggering a failed publish feed, see Retriggering a Failed Publish Feed.

Retriggering a Failed Publish Feed

To retrigger a particular publish feed,

  1. Click the Feed History tab in the left panel.
    A list of feeds appears in the Feed History page:
  2. Click a particular publishmaster feed history.
    The Feed Details page appears as shown below:
  3. Click the RE-TRIGGER button to retrigger the feed.

Modifying Predefined Rows per Screen

By default, 10 feeds per page appear, but the number of feeds per screen can be modified to 25 Rows or 50 Rows.

To modify predefined rows per screen,

  1. Click Feed History in the left panel.
  2. Select the page drop-down option in the lower left of the screen.

Configuring Auto-Refresh Option

The Feed History page can be refreshed manually or automatically every  5 seconds to display the latest history of the Feed. 

To configure auto-refresh,

  1. Click Feed History in the left panel.
  2. Enable/disable the Auto Refresh toggle located in the upper right of the screen to enable/disable the auto-refresh.
    Note: By default, the auto-refresh is enabled.

Exporting the Feed Details

To export feed details,

  1. Click Feed History in the left panel.
  2. Click the vertical eclipse located upper right of the screen.
  3. Click the Export Rows option.
    Note: It might take a few minutes to export the feed details.
    The exported Excel (.xlsx) spreadsheet is downloaded to your local system.
All Businesses Page | top

Revision History
2022-04-10 | JP – Fixed link and http issues.
2021-12-21 | AN – Updated contents for 8.11 release.
2021-02- 09 | AN – Formatted the TOC.
2020-05-25 | JP – Updated the document for Release 8.8.0.
2020-03-13 | AM – Updated content for April 2020 release.
2020-01-22 | AN – Revamped the document.
2019-09-18 | JP – Updated content for September 2019 release.
2019-06-08 | PLK – Minor copyedits.
2019-05-08 | AN – Inserted images and fixed links issues.
2019-05-04 | PLK – Updated content for April 2019 release.
2019-01-22 | PLK – Page created, content uploaded, and TOC and links added.