menu
Oro Documentation: Find everything you need to use and develop your OroCommerce, OroCRM, and OroPlatform application
    Result in:
    close
    • Back to Oro Inc
    • Users
      • Solution ArchitectureLearn about the OroCommerce architecture, integration points, and the infrastructure to implement it.
      • Concept GuidesGet contextual references to detailed feature descriptions based on your business use case.
      • Back-OfficeExplore the key features and learn to automate workflows, create reporting and much more.
      • Commerce StorefrontIntroduction to OroCommerce default storefront navigation, interaction, and browsing.
      • IntegrationsExplore OroCommerce's pre-built and custom integration options.
      • GlossaryNavigate OroCommerce terms easily with our comprehensive glossary guide.
      Up for a challenge? Validate your skills and earn the Oro Certificate!
      • Learn More
    • Developers
      • Backend Developer GuideComprehensive documentation on installing, customizing, and maintaining Oro applications efficiently.
      • Frontend Developer GuideLearn to efficiently customize Oro apps appearance both on the Storefront and in the Back-office.
      • Oro Bundles & ComponentsExplore Oro Config Component and core bundle implementation for non-standard customizations.
      • Web Services API GuideIntegrate Oro functionality into third-party systems with REST API guide.
      • Community GuideLearn about the best ways to contribute to Oro applications, and engage with the Oro community.
      Up for a challenge? Validate your skills and earn the Oro Certificate!
      • Learn More
    • Cloud Administrators
      • ArchitectureUncover OroCloud's architecture with illustrative diagrams for deeper understanding.
      • Environment TypesUnderstand OroCommerce environment types for tailored deployment options and configurations.
      • SecurityDiscover OroCloud network diagram and Oro's comprehensive security protocols.
      • MonitoringEnsure service continuity and proactive resource management with OroCloud monitoring tools.
      • OnboardingStreamline your Oro application deployment with our comprehensive onboarding process guide.
      • VPN ConnectionLearn how to connect OroCloud VPN across different operating systems.
      • MaintenanceExplore the tools to manage maintenance tasks within your OroCloud environment.
      • SupportDiscover Oro's support process for Oro authorized partners and Enterprise customers.
      Up for a challenge? Validate your skills and earn the Oro Certificate!
      • Learn More
    • OroCommerce
    • OroHive
    • Documentation >
    • Developers >
    • Backend Developer Guide >
    • Configuration Reference >
    • YAML
    • Backend Developer Guide
      • Application Setup and Configuration
        • System Requirements
          • Performance Optimization
        • Development Environment
          • Setup on Ubuntu
          • Setup on macOS
          • Setup on Windows
          • Docker & Symfony Server
          • Web Server Configuration
          • Configuration Parameters
          • Environment Variables
          • Healthcheck and Data Monitoring
          • Setup From Database Dump
          • Oro Devbox VM
        • Demo Environment
          • Docker
          • VM VirtualBox
          • AWS Cloud Platform
          • Google Cloud Platform
          • Azure Cloud Platform
        • Jenkins CI
        • Get the Oro Application Source Code
        • Installation
        • Installation in Sub-Folder
        • Post-Install Activities
          • Content Restrictions
          • Flat Pricing
          • Cookies Configuration
          • Protected Cookies
        • Loading Demo Data
        • Launch
        • Upgrade Source Code
        • Upgrade Application
        • Deploy Changes
        • Reinstall
      • Application Architecture
        • Technology Stack
          • Database
          • File Storage
          • Session Storage
          • Message Queue
          • Search Index
            • Query Builder
            • Best Practices
            • Elasticsearch Configuration and Tuning
            • Fuzzy Search
            • Troubleshooting
        • Application Structure
        • Application Framework
          • Architecture Principles of Oro Applications
        • Application Customization
        • Differences to Common Symfony Applications
        • Custom Oro Application
        • Bundle-less Structure
      • Bundles and Extensions
        • Create a Bundle
        • Install Extension from the Oro Extensions Store
        • Add an Extension to Oro Extensions Store
      • Entities
        • Create Entities
        • Database Structure Migrations
        • Extend Entities
          • Option Enum Set Fields
          • Extended Associations
          • Multi-Target Extended Associations
          • Serialized Fields
          • Validation for Extended Fields
          • Define Custom Form Type for Fields
          • Extending the Extended Field Rendering
        • Configure Entities
          • Define a New Object Configuration Attribute
          • Implementation
          • Add Configuration Options
          • Access Entities Configuration
        • Create Custom Entities
        • Merge Entities
        • CRUD Operations
        • Custom Field Validation
        • Entity Aliases
        • Entity Activities
        • Turn an Entity into an Activity
        • Entity Fallback Values
        • Entity Manager
        • Entity Name Resolver and Providers
        • Entity Class Name Provider
        • Entity Structure Data Provider
        • Events
        • Dictionaries
        • Doctrine Field Types
        • Partial Indexes
        • Profiler of Duplicated Queries
        • Resolving ORM Query Hints
        • Entity Repositories as a Services
        • Transaction watchers for Default DBAL Connection
        • Attributes Configuration
        • Datagrids
          • Pass Request Parameters to the Grid
          • Enable Entity Pagination
        • Customize Datagrids
          • Backend Datagrid
            • Scopes
            • Views List
            • Datasources
              • Array Datasource
              • ORM Datasource
            • Parameter Binding
            • Extensions
              • Action Extension
              • Board Extension
              • Export Extension
              • Field ACL Extension
              • Formatter Extension
              • Grid Views Extension
              • Inline Editing
              • Mass Action Extension
              • Mode Extension
              • Pager Extension
              • Sorter Extension
              • Toolbar Extension
              • Totals Extension
              • Organization Column Extension
            • Events
            • Advanced Grid Configuration
            • Editable Datagrid Cells
            • Selected Fields Providers
            • State Providers
            • References in YAML Configuration
          • Frontend Datagrid
            • Mass Action Configuration
        • Protect Entities Using ACLs
        • Entity Attachments
        • Customize CRUD Pages
        • Fixtures
        • Data Sanitization
      • Entities Data Management
        • Fixtures and Demo Data
        • Reports & Segments
        • Workflows
          • Introduction
          • Configuration Reference
          • Elements
          • Basic Configuration
          • Transition Forms
          • Transition Services
          • Translation Wizard
          • Workflow Events
          • Configuration Example
        • Operations (Actions)
          • Glossary
          • Buttons
          • Action Groups
          • Configuration Reference
          • Actions and Conditions
          • Console Commands
        • Processes
        • Data Audit
      • Security
        • Introduction to Security in Oro Applications
        • ACL Manager
        • Custom Permissions
        • Field ACL
        • Configurable Permissions
        • CSRF Protection
        • Access Rules
        • Access Control
        • Custom listeners
        • Access Levels and Ownership (Example)
        • Global View Entities
        • HTTP Security Response Headers
      • Translation and Localization
        • Content and User Interface Translation
        • Translation Configuration
        • Data Fixtures
        • Schema Migrations
        • Localization
        • Add Translations to Source Code
      • Integrations
        • Oro Integration Bundle
          • Basic Implementation
          • Configuration Reference
          • Additional Serializable Fields
          • Reverse Synchronization
          • Default Owner for Integration Related Entities
          • Additional Capabilities
        • Import and Export
          • Overview
          • Domain Model
          • Gaufrette
          • Fields Configuration
          • Import and Export Entities
          • Events
          • Extend Entities to Support Bulk Import and Export
          • Accelerate Import
          • Postponing Rows
          • Import Custom Format File Via Batch API
        • API-Based Integration
        • Initial Data Loading
        • Notification Alerts
      • Dashboards
      • Navigation
      • Emails
      • Message Queue
        • Message Queue Topics
        • Message Queue Jobs
        • Consumer
          • Resetting Container
        • Security Context
        • Logging, Error Handling and Debugging
          • Writing Logs to ELK Stack
        • Testing
        • RabbitMQ (Enterprise Edition Only)
          • Command Lines
          • RabbitMQ Exchanges
          • Divide Queue to Separate Queues
          • Configure RabbitMQ for Production
          • Re-deliver Message with Limited Attempts
          • Backup and Restore
          • Troubleshooting
        • Supervisord
        • Writing Logs to Stackdriver
        • Filtering Messages in the Message Producer
        • Buffering Messages in the Message Producer
        • Delaying Messages
      • Cron
      • WebSocket Notifications
        • Websocket Recipes
          • Use Maintenance Mode Notifications in Oro Applications
          • Use Content Outdated Notifications in Oro Applications
          • Create a Topic and a Handler for Publishing and Subscribing
          • Publish Messages to Existing Topics
          • Use Authentication and Authorization in WebSocket Connections
        • WebSocket Connection Configuration
      • Scopes
      • Feature Toggle
      • Logging
      • System Configuration
      • Configuration Reference
        • Attributes
          • #[Acl]
          • #[AclAncestor]
          • #[Config]
          • #[ConfigField]
          • #[TitleTemplate]
        • YAML
          • Bundles’ Configuration
          • Access Control Lists
          • Access Control List Categories
          • Assets
          • Dashboards
          • Datagrids
          • Entity Configuration
          • Navigation
          • Placeholders
          • JS Modules
          • Search Index
          • System Configuration
          • Workflows
      • Extending Oro Application
        • Create Payment Method Integrations
        • Create Shipping Method Integrations
        • Add OroCommerce Capabilities to an OroCRM Application
        • Common Checkout Customization Methods
      • Akeneo Integration
      • Automated Tests
        • End-to-End
        • Integration
        • Functional
        • k6 Performance Tests
        • Debug Behat Tests
      • API Developer Guide
        • CLI Commands
        • Configure Stateless Security Firewalls
        • Configure Feature Depended Firewall Authenticators
        • General Configuration
        • Configuration Reference
        • Configuration Extras
        • Configuration Extensions
        • Forms and Validators Configuration
        • Documenting API Resources
        • Actions
        • Request Type
        • Processors
        • Headers
        • Filters
        • Post Processors
        • How to
        • CORS Configuration
        • CORS Configuration for Published OpenAPI Specifications
        • Testing REST API
        • Storefront REST API
        • Storefront Routes
        • Batch API
      • Organization Types
      • Field Sales App
        • Configuration Reference
    Version:
    6.1 (latest)
    • 5.1
    • 6.0
    • 6.1 (latest)
    • 7.0 (dev)

    YAML 

    • Bundles’ Configuration
    • Access Control Lists
    • Access Control List Categories
    • Assets
    • Dashboards
    • Datagrids
    • Entity Configuration
    • Navigation
    • Placeholders
    • JS Modules
    • Search Index
    • System Configuration
    • Workflows

    Get the latest Oro News

    • OroCommerce
    Compliances
    • Compliances
    • pci-dssfooter1SOCfooter1

    About Us

    • About us
    • Partners
    • Events
    • Careers
    • Bug Bounty

    Certifications

    • PCI DSS
    • SOC2

    Services

    • Oro Services
    • Training

    More Resources

    • Guides & Reports
    • Documentation
    • OroCommerce Blog

    Compliances

    pci-dssfooter1 SOCfooter1

    Follow Oro

    Oro GitHub Oro linkedin Oro twitter Oro Youtube
    © 2024 Oro, Inc. All Rights Reserved
    Terms & Conditions Privacy Policy Data Protection Framework Certification

    Follow Oro

    Oro GitHub Oro linkedin Oro twitter Oro Youtube
    Back to top