Skip to content

Latest commit

 

History

History
563 lines (384 loc) · 21.9 KB

bundles.rst

File metadata and controls

563 lines (384 loc) · 21.9 KB

The Oro Bundles

OroPlatform together with OroCRM offer wide range of bundles. This article gives you an overview of all these bundles. For each bundle, it is shortly described which features it offers. You can click on the bundle name to read the documentation that is distributed with the code on GitHub. When there are more detailed articles related to a bundle in this documentation, a list of related articles is provided below the description.

AccountBundle (OroCRM)

Management of customer account entities.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/emails`

ActivityBundle (OroPlatform)
Assign activities (such as calls, emails and tasks) to other entities.
ActivityListBundle (OroPlatform)
The bundle provides methods to show all activities in one widget.
AddressBundle (OroPlatform)

Base definition and implementation of interfaces for addresses and address related data like country, region, phone and email.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/emails`

AnalyticsBundle (OroCRM)
Provides tools to analyze data and to visualize the analysis results.
AsseticBundle (OroPlatform)

Extension of the well-known core AsseticBundle to easily manage CSS assets that are distributed across several bundles.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/layout`

AttachmentBundle (OroPlatform)
Allows to add file and image field types to extended entities.
BusinessEntitiesBundle (OroPlatform)
Basic business entities that should be used across multiple platform based applications.
CacheBundle (OroPlatform)
Adds abstract services as starting points for custom cache services.
CalendarBundle (OroPlatform)

Integrates the jQuery FullCalendar plugin into OroPlatform and provides additional calendar related functionality.

.. seealso::

    Read more about it in the following articles:

    * User guide: :doc:`/user_guide/outlook_sync`

CallBundle (OroCRM)
Basic implementation to log calls to and of contacts and accounts.
CampaignBundle (OroCRM)

Offers the ability to create and manage campaigns and to connect them to other entities.

.. seealso::

    Read more about it in the following articles:

    * User guide: :doc:`/user_guide/marketing_campaigns`
    * User guide: :doc:`/user_guide/email_campaigns`
    * User guide: :doc:`/user_guide/marketing_tracking_website_records`

CaseBundle (OroCRM)
Case entitiy management.
ChannelBundle (OroCRM)

Brings business entities from external applications into the system.

.. seealso::

    Read more about it in the following articles:

    * User guide: :doc:`/user_guide/multi_channel_functionality`
    * User guide: :doc:`/user_guide/channels`
    * User guide: :doc:`/user_guide/accounts`
    * User guide: :doc:`/user_guide/b2b_channels`
    * User guide: :doc:`/user_guide/magento_channels`

ChartBundle (OroPlatform)
Display different types of charts (like line charts, pie charts, flow charts).
CommentBundle (OroPlatform)
Add comments to activities.
ConfigBundle (OroPlatform)
Introduce and maintain configuration setting in different scopes. Organize and visualize multiple configuration trees.
ContactBundle (OroCRM)

Offers management functionality for customer contact data.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/emails`
    * User guide: :doc:`/user_guide/outlook_sync`

ContactUsBundle (OroCRM)
Embedded form and workflow for contact us requests.
CronBundle (OroPlatform)

An interface and scheduler for time-based command execution.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/jobs`

DashboardBundle (OroPlatform)
Organize widgets that contain useful information on the user's homepage.
DataAuditBundle (OroPlatform)

Provides changelogs of configured properties for entities.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/data_audits`
    * Reference: :doc:`/reference/format/dashboard`

DataGridBundle (OroPlatform)

UI control implementation for data grid views.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/crud`
    * User guide: :doc:`/user_guide/channels`

DemoDataBundle (OroCRM)

Contains necessary fixtures for CRM features demonstration.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/installation`

DistributionBundle (OroPlatform)
Makes it possible to automatically register bundles in the application without requiring the user to do that manually in the application kernel.
EmailBundle (OroPlatform)

Manages email templates, supports attachments and offers a direct mailer implementation.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/emails`

EmbeddedFormBundle (OroPlatform)
Makes it possible to embed Symfony forms on third-party sites and view their submitted data.
EntityBundle (OroPlatform)

Extends the functionality of the Doctrine entity manager. Adds support for entity and field selectors.

.. seealso::

    Read more about it in the following articles:

    * User guide: :doc:`/user_guide/entities`
    * User guide: :doc:`/user_guide/entity_fields`
    * User guide: :doc:`/user_guide/channels`

EntityConfigBundle (OroPlatform)

Allows to attach metadata to entity classes and offers a UI to manage them.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/customization`
    * Book: :doc:`/book/data_audits`
    * Book: :doc:`/book/configuration`
    * Book: :doc:`/book/entities`
    * User guide: :doc:`/user_guide/entities`
    * User guide: :doc:`/user_guide/entity_fields`

EntityExtendBundle (OroPlatform)

Offers a way to create new entities in the UI, to add new relations between existing entities and to add additional field to existing entities.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/customization`
    * Book: :doc:`/book/entities`
    * User guide: :doc:`/user_guide/entities`
    * User guide: :doc:`/user_guide/entity_fields`

EntityMergeBundle (OroPlatform)
Merges different entity definitions into one entity.
EntityPaginationBundle (OroPlatform)
Provides the ability to paginate data grids and entity edit pages.
FilterBundle (OroPlatform)

A reusable set of components of interactive JavaScript widgets that make it possible to filter data in the backend.

.. seealso::

    Read more about it in the following articles:

    * User guide: :doc:`/user_guide/filters`

FormBundle (OroPlatform)
Adds additional form types and form extensions.
HelpBundle (OroPlatform)
Associate help sections from external web sites to application pages.
ImapBundle (OroPlatform)
Work with email server through the IMAP protocol.
ImportExportBundle (OroPlatform)

Makes it possible to import and export data in an automated way into and from different formats.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/importexport`
    * User guide: :doc:`/user_guide/import_export_functionality`

InstallerBundle (OroPlatform)

The web installer for OroCRM.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/installation`

IntegrationBundle (OroPlatform)

Contains the abstracted logic to connect OroPlatform and OroCRM with third-party services and applications.

.. seealso::

    Read more about it in the following articles:

    * User guide: :doc:`/user_guide/channels`
    * User guide: :doc:`/user_guide/magento_channel_integration`

LocaleBundle (OroPlatform)

Formatting of numbers, dates, names and addresses based on the user's locale.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/localization`

MagentoBundle (OroCRM)

Provides integration with the Magento e-commerce solution.

.. seealso::

    Read more about it in the following articles:

    * User guide: :doc:`/user_guide/multi_channel_functionality`
    * User guide: :doc:`/user_guide/channels`
    * User guide: :doc:`/user_guide/magento_channel_integration`
    * User guide: :doc:`/user_guide/magento_channels`

MarketingListBundle (OroCRM)

Supports generating contact lists automatically for marketing purposes.

.. seealso::

    Read more about it in the following articles:

    * User guide: :doc:`/user_guide/marketing_lists`

MigrationBundle (OroPlatform)

Allows to version the application's database.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/customization`
    * User guide: :doc:`/user_guide/entities`

NavigationBundle (OroPlatform)

Define menus in different bundles in YAMl files based on the KnpMenuBundle.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/navigation`
    * Book: :doc:`/book/crud`
    * Book: :doc:`/book/reports_configuration`
    * Reference: :doc:`/reference/format/navigation`

NoteBundle (OroPlatform)
Attach notes to different entities.
NotificationBundle (OroPlatform)
Send email notifications triggered by system entities.
OrganizationBundle (OroPlatform)
Models the company's organization hierarchy and its business units.
PlatformBundle (OroPlatform)
The OroPlatform core.
QueryDesignerBundle (OroPlatform)
Rich UI to design queries based on an entity's properties.
ReminderBundle (OroPlatform)
Triggers reminders for entities via emails or as a flash message in the application.
ReportBundle (OroPlatform and OroCRM)

Build custom reports for entities.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/reports_configuration`
    * User guide: :doc:`/user_guide/accounts`
    * User guide: :doc:`/user_guide/b2b_customers`
    * User guide: :doc:`/user_guide/leads`
    * User guide: :doc:`/user_guide/opportunities`
    * User guide: :doc:`/user_guide/reports`

RequireJSBundle (OroPlatform)

Integrates the RequireJS JavaScript library.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/customization`
    * Book: :doc:`/book/frontend_architecture`
    * Book: :doc:`/book/javascript_modularity`
    * Reference: :doc:`/reference/format/requirejs`

SalesBundle (OroCRM)

Support for sales related workflows.

.. seealso::

    Read more about it in the following articles:

    * User guide: :doc:`/user_guide/sales_processes_workflow`

SearchBundle (OroPlatform)

Manages the application's search index and allows to search this index.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/search`

SecurityBundle (OroPlatform)

A flexible security model which allows to protect data integrity and privacy.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/security`
    * Reference: :doc:`/reference/format/acl`

SegmentBundle (OroPlatform)
Provides entity segmentation that can be used for further processing.
SidebarBundle (OroPlatform)
Provides the sidebar layout and sidebar widget containers.
SoapBundle (OroPlatform)
Adds support to create SOAP controller classes and generates a single WSDL file for a SOAP API.
SyncBundle (OroPlatform)
Supports websocket communications based on the JDareClankBundle.
TagBundle (OroPlatform)
Categorize entities with user-defined tags.
TaskBundle (OroCRM)

Task entity management and relations.

.. seealso::

    Read more about it in the following articles:

    * User guide: :doc:`/user_guide/outlook_sync`

TestFrameworkBundle (OroPlatform and OroCRM)

Test framework functionality and main entry point for the JS UnitTest runner.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/functional_tests`

ThemeBundle (OroPlatform)

Basic theme support.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/layout`

TrackingBundle (OroPlatform)

Provides the main data structure for web trackings and proxies tracking data to Piwik (if enabled).

.. seealso::

    Read more about it in the following articles:

    * User guide: :doc:`/user_guide/marketing_tracking_website_records`

TranslationBundle (OroPlatform)

Integration for translatable entities.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/localization`
    * Book: :doc:`/book/customization`

UIBundle (OroPlatform)

Layouts and control elements for the user interface.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/crud`
    * Book: :doc:`/book/customization`
    * Book: :doc:`/book/frontend_architecture`

UserBundle (OroPlatform)
Provides user management functionality (authentication, authorization, etc).
WindowsBundle (OroPlatform)
Consists of a set of tools for manipulating dialog windows and their states.
WorkflowBundle (OroPlatform)

Perform a set of actions when some predefined conditions are fulfilled.

.. seealso::

    Read more about it in the following articles:

    * Book: :doc:`/book/workflow`
    * Reference: :doc:`/reference/format/workflow`
    * User guide: :doc:`/user_guide/b2b_customers`
    * User guide: :doc:`/user_guide/leads`
    * User guide: :doc:`/user_guide/opportunities`
    * User guide: :doc:`/user_guide/sales_processes_workflow`
    * User guide: :doc:`/user_guide/workflow_management`