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 allows business administrators to manage feeds for various microservices such as Catalog, Pricing, Merchandising, Promotions, etc. Each service includes a list of feeds tailored to business requirements. Refer to the feeds documents available under the respective microservices. Each feed contains a specific feed job (batch job) for each microservice collection. Feed jobs are automatically created when a microservice collection is created. You can update a feed job, and each job can have multiple schedules. New schedules can be created via the Feeds Admin console, configured to run on-demand or at specified times. Feed jobs are triggered by events, generating a batch history upon execution.

For example, in the Catalog microservice, you can bulk import catalog data such as products, SKUs, etc. via the catalogimport feed. When a business admin creates a catalog collection, a catalogimport feed job is automatically created, named <em><CollectionID></em>_catalogimport. While setting up data for a catalog, the business admin can schedule this feed job on demand. You can schedule this feed to import the catalog data from an Excel sheet to the Catalog service. To schedule this feed, you can perform any one of the steps given below:

• Import the Excel sheet in the Catalog Admin console.
• Create a schedule in the Feeds Admin console.
• Retrigger an existing schedule in the Feeds Admin console.

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, managing common sets of users, catalogs, and other services for the stores associated with the business.
• Business Admin: A role responsible for managing business settings, creating and managing stores, and enabling microservice(s) for a business.
• Collection: A set of properties controlling the behavior of a microservice when launched, allowing different configurations for each store within a business.
• Microservice: A self-contained application that is part of a loosely coupled services architecture. 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
  • Location
  • 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 includes various feeds in each microservice, such as promotions import feed, promo codes export feed, and so on in the Promotions microservice.
• Feed Job (Batch Job): A scheduled program running without further user interaction, specific to each microservice collection.
• Job Schedule: The process of executing tasks at predetermined times or when triggered by an event. For example, a pricing export schedule is triggered to run when the user clicks the Export button in the Pricing console.

Accessing the Feeds Admin Console

top | Configuring Search Parameters

Configuring Search Parameters

Accessing the Feeds Console | View Batch Run Histories

On the Feeds Admin landing page, you can search the batch histories based on Batch Name, Service Type, Collection Id, Request Id, Start Time, End Time, and/or Status. Modify the search fields as needed, and select the number of pre-defined rows per screen.

Searching for Batch Histories

To search for batch histories,

1. Click the Batch Name, Service Type, Collection Id, Request Id, Start Time, End Time, and/or Status drop-down list in the header to open an entry field.
   
2. Enter the desired search criteria:
3. Click the Go button. The batch histories which match 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 searchable fields in the header:
   The selected searchable fields appear in the header.

View Batch Histories

Configuring Search Parameters | Manage Feed Jobs

The Feeds Admin landing page shows the latest completed batch histories at the top of the list. To view a batch history, see Viewing a Batch History.

Viewing a Batch History

To view a batch history, on the Feeds Admin landing page, click on a batch history. The batch 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 batch history in the JSON format: Note: The summary details display a URL link to navigate and download the error or output files of the feed job.
	Appears for the completed batch to retrigger again. To retrigger the specific run of a feed job, see Edit or Retrigger a Job Schedule.
	If the batch is for importing items and the batch is completed partially, you can find this button to download and view the failed items.
	To view the log details of the batch:

Manage Feed Jobs

View Feed Histories | Revision History

You can:

• View job schedules of a feed job.
• View run details of a feed job.
• Edit a feed job.
• Create a feed job schedule.
• Stop a running feed job.
• Edit or retrigger a job schedule.

Viewing Job Schedules of a Feed Job

To view the schedules of a feed job,

1. On the Feeds Admin landing page, click Batch Jobs in the left navigation panel.
   A list of available feeds is displayed:
   This table lists feeds of all the microservices:
   

   Service	Feeds Page Link
   Accounts	https://developer.infosysequinox.com/microservices/accounts/accounts-feeds/
   Catalog	https://developer.infosysequinox.com/microservices/catalog/catalog-feeds/
   Customers (User)	https://developer.infosysequinox.com/microservices/customers/customers-feeds/
   Foundation	https://developer.infosysequinox.com/microservices/foundation/foundation-feeds/
   Inventory	https://developer.infosysequinox.com/microservices/inventory/inventory-feeds/
   Loyalty	https://developer.infosysequinox.com/microservices/loyalty/loyalty-feeds/
   Merchandising	https://developer.infosysequinox.com/microservices/merchandising/merchandising-feeds/
   Pricing	https://developer.infosysequinox.com/microservices/pricing/pricing-feeds/
   Promotions	https://developer.infosysequinox.com/microservices/promotions/promotions-feeds/
   Ratings and Reviews	https://developer.infosysequinox.com/microservices/rating-and-review/ratingsandreviews-feeds/
   Reporting	https://developer.infosysequinox.com/microservices/reporting/reporting-feeds/
   Search	https://developer.infosysequinox.com/microservices/search/search-feeds/
   Subscription	https://developer.infosysequinox.com/microservices/subscription/subscription-feeds/

2. Click on a feed job to view the feed job details and job schedules.
   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 job schedules are displayed:
   Note: You can edit or retrigger a schedule and/or create 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. Click History in the left navigation panel:
   
   The feed job run histories containing History Id, Run Request Id, Status, Start Time, and End Time are displayed:
   
   Note: For more details on batch history, see Viewing a Batch History.

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:
   
   The feed job details appear:
   
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
   Execution Type	Change the execution type to any one of the following: ETL: ETL refers to Extracting, Transforming, and Loading data. The feed job is executed via the Pentaho server. By default, the ETL feed job is executed.  LWJ: LWJ refers to Lightweight Job. The feed job is executed as a lightweight job via the Spring Batch server. This takes less time for completion compared with ETL jobs.
   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 values.

   Note: Fields marked with * are mandatory.
4. Click the Save button to save the updated feed job details.

Creating a Job Schedule

You can create a job schedule using the Create Schedule button on the Job Schedules page.

To create 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 the Create Schedule button:
   
   The Create Schedule page appears:
   
3. Add the required details.
   The following table provides the field description to create a 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. INACTIVE: The feed job is not triggered. SCHEDULED: The feed job is triggered repeatedly in a specified interval of time. The time interval is specified in the field Repeat Interval.
   Batch Interval	Specify the feed refresh interval (in seconds). The value should be less than or equal to the Repeat Interval. For example, If Repeat Interval is 1800 seconds and Feed Interval is 180 seconds. At each refresh interval, the system checks the completion of the Repeat Interval duration.
   Repeat Interval	Update the frequency interval (in seconds) that triggers the feed job repeatedly. The Start Time of the feed job is updated based on Repeat Interval.
   Last Run Time	Update the last run time (in seconds) of the feed schedule.
   Max Run Time	Update the maximum running time (in seconds) of the feed schedule. An alert email will be sent if it exceeds the maximum running time limit.
   Start Time	Update the start time of the job schedule.
   End Time	Update the end time of the job schedule.
   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. For example, the parameter inputFileCdnUrl holds the S3 URL of an Excel sheet  for scheduling the import feed.

   Note: Fields marked with * are mandatory.
4. Click the Save button to create a job schedule.

Stopping a Running Feed Job

When a feed job is triggered and if it is in running status, you can stop it by killing its job schedule.

To stop a running feed job,

1. Go to the History Details page of the  feed job schedule.
   Note: For more details on batch history, see Viewing a Batch History.
2. Click Stop:
   
   The schedule status changes to Killed.
   

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:
   
   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 required details.
5. Click the Save button to save the updated job schedule details.
   
   

Revision History
2024-12-06 | JP – Improved content using AI.
2022-12-09 | AN – Updated for the 8.13 release.
2022-04-10 | JP – Fixed link and http issues.
2022-02-15 | AN – Created the page for the 8.11.2 release.