DOCSEARCHbyAlgolia
Submit Docs

Elastic Path Documentation

website·Indexed 37 days ago

https://documentation.elasticpath.com/storefront-react/docs/

Technical documentation for Elastic Path, featuring JavaDocs for the Extension Framework (versions 1.2.x through 1.5.x) and API references for Account Management (versions 2.0.x through 2.3.x). Includes detailed specifications for the com.elasticpath.xpf connectivity packages, entity builders, and deprecated Account Management API endpoints.

Tokens
4.6M
Snippets
15.9K
Records
32.5K
Agent score
55%

What's inside Elastic Path

  1. Overview of Elastic Path Chatbot implementations

    Elastic Path provides reference chatbot implementations to enable conversational interfaces in eCommerce stores, allowing shoppers to perform actions (like adding items to a cart) or retrieve information (like product descriptions) via keyword-based inputs.

    Currently, reference implementations are available for:

    • Amazon Lex: Implemented in the React PWA Reference Storefront.
    • Facebook Messenger: Supported for specific legacy versions only; instructions for this implementation are no longer updated.

  2. Overview of Load Balancing and HTTP Routing in CloudOps for Kubernetes

    CloudOps for Kubernetes implements load balancing and HTTP routing by combining AWS network load balancers with the HAProxy Ingress Controller. External traffic is received by the AWS load balancer and forwarded to the HAProxy Ingress Controller, which then routes the traffic to the appropriate Kubernetes Services and Pods based on defined Ingress rules.

  3. Overview of the Data Population CLI tool

    The Data Population CLI tool is designed for use in non-development environments where Maven is not installed. It provides the same capabilities as Maven-based data population but adds support for filtering data directories without updating the database (supporting Data Population Deployment Models) and the ability to disable specific commands (e.g., reset-db) for specific environments like production.

  4. Overview of the Helix programming model for Cortex API

    The Helix programming model is a modern development framework for creating Cortex API resources. It improves the developer experience compared to legacy resources through several key architectural changes:

    • Resource Prototypes: API definitions are created using an API definition language, which then generates a prototype for implementation.
    • Operation Interfaces: Developers only need to implement the specific CRUD (Create, Read, Update, Delete) operation logic; the underlying wiring is handled automatically by the prototype generation process.
    • Granular Responsibility: Each resource operation has its own prototype class, leading to more lightweight and maintainable code.
    • Hot Deployment: Bundles can be deployed into the Cortex webapp without a full restart, enabling rapid prototyping and testing.

  5. Overview of Commerce Manager State Policies

    State Policies are a rule-based system used to determine the state of UI widgets in Commerce Manager. A widget can be in one of three states:

    • editable: The user can view and modify the value.
    • read-only: The user can only view the value.
    • disabled: The widget is disabled; the user cannot view or modify the value.

    State is determined by factors such as user permissions (e.g., Manage Products and SKUs), catalog assignments, or whether an object is locked in a Change Set.

  6. Overview of Elastic Path Commerce Manager

    Commerce Manager is the administration interface for Elastic Path Commerce. It is a browser-based application where access is managed via environment-specific URLs (e.g., separate URLs for Test, Authoring, and Live environments). The interface is role-based; available features are determined by the user's assigned role and permissions (such as store manager, catalog manager, customer support representative, or commerce administrator). Features for which a user lacks permission are either disabled or hidden from the UI.

  7. Overview of Elastic Path Self-Managed Commerce Documentation

    The Self-Managed Commerce documentation provides resources for Java developers, back-end/front-end developers, solutions architects, and operations engineers. The documentation is organized into the following primary areas:

    • Getting Started: Infrastructure and developer environment setup.
    • Core Commerce: Building and extending the platform.
    • Cortex: API concepts, resource development, and front-end consumption.
    • Deployment: Deployment concepts and options.
    • Tools: Frameworks and tools for implementation.
    • Accelerators: Business-requirement based accelerators.

    Additional specialized documentation is available for the Extension Point Framework, Commerce Manager, CloudOps for Kubernetes, and the React Reference Storefront.

  8. Overview of the Data Population CLI tool

    The Data Population CLI tool is a platform-independent utility (Windows, Linux, Mac) built on Spring Shell and the Spring Framework. It is designed for use in non-development environments where Maven is not installed. Key capabilities include filtering data directories without requiring a database connection and the ability to disable specific commands (e.g., reset-db) for production environments.

  9. Overview of Asynchronous Event Messaging

    Self-Managed Commerce uses asynchronous messaging to decouple the Commerce Manager, Search Server, and Cortex. This architecture allows systems to share data and process events without requiring all systems to be operational simultaneously and ensures that time-sensitive operations can be prioritized over non-critical ones.

  10. Overview of Elastic Path Catalog Syndication

    Elastic Path Catalog Syndication (available since version 7.5.1) allows the sharing of commerce catalog data with external systems such as Content Management Systems (CMS), Digital Experience Platforms, recommendation engines, User Generated Content (UGC) platforms, and fulfillment systems.

    When business users or Elastic Path tools (like the Import Export Tool, Data Population Tool, or Data Sync Tool) update domain objects, the system creates simplified representations called 'projections' in the Self-Managed Commerce database and sends catalog event messages via Java Messaging Service (JMS) to notify external systems of the changes.

  11. Overview of CloudOps for Kubernetes

    CloudOps for Kubernetes is an infrastructure-as-code asset designed for Self Managed Commerce customers to assist in infrastructure development and deployment. It provides a prescriptive way to deploy AWS cloud and Kubernetes infrastructure, which can be extended and modified to meet unique customer requirements.

  12. Overview of CloudOps for Kubernetes build infrastructure

    CloudOps for Kubernetes provisions a build infrastructure designed to support the customization of Self Managed Commerce. The infrastructure handles five primary tasks: building artifacts (including deployment packages), storing artifacts in a Maven repository, caching external Eclipse P2 dependencies for Commerce Manager builds, converting deployment packages into container images, and storing those images in a Docker Registry compatible service. Note that CloudOps for Kubernetes does not provision a Git server.