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 >
    • Users >
    • Back-Office >
    • Manage System Settings in the Back-Office >
    • Configure Entities in the Back-Office >
    • Create Entity Fields >
    • Type-Related Entity Field Properties
    • User Documentation
      • Solution Architecture
        • Concepts
        • Integration Points
        • Cloud and Infrastructure
      • Concept Guides
        • Business Models
          • Marketplace
          • B2C Website
          • Multiple Websites
        • Catalog and Promotions
          • Master Catalog Management
          • Inventory and Warehouse Management
          • Product Management
            • Product Kits
          • Price Management
          • Promotion Management
          • Search Functions
        • Content Management
          • Web Catalog
          • Landing Page
          • Content Blocks
          • Content Widgets
          • WYSIWYG Editor
        • Customers and Sales
          • Customer Management
          • RFQ and Quote Management
          • Order Management
        • Administration
          • Localization and Translation
            • Translate Content
            • Translate Product Attribute Options
            • Translate Labels, Options, and Messages
          • Customer Permissions
          • Guest Functions
          • Payment Configuration
          • Shipping Configuration
          • Tax Management
          • Storefront and Back-Office Menu Management
          • Checkout Configuration
          • Consent Management
            • Add a Consent Landing Page to a Web Catalog
            • Localize Consents
            • Reports with Accepted Consents
          • Data Import
        • AI and Automation
        • Field Sales App
      • Back-Office
        • Getting Started
          • Community vs Enterprise Edition
          • Application Authentication
            • Log In/Out
            • Restore Password
            • Troubleshoot Login Issues
          • User Menu
            • My User
              • Add OAuth Applications
            • My Configuration
            • My Emails
            • My Calendar
          • Navigation
            • Navigation Basics
            • Record Tables (Grids)
            • Shortcuts
            • Company Structure and Organization Selector
            • Pinbar
            • User Menu
            • Extended Menu
            • Sidebar Panel
            • Flash Notifications
            • Dialog Windows
          • Information Management
            • Create a Record
            • Manage Records
              • View Records
              • Edit Records
              • Delete Records
            • Import Records
            • Export Records
            • Add Notes
            • Create and View Comments
            • Add Attachments
          • E-Commerce Accessibility
        • Dashboard
          • Dashboards
          • Widgets
            • Lead Statistics
            • Opportunity Statistics
            • Average Lifetime Sales
            • Campaign Leads
            • Campaigns by Close Revenue
            • Forecast
            • Leads List
            • Opportunities by Lead Source
            • Opportunities by Status
            • Opportunities List
            • Opportunity Generating Campaigns
            • Quick Launchpad
            • Recent Calls
            • Recent Emails
            • Recently Accessed Account
            • Recently Accessed Contacts
            • Today’s Calendar
            • Sales Orders Volume
            • Sales Orders Number
            • AI Smart Order
        • Customers
          • Accounts
            • Create an Account
            • Manage Accounts
            • Merge Accounts
            • Import Accounts
            • Export Accounts
          • Contacts
            • Export Contacts
            • Import Contacts
          • Customers
            • Create a Customer
            • Create an Address
            • Export Customers
            • Import Customers
            • Configure Price List per Customer
            • Add All Products Page to Storefront Menus per Customer
            • Customize Storefront Menus per Customer
            • Configure Settings per Customer
              • Routing
              • AI Smart Agent
              • Warehouses
              • Search History
              • Product Data Export
              • Sales
          • Customer Groups
            • Configure Price List per Customer Group
            • Add All Products Page to Storefront Menus per Customer Group
            • Customize Storefront Menus per Customer Group
            • Configure Settings per Customer Group
              • Routing
              • AI Agent
              • Warehouses
              • Search History
              • Product Data Export
              • Sales
          • Customer Users
            • Export Customer User Details
            • Import Customer User Details
          • Customer User Roles
          • Business Customers
            • Export Business Customers
            • Import Business Customers
          • Customer User Login Attempts
          • Customer User OAuth Applications
        • Sales
          • Leads
            • Create a Lead
            • Manage Leads
            • Qualify a Lead
            • Import Leads
            • Export Leads
          • Opportunities
            • Create an Opportunity
            • Manage Opportunities
            • Import an Opportunity
            • Export an Opportunity
            • Manage Opportunity Workflow
            • Multi-Currency Opportunities
          • Shopping Lists
          • Request for Quote (RFQ)
            • View a Request for Quote Details
            • View Requests for Quote Summary
            • Manage RFQs
            • Use RFQ Workflows
          • Quotes
            • Create a Quote
              • Create a Quote From Scratch
              • Create a Quote on Customer Request
            • Manage Quotes
            • Send a Guest Quote
            • Use Quotes Workflows
              • Simple Quote Management: Steps and Transitions
              • Quote Management with Approvals: Steps and Transitions
              • Basic Quote Lifecycle Management (When Workflows Are Disabled)
            • Assign a Shipping Method to a Quote
          • Orders
            • Create an Order
            • Import External Orders in JSON Format
            • View Order Details
            • Manage Orders
            • Move an Order Through Its Lifecycle
            • Add a Shipping Tracking Number to the Order
            • View Order Internal Statuses
          • Invoices
          • Price Lists
            • Create a Price List
            • Duplicate a Price List
            • Export Prices from the Price List
            • Import Prices Into the Price List
            • Add a Product Price Manually
            • Generate a Product Price Automatically
            • Use Autocomplete
            • Schedule Price Adjustments
            • Manage Prices in Multiple Currencies
          • Payment Terms
          • Sales Territories
          • Seller Registration Requests
          • Price Calculation Details
        • Products
          • Master Catalog
            • Import Master Catalog Categories Information
            • Export Master Catalog Categories Information
          • Products
            • Create a Simple Product
            • Create a Configurable Product
            • Create a Product Kit
            • Manage Product Visibility
            • Manage Product Grids
              • View Product Details
              • Edit a Product
              • Manage Product Pricing
              • Manage Inventory
            • Manage Product Units
            • Import Product Information
            • Export Product Information
          • Product Families
            • Create a New Product Family
            • Manage Product Attributes in Product Families
          • Product Attributes
            • Import Product Attributes
          • Product Brands
          • Price Attributes
        • Marketing
          • Marketing Lists
          • Email Campaigns
            • Send an Email Campaign via Mailchimp
            • Send Email Campaign via Dotdigital
            • Manage Dotdigital Data Fields and Mappings
          • Marketing Campaigns
          • Promotions
            • Promotions
              • Create Promotions
              • Add Conditions to Promotions
              • Add Expressions to Promotions
              • Manage Discounts in Orders
              • Calculate Order Total in Promotions
              • Review the FAQs
            • Coupons
              • Manage Coupons in Orders
              • Create a Sample Coupon
              • Export Coupons
              • Import Coupons
          • Tracking Websites
          • Web Catalogs
            • Create a Web Catalog
            • Edit a Web Catalog Content Tree
              • Set Up the Homepage, First Level Menu, and Sub Menus
              • Configure Content Variants for the Content Node
              • Customize Web Catalog Contents for Localization, Customer, Customer Group, or Website
              • Preview Web Catalog
            • Build a Custom Web Catalog From Scratch (Example)
            • Use Web Catalog Nodes as Root Nodes (Example)
          • Landing Pages
          • Content Templates
          • Content Blocks
          • Customer Login Pages
          • Content Widgets
          • Digital Assets
          • Search
        • Taxes
          • Product Tax Codes
            • Create a Product Tax Code
            • View Product Tax Code Details
            • Link a Tax Code to a Product
          • Customer Tax Codes
            • Create a Customer Tax Code
            • View Customer Tax Code Details
            • Link a Tax Code to a Customer or Customer Group
          • Taxes (Tax Rates)
            • Create a Tax Rate
            • View and Filter Tax Rates
            • Export Tax Rates
            • Import Taxes Rates
          • Tax Rules
            • Create a Tax Rule
            • View and Filter Tax Rules
            • Export Tax Rules
            • Import Tax Rules
          • Tax Jurisdictions
            • Create a Tax Jurisdiction
            • View and Filter Tax Jurisdictions
        • Inventory
          • Warehouses
          • Manage Inventory Levels
          • Export Inventory Levels and Statuses
          • Import Inventory Levels and Statuses
        • Activities
          • Conversations
          • Emails
            • OroConnector Add-on for Google Workspace
            • OroConnector Add-in for Microsoft 365
          • Tasks
            • Create a Task
            • Manage Tasks
          • Calls
          • Contact Requests
          • Cases
          • Calendar Events
            • Add a Calendar Event
            • Manage Calendar Events
        • Reports and Segments
          • Reports
            • Use System Reports
              • Accounts Reports
              • Leads Reports
              • Opportunities Reports
              • Best Selling Products Report
              • Search (Terms) Report
            • Use Custom Reports
          • Segments
          • Filters
        • System
          • Configuration
            • System Configuration
              • General Setup
              • Integrations
              • Websites
            • CRM Configuration
              • Sales Pipeline
            • Commerce Configuration
              • Customer
              • Guests
              • Catalog
              • Design
              • Product
              • Inventory
              • Sales
              • Taxation
              • Payment
              • Contacts
              • Search
              • Orders
              • Shipping
              • Marketplace
            • Marketing Configuration
              • General Setup
            • Configuration Quick Search
          • User Management
            • Users
              • Create a User
              • Manage Users
              • Configure User System Settings
            • Roles and Permissions
              • Entity and System Capabilities
              • Configure User Roles
              • Field Level Permissions
              • Configure End-to-End Access in Context
            • User Groups
            • Business Units
            • Organizations
              • Create an Organization
              • Manage Organizations
              • Add All Products Page to Storefront Menus per Organization
              • Customize Menus per Organization
              • Configure Organization System Settings
              • Organization Types
            • Login Attempts
            • OAuth Applications
          • Theme Configuration
          • Contact Reasons
          • Contact Groups
          • Emails
            • Templates
            • Notification Rules
          • Integrations
            • Manage Integrations: Payment Method Integration
              • Check/Money Order Service
              • Payment Terms
              • OroPay
              • PayPal Payment Services
              • Apruve Payment Service
              • Authorize.Net Payments Services
              • InfinitePay Payment Service
              • Ingenico Payment Service
              • Stripe
              • Payments at Checkout
            • Manage Integrations: Shipping Method Integration
              • Flat Rate Shipping Integration
              • Fixed Product Shipping Cost Integration
              • UPS Shipping Integration
              • FedEx Shipping Integration
              • DPD Shipping Integration
            • Google Tag Manager Integration
            • Dotdigital Integration
              • Configure Dotdigital Integration
              • Configure Single Sign-on
            • Mailchimp Integration
            • Zendesk Integration
            • LDAP Integration
            • Embedded Forms
            • OpenAPI Specifications
            • AI Integrations
          • Channels
          • Jobs
          • Data Audit
          • Scheduled Tasks
          • Entities
            • Manage Entities
            • Create Entity Fields
              • Basic Entity Field Properties
              • Advanced Entity Field Properties
              • Type-Related Entity Field Properties
              • Examples of Creating Custom Entity Fields
            • Manage Entity Fields
          • Tags Management
            • Tags
            • Taxonomies
          • Menus
          • Storefront Menus
            • Change a Storefront Menu
            • Add All Products Page to Storefront Menus Globally
          • System Calendars
          • Shipping Rules
            • Expression Language for Shipping and Payment Rules
          • Payment Rules
          • Workflows
            • System Workflows
              • Checkout Workflow
              • Alternative Checkout Workflow
              • Single Page Checkout Workflow
              • Quote Workflows
              • RFQ Management Flow Workflow
              • RFQ Submission Flow Workflow
              • Task Flow
              • Unqualified Sales Lead Workflow
              • Contact Request Workflow
              • Seller Registration Request Workflow
              • Seller Product Approval Workflow
              • Conversations Workflow
            • Custom Workflows
            • Workflow Steps, Transitions, and Attributes
          • Processes
          • System Information
          • Consent Management
          • Websites
            • Configure Website System Settings
              • System Configuration
              • Commerce Configuration
            • Create a Website
            • Manage a Website
            • Configure Price Lists per Website
            • Add All Products Page to Storefront Menus per Website
            • Customize Storefront Menus per Website
          • Localization
            • Languages
            • Translations
            • Localizations
          • Alerts
      • Commerce Storefront
        • Navigation and UI
          • General Layout
          • Common Controls
        • Register and Log In
          • Create Account
          • Log In
          • Forgot Password
        • My Account
          • Dashboard
          • My Profile
          • Address Book
          • Users
          • Roles
          • Shopping Lists
            • Shopping Lists for Registered Users
            • Shopping Lists for Guest Users
          • Requests for Quote
            • Create an RFQ
            • Create a Guest RFQ
          • Order History
          • Previously Purchased Products
          • Invoices
          • Quotes
          • Saved Search
          • Manage Payment Profiles (Authorize.Net Customer Profiles)
        • Conversations
        • Orders
          • Create an Order
          • Order via Matrix Form
          • Order a Kit
          • Re-Order Products
        • Quotes
          • Accept a Quote
          • Send Guest Quotes
        • Quick Order Form
        • Checkout
          • Multi Page Checkout
          • Single Page Checkout
          • Guest Checkout
          • Promotions at Checkout
        • Cookie Consent Banner
      • Integrations
        • Pre-Built
          • Payment Integrations
            • Stripe
            • Paypal
            • Authorize
            • Apruve
            • CyberSource
            • InfinitePay
            • Ingenico
          • Shipping Integrations
            • DPD
            • UPS
            • Fedex
          • ERP
            • SAP (B1 and ECC)
            • Epicor Prophet
            • Oracle JD Edwards
            • Eclipse
            • MDS
            • Sage X3
          • Marketing
            • HubSpot
            • Mailchimp
            • Dotdigital
            • Google Analytics
          • PIM
            • Akeneo
          • CRM & Marketplace
            • OroCRM
            • OroMarketplace
            • Salesforce
          • Customer Support
            • Twilio
            • Zendesk
          • AI
            • Google Retail
            • AI Content Generation
          • E-Procurement
            • Greenwing Punchout
          • Reporting and Business Intelligence
            • Integration with Google Looker Studio
            • Integration with Microsoft Power BI Dashboard
            • Tableau Integration
          • More
            • GS1
            • Avatax
            • Hawksearch
            • Marello
        • Custom
          • Oro API
          • Import and Export
          • OroIntegrationBundle
      • Glossary
    Version:
    6.1 (latest)
    • 5.1
    • 6.0
    • 6.1 (latest)
    • 7.0 (dev)

    Type-Related Entity Field Properties 

    Depending on the entity type selected when defining the basic properties for the entity field you are creating, additional options appear in the General Information section once you click Continue. The following is the list of field types and the options that appear once the types are selected.

    For the Decimal type:

    Additional Option

    Option Description

    Precision

    Maximum number of digits. E.g., 15.252 has precision 5. And 1.12 has precision 3.

    Scale

    Maximum number of decimal places. E.g., 15,252 has scale 3. And 1.12 has scale 2.

    For the String type:

    Additional Option

    Option Description

    Length

    The number of characters in the string. It is a number from 1 to 255.

    For the File type:

    Additional Option

    Option Description

    Stored Externally

    Indicates whether the file referenced by this field is stored externally on a third party service. If enabled, the external URL text input is displayed instead of the file upload input. The URLs of the external files should be publicly available. The URLs provided by the users should match the Allowed URLs RegExp specified in the system settings. The system will not process, resize or modify the files that are stored externally.

    File Size

    The maximum file size allowed for an upload (in MB).

    Allowed MIME Types

    The list of allowed MIME types. If the field is left empty, it means that all listed extension types are allowed. To define the MIME types allowed for upload, refer to the system settings.

    Use DAM

    Setting to Yes enables the usage of Digital Asset Manager that changes the usual uploading behavior of the File type field for the selected entity. Now, your entity attachments are first uploaded to the DA database that organizes and stores all assets in one place, and then you can select the required asset from the list of available DA records. All attachments that are saved to the Digital Assets pool can be further re-used by any other entity with the enabled Use DAM field for the File type. If set to No, the usual uploading behavior is applied enabling you to select the asset from your local directory and do not save it to the DA pool. Such attachments cannot be shared and used by other entities.

    The difference in the image uploading behavior when **Use DAM** is set to yes and no

    ACL Protected

    Enable or disable the ACL check for attachments by selecting Yes or No respectively.

    File Applications

    The list of applications where a file or an image loaded to this field should be accessible. Possible applications are default and commerce, where default means back-office and commerce means storefront. If the files or images that you want to upload through this field are going to be accessed only from back-office, then select default; if from both back-office and storefront, then select both default and commerce. Please be aware that this setting is not used when ACL Protected is set to No.

    Important

    • Fields of the File type can be only of the Column table storage type.

    • These fields cannot be defined as identity fields for export/import operations.

    • Fields of the File type are not displayed on a grid, so Show on Grid and Show Grid Filter properties cannot be defined for them.

    Warning

    Auditing is not available for actions with the entity fields of the File type.

    For the Image type:

    Additional Option

    Option Description

    Stored Externally

    Indicates whether the file referenced by this field is stored externally on a third party service. If enabled, the external URL text input is displayed instead of the file upload input. The URLs of the external files should be publicly available. The URLs provided by the users should match the Allowed URLs RegExp specified in the system settings. The system will not process, resize or modify the files that are stored externally.

    File Size

    The maximum file size allowed for an upload (in MB).

    Thumbnail Width

    The image thumbnail width in pixels.

    Thumbnail Height

    The image thumbnail height in pixels.

    Allowed MIME Types

    The list of allowed MIME types. If the field is left empty, it means that all listed extension types are allowed. To define the MIME types allowed for upload, refer to the system settings.

    Use DAM

    Setting to Yes enables the usage of Digital Asset Manager that changes the usual uploading behavior of the Image type field for the selected entity. Now, your entity attachments are first uploaded to the DA database that organizes and stores all assets in one place, and then you can select the required asset from the list of available DA records. All attachments that are saved to the Digital Assets pool can be further re-used by any other entity with the enabled Use DAM field for the Image type. If set to No, the usual uploading behavior is applied enabling you to select the asset from your local directory and do not save it to the DA pool. Such attachments cannot be shared and used by other entities.

    The difference in the image uploading behavior when **Use DAM** is set to yes and no

    ACL Protected

    Enable or disable the ACL check for attachments by selecting Yes or No respectively.

    File Applications

    The list of applications where a file or an image loaded to this field should be accessible. Possible applications are default and commerce, where default means back-office and commerce means storefront. If the files or images that you want to upload through this field are going to be accessed only from back-office, then select default; if from both back-office and storefront, then select both default and commerce. Please be aware that this setting is not used when ACL Protected is set to No.

    Important

    • Fields of the Image type can be only of the Column table storage type.

    • These fields cannot be defined as identity fields for export/import operations.

    • Fields of the Image type are not displayed on a grid, so Show on Grid and Show Grid Filter properties cannot be defined for them.

    Warning

    Auditing is not available for actions with the entity fields of the File type.

    For the Select and Multi-select types:

    Additional Option

    Option Description

    Options

    Define values that will be included in the select list.

    • To add an option, click the +Add.

    • To set the default option, select the checkbox next to the option.

    • Click the Do not set as Default link to clear the Default checkboxes.

    • To move an option up or down on the list, drag the Move icon next to the option.

    • To delete an option, click x next to the option. When you delete an option, it is removed from all the entity records in the system where it is currently present.

    Important

    • The fields of the Select and Multi-Select types can be only of the Column table storage type.

    • These fields cannot be defined as identity fields for export/import operations.

    Warning

    When editing system select fields, note that some options could be defined as system and cannot be deleted.

    For relations (many to many, one to many, and many to one):

    Additional Option

    Option Description

    Target Entity

    Select the entity which record(s)to be tied with the records of the current entity.

    Related Entity Data Fields

    Select those fields of the entity selected in Target Entity which contain information that you want to see on the master entity record edit page. These could be a couple of important details in edition to the title which give you the most important information about the related entity record. Hold the Ctrl key to choose several fields.

    Related Entity Info Title

    Select the fields of the entity selected in the Target Entity field by which the users can identify the related entity record. These fields serve as a title to the related entity record on the master entity pages. Choose these fields carefully. It would be a good idea to select a related entity name or similar information. On the view page of the master entity record, these fields will appear as links to the corresponding related entity record. On the edit page of the master entity record, you will see these fields as titles of the section that contains information selected in Related Entity Data Fields . Hold the Ctrl key to choose several fields.

    Related Entity Detailed

    Select those fields of the entity selected in the Target Entity field which contain additional information that you want to see on the master entity record edit page. The values of the fields selected will be available in the dialog box that appears when you click the title of the related entity on the master page edit page. Hold the Ctrl key to choose several fields.

    Important

    • Relation fields can be only of the Column table storage type.

    • Relation fields cannot be defined as identity fields for export/import operations.

    • Relation fields type are not displayed on a grid, so Show on Grid and Show Grid Filter properties cannot be defined for them.

    Note

    Fields of the Text type are not displayed on a grid, so Show on Grid and Show Grid Filter properties cannot be defined for them.

    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