BB-21690: Global Brands Data (#33784)

Author: yurio

backend/security/global-view-entities.rst

@@ -0,0 +1,67 @@
+.. _backend-security-bundle-global-view-entities:
+
+Global View Entities
+====================
+
+In Enterprise editions, data from the ACL-protected entities with the User, Business Unit, and Organization ownership types are separated by organizations.
+
+You can view an entity only from the organization where it was created. You can view data from all organizations only in the Global organization when the access level to the View permission is set to Global.
+
+A global view entity is helpful for cases when data created in one organization should be available from other non-global organizations. For example, when the administrator wants to create a predefined list of brands for products from other organizations. 
+
+If the entity is marked as a Global view, data created in the global organization will be available in non-global organizations along with
+the data created in this organization.
+
+You can only view a global view entity from a non-global organization. It cannot be edited, deleted, or shared.
+
+Configuring an Entity as a Global View
+--------------------------------------
+
+To see the data created from the global organization in a non-global organization for an ACL-protected entity,configure the chosen entity with the ``global_view`` parameter of the ``security`` scope in the
+``defaultValues`` section of the ``@Config`` annotation, as illustrated below:
+
+.. code-block:: php
+
+    /**
+     * @Config(
+     *  defaultValues={
+     *      "security"={
+                ...
+     *          "global_view"=true,
+     *      }
+     *  }
+     * )
+     */
+     class MyEntity
+
+If the entity already exists, create a migration to add the ``global_view`` parameter to the entity config:
+
+.. code-block:: php
+
+    namespace Acme\Bundle\MyBundle\Migrations\Schema\v1_0;
+
+    use Doctrine\DBAL\Schema\Schema;
+    use Oro\Bundle\EntityExtendBundle\Migration\OroOptions;
+    use Oro\Bundle\MigrationBundle\Migration\Migration;
+    use Oro\Bundle\MigrationBundle\Migration\QueryBag;
+
+    /**
+     * Switch my entity to the global view.
+     */
+    class MakeMyEntityGlobalView implements Migration
+    {
+        /**
+         * {@inheritDoc}
+         */
+        public function up(Schema $schema, QueryBag $queries)
+        {
+            $table = $schema->getTable('name_of_my_table');
+
+            $options = new OroOptions();
+            $options->set('ownership', 'global_view', true);
+            $table->addOption(OroOptions::KEY, $options);
+        }
+    }
+
+.. include:: /include/include-links-dev.rst
+   :start-after: begin

backend/security/index.rst

@@ -34,6 +34,8 @@ Read more in the following topics below:
   * :ref:`How to Configure and Apply Custom Permissions to an Entity <backend-security-bundle-permissions>`
   * :ref:`How to Work with Configurable Permissions <backend-security-bundle-configurable-permissions>`
 
+* :ref:`Global View Entities <backend-security-bundle-global-view-entities>`
+
 .. toctree::
    :titlesonly:
    :hidden:
@@ -47,3 +49,4 @@ Read more in the following topics below:
    access-rules
    custom-listeners
    example
+   global-view-entities

bundles/platform/SecurityBundle/index.rst

@@ -31,6 +31,8 @@ Related Documentation
   * :ref:`How to Configure and Apply Custom Permissions to an Entity <backend-security-bundle-permissions>`
   * :ref:`How to Work with Configurable Permissions <backend-security-bundle-configurable-permissions>`
 
+* :ref:`Global View Entities <backend-security-bundle-global-view-entities>`
+
 .. tip::
         Take a look an how ACL works in the application in the :ref:`Access Levels and Ownership <backend-security-bundle-example>` topic which illustrates the hierarchy of two sample organizations and access setup within them.