Oro Documentation
Oro Documentation
  • USERS
  • DEVELOPERS
    • Backend Developer Guide
    • Frontend Developer Guide
    • Web Services API Guide
    • Community Guide
  • CLOUD
  • BLOG
  • ACADEMY
  • Home >
  • Developer Documentation >
  • Backend Developer Guide >
  • Configuration Reference >
  • Annotations
  • Backend Developer Guide
    • Setup
      • System Requirements
        • Performance Optimization
        • MySQL Optimization
      • Development Environment
        • Community Edition
        • Enterprise Edition
        • Docker & Symfony Server
          • Setup on Ubuntu
          • Setup on macOS
          • Setup on Windows
        • Web Server Configuration
        • Environment Types
        • Healthcheck and Data Monitoring
      • Demo Environment
        • Docker
        • VM VirtualBox
        • AWS Cloud Platform
        • Google Cloud Platform
        • Azure Cloud Platform
        • Vagrant Provision
      • 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
      • Reinstall
    • Application Architecture
      • Technology Stack
        • Database
        • File Storage
        • Session Storage
        • Message Queue
        • Search Index
      • Application Structure
      • Application Framework
        • Architecture Principles of Oro Applications
      • Application Customization
      • Differences to Common Symfony Applications
      • Custom Oro Application
    • Bundles and Extensions
      • Create a Bundle
      • Extend an Existing Bundle
      • Install Extension from the Oro Marketplace
      • Add an Extension to Oro Marketplace
    • Entities
      • Create Entities
      • Database Structure Migrations
      • Extend Entities
        • Option Set Fields
        • Extended Associations
        • Multi-Target Extended Associations
        • Serialized Fields
      • Configure Entities
      • Create Custom Entities
      • Merge Entities
      • CRUD Operations
      • Custom Field Validation
      • Entity Aliases
      • Entity Activities
      • 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
          • 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
          • 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
      • Filters
        • Grid Extension
        • Filter Form Types
        • Javascript Widgets
      • Fixtures
    • Entities Data Management
      • Fixtures and Demo Data
      • Reports & Segments
      • Search Index
        • Configuration
        • Console Commands
        • Query Builder
        • Best Practices
        • Elasticsearch Configuration and Tuning
        • Troubleshooting
      • Workflows
        • Introduction
        • Configuration Reference
        • Elements
        • Basic Configuration
        • Transition Forms
        • Translation Wizard
        • 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
      • Custom listeners
      • Access Levels and Ownership (Example)
    • Translation and Localization
      • Content and User Iterface Translation
      • Translation Configuration
      • Data Fixtures
      • Schema Migrations
      • Localization
    • Integrations
      • Configuration
        • 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
    • Dashboards
    • Navigation
    • Emails
    • Message Queue
      • 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
      • Annotations
        • @Acl
        • @AclAncestor
        • @Config
        • @ConfigField
        • @TitleTemplate
      • YAML
        • Access Control Lists
        • Access Control List Categories
        • Assets
        • Dashboards
        • Datagrids
        • Entity Configuration
        • Navigation
        • Placeholders
        • JS Modules
        • Search Index
        • System Configuration
        • Workflows
    • Extending OroCRM
      • Add OroCommerce Capabilities to an OroCRM Application
    • Extending OroCommerce
      • Create Payment Method Integrations
        • CyberSource Integration
      • Create Shipping Method Integrations
    • Akeneo Integration
    • Automated Tests
      • Functional Tests
      • Behat Tests
    • API Developer Guide
      • CLI Commands
      • Configure Stateless Security Firewalls
      • Configure Feature Depended Firewall Listeners
      • 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
      • Testing REST API
      • Storefront REST API
      • Storefront Routes
      • Batch API
    • Bundles Documentation
      • ActionBundle
      • ActivityBundle
      • ActivityListBundle
      • AddressBundle
      • ApiBundle
      • AssetBundle
      • AttachmentBundle
        • OroAttachmentBundle Configuration
        • Image Placeholder Configuration
      • BatchBundle
      • CacheBundle
      • CalendarBundle
      • ChartBundle
      • CookieConsentBundle
      • CommentBundle
      • ConfigBundle
      • CronBundle
      • CurrencyBundle
      • DashboardBundle
      • DataAuditBundle
      • DataGridBundle
        • Default Editors
      • DistributionBundle
      • DigitalAssetBundle
      • ElasticSearchBundle
        • Index Agent and Search Engine
        • ElasticSearch Indexes Backup
        • ElasticSearch Configuration
        • Request Builders
        • Troubleshooting
        • Upgrade Standard Index to Elasticsearch 7.*
      • EmailBundle
      • EmbeddedFormBundle
      • EntityBundle
        • EntityModel
        • EntitySelectSearchApiAccessor ⇐ SearchApiAccessor
        • EntityStructureDataProvider
      • EntityConfigBundle
      • EntityExtendBundle
      • EntityMergeBundle
      • EntityPaginationBundle
      • EntitySerializedFieldsBundle
      • FeatureToggleBundle
      • FilterBundle
      • FormBundle
      • GaufretteBundle
      • GridFSConfigBundle
      • ImapBundle
      • ImportExportBundle
      • InstallerBundle
      • IntegrationBundle
      • LayoutBundle
        • Layout Cache
      • LocaleBundle
      • LoggerBundle
      • MessageQueueBundle
      • MigrationBundle
      • NavigationBundle
      • NoteBundle
      • NotificationBundle
        • Register an Event to Send Notification Emails
      • OAuth2ServerBundle
      • OrganizationBundle
      • PlatformBundle
      • QueryDesignerBundle
      • RedisConfigBundle
        • Configure Redis Servers
        • Configure Application to Use Redis
      • ReportBundle
      • ScopeBundle
      • SearchBundle
        • ORM Search Engine
        • Search Relevance Weight
        • DateTimeFormatter
      • SecurityBundle
      • SegmentBundle
      • SidebarBundle
      • SyncBundle
      • TagBundle
      • TestFrameworkBundle
        • Additional Doctrine Events
      • ThemeBundle
      • TranslationBundle
      • TwigInspectorBundle
      • UIBundle
        • Action Manager
        • Client Side Navigation
        • Content Providers
        • Dynamic Assets
        • Formatters
        • Scroll Data Customization
        • TWIG Placeholders
        • TWIG Filters
        • Widgets
        • ApiAccessor
        • BaseClass
        • HiddenInitializationView ⇐ BaseView
        • Layout Subtree View
        • LoadMoreCollection
        • Loading Mask View
        • MultiUseResourceManager ⇐ BaseClass
        • PersistentStorage
        • Highlight Text View
        • RouteModel
        • RoutingCollection
        • SearchApiAccessor
        • Viewport Manager
        • Error Handler
        • Input Widgets
        • Items Manager
        • Mediator Handlers
      • WindowsBundle
      • WorkflowBundle
      • DraftBundle
        • How to Use Drafts
        • How to Use Draft ACL
        • How to Use the Draft Filter
        • How to Resolve Draft Conflicts
        • How to Use a Draft Extension
      • CatalogBundle
      • CheckoutBundle
      • CMSBundle
        • Content Widgets
        • WYSIWYG Field
          • How to Add WYSIWYG Field
          • How to Change TextArea Field to WYSIWYG Field
          • WYSIWYG Field Validation
        • Content Blocks
        • Create Editor Components
      • ConsentBundle
        • Cookie Consent Banner
        • Add the Customer Consents Field to a Form (Example)
        • Add the Agreements Step to a Custom Checkout Based on the Default Checkout Workflow (Example)
        • Add the Agreements Section to a Custom Checkout Based on the Single Page Checkout Workflow (Example)
      • CustomerBundle
      • FrontendBundle
        • Frontend Sessions and Debug Routes
        • Frontend Access
        • Set Up Mass Action in Datagrid
        • Sticky Panel View
        • Dom Relocation Global View
      • InventoryBundle
      • OrderBundle
        • Previously Purchased Products
      • PayPalBundle
      • PricingBundle
        • Configure Price List Sharding
        • Optimize Website Indexation and Price Recalculation
        • Combined Price List
        • Price Storage
        • Pricing Strategy
      • ProductBundle
        • Product Actions
        • Customize Products Using Layouts
          • Customize Product View Page
          • Customize Product List Page
          • Customize Products SKU Validation
        • Product Attributes
        • Product Unit Formatting
        • Product Variant Search
        • Related Items
      • SEOBundle
        • Sitemap
        • SEO Meta Fields
      • TaxBundle
      • WebCatalogBundle
      • WebsiteElasticSearchBundle
        • Website ElasticSearch Search Engine
        • Website ElasticSearch Configuration
        • Attributes Boost
        • Request Builders
        • Upgrade Website Index to Elasticsearch 7.*
      • WebsiteSearchBundle
        • Website Search VS Regular Search
        • Website Search Configuration
        • Search Index Structure
        • Console Commands
        • Perform Search
        • Indexation Process
        • Reindexation During Platform Update
        • ORM Search Engine
        • Search Relevance Weight
        • Testing
Version:
4.2 (latest)
  • 3.1
  • 4.1
  • 5.0 Beta 1 (master)

Annotations

  • @Acl
  • @AclAncestor
  • @Config
  • @ConfigField
  • @TitleTemplate
Oro Documentation
  • Oro inc
  • Orocommerce
  • Orocrm
  • Oroplatform
  • Partners
  • Services
  • Events
  • Twitter
  • Terms & conditions
  • Privacy policy
  • Contributor license agreement

@2021 Oro, Inc. All Rights Reserved.

Back to top