This page provides Business administrators a user guide for the Feeds microservice for the Infosys Equinox Commerce platform.
Getting Started
Overview
The Feeds microservice provides business admins the ability to manage feeds of the microservices such as the Catalog, Pricing, Merchandising, Promotions, etc. Each service contains a list of feeds based on the business requirements. Refer to the feeds documents available under the respective microservices. Each feed contains a feed job (batch 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. If needed, you can create a new schedule via the Feeds Admin console. 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 batch history is generated.
For example, in the Catalog microservice, you can bulk import catalog data such as products, SKUs, etc. via the feed catalogimport. When a business 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. You can schedule this feed to import the catalog data from an Excel sheetto the Catalog service. To schedule this feed, you need to 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. The basic use of a business is to manage common sets of users, catalogs, and other services for the stores associated with the business.
- Business Admin – a role that manages business settings, creates and manages stores, and enables microservice(s) for a business.
- Collection – provides a set of properties that control the behavior of the microservice when launched. Allows Business Admins to set up different information for each store so that a Business can have multiple stores, each with its own configuration for a specific microservice.
- Microservice – a self-contained application that is the building block of a loosely coupled services architecture consisting of other microservices. The Infosys Equinox Commerce platform version 8.0 includes the following microservices:
- Foundation
- Accounts (B2B)
- Address
- Authorization
- Cart
- Catalog
- Customers (Users)
- Feeds
- Feed Job
- 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 (Batch 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 Admin Console
top | Configuring Search Parameters
You can view the Feeds Admin console for a business, store, and microservice.
Accessing the Feeds Admin Console by a Buiness Admin
A Business Admin can navigate to the Feeds Admin console to view and manage batch histories and batch jobs for a buiness.
To navigate to the Feeds Admin console for a business,
- Log in to the Foundation service for your business (URL provided by Infosys Equinox).
- Select the desired business.
- In the business landing page, click Batch Jobs in the left navigation panel to view feeds of a business:
The Feeds Admin landing page for the business appears:
Accessing the Feeds Admin Console by a Store Admin
A Store Admin can navigate to the Feeds Admin console to view and manage batch histories and batch jobs for a store.
To navigate to the Feeds Admin console for a store,
- Log in to the Foundation service for your business (URL provided by Infosys Equinox).
- Select the desired business.
- Select the desired store.
- Click Batch Jobs in the StoreOps page:
The Feeds Admin landing page for the store appears:
Configuring Search Parameters
Accessing the Feeds Console | View Batch Run Histories
In 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 History(ies)
To search for batch history(ies),
- 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 to provide search criteria.
- Enter the desired search criteria in the search field:
- Click the Go button. The batch history(ies) which matches the search criteria appears:
Modifying Searchable Fields
To modify the searchable fields,
- Click
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.
View Batch Histories
Configuring Search Parameters | Manage Feed Jobs
The Feeds Admin landing page shows the batch histories. 
The Batch Histories page shows the latest completed batch histories in 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 displays 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
To manage the feed jobs, you can:
- view the job schedules of a feed job
- view the 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 the Job Schedules of a Feed Job
To view the schedules of a feed job,
- On the Feeds Admin landing page, click Batch Jobs in the left navigation panel.
A list of the existing feeds appears:
This table lists feeds of all the microservices:
- Click on a feed job to view the feed job details and 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 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,
- Navigate to the Job Details and Job Schedules page. For more information, refer to View the Job Schedules of a Feed Job.
- In the Job Details and Job Schedules page, 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,
- Navigate to the Job Details and Job Schedules page. For more information, refer to View the Job Schedules of a Feed Job.
- Click the edit icon:
The feed job details appear:
- Edit the details as required.
The following table provides the field description to edit a feed job:
Note: Fields marked with * are mandatory.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 the 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. - 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,
- Navigate to the Job Details and Job Schedules page. For more information, refer to View the Job Schedules of a Feed Job.
- Click the Create Schedule button:
The Create Schedule page appears:
- Add the details as required.
The following table provides the field description to create a job schedule:
Note: Fields marked with * are mandatory.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 be triggered.
- SCHEDULED – the feed job is triggered repeatedly in a given 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 Repeat Interval. For example, 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), which triggers the feed job repeatedly. The feed job Start Time 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. - 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,
- Go to the History Details page of the feed job schedule.
Note: For more details on batch history, see Viewing a Batch History. - Click Stop:
Now, you can find the schedule in Killed status:
Editing or Retriggering a Job Schedule
To edit or retrigger a job schedule,
- Navigate to the Job Details and Job Schedules page. For more information, refer to View the Job Schedules of a Feed Job.
- 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. - Click the edit icon. The schedule details appear:
- Edit the details as required.
- Click the Save button to save the updated job schedule details.
Revision History
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.
