This page provides Business administrators a user guide for the Foundation microservice for the Infosys Equinox Commerce platform.
Getting Started
Overview
Accessing the Foundation Console
The Infosys Equinox Foundation Admin Console is a centralized interface that allows administrators to manage and configure various aspects of the Infosys Equinox platform. This console provides a comprehensive set of tools and features designed to streamline administrative tasks, enhance security, and improve user experience. With its intuitive design and user-friendly navigation, the console simplifies the process of managing users, setting permissions, configuring settings, and monitoring system performance.
Once a business is created with the appropriate configurations and enabled microservices during implementation, the business admins can manage settings, create/manage stores, invite and manage teams, assign various roles for each business tool, and so on. It also provides a list of supported countries, currencies, locales, services, store types, and time zones for business.
Two distinct capabilities available in the Foundation Admin Console that allow admins to manage the business effectively are admin and operations. Admin controls are available to store and service admins to control all administrative aspects of the business, including enabling microservices, adding a microservice collection, creating a store with domain-specific data (like MLM, Retail, Telco, and Auto), and mapping stores to services.
Operation capabilities are used by teams to manage the day-to-day operation of each of the microservices.
Business admins can:
- Switch between the admin and operations capabilities.
- Invite other users to the business.
- Customize the admin consoles.
For a detailed overview of the Foundation microservice, see the Foundation Microservice Overview.
Business On-Boarding Workflow
Once a company receives its Infosys Equinox Commerce deployment, business admins set up the commerce infrastructure. The process varies based on each business’s setup and needs. Below is a possible onboarding workflow for a new implementation:
Planning
- Identify the store(s) to be created and gather relevant details (type, name, locales, currencies, etc.).
- Determine the required microservices for each store and decide if 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 the business and configure them for each store per Infosys Equinox Commerce microservice (for example, promotion, inventory, customer).
Store Management
- Create and configure store(s).
- Associate the appropriate collection of each microservice with the 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:
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.
- Business-to-business (B2B) – a business model in which commerce transactions are carried out between two businesses.
- Business-to-customer (B2C) – a business model in which commerce transactions are carried out between a business and an end-customer (storefront user).
- Business-to-business-to-consumer (B2B2C) – this business model combines two or more businesses (B2B) and consumers (B2C) to provide comprehensive services to both businesses and customers, thereby providing mutually beneficial services.
- 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
- App Marketplace
- Authorization
- Cart
- Catalog
- Customers (Users)
- Feeds
- Feed Job
- Inventory
- Lists
- Loyalty
- Merchandising
- Notification
- Orders
- Payment
- Pricing
- Promotions
- Ratings and Reviews
- Reporting
- Rules Manager
- 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) allows enabling multi-factor authentication (MFA) at the business instance level for admin users. By default, admin users must enter an email ID and password to log in. With MFA, they must also pass an additional security check using a unique OTP (One-Time Password) sent via email or SMS.
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,
- Log in to the Foundation service for your business (URL provided by Infosys Equinox):
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, - 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 sends a new OTP for verification.
Note: MFA can be configured to set the number of failed retry attempts and the number of times a code can be sent. It also supports verification via email, SMS, or both.
Configuring Search Parameters
Accessing the Foundation Console | All Businesses Page
On 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),
- 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. - Enter the desired search criteria in the search field:
- Click the Go button.
The business(s), which match the search criteria appears:
Modify Searchable Fields
To modify the searchable fields,
- Click the vertical ellipse available at the beginning of the search field.
- Select or deselect the items to add or remove the searchable fields in the header:
- 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:
-
Click the row select option at the bottom-left of the page.
- Select the desired number of rows:
A list of businesses appears as per the row selection:
Managing Businesses
Configuring Search Parameters| Revision History
On the All Businesses page, you can:
- Create a new business
- View or edit existing businesses
- Search by business name, business ID, default locale, default currency, and/or business status
- Sort business name, business ID, default locale, default currency, and/or business status by ascending/descending order
Note:
- The pagination option appears on all screens that contain business information.
- To navigate to the next page, click the page number.
For creating a business, see the video given below or refer to the step-by-step instructions.
- On the All Businesses page, click the Add a Business button.
The Create Business page appears: - 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 purposes 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 purposes only.Default Locale Select the default locale of the business.
Note: This field is not in use. It is used for reference purposes only.Default Currency Select the default currency of the business.
Note: This field is not in use. It is used for reference purposes only.Events Enable or disable the event management system for the business. This 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/B2B2C store and the applicable microservices). All background data is set up for the business via feeds. Once completed, you will have a sample storefront set up readily for the business.
Note: If disabled, you need to set up the business data manually.Business Logo Upload the business logo.
- 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:
On the All Businesses page, click a particular business:
The Business Overview page includes the following tabs:
Business Overview Page
On the Business Overview page, you can:
- Edit business information
- Enable or disable microservices
- Manage API gateway keys, business secret keys, and RabbitMQ credentials
- Configure custom properties
Editing Business Information
To edit the business information,
- In the Business Information tab, update the required business details:
- Click the Save button to save the updated business details.
Enabling or Disabling Microservices
On the Available Microservices page, a super admin user can enable the required microservices chosen by the client.
Note:
- Disabled microservice(s) cannot be associated with the stores within the business.
-
If the client opts for a third-party service instead of an enabled service, the super admin can uncheck the service.
To enable or disable the microservices under the business,
- In the Business Overview page, click the Available Microservices tab:
- Select the desired microservice(s) for your business.
Note: Only the selected microservice will be available for use within the business. - Click the Save button.
Managing Keys and Credentials
When you create a business, two or three sets of security keys and credentials are automatically generated for the business instance. In the Keys & Credentials tab, a business admin can view:
Note: API Gateway Keys and RabbitMQ Credentials are hidden if the Events slider is disabled under the Business Information tab.
Business Secret Keys
Overview
To invoke all Infosys Equinox API(s), you need to use x-auth-token. The business secret key is the key, which allows you to generate an x-auth-token (JWT token). Each business will have its own business secret key. This business secret key restricts other business(es) from accessing its data.
When a business needs to refresh its secret key, the business admin contacts the Infosys Equinox Commerce admin. The Infosys Equinox Commerce admin creates a new secret key and notifies the business admin via email. The new secret key is also displayed in the Business Secrets Keys section. A business can have up to two active secret keys. The Infosys Equinox Commerce admin can terminate the old secret key if needed.
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 a business secret key, contact the 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 authenticating the API(s) at the API gateway layer. Each business will have its own API gateway key, which must be used in its request.
To refresh the API gateway key, the business admin contacts the Infosys Equinox Cloud admin. The Cloud admin creates a new key and notifies the business admin via email about the new API gateway key creation. The new key appears in the API Gateway Keys section. A business can have multiple active API gateway keys. The Cloud admin can terminate keys as needed.
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 an API gateway key, contact the Infosys Equinox Cloud admin.
RabbitMQ Credential
Overview
A business admin can view the login credentials in the RabbitMQ Credentials section and use them to configure RabbitMQ for consuming events in 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.
For more information, see:
Adding a Custom Property
To add a custom property,
- In the Advanced tab, click the Add Properties button.
- Enter a property name and its value:
- Click the Save button to save the added custom property:
Note: To add another custom property, click the Add Properties button again.
List of Custom Properties
This table lists out custom properties that you can configure at the business level:
Sl. # | Property | Description | Type | Possible Values | Example |
---|---|---|---|---|---|
1 | enableCustomRoles | When this property is set to:
| Boolean | true , false | true |
2 | domain | This property contains the domain details for automatic B2B or B2C store setup. | JSON | A valid JSON | [{“key”:”Telco”,”path”:”e9a42671-9438-4ee6-8f48-6d3d80e61da4″},{“key”:”Auto”,”path”:”a2fa019e-bd0b-44e4-9aaf-cd5dd1ac0b6d”},{“key”:”MLM”,”path”:”eb3a94f8-caa3-4c31-96cf-a31b00f14016″},{“key”:”Retail”,”path”:”60575c82-ad6d-448e-a081-0fd93de4e48b”}] |
3 | sheetPath | This property contains the cloud path of an Excel sheet used for automatic B2B or B2C store setup. | URL | A valid sheet path | https://d3gqeq5wcctqxw.cloudfront.net/catalogadmin |
4 | EcareBot | When this business property is set to true , the business assistant is displayed on all admin consoles. | Boolean | true , false | true |
Managing Stores
On the All Stores page, you can:
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.
- The pagination option appears on all screens that contain store 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),
- 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.
- 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,
- Click the vertical ellipse available at the beginning of the search field.
- 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:
- Click the pages drop-down option located at the lower left on the All Stores page.
- Select 10 Rows, 25 Rows, or 50 Rows from the drop-down list. 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.
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:
- Click Go in the upper right of the screen.
- Select Business Admin to view the Business Admin’s All Stores page.
- Click the Add a Store button on the All Stores page. The Create Store page appears:
- 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 store’s time zone.
Store Type* Select the store type:
- Business to Business: Creates a B2B store.
- Business to Customer: Creates a B2C store.
- E-commerce: Creates an E-Commerce store.
Note: This field is not in use. It is used for reference purposes only.
Note: You can create a B2B2C (Business-to-Business-to-Customer) store type via the store property activateB2B2C.
Locales* Select the store’s locales.
Default Locale* Select the store’s default locale.
Ship To Regions* Select regions where items can be shipped.
Default Ship To Region* Select the store’s default ship-to region.
Currencies* Select the store’s currencies.
Default Currency* Select the store’s default currency.
Status When a store’s status is inactive, it will not be picked up by the business.
Select:
- Active to activate the store.
- In-Active to deactivate the store. You can change the status to Active later if needed.
Auto-associate collections Enable this toggle to automatically create and associate collections for all applicable microservices with the store.
Note:
- When disabled, you must manually create and associate collections with the store.
- The store property
autoCreateAssociation
is created with the provided value.
Enable Backorder Enable this toggle to allow backorders in the store.
Note: When disabled, customers cannot place backorders.Enable this toggle to create and set up the store automatically with the sample data as per the selected domain. Before you enable this toggle, ensure you first enable the Auto-associate collections toggle. This triggers the automatestore feed to complete the store automation process.
Domain*
Select one of the following domains:
- Retail: Imports retail domain data into the store during the automation process.
- Auto: Imports automobile domain data into the store during the automation process.
- MLM: Imports Multilevel Marketing (MLM) data into the store during the automation process.
- Telco: Imports telecommunication domain data into the store during the automation process.
- Click the Create button to create a store.
If you have enabled the Sample Data toggle, the automatestore feed is triggered to complete the store setup steps. While the feed runs to complete the store setup:
-
- The following screen is shown while creating an empty store:
- The following screen is shown when a store is created without any data setup:
- The following screen is shown while creating an empty store:
-
- The following screen is shown before triggering the feeds automatically:
- The following screen is shown when the feeds are started, indicating the store automation process time is approximately 15 minutes.
Note: To continue the store automation process, click Ok. - The following screen is shown when a particular feed is running. It shows the progress of the feed as highlighted in the screen:
- The following screen is shown when there are errors after running the feed:
Note:
- To go back to the All Stores page, click Cancel.
- To restart the store automation process, click Retrigger.
- To view the feed (batch) histories, click the link available at the bottom.
- The following screen is shown when the feeds are successfully triggered:
- The following screen is shown when the store setup is completed successfully:
- The following screen is shown before triggering the feeds automatically:
-
- Do any one of the following:
- To open the Store Ops page of the store, click Go To Admin.
- To launch the storefront configuration page of the store, click Go To Store. To reflect the data in the storefront, you need to update the new store ID:
- To open the Store Ops page of the store, click Go To Admin.
Store Overview Page
You can view the Store Overview page at:
- Edit a store
- Associate microservice collections with a store
- Add store-specific properties
- Update storefront orchestration properties
- Manage store operations
Viewing the Store Overview Page
To view the Store Overview page,
- Click a particular store.
Note: Click the Edit button against a particular store to edit it. For more details, see Edit a store. - Click Store Overview in the left navigation panel.
The Store Overview page appears:
Editing a Store
To edit a store,
- Click the Edit Store button on the Store Overview page.
The Store detail page appears: - Make necessary changes as required under the Store Info tab.
- 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, 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,
- In the Store Overview page, click the Service Association tab.
The Service Association tab of the Store Overview page appears: - Click the edit icon against a particular microservice to change the collection association.
- Select a collection, to which you want to associate the store.
Configure service-wise specific instructions:- Catalog: Associate a specific catalog from a Catalog Collection with the store. For details, see Associating the Store and a Catalog Collection with a Catalog.
- Pricing: Associate a Pricing Collection with one or more shipping regions. For multiple regions, associate each region with a price list or price rule. A price list or price rule varies for each region. For details, refer to the sections given below:
- Inventory: Associate a specific bin from an Inventory Collection with the store. For details, see Associating the Store and an Inventory Collection with a Bin.
- Click the Associate button to associate the collection with the store.
- Click the Save button after associating the required microservice collections with the store.
Associating the Store and a Catalog Collection with a Catalog
To associate the store and a Catalog Collection with a catalog, in the selected collection, select the required catalog under the Catalog Name column.
Note:
- You can use the search option to find a specific catalog.
- To associate the selected Catalog collection with the store, continue Step 4 of Associating Microservice Collections with a Store.
Associating a Pricing Collection with a Price List or Price Rule
To associate a Pricing Collection with a price list or price rule,
- 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. - Enable the Enable Price Rule toggle if you want to add a price rule for the selected collection.
- In the selected collection, select the required price rule under the Price Rule Name column.
Note:
- You can use the search option to find a specific price rule.
- For more information, refer to Associating a Pricing Collection with Multiple Shipping Regions.
- To associate the selected Pricing collection with the store, continue Step 4 of Associating Microservice Collections with a Store.
Associating a Pricing Collection with Multiple Shipping Regions
To associate a Pricing Collection with multiple shipping regions,
- 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. - Go to the Service Association tab, and click the Add button to add the remaining shipping region(s).
Another Pricing collection row appears in the Service Association tab. - Select a locale of the shipping region to be associated in the newly added Pricing collection row.
Note:
- Repeat the above steps based on the number of shipping regions you have added in the Store Info tab
- For more information, refer to Associating the Pricing Collection with a Price List or Price Rule.
- To associate the newly added Pricing collections with the store, continue Step 4 of Associating Microservice Collections with a Store.
Associating the Store and an Inventory Collection with a Bin
To associate the store and an Inventory Collection with a bin, in the selected collection, select the required bin under the Inventory Name column.
Note:
- You can use the search option to find a specific bin.
- To associate the selected Inventory collection with the store, continue Step 4 of Associating Microservice Collections with a Store.
Adding Store-Specific Properties
On the Advanced tab of the Store Overview page, the Business Admins can add and/or view custom properties to customize the implementation.
You can add the below store properties:
Property Key | Description | Type | Possible Values | Example | Consumable Services | |||
---|---|---|---|---|---|---|---|---|
activateB2B2C | Indicates whether the B2B2C store is enabled. A value of true means the B2B2C store creates Accounts and Customers (User) services, along with other selected services. | Boolean | true, false | TRUE | Storefront Orchestration | |||
allowedCountries | Contains a list of permitted countries. | String | List of comma-separated country codes | US,USA,CA,GR | Shipping | |||
allowedPromotionPriceFacets | Contains a comma-separated list of PriceFacets that enable the discount functionality for additional components (PV, CV, and SB). | String | PV,CV,SB,GRP | PV,CV | Storefront Orchestration | |||
allowedRewardTypesForOptIn | Contains a list of default reward types. The reward types configured here will be eligible based on opt-in functionality and will be displayed in the storefront for users to opt-in. When users opt-in to the loyalty program, they will be able to earn loyalty rewards.Note:
| String | LOYALTY, STORE CREDIT | LOYALTY | Storefront Orchestration and Admin Orchestration | |||
autoCreateAssociation | Indicates whether collections for all applicable microservices are automatically created and associated with the store. When enabled, collections are automatically created and associated with the store. When disabled, you must manually create and associate the collections with the store. | Boolean | true, false | TRUE | Foundation | |||
defaultAddressforShippingMethod | Holds the default shipping address. | JSON | { | Shipping | ||||
defaultCheckOutFlow | Activates the default checkout flow when set to true . | Boolean | true, false | TRUE | Orders | |||
enableBackOrder | Activates the back order when set to true . | Boolean | true, false | TRUE | Inventory | |||
excludePriceFacets | Contains a list of price facets to exclude from the storefront and the API response. | String | SB | SB | Storefront Orchestration | |||
fetchRewardsEventId | Contains the ID of an event used to retrieve rewards before the reward points are credited to the account. | String | Order Shipped, Order Created | Order Shipped | Storefront Orchestration and Loyalty | |||
orderChannelTypes | Identifies the type of channel used to place the order. | String | Web, Phone, Walk in Center | Web, Phone | Order Admin | |||
percentInPriceToPayByPoints | Specifies the percentage of the amount eligible to be paid using points. For example, if the eligible amount is $100 and you set the percentInPriceToPayByPoints to 50%, then 50% of $100 (which is $50 if the pointValueInPriceUnit is 1) will be eligible to be paid using points.Note: The eligible amount to be paid using points is calculated based on the store property redeemloyaltyproperty . | String | 0-100 | 100 | Storefront Orchestration and Admin Orchestration | |||
pointValueInPriceUnit | Stores the conversion value of loyalty points to price units. For example, a value of 1 means one point is equivalent to one dollar. | String | 0-100 | 1 | Storefront Orchestration and Admin Orchestration | |||
PriceRuleConfigMap | Stores a list of account types used in price rules to set different prices based on the account type. | JSON | {"id":"AccountType","name":"AccountType","options":["Retail Customer","Brand Affiliate - Individual","Brand Affiliate - Business Entity","Preferred Customer/Member"]} | Admin | ||||
productPropertiesForPromotion | Holds a product property to send to the Promotions service from the Storefront Orchestrations and Admin Orchestrations services. | String | Any product property | pointEarn | Storefront Orchestration and Admin Orchestration | |||
productPropertyToAllowDiscount | Stores a product property to determine discount eligibility. For example, products with the pointDiscount attribute set to true are eligible for a discount.Note:
| String | Any product property | pointDiscount | Storefront Orchestration, Admin Orchestration, and Cart | |||
productPropertyToEarnRewards | Contains an attribute to determine a product’s eligibility for earning loyalty points. For example, products with the pointEarn attribute set to true are eligible to earn loyalty points.Note:
| String | Any product property | pointEarn | Storefront Orchestration and Admin Orchestration | |||
redeemloyaltyproperty | Contains an attribute to determine if a product is eligible to redeem loyalty points. Products with the pointRedeem attribute set to true are eligible for loyalty point redemption.For example, if an order includes:
The total value of products eligible for redemption is $100. Note:
| String | Any product property | pointRedeem | Storefront Orchestration and Admin Orchestration | |||
sfStoreDetails | Contains the store details for the storefront. | JSON | { | Storefront Orchestration | ||||
siteURL | Contains the storefront URL of the store. | String | Any valid URL | https://<<EnvironmentName>>.skavacommerce.com/ | Storefront | |||
tierConfigMap | Contains the percentage and tier name displayed in the storefront. For example, T1 corresponds to a 5% discount and is labeled as Basic. | String | Valid JSON value | { | Storefront | |||
customization_js | Contains the S3 URL of the minified JS file that customizes the admin console for all applicable services at the store level. | URL | NA | https://d3gqeq5wcctqxw.cloudfront.net/equinox-platfom/admin-customization/admin-customization.min.js | Foundation Admin | |||
customization_css | Contains the S3 URL of the minified CSS file that customizes the admin console for all applicable services at the store level. | URL | NA | https://d3gqeq5wcctqxw.cloudfront.net/equinox-platfom/admin-customization/admin-customization.min.css | Foundation Admin | |||
discountModelRewardTypes | Contains a list of reward types to be considered as discounts. The default value is REWARDS. | String | LOYALTY,POINTS,STORE CREDIT | LOYALTY | Loyalty | |||
enableVoucherSupport | Indicates whether voucher support is enabled in the Cart service. | Boolean | True, False | True | Admin and Storefront Orchestration (Cart) | |||
livePriceEnabled | Indexes the most recent schedule price for sorting and filtering operations. | Boolean | True, False | FALSE | Feed Jobs | |||
enableVoucherSupport | Indicates whether voucher support is enabled. When this property is set to:
| FALSE | Admin Orchestration (Cart) | |||||
productPropertyToEarnVouchers | Specifies product property name to identify if the product is eligible for earning and redeeming vouchers. The default value is earnVoucher . | earnVoucher | Foundation | |||||
productPropertyToRedeemVouchers | Specifies the product property name to determine if the product is eligible for earning and redeeming vouchers. The default value is redeemVoucher . | redeemVoucher | Foundation | |||||
enableAppMarketplace | Indicates the feature flag for the newly added App Marketplace Admin. The default value is FALSE . | True, False | FALSE | AppMarketplace Admin | ||||
enableDashboard | Indicates the feature flag for the newly added Dashboard link under Store Overview. The default value is FALSE . | True, False | FALSE | Catalog, Foundation Admin | ||||
domain, sheetPath | Specifies a segment or domain and the data sheet path for that domain. | -- | Foundation | |||||
cdnConfig | When the seller publishes the site, and if the site has been cached by the CDN, the Storefront Orchestration service reads this property information and flushes the cache asynchronously. Sample data:
| {} | Foundation Admin (Emall) | |||||
sellerRoleAccountTypes | This property defines the Seller role account type. Once configured, the ROLE_SELLER_USER is assigned, allowing the seller user to sign up for Emall. | -- | Storefront Orchestration | |||||
setResetParamInResponse | This property determines whether to include the reset parameter in the response. If the flag is enabled, the reset parameter will not appear in the API response. By default, this property is disabled when set to false . | false | Foundation | |||||
preferenceBasedSubscription | This property controls whether to enable the existing preference flow subscription or the multiple subscriptions flow. When set to:
| true | Admin Orchestration | |||||
productCompareAppURL | This property allows users to view product comparisons based on the products added for comparison. Users can see the “Descriptive Comparison of Products” section, generated by the Product Compare AI app, based on comparable attributes. Enter the app URL in the value field. | Foundation Admin Console, Ultra Storefront | ||||||
EnablePromotionProximity | When this property is set to:
| Boolean | True, False | Foundation Admin Console, Promotions Admin Console | ||||
quicksightDashboardInfo | This property displays a new card, “Analytics & Insights,” on the Store Ops page and the left navigation panel, allowing navigation to the Dashboard page. Sample value: {"Order": "dashboard_id", "Inventory": "dashboard_id"} The dashboard ID for the service can be obtained from the QuickSight plugin. Before configuring this property, ensure the QuickSight plugin is installed for the store. | quicksightDashboardInfo | ||||||
enableCartApproval | If this property value is set to:
| Boolean | True, False | false | Accounts | |||
allowGuestUserToGetAttributes | If this property value is set to:
| Boolean | True, False | false | Storefront Orchestration | |||
EnablePriceParam | Contains the price parameters with conditions. | Boolean | Pricing | |||||
priceRuleCustomType | Contains the custom attributes created for an account. | Pricing | ||||||
ComparebyAI | This property, used with productCompareAppURL , controls the display of the “Descriptive Comparison Products” section on the Compare Products page. The value can be:
Note: The app is deployed in Azure. The app will only be called if the app URL is configured in the store property productCompareAppURL . | Boolean | True, False | false | Ultra Storefront, Storefront Orchestration | |||
productCompareAppURL | This property contains the app URL for the Product Compare AI app and requires the ComparebyAI store property to be configured when defined. | App URL | Ultra Storefront, Storefront Orchestration | |||||
ProximityPromotionURL | This property contains the app URL for the Proximity Promotion AI app and requires the EnableProximityPromotion store property to be configured when defined.Note: The app is being deployed in Azure. The app will only be called if the app URL is configured. | App URL | Ultra Storefront, Storefront Orchestration | |||||
bundleSuggestionAppURL | This property contains the app URL for the Bundle Suggestion AI app. | App URL | Ultra Storefront, Storefront Orchestration | |||||
adminV2Enable | This property enables Ultra Admin Apps (for example, CSR, Shipment) on the StoreOps page. | Foundation Admin | ||||||
SubscriptionMessage | The property can be any value containing the %d format specifier to indicate the subscription percentage. | subscriptionSuggestion%d | Subscribe to the product and get %d off. | Catalog | ||||
UserSKUOrderHistoryCount | This property with a numeric value (for example, 1 to signify number of orders) indicates the count of items a user has purchased. | Catalog | ||||||
UserSKUOrderHistoryTime | This property with a numeric value (for example, 1 to signify the number of items) indicates the number of items a user has purchased in a month. | Catalog | ||||||
quicksightDashboardId | This property is used to display the dashboard/reports in the Analytics and Insights page.is used to configure the dashboard name and respective dashboard IDs to display them on the Analytics & Insights page. | NA | To display inventory, catalog, promotion, order, subscription, and loyalty dashboards, the JSON value can be:
| Foundation Admin | ||||
allowMerchandiseMilestone | This property specifies whether to allow creating category milestone in the Merchandising service when the property is set to true. The default value is false. | Boolean | True, False | false | Merchandising Admin | |||
phonenumberCountryCode | This property stores the country code values available for user selection on the user and account details pages when providing a phone number. The default value is US(+1). | List of comma-separated country codes | AR(+54),AT(+43),US(+1) | CSR Admin | ||||
enableUserActivationFlow | This property invites users to fill their profile for activation in the B2B2C flow. The default value is false. | Boolean | True, False | false | Ultra Storefront, Storefront Orchestration | |||
enableZeroCheckout | This property allows users to place an order without any payment. Note: Payment validation is skipped if the cart value is zero and enableZeroCheckout is set to true. If the cart total is zero and the enableZeroCheckout property is false, an appropriate error is thrown. The default value is false. | Boolean | True, False | false | Ultra Storefront, Storefront Orchestration | |||
discountRewardGroups | When the loyalty reward is applied as a promotion discount, the promotion object name will be taken from the promotion class object. This property must be defined when the store property discountModelRewardTypes is configured with LOYALTY. | JSON | NA | {LOYALTY" : {"promotionClass": "Program", "promotionGroup" :"Group"}} | Loyalty, Payment | |||
discountRewardGroups | Specifies whether the inventory is blocked during the order placement by a storefront user or not. When this property is set to:
| Boolean | True, False | false | Storefront Orchestration | |||
enableInventoryQtyBlockValidationadmin | Specifies whether the inventory is blocked during the order placement by a CSR amin user or not. When this property is set to:
| Boolean | True, False | false | Admin Orchestration |
- Click the Advanced tab on the Store Overview page.
- In the Advanced tab of the Store Overview page, click the Add Properties button.
- Provide a property name and its value.
For example, to customize the admin consoles at the store level, enter the following property keys:
- customization_js for uploading a JS file.
- customization_css for uploading a CSS file.
In the property value, upload CSS and JS files from your local computer by clicking the Add File button, or provide the S3 URL of these files.
After uploading the custom JS and CSS files, the Accounts admin console will appear as shown below: - Click the Save button to save the custom properties.
Note: You can add more custom properties by repeating the above steps.
Updating StoreFront Orchestration-Specific Properties
In the SF Orchestration Properties tab of the Store Overview page, a business admin can update or view the below storefront orchestration-specific properties:
Service | Property Key | Description |
Customers | Allow customer deletion |
Indicates whether customer deletion is permitted. When enabled, a CSR can delete a customer account. |
Retention period for customer deletion |
Defines the retention period before customer deletion. |
|
Google Places API Key |
Holds the Google Places API key for accessing Google Places APIs. |
|
Inventory | Enable Inventory Check |
Indicates whether inventory checks are permitted. |
Include Out Of Stock |
Specifies whether out-of-stock products are displayed on the storefront site (for example, PLP, PDP). Enable to show out-of-stock products. |
To update the storefront orchestration-specific properties:
- In the SF Orchestration Properties tab of the Store Overview page, make the required updates in the available SFO properties.
- Click the Save button to update the storefront orchestration-specific properties.
Managing Store Operations
To launch a Store Ops page,
- On the All Stores page, click a particular store:
The Store Overview page is displayed:
Note: To edit the store details, see Editing a Store. - Click the Store Ops button on the Store Overview page.
The Store Ops page appears: - On the Store Ops page:
Indexing and Publishing Store Data
Infosys Equinox Commerce allows you to:
First, index the store data in the authoring environment, then publish it in the live environment to reflect changes on the storefront.
Refer to the following sections for prerequisites and steps for indexing or publishing data:
- Full Indexing the Catalog and Pricing Data: Index the entire catalog and pricing store data.
- Full Indexing the Merchandising Data: Index the entire merchandising store data.
- Delta Indexing the Catalog Data: Index catalog updates of a store.
- Delta Indexing the Pricing Data: Index pricing updates of a store.
- Full Publishing the Store Data: Publish the catalog, pricing, merchandising, promotions, foundation, accounts, and search data of a store from the authoring environment to the production environment.
- Full Publishing the Promotions Data: Publish the promotions data of a store from the authoring environment to the production environment.
- Delta Publishing the Store Data: Publish the latest changes of the catalog, pricing, merchandising, foundation, accounts, and search data of a store from the authoring environment to the production environment.
Indexing the Store Data
To retrieve product/SKU details for the storefront, and index the catalog, pricing, and merchandising data in the store’s SOLR collections.
In Infosys Equinox Commerce, choose from the following indexing types based on your business needs:
Full Indexing
To index the entire catalog, pricing, or merchandising data in the store’s collections, run full indexing.
Full Indexing Options:
- Catalog and Pricing: Index all product and SKU details with pricing information.
- Merchandising: Index all categories and site navigation details.
Full Indexing Catalog and Pricing Data
Prerequisites
Before running full indexing for catalog and pricing, ensure the following:
- Valid catalog and pricing data in the collection’s default project.
- Active products have at least one active SKU with valid pricing information.
Scenarios for Not Indexing a Product
A product will not be indexed if:
- The product status is inactive.
- The current date is outside the product’s and/or SKUs’ start and end date and time (considered expired).
- The product has no active SKUs.
- There is no pricing information for any SKUs.
Steps for Full Indexing Catalog and Pricing Data
To run a full indexing feed on the catalog and pricing data,
- In the Store Ops page, click the Refresh/Publish Data dropdown.
A list of indexing and publishing options appears. - Select the option Full Indexing – Catalog & Pricing only in the Refresh/Publish Data dropdown.
- Click the Go button.
The Refreshing Data popup appears. - 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.
- The feeds such as CatalogEventPublisher, CatalogEventListener, CatalogB2BEventPublisher (for a B2B store), CatalogB2BEventListener (for a B2B store), PriceEventPublisher, PriceEventListener, PriceRuleEventPublisher (applicable only when a price rule is mapped with the store), and PriceRuleEventListener (applicable only when a price rule is mapped with the store), are triggered. For more details on these feeds, see https://developer.infosysequinox.com/microservices/search/search-feeds/.
- To view the feed running details, go to the URL: https://<<EnvironmentName>>.skavacommerce.com/admin/feed/histories?businessId=<<BusinessID>>&page=1&size=10
For example, the feed histories of the Search collection 373:
Note: You can get the Search collection ID in the Service Association tab of the store. - You can also view the feed run history using the Swagger link: https://<<EnvironmentName>>.com/feedservices/swagger-ui/Job_History/getFeedRunHistories
- On the storefront site, verify that the catalog and prices for the SKUs are displayed correctly:
Full Indexing Merchandising Data
Prerequisites
Before running full indexing for merchandising, ensure the following:
- Valid merchandising data is in the collection’s default project.
- Active categories contain valid milestones for successful indexing.
Scenarios for Not Indexing a Category
A category will not be indexed if:
- The category status is inactive.
- The category lacks active milestones.
- The category lacks valid milestones (applicable for the current period).
- The category is not mapped to any valid site navigation milestones.
Steps for Full Indexing Merchandising Data
To run a full indexing feed on the merchandising data,
- In the Store Ops page, click the Refresh/Publish Data dropdown.
A list of indexing and publishing options appears. - Select the option Full Indexing – Merchandising only in the Refresh/Publish Data dropdown.
- Click the Go button.
The Refreshing Data popup appears. - 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.
- The feeds such as MerchandiseEventListener and MerchandiseEventPublisher are triggered. For more details on these feeds, see https://developer.infosysequinox.com/microservices/search/search-feeds/.
- To view the feed running details, go to the URL: https://<<EnvironmentName>>.skavacommerce.com/admin/feed/histories?businessId=<<BusinessID>>&page=1&size=10
For example, the feed histories of the Search collection 373:
Note: You can get the Search collection ID in the Service Association tab of the store. - You can also view the feed run history using the Swagger link: https://<<EnvironmentName>>.skavacommerce.com/feedservices/swagger-ui/Job_History/getFeedRunHistories
- On the storefront site, verify that the categories and its products are displayed correctly:
Delta Indexing
Delta Indexing Catalog Data
Prerequisites
Before running delta indexing for the catalog, ensure that the collection’s default project contains valid, updated catalog data.
When this feed is triggered, any changes made to existing products and/or SKUs, as well as 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 Catalog Data
To run a delta indexing feed on the catalog data,
- In the Store Ops page, click the Refresh/Publish Data dropdown.
A list of indexing and publishing options appears. - Select the option Delta Indexing – Catalog only in the Refresh/Publish Data dropdown.
- Click the Go button.
The Refreshing Data popup appears. - 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 on the Feed History page. For more information, see Viewing a Feed History.
Delta Indexing Pricing Data
Prerequisites
Before running delta indexing for pricing, ensure that the collection’s default project contains valid, updated pricing data.
Steps for Delta Indexing Pricing Data
To run a delta indexing on the pricing data,
- In the Store Ops page, click the Refresh/Publish Data dropdown.
A list of indexing and publishing options appears. - Select the option Delta Indexing – Pricing only in the Refresh/Publish Data dropdown.
- Click the Go button.
The Refreshing Data popup appears. - 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 on 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 of the Store Data
- Full Publishing of the Promotions Data
- Delta Publishing of the Store Data
Full Publishing of the Store Data
This option publishes the complete store data (such as Catalog, Pricing, Merchandising, Promotions, Foundation, Accounts (for B2B), and Search) from the authoring environment to the production environment.
Prerequisites
Before running the full publish feed, ensure the following:
- Availability of 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 of the Store Data
To publish the complete store data,
- In the Store Ops page, click the Refresh/Publish Data dropdown.
A list of indexing and publishing options appears. - Select the option Full Publish in the Refresh/Publish Data dropdown.
- Click the Go button.
The Publish Store Data popup appears. - 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 on 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 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 of the Promotions Data
This option publishes the complete store data of the Promotions microservice from the authoring environment to the production environment.
Prerequisites
Before running the full publish feed, ensure the following:
- Availability of 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,
- In the Store Ops page, click the Refresh/Publish Data dropdown.
A list of indexing and publishing options appears. - Select the option Promotion Full Publish in the Refresh/Publish Data dropdown.
- Click the Go button.
The Publish Store Data popup appears. - 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 on 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 publishing 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 of the Store Data
This option publishes only the latest changes made to the store data (such as Catalog, Pricing, Merchandising, Foundation, Accounts (for B2B), and Search) from the authoring environment to the production environment.
Prerequisites
Before running the delta publish feed, ensure the following:
- Availability of 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 of the Store Data
To publish only the recent changes from the store data,
- In the Store Ops page, click the Refresh/Publish Data dropdown.
A list of indexing and publishing options appears. - Select the option Delta Publish in the Refresh/Publish Data dropdown.
- Click the Go button.
The Publish Store Data popup appears. - 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 on 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.
Dashboard – Sales Metrics, Task Trays, Other Reports
Overview
The Dashboard offers a high-level, one-page view of the store’s order and sales statistics for the last 7 days. It includes key tasks for the business admin to address, recently updated items, a chart displaying the top 5 selling products, and inventory availability details.
Tasks can be customized in the collection property of the required service based on business requirements:
Accessing the Dashboard
To access the dashboard,
- Click available on the top left corner of the Store Overview page:
- Select Dashboard on the left navigation panel.
The Dashboard page appears. For more information on the Dashboard page, see the next section.
Dashboard Page and Reports
These reports present the store’s current status and identify issues to be addressed using preset filters.
The following page explains the details available on the Dashboard page:
Call Out |
Explanation |
Displays the total number of orders and sales matrix, such as the total value of sales and the average order price. |
|
Displays the catalog and pricing-related report types. The task trays can be configured; for example:
A business or store admin can click, which navigates to the required page with the preset filter results; for example, on clicking “Products with No Images”, the following screen is displayed: <pending> |
|
Displays the recently updated items for the last 7 days. |
|
Displays the 5 top-selling SKUs for the last 7 days. |
|
Displays the inventory availability details (such as preorder, backorder, low stock, and/or out-of-stock) of SKUs. |
Configuring Collections for Microservices
In the Business Overview page, click Microservices in the left navigation panel. It shows the All Microservices page:
The All Microservices page can be used to navigate to collections of a microservice.
Note:
- If a microservice does not appear on the All Microservices page, it indicates that it has not been added to the business.
- If a microservice appears on the All Microservices page but does not have an arrow, it indicates that 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:
It shows the collections management page of the microservice:
Note:
- The pagination option appears on all screens that contain collection information.
- To navigate to the next page, click the page number.
Managing Collections of a Microservice
On the collections management page of a microservice, you can:
- Create a collection for the microservice.
- Configure a collection for each of the microservices.
- Launch the microservice.
For managing collections of a microservice, see the video below or click the links above for step-by-step instructions:
Creating a Collection for the Microservice
To create a collection,
- In the collections management page of the microservice, click the Create Collection button:
The Create Collection page appears. - 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. This allows a business to pick the collection.
- Disable the toggle to deactivate the collection. This prevents a business from picking the collection.
Collection Properties Update the values of the collection properties.
- Click the Create button to create the collection.
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:
- In the collections management page of the microservice, click the Configure button against a collection
Note: You can open the Feeds dashboard of the respective microservice by clicking the Feeds button.
The Configure Collection page appears. - Update the required information.
- 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:
Note: You can open the Feeds dashboard of the respective microservice by clicking the Feeds button.
The admin console page of the microservice appears:
Available Collection Properties
Below is the list of available collection properties by service.
For the Microservice | Click the 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
On the Team page, a user can be invited, and a role can be assigned to a user.
On the Team page, you can:
- Invite user(s) as a business admin.
- Invite user(s) as a business user.
- View or edit existing team members.
- Search team members by first name, last name, and/or email.
- Sort team members by first name, last name, and/or email in ascending or descending order.
Note:
- The pagination option appears on all screens that contain team 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,
- Click the Team in the left navigation pane.
- Click the Invite Members button.
- In the Email Address section, enter the required email address(es).
- Enable the Business Admin.
- Click the Send Invite button.
The following confirmation message is displayed on the screen:
The Business Admin receives an email for creating an Infosys Equinox Commerce account. - Click the ACTIVATE button in the email.
- 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 businesses for which the Business Admin has privileges to access and manage.
Inviting User(s) as a Business User
To invite user(s) and assign them the roles,
- Click the Team in the Left Navigation panel.
- Click the Invite Members button.
The Invite User page appears: - In the Email Address section, enter the required email address(es).
- 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 an editor role in the Promotion Admin console. - In the Store section, select the required store.
Note: To add multiple roles for a store, click and repeat the above steps 4 and 5. - Click the Send Invite button.
The following confirmation message is displayed on the screen:
The Business User receives an email for creating an Infosys Equinox Commerce account. - Click the ACTIVATE button in the email.
- 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 businesses for which the Business User has privileges to access and manage.
Configuring Custom Roles
Overview
In the Foundation Admin console, you can configure your own custom roles for the selected service(s) and associate privilege(s) and privilege group(s) that are required for the given role. Once created, you invite users via Teams and assign the configured roles to them for the selected store(s).
In Custom Roles, you can:
- View the created roles
- Create a new role and associate privilege(s) and privilege group(s)
- Edit the existing custom role
- Delete a particular custom role
Note: You cannot delete predefined roles, which are available by default.
Before You Begin
You must configure the <a href="#enableCustomRoles">enableCustomRoles</a>
property with the value true
in the Business Overview’s Advanced tab. For more information, see Configuring Custom Properties.
Once configured, Custom Roles is visible in the left navigation panel for the business with the predefined roles. To create a new custom role, see Creating a New Role with Privileges.
Viewing Custom Roles
To view the existing custom roles,
- Log in to the Foundation service for your business (URL provided by Infosys Equinox).
- Click on a particular business.
- Click Custom Roles in the left navigation panel:
The List of Custom Roles page appears:
Creating a New Role with Privileges
To create a new role with the custom name and associate the required privileges or privilege groups,
- Log in to the Foundation service for your business (URL provided by Infosys Equinox).
- Click on a particular business.
- Click Custom Roles in the left navigation panel:
The List of Custom Roles landing page appears: - On the landing page of the custom roles, click the Create Role button.
The Create Custom Roles page appears: - Enter the role name and select the required service.
- Once you select the service, select the required privilege group. Once you select the privilege group, you can view the associated privileges.
- Click to add more services with the corresponding privileges to create the role.
- Click the Create button.
Once the role is created successfully, the role appears on the List of Custom Roles page.
Note: For inviting users and assigning the configured roles to them for the selected store(s) in the Teams page, see Managing Teams.
Editing the Existing Custom Role
You can edit existing custom roles; however, you cannot edit predefined roles created by default.
To edit a custom role,
- Log in to the Foundation service for your business (URL provided by Infosys Equinox).
- Click on a particular business.
- Click Custom Roles in the left navigation panel:The List of Custom Roles landing page appears:
- Click to edit a particular custom role; for example:
- Update the role name if required.
- Deselect and then select another service if required.
- Once you select the service, select the required privilege group. After selecting the privilege group, you can view the associated privileges.
- Click to add more services with the corresponding privileges if required.
- Click the Update button:The changes are updated.
Deleting a Custom Role
You can delete the existing custom roles; however, you cannot delete the predefined roles that are created by default.
To delete a custom role,
- Log in to the Foundation service for your business (URL provided by Infosys Equinox).
- Click on a particular business.
- Click Custom Roles in the left navigation panel:
The List of Custom Roles landing page appears: - Click to delete a particular custom role; for example:
After clicking OK in a confirmation pop-up. The role is deleted successfully.
Managing Feeds
You can manage the feeds of the microservices via the Feeds Admin console. To view the Feeds Admin console, click Batch Jobs in the left navigation panel.
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.
Managing Developer Apps
You can register the app in Developers Apps and publish it to the App Marketplace. See Developer Apps and App Marketplace.
Revision History
2024-09-13 | SD – Updated store & business properties for 8.18.6 & 8.18.7 release.
2024-08-18 | JP – Improved content using AI.
2024-06-08 | JP – Updated store & business properties for 8.18 release.
2024-24-07 | JP – Updated store & business properties for 8.18 release.
2023-20-10 | JP, SW, AN – Updated content for 8.15.4 release.
2023-08-03 | AN – Updated content for 8.15.0 release.
2023-01-12 | AN – Updated content for 8.13 release.
2022-11-04 | AN – Updated contents for 8.13 release.
2022-11-01 | AN – Updated Swagger URL for release 8.12.
2022-10-10 | AN – Updated Full Indexing section.
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 link issues.
2019-05-04 | PLK – Updated content for April 2019 release.
2019-01-22 | PLK – Page created, content uploaded, and TOC and links added.