Conversation
|
Note that these docs should be targeted to Mautic v7.x but that branch is not available yet. |
passive -> active... hopefully
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
dcjarvis
force-pushed
the
campaign-import-export-user-docs
branch
from
5defae6 to
4f4b529
Compare
|
Added further parameter to the command line for export |
RCheesley
requested review from
adiati98 and
favour-chibueze
and removed request for
a team
RCheesley
left a comment
RCheesley
left a comment
There was a problem hiding this comment.
I'm not sure if we should be using the English spelling in this cron job - I think it should be mautic:fields:analyze - @escopecz is this something we can change easily in the code? I am sure it will cause confusion in our users using the British English version.
| - Processes mail queue | ||
| - | ||
| * - ``mautic:fields:analse`` | ||
| * - ``mautic:fields:analyse`` |
There was a problem hiding this comment.
Given we're en_US should we be using mautic:fields:analyze here @escopecz ?
There was a problem hiding this comment.
Mautic is using US English if I'm not mistaken. It can be changed in the code quite easily. And in fact it's not that hard to support both. One will be an alias of the other.
There was a problem hiding this comment.
If one will be an alias of the other, can we use mautic:fields:analyze here, as our docs based on en_US?
There was a problem hiding this comment.
Sorry, such alias isn't present. We'll have to stick with s
There was a problem hiding this comment.
OK, something to consider for future reference. I can see this tripping people up in the future because they're so used to USA language but it's done now!
…nd_line_interface.rst
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
@mautic/core-team @RCheesley,
As these are new pages, I deliberately took the initiative to adjust the wordings, restructure, and add images to make them clearer and consistent.
Therefore, I need your help to review the content thoroughly.
Additionally, I left some questions in this PR on the comments. TIA! ✨
There was a problem hiding this comment.
I don't see we use this file in any content. Do we still need this?
| Supported data types | ||
| ******************** | ||
|
|
||
| When you select a Campaign, the export feature extracts all Campaign data and entities, along with any dependencies the Campaign needs to function, including: | ||
|
|
||
| * Dynamic Content | ||
| * Asset\* | ||
| * Custom Fields | ||
| * Other related dependencies | ||
|
|
||
| The export command: | ||
|
|
||
| * Detect use of Plugins and Custom Fields | ||
| * Include the data to support these dependencies | ||
|
|
||
| .. important:: | ||
|
|
||
| The importing instance needs the same Custom Fields and Plugins to be present. |
There was a problem hiding this comment.
I'm not sure if user docs need these info.
But if we do need it, I particularly don't understand about the export command here. What do we actually want to explain?
| .. vale off | ||
|
|
||
| How the exporting Campaigns works | ||
| ********************************* | ||
|
|
||
| .. vale on | ||
|
|
||
| Whether exporting via Mautic instance, the command line, or the API, the process follows these logic steps: | ||
|
|
||
| Permissions | ||
| Checks that the logged-in User has the correct permissions to export. | ||
|
|
||
| Bulk export | ||
| Supports exporting multiple Campaigns simultaneously. | ||
|
|
||
| Data structure | ||
| Exports data in a structured JSON format to ensure compatibility. | ||
|
|
||
| Asset management | ||
| Exports Assets into a separate folder in their original format. | ||
|
|
||
| File packaging | ||
| Zips the resulting collection of files into a single package for easy transfer across systems. | ||
|
|
||
| .. vale off |
There was a problem hiding this comment.
I'm thinking if we should move this section to after the "Exporting a Campaign" section. Because in my opinion, this is more like a supplement info if users want to know how the feature works under the hood.
|
|
||
| .. vale on | ||
|
|
||
| cURL example |
There was a problem hiding this comment.
Do we want to use "Curl", "cURL", or "curl"?
| How the importing Campaign works | ||
| ******************************** | ||
|
|
||
| During the import process, Mautic performs a comprehensive analysis of the data: | ||
|
|
||
| Permissions | ||
| Checks that the logged-in User has the correct permissions to import. | ||
|
|
||
| Entities | ||
| Identifies required entities for the Campaign to function. | ||
|
|
||
| Plugin validation | ||
| The import function verifies Plugin installation. It checks if a Campaign template depends on an external Plugin. If a required Plugin is missing, the import process halts and prompts the User to install the necessary Plugin before continuing. | ||
|
|
||
| Conflict resolution | ||
| Validates for potential ID conflicts in imported entities. Where conflicts exist, Mautic provides options to: | ||
|
|
||
| * Update existing entities, allowing Administrators to update existing Campaigns. | ||
| * Create new entities using a new ID. | ||
|
|
||
| Automatic data mapping | ||
| Mautic maps imported data to the correct locations and automatically creates any necessary dependent entities. | ||
|
|
||
| Campaign activation | ||
| After a successful import, the Campaign remains inactive by default. | ||
|
|
||
| .. vale off |
There was a problem hiding this comment.
Same comment here with the one in the exporting_campaigns.rst regarding moving this section down.
5 participants
Added descriptions for campaign import and campaign export.