diff --git a/user_guide/data_management.rst b/user_guide/data_management.rst index 929c71951..73d00e202 100644 --- a/user_guide/data_management.rst +++ b/user_guide/data_management.rst @@ -107,7 +107,7 @@ Create New Records and Edit Existing Records To change the details of an existing record or to create a new record, you need to (re)define the record properties on its Create/Edit form. -The Create/Edit form details are described in the :ref:`Create/Edit Forms `` +The Create/Edit form details are described in the :ref:`Create a New Record and Edit the Record Details Pages `` guide. Tag the Records @@ -236,4 +236,4 @@ Related Documents :align: middle .. |BReset| image:: ./img/buttons/BReset.png - :align: middle \ No newline at end of file + :align: middle diff --git a/user_guide/data_management_form.rst b/user_guide/data_management_form.rst index 6066fcbf3..aeb8b72b7 100644 --- a/user_guide/data_management_form.rst +++ b/user_guide/data_management_form.rst @@ -1,71 +1,94 @@ .. _user-guide-ui-components-create-pages: -Forms to Create New Records and Edit Their Details -================================================== +Create a New Record and Edit the Record Details Pages +===================================================== -In order to create a new record of an :term:`entity`, or to update details of the existing record, use the dedicated -Create/Edit forms as described below. +.. contents:: :local: + :depth: 3 + + +In order to create a new record of an :term:`entity` or to update details of the existing record, use the dedicated **Create ** and **Edit ** pages. Create a Record --------------- -Click the :guilabel:`Create {Entity Name}` button in the top right -corner of the grid to get to the *"Create ..."* form. +1. On the **All ** page (the page with the list of all entity records), click the :guilabel:`Create ` button in the upper-right corner. The **Create ** page opens. + + | + + .. image:: ./img/ui_components/create_page_example.png -- All the editable fields of the entity will be displayed in the grid. + | -.. note:: - The list of fields available from the form s defined by the system administrator - (:ref:`Show on Form ` settings defined for - fields of the entity). + .. note:: -- Mandatory fields are identified with a red asterisk. + The default list of fields available on the page can be modified by an administrator. For more information, see the description of the **Show on Form** field in the :ref:`Show on Form ` guide. -- If there are several sections, they are displayed one after another and allocated into different tabs. -For example, this is a *"Create Email Campaign"* form: -| +2. Fill in all the required information. + + Note that mandatory fields are identified with the red asterisk. -.. image:: ./img/ui_components/create_page.png + | -| + .. image:: ./img/ui_components/create_page_asterisk.png -You can click on a name of the section you need (e.g. *"Email Settings"*), and this section will be -displayed at the top: + | -| -.. image:: ./img/ui_components/create_page_tab.png -| + Available fields are usually gathered into logical sections. Click the section name to scroll the page to the fields that belong to this section. + + | + + .. image:: ./img/ui_components/create_page_sections.png + + | + +3. Save the new record or discard it. + + To save the record, click one of the options in the save menu in the upper-right corner of the page: + + - :guilabel:`Save`—Save the changes and stay on the **Create ** page. Use this option if you want to make more changes to the record configuration. + + - :guilabel:`Save and Close`—Save the changes and close the **Create ** page. The record view page opens. + + - :guilabel:`Save and New`—Save the changes and open a new **Create ** page. The blank **Create ** page opens. Use this option if you want to immediately create another record. + + To discard the changes, click the :guilabel:`Cancel` button in the upper-right corner of the page. + + | + + .. image:: ./img/ui_components/create_page_save_cancel.png + + | Edit a Record ------------- -To change the properties of a records, use the Edit form. In most cases, the only difference between the *"Edit"* and -*"Create"* forms is that previously defined field values are already filled in. +To change the properties of a record, use the **Create ** page. -.. note:: +1. Do one of the following: + + - In the grid on the **All ** page (the page with the list of all entity records), choose the entity record you want to edit, click the ellipsis menu at the right-hand end of the corresponding row and then click the |IcEdit| **Edit** icon. - Some of the values cannot be re-defined, subject to the system requirements. + - Open the entity view page and click the :guilabel:`Edit` button in the upper-right corner. + + | + .. image:: ./img/ui_components/edit_page_example.png -Form Action Buttons -------------------- + | -In the top right corner of every *"Create/Edit"* form, you can usually see two Action Buttons: :guilabel:`Cancel` and -:guilabel:`Save` or :guilabel:`Save and Close`. +2. Modify records and save the changes as described in step 2–3 of the `Create a Record <./data-management-form#create-a-record>`__ section. -.. image:: ./img/ui_components/create_action_buttons.png +.. note:: -- If you don't want to save the changes in the system, click :guilabel:`Cancel`. + Some of the fields labels cannot be changed after the record is created, subject to the system requirements. -- To Save the changes applied and stay on the form, click :guilabel:`Save`. -- To get to the :ref:`View page ` of the entity record, click - :guilabel:`Save and Close` .. |IcDelete| image:: ./img/buttons/IcDelete.png diff --git a/user_guide/img/ui_components/create_page_asterisk.png b/user_guide/img/ui_components/create_page_asterisk.png new file mode 100644 index 000000000..2aabbaab8 Binary files /dev/null and b/user_guide/img/ui_components/create_page_asterisk.png differ diff --git a/user_guide/img/ui_components/create_page_example.png b/user_guide/img/ui_components/create_page_example.png new file mode 100644 index 000000000..07df724e6 Binary files /dev/null and b/user_guide/img/ui_components/create_page_example.png differ diff --git a/user_guide/img/ui_components/create_page_save.png b/user_guide/img/ui_components/create_page_save.png new file mode 100644 index 000000000..aa51be280 Binary files /dev/null and b/user_guide/img/ui_components/create_page_save.png differ diff --git a/user_guide/img/ui_components/create_page_save_cancel.png b/user_guide/img/ui_components/create_page_save_cancel.png new file mode 100644 index 000000000..aa51be280 Binary files /dev/null and b/user_guide/img/ui_components/create_page_save_cancel.png differ diff --git a/user_guide/img/ui_components/create_page_sections.png b/user_guide/img/ui_components/create_page_sections.png new file mode 100644 index 000000000..f4acf8039 Binary files /dev/null and b/user_guide/img/ui_components/create_page_sections.png differ diff --git a/user_guide/img/ui_components/edit_page_example.png b/user_guide/img/ui_components/edit_page_example.png new file mode 100644 index 000000000..b3b461afd Binary files /dev/null and b/user_guide/img/ui_components/edit_page_example.png differ diff --git a/user_guide/index.rst b/user_guide/index.rst index facf28823..251518150 100644 --- a/user_guide/index.rst +++ b/user_guide/index.rst @@ -1,26 +1,35 @@ User Guide ========== -OroCRM is a highly flexible open source CRM that can and should be custom-tailored to meet the specific needs of your -business. Our belief is that the software should yield to business needs and adapt to the way you handle your -business — so all sales, marketing, support, and administrative activities appear familiar, convenient and as a result, -efficient. - -With OroCRM you can easily store and process all kinds of customer data; record and analyze your customer interactions; -and manage your sales from a prospect to a close deal. OroCRM also possesses comprehensive marketing and support -capabilities, and our extensive Magento integration provides unprecedented eCommerce CRM experience. Convenient user -interface of OroCRM will ensure that all necessary details are always at hand when they are required. - -This guide will provide you with the detailed overview of all capabilities, tools, and functions of OroCRM. It is -divided in sections that gradually explain the system from the very basics of setting up a user profile and generic -data management tasks to more advanced CRM concepts such as Contact and Account management and then further into -specialized areas of handling sales, marketing, and support-specific duties. The final part of this guide is dedicated +OroCRM is a highly flexible open source CRM. It can be easily custom-tailored to meet the specific needs of your +business and to make all sales, marketing, support, and administrative activities appear familiar, convenient for your employees, and as a result, efficient. + +With OroCRM you can easily: + +* Store and process all kinds of customer data. + +* Record and analyze your customer interactions. + +* Manage your sales from a prospect to a close deal. + +* Manage your marketing campaigns and other marketing activities. + +* Provide support for clients and stuff. + +* Engage into eCommerce using extensive Magento integration. + + +This guide will provide you with the detailed overview of all capabilities, tools, and functions of OroCRM. +It is divided in sections that gradually explain the system from the very basics (e.g. setting up a user profile and generic +data management tasks) to more advanced CRM concepts(e.g. the contact and account management) and then further into +specialized areas (handling sales, marketing, and support-specific duties, etc). The final part of this guide is dedicated to system administration and configuration. If you are reading it for the first time, we recommend that you begin with :ref:`Getting Started section `, and then continue -to :ref:`Data Management Basics `. The -:ref:`OroCRM Users and Their Benefits ` page will help you find out which sections of this +to :ref:`Data Management Basics `. + +The :ref:`OroCRM Users and Their Benefits ` page will help you find out which sections of this guide are most relevant for your work duties. @@ -64,6 +73,7 @@ guide are most relevant for your work duties. * :doc:`/user_guide/business_intelligence_reports` * :doc:`/user_guide/rfm_user` + | * :doc:`/user_guide/common_features` @@ -71,13 +81,11 @@ guide are most relevant for your work duties. * :doc:`/user_guide/common_features_accounts` * :doc:`/user_guide/common_features_channels` * :doc:`/user_guide/common_features_multi_channel_functionality` - * * :doc:`/user_guide/common_features_contacts` * :doc:`/user_guide/common_features_contact_groups` | - * :doc:`/user_guide/sales_index` @@ -99,7 +107,6 @@ guide are most relevant for your work duties. | - * :doc:`/user_guide/marketing_index` * :doc:`/user_guide/marketing_lists` @@ -109,7 +116,6 @@ guide are most relevant for your work duties. * :doc:`/user_guide/marketing_tracking_website_records` * :doc:`/user_guide/marketing_campaigns` - | * :doc:`/user_guide/support_index` @@ -136,7 +142,6 @@ guide are most relevant for your work duties. * :doc:`/user_guide/notification_rules` * :doc:`/user_guide/workflow_management` - | * :doc:`/user_guide/admin_index`