diff --git a/docs/companies/companies_overview.rst b/docs/companies/companies_overview.rst index e162421b4..950bdf075 100644 --- a/docs/companies/companies_overview.rst +++ b/docs/companies/companies_overview.rst @@ -34,10 +34,58 @@ In *Configuration > Company Settings* you can choose the operator used when merg These settings allow Mautic to find and merge duplicate Companies during the import, using the Integrations Framework and in other parts of Mautic. +Batch changes +************* + +To apply changes to several Companies at once, select the checkboxes next to the Company names. A selection bar appears at the top of the table, showing **Delete selected** and a three-dot icon for more options. + +.. image:: images/companies_batch_selection_bar.png + :alt: Two selected Companies in the list with the selection bar showing Delete selected and the three-dot menu open on Find and Replace. + +The following batch options are available: + +* **Delete Selected** - Deletes the selected Companies. +* **Find and Replace** - Replaces a value in a chosen field across all selected Companies. Selecting this option opens a dialog. + + #. Choose the **Company field** to update. Search or scroll to find it in the list. + #. Enter the value to find in **Find value**. + #. Enter the new value in **Replace with**. + + Find and Replace updates only Companies that match the **Find value**. Both **Find value** and **Replace with** are case sensitive, so the value you enter must match the stored value exactly. For example, if you find and replace on the Country field, entering 'United states' or 'united states' changes nothing - you must enter 'United States'. + + .. note:: + + To use **Find and Replace**, Users need these Role permissions under **Contacts**: + + * View permission - **View Own** or **View Others** + * Edit permission - **Edit Own** or **Edit Others** + + Users with only **Edit Own** can update Companies they own, and those with **Edit Others** can update any Company. + +.. vale off + +Find and Replace for all Companies +================================== + +.. vale on + +To update every Company that matches a specific Find and Replace value, you don't need to select any checkboxes. In the Companies list table: + +#. Click the gear icon at the top of the table to open **Options**. +#. Select **Find and Replace**. +#. Choose the **Company field** to update. Search or scroll to find it in the list. +#. Enter the value to find in **Find value**. +#. Enter the new value in **Replace with**. + +.. image:: images/companies_find_and_replace_list_view.png + :alt: Companies list view with the gear icon menu open, showing the Find and Replace option + +Case sensitivity and Role permission requirements are the same as for selected Companies. + Company actions *************** -.. vale off +.. vale off Merging Companies ================= diff --git a/docs/companies/images/companies_batch_selection_bar.png b/docs/companies/images/companies_batch_selection_bar.png new file mode 100644 index 000000000..cfac07f64 Binary files /dev/null and b/docs/companies/images/companies_batch_selection_bar.png differ diff --git a/docs/companies/images/companies_find_and_replace_list_view.png b/docs/companies/images/companies_find_and_replace_list_view.png new file mode 100644 index 000000000..3077862e6 Binary files /dev/null and b/docs/companies/images/companies_find_and_replace_list_view.png differ diff --git a/docs/contacts/images/batch-actions.png b/docs/contacts/images/batch-actions.png deleted file mode 100644 index ab92bd126..000000000 Binary files a/docs/contacts/images/batch-actions.png and /dev/null differ diff --git a/docs/contacts/images/batch_actions.png b/docs/contacts/images/batch_actions.png new file mode 100644 index 000000000..f4f2c0900 Binary files /dev/null and b/docs/contacts/images/batch_actions.png differ diff --git a/docs/contacts/images/contacts_find_and_replace_list_view.png b/docs/contacts/images/contacts_find_and_replace_list_view.png new file mode 100644 index 000000000..932961402 Binary files /dev/null and b/docs/contacts/images/contacts_find_and_replace_list_view.png differ diff --git a/docs/contacts/manage_contacts.rst b/docs/contacts/manage_contacts.rst index 5722b59b9..5d363a0ff 100644 --- a/docs/contacts/manage_contacts.rst +++ b/docs/contacts/manage_contacts.rst @@ -129,45 +129,77 @@ So, Mautic takes care of duplicate Contacts created by the event tracking. You c | -Batch actions +Batch changes ============= -To make updates to several Contacts at once, select those Contacts then click the green arrow at the top of the checkbox column. +You can use this feature to quickly update large volumes of Contacts, but if you need to change more than a few hundred Contacts at a time, it's better to use a Campaign - for example, add the Contacts to a Segment, then run a Campaign to trigger the change. -A modal window displays when you click one of the actions, with more configuration details. +To apply changes to several Contacts at once, select the checkboxes next to the Contact names. A selection bar appears at the top of the table, showing **Delete selected**, **Export to CSV**, and a three-dot icon for more options. +.. image:: images/batch_actions.png + :align: center + :alt: Contacts list with two Contacts selected and the three-dot batch actions menu open, listing options such as Change Campaigns, Export to Excel, and Find and Replace. +You can find the following options: -You can use this feature to quickly update large volumes of Contacts, but it might be better to use a Campaign action - for example add all the Contacts you need to update into a Segment and use a Campaign to trigger the change - if you need to change more than a few hundred Contacts at a time. - -.. image:: images/batch-actions.png - :width: 200 - :align: center - :alt: Screenshot of Contact Batch actions - -| - -The following batch actions are currently available: +.. vale off * **Change Campaigns** - Allows you to add/remove the selected Contacts to/from Campaigns. * **Change Categories** - Allows you to add/remove the selected Contacts to/from global Categories. -* **Change Channels** - Allows you to subscribe/unsubscribe the selected Contacts to/from communication Channels (Email, SMS, etc.) and also define frequency rules. +* **Change Channels** - Allows you to subscribe/unsubscribe the selected Contacts to/from communication Channels, such as Email and SMS, and also define frequency rules. -* **Change Owner** - Allows you to assign/unassign the selected Contacts to/from an owner (a Mautic User). +* **Change Owner** - Allows you to assign/unassign the selected Contacts to/from an owner. -* **Change Segments** - Allows you to add/remove the selected Contacts to/from Segments. Note that if you add or remove a Contact to or from Segment manually, then Segment filters won't apply for them in that particular Segment. +* **Change Segments** - Allows you to add/remove the selected Contacts to/from Segments. Note that if you add/remove a Contact to/from Segment manually, then Segment filters won't apply for them in that particular Segment. * **Change Stages** - Allows you to add/remove the selected Contacts to/from a specified Stage. -* **Export** - Allows you to export selected Contacts to CSV. +* **Change Tags** - Allows you to add or remove multiple Tags across the selected Contacts in a single action. Selecting this option opens a dialog with 'Add tags' and 'Remove tags' fields, where you can select existing Tags or type a new one to create it inline. You see this option only when an administrator turns on the Tag Manager Plugin and grants your User the Contacts **Edit Own** or **Edit Others** permission together with the Tag Manager **View** permission. + +* **Export to Excel** - Allows you to export selected Contacts to Excel. + +* **Find and Replace** - Replaces a value in a chosen field across all selected Contacts. + + #. Choose the **Contact field** to update. Search or scroll to find it in the list. + #. Enter the value to find in **Find value**. + #. Enter the new value in **Replace with**. + + Find and Replace updates only Contacts that match the **Find value**. Both **Find value** and **Replace with** are case sensitive, so the value you enter must match the stored value exactly. For example, if you find and replace on the Country field, entering 'United states' or 'united states' changes nothing - you must enter 'United States'. + + .. note:: + + To use **Find and Replace**, Users need these Role permissions under **Contacts**: + + * View permission - **View Own** or **View Others** + * Edit permission - **Edit Own** or **Edit Others** + + Users with only **Edit Own** can update Contacts they own, and those with **Edit Others** can update any Contact. + +* **Set Do Not Contact (DNC)** - Sets all selected Contacts as DNC for the Email Channel and allows you to enter a custom reason explaining why you unsubscribed them. + +If you need to delete large numbers of Contacts, visit the :doc:`Segments` page. + +.. vale off + +Find and Replace for all Contacts +--------------------------------- + +.. vale on + +To update every Contact that matches a specific Find and Replace value, you don't need to select any checkboxes. In the Contacts list table: -* **Set Do Not Contact (DNC)** - This action sets all selected Contacts as DNC for the Email Channel, and it allows you to provide a custom message as "reason" for why the Contacts were manually unsubscribed by a Mautic User. +#. Click the gear icon at the top of the table to open **Options**. +#. Select **Find and Replace**. +#. Choose the **Contact field** to update. Search or scroll to find it in the list. +#. Enter the value to find in **Find value**. +#. Enter the new value in **Replace with**. -* **Delete Selected (batch delete)** - The batch delete action in the Contact table allows the deletion of up to 100 Contacts at a time. This limit is there as a performance precaution, since deleting more Contacts at a time could cause performance degradation issues. +.. image:: images/contacts_find_and_replace_list_view.png + :alt: Contacts list view with the gear icon menu open, showing the Find and Replace option -If you need to delete large numbers of Contacts, visit the :doc:`segment docs` which explains how to delete thousands of Contacts easily. +Case sensitivity and Role permission requirements are the same as for selected Contacts. .. vale off