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

Getting Started

Overview

Accessing the Feeds Console

 

The Feeds microservice provides business admins the ability to manage feeds of the microservices such as the Catalog, Pricing, Merchandising, and Promotions. Each service contains a list of feeds based on the business requirements. Each feed contains a feed job specific to each microservice collection. The feed jobs are automatically created when you create the microservice collection. You can update a feed job. Each feed job can contain multiple schedules. The schedules can be configured to run either on-demand or on the specified time schedules. The feed jobs are scheduled when an event occurs. When the feed job is scheduled, it triggers the feed job to run and a feed run history is generated.

For example, in the Catalog microservice, you can bulk import catalog data such as products, SKUs, attributes, etc. via the feed catalogimport. When a buiness admin creates a catalog collection, a feed job of the catalogimport feed is created automatically. The naming format of the feed job is <CollectionID>_catalogimport.  While setting up data for a catalog, the business admin can schedule this feed job on demand. That is, when you click import button in the Catalog Admin console, the feed job is triggered and the catalog data is imported from an Excel sheet to the Catalog service.

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

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

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 Skava 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
  • Feed – an ongoing stream of structured data that provides end-users or systems with updates of current information from one or more sources. Infosys Equinox has a list of feeds in each microservice such as promotions import feed, promo codes export feed, etc in the Promotions microservice.
  • Feed Job – a scheduled program that is assigned to run on a computer without further user interaction. In Infosys Equinox Commerce, a feed job is an instance of a feed specific to each microservice collection.
  • Job Schedule – the process where different tasks get executed at pre-determined times or when an event is triggered. For example, a pricing export schedule is triggered to run when the user clicks the Export button in the Pricing console.

Accessing the Feeds Console

top | Configuring Search Parameters

To access the Feeds console,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. Select the desired business.
  3. In the business landing page, click Feeds in the left navigation panel to view feeds of a business:
    Or, click Feeds in the StoreOps page to view the feeds of a store: 

    The Feeds Admin landing page appears:

Configuring Search Parameters

Accessing the Feeds Console | Manage Feed Jobs

In the Feeds Admin landing page, you can search the feeds based on Feed Id and/or Service Type, modify the search fields as needed, and select the number of pre-defined rows per screen.

Searching for Feeds

To search for feeds,

  1. Click the Feed Id and/or Service Type drop-down list in the header to open an entry field to provide search criteria.
  2. Enter the desired search criteria in the search field:
  3. Click the Go button. The feeds which matches the search criteria appears:

Modifying Searchable Fields

To modify the searchable fields,

  1. Click  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:

Manage Feed Jobs

Configuring Search Parameters| Revision History

To manage the feed jobs, you can:

Viewing the Job Schedules of a Feed Job

To view the schedules of a feed job,

  1. On the Feeds Admin landing page, click on a feed to view the feed jobs.
  2. Click on a feed job to view its details and schedules. image alt text
    Note: If you want to view the run details of a feed job, click History of a feed job. For more details, see Viewing Run Details of a Feed Job.
    The job details and schedules are displayed: image alt text
    Note:
    • The Created Time displays the date and time when the feed job is created for the first time.  
    • The Updated Time displays the date and time as and when the feed job is updated. 
    • You can edit or retrigger a schedule via the Job Details and Job Schedules page. 

Viewing Run Details of a Feed Job

To view the run 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 Job.
  2. In the Job Details and Job Schedules page, click History in the left navigation panel:
    image alt textThe feed job run histories containing History Id, Run Request Id, Status, Start Time, and End Time are displayed:image alt text

  3. Click on a feed job run history.
    The feed job run history details and the summary of the selected history appear:

    The following table explains the above screen:

    Button/Section Purpose

    To view the summary of the completed feed run history in the JSON format:

    Note: The summary details displays a URL link to navigate and download the error or output files of the feed job.

    Appears for the completed feed run to retrigger again. To retrigger the specific run of a feed job, see Edit or Retrigger a Job Schedule.

    If the feed run is for importing items and the feed run is completed partially, you can find this button to download and view the failed items.

    To view the log details of the feed run:

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 Job.
  2. Click the edit icon:
    image alt text
    The feed job details appear:
    image alt text
  3. Edit the details as required.
    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 are triggered
    • INACTIVE – inactive feed jobs are not triggered
    Max Run Time Update the maximum running time (in seconds) of the feed job. The feed job is 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. This property key-value pair impacts the configuration of the active job execution. 
    Note: By default, a job parameter named email is supported to send job status email notifications to the configured emails, super admin, business admin, and the logged-in user. Multiple email IDs are given as comma-separated. 
    Note: Fields marked with * are mandatory.
  4. Click the Save button to save the updated feed job details.

Editing or Retriggering a Job Schedule

To edit or retrigger a job schedule,

  1. Navigate to the Job Details and Job Schedules page. For more information, refer to View the Job Schedules of a Feed Job.
  2. Click on the desired job schedule:
    image alt text
    The schedule details are displayed:
    Note: To retrigger the schedule, click the Retrigger button. The status of the schedule will be changed to RUNNING and later to COMPLETED.
  3. Click the edit icon. The schedule details appear:
  4. Edit the details as required.
  5. Click the Save button to save the updated job schedule details.

Manage Feed Jobs | top

Revision History
2022-04-10 | JP – Fixed link and http issues.
2022-02-15 | AN – Created the page for the 8.11 release.