From b93812dde61cb3d8706933232e2a7d8b9ec7e52f Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Mon, 29 Apr 2024 17:10:04 +0100 Subject: [PATCH] Add docs for scheduled export of contacts --- docs/configuration/command_line_interface.rst | 5 ++++- docs/configuration/cron_jobs.rst | 15 +++++++++++++++ docs/configuration/images/export-settings.png | Bin 0 -> 12090 bytes docs/configuration/settings.rst | 13 +++++++++++-- 4 files changed, 30 insertions(+), 3 deletions(-) create mode 100644 docs/configuration/images/export-settings.png diff --git a/docs/configuration/command_line_interface.rst b/docs/configuration/command_line_interface.rst index 889c9979..3af9386b 100644 --- a/docs/configuration/command_line_interface.rst +++ b/docs/configuration/command_line_interface.rst @@ -103,7 +103,10 @@ These are the commands you may need to use in relation to your Mautic instance. - * - ``mautic:contacts:deduplicate`` - Merge Contacts based on same unique identifiers - - + + * - ``mautic:contacts:scheduled_export`` + - Processes exports of Contacts to a CSV file and sends the results via Email. + - * - ``mautic:custom-field:create-column`` - Creates the actual column in the table - diff --git a/docs/configuration/cron_jobs.rst b/docs/configuration/cron_jobs.rst index 433d6f21..ae31d400 100644 --- a/docs/configuration/cron_jobs.rst +++ b/docs/configuration/cron_jobs.rst @@ -157,6 +157,21 @@ To import an especially large number of Contacts or Companies in the background, The time taken for this command to execute depends on the number of Contacts in the CSV file. However, on successful completion of the import operation, a notification appears on the Mautic dashboard. +.. vale off + +Export Contacts cron job +======================== + +.. vale on + +To export Contacts to CSV - sending the results via Email - use the following command: + +.. code-block:: bash + + php /path/to/mautic/bin/console mautic:contacts:scheduled_export + +The time taken for this command to execute depends on the number of Contacts in the CSV file. However, on successful completion of the export operation, Mautic sends an email with the link to download the CSV. + Webhooks cron job ================= diff --git a/docs/configuration/images/export-settings.png b/docs/configuration/images/export-settings.png new file mode 100644 index 0000000000000000000000000000000000000000..e342b2fb4db93f38f8f2e527755cdc37d1682ee7 GIT binary patch literal 12090 zcmeHt_fu1Cw>Bc^BN4$uumToDs;CsDMi5ZCK#q-UanOB(e2b?*->;xwJ-uGJTy4Skawf0+0btPt|t4wrsbj&ZF zKhvV4V`!s&kN)Qr?fTwBL6i1z!b?j@jtyhb+^xNevMSYHE6* zX#3#o0)!)W4cimg_XI<1c<(3Gz?q5nqR$BOko)|Y6-0M};qS|OB!~|BSxGm=;Z`Ue z{Xbm)d3k(-{s9NWk(+1>X`Eq=^mD9D7C3SbZ3*b*zN2e#g@)!c{L>~?IiU(Xx(`q& z=$+j$`vWy=(=%9R7`on#K4wV}SI49O-0}Z6V49ba;z&ph4RoN ztvfIBIwgvXH!c)h0(#4{KelLLxH?sm(wp9tquvOd?052daEwEs*Y30Cf{N6C2Et54 z31A;tkL8A|Rr`w_v3yZ_Y0_C)-UMkFhAi-Q`(016mVD^_ zUb)?CL_pFHglv%+#6~q!4q_C%*xTprV;FN?v-Pl6cgul^sqWPze)AaT(Ls%P{ycuo zOJh0Aj#IC{-F#Knw?%dwx66rHN19E=4H%7zu1zjL_I_LuCG2_RSnav%NareleD+;E zV<@XhotHf6Fo}^qh3HRQJxzs7VCpE}=dRuJ$bJJuyJu4msM3(kUXz-F%&G&jsN0!K z;>UTmMvlu6I*P!ZgKwqk=~^|S^FD3LW|-hyC*WCMQJR#%C)?xQ+>q^2gG&D(#8e18 z<)QWSEKV_k-pBkkZFBR`odXYJ6H;(?H2c4k=4Ey&aPjd3U9>>qr3)AG(wjJR2~YWH zUzdYroQzM7HEN`v(V98fT^@bwrJQi9Fz)V)MHot;fE+x;c~#0XCd89h>+Zn2kHiT~ zrIGs3zE=`|^#yL_FDglL2O+`bUVhTsAX{G0IQjbnh@VqoMpu&jY6`G^mUON9djFhX z8K1&t+u8)+={Jes*)&6x*!LL1Y_56ZsAG6YLlcEkt)6jC3(Dhp&*C-6Wzz5YB>DbU zY~KXae0SEfGZzKp`y5;WnNR z(v`E8R=yy_=U3LYR*nsk$q}D2gl#Wr+i!nKQI30@1xUWY&7||X8Fc8e{$~7D@F^R+PUO6Csh0Ok1$YCMW)7N3cwV+Xz2u0g#p9B%$!_TT->8A~$P!pUv}3x#HAIV3ZPJ=d{(=ydrIM z{a}INzS2acz@_rr4sp*AOvS`&TifQn?>?S#eaYO`qW7+GJTE7Tt;WpEZS?EYR$csI zHGBzmeaU7{ALXBv7h8mfH3u3=erGPs?YW{|*YDolD}Pmn!heH8-X`kBYy4Gq{_9U; zJz6r+x0Y^OIakFz`1(FR!N%yak$1*i%Bb0WR;Td|t45+fqs`Aa!+5*kl6{rx8n073 zMMV*`nDD^8?N>gzA;#k_r-OQU%)z>Z9oXzzr4QBPuz?)e1q|sw-0K+bi_#IaKzN4S?zP?yB_@T?PwZ!_u3yh|0AQw8Q*>l(S zyA+EZn2PAT_xO&E=rs-9`lKlMs{vz5hUE$9iIgXKC^)*T`l;)bH`gGjhn+87=3)-1 zI8RBUyLVODp<^OuJY;$^^#N9de_l>FKzqKTR(3I_D%Zs95%%Gd(=?&JzY@`8u6$8X zK^ML+!pLZX5Qui}w%%hxMnd(8QL(U>tNF%FWgq&5T_!!A56vG;6WkK-ytw7#0_ad= z4pd(nytB1yJqJAwgpuigKnOs-zkb-%v6kO!+`q_+v;UFWR~HI*?Or0eTbt-@h}bTR z82()abFXKQsV+k}>hbMD$cWK)Y^a z0p8v^r7rfH;S9Z~kL7KjDRg>>V{6_ah3OI5Z*n1H7|!*vel6Zqn~U4B=z!m4zG4&mXkhl4>bZa=OMmzTjEw{E0X-Owz7@=qjv zG{Mbdid;|VeY3SNB6h@An0wB_rygEG$rY`twCm(8{!4N^sL6Qg^qp1N;E^gN+`=O}<=nQn7x${w6&v0YLFEC2F`wZ^mxl)) z#dy2EM0A+@LZ8W$*p>8F)i`dooTs;>Bi~;4Yb2Qu6+LuZ8(;R6BZFfID2?!D9DV%%R;CUD<<@;|l@hf&wk?=;fQFWq3e#EuS$b8Dqh480 zr1d=2=+v=eFrC3p^YOuLx}%ujniixv*{xW-{21;lbsxkvzpq4V_5SX#K+Q(9fKC~@ z*&YK^U(--f&sHoQ-O+G|R@1trhRUg)W4fjF2ATm2oG0jxJdEyy+n>(NsWDmbXlFL< zM>C*LmY(jIdOP(8TWJ4BM#mVi^``|3VW2yPtTu4d>@FtSRvlx&0wb;6qy9s8OmXy8 zq1kPO|LJ@Tnd<}444|B+JBIoEci^VJ(X-z-9nNYxhtIe^Mwm8uDEjxlEol(}2DD!D z44Z5s3`{Ua50?htu<8B8+ku%VgVX~BOtViB9r05EYi|c2GM7bl3$^pL{`H4gz6#!p zS5KG7-Bo(0yA-DZch90nqD+m=%v(D+E1lc(9S4dw*zl}a;u&VaiyYl4Dpe-$KTQkV15ipRby z;*s^Yq%hNBBN4s$a3XObt7*7UMcn0JgU2URiLzBn+F8!?!BIhGAzSHH&ieVZ6kngI zmbRI73PsMC@A(W=7lg}} z^Ia#Y;gR*{4vh@htO5W&_~>`#Qof*s$7W9Wx#fJ_RS5?oyA!d)=|+NxgH}wYh=O!I z3W4*cuF)^X=Ba9;csP8lDj-v3E~zLg$&34+v#)TeP4;i=UJ+I)2mblzgsjVNKYpw~ z=}&}!t$kwq`P41}Uu9cqKlJoP z+?|2b@;Hx>-jC9$l+h3nj#~OMj7cgt*llO~w2Ur9%xlLuT_#9T6b2sPcQN99`kKLz zJR-py>{dgr+ci2Qj((+%yic#6fUNkl{Aw_>lJO-(ahKvlgdNjRCe%iF)G{VN0xRU( z7%*B@^I(o=X`WJAGU2v_@8Sn+iylhV0kYh$dxd)D&T7Mt4u4Y56}_A2B9D{eQ(wMtQ72Z?8p%6_ zxGy(d)iMHamH0#O*(+mfsFoqVHfO=L`dyCQ+Lkb;tBhQdd-T~)S*qFQ~3 z^uq-Ej|Tb)U>X5F6QA!e6PLTz5a`G0gBY^wMTdO>bY%#pUi+RpiR%}~6=O1j$lI9_ z9E0mGttQH~vwdGOUzgH}mNA%@aXO({$(Jzk1o)Y<`;q!M1l|QR$cOTQ?=7Gme|_E{ z?PGApjET}0S)|;X>Rv5Rr>&N@>_=KtD+YOO|b>`OH5tl(XR;0 zJ~>^m#TwQKKn1x`Al}DTk<*~Z{wSE`%iubH%F2Jdh3LXDUS5veYxxP;y<$>3eRiUYnTLh`*dVt}R#cciTUWx%P3uk( zw;4-mquT7LC5+M|+n?xEHx`|xIPOn(A&$G{9n8yx-SCnc_ZIpak}#d3FH|$LhqtgWJaW3pNm z?Xf%Q%l$hxhZQ#P3|_sRsN#?3`RfCNf$O>I30>d|2A3`8h&MQcw>QAM`$2uCO=fMi z=}!W5!Hx~n>LD|=SIZm=>dUMLidc9|HZCbtdE3hRHXAvPpyJ6zVJa8%RJ8~1yr^8; zN^q4lw+8y)(nmNWrFRx@BL+Tl>Bw@CfV4{v&T~0z3WgqNU-gLqY4ryXnVKO|C zv^ZDm8a-2M)~LLw&bH&%27=Ts$41V$?~G*P06Y*2F4yfFaha~lEY_FmW293vtU%}e zG}>;hyI=9DJzuCF8LW-=={koc5&f%8Ke{FdQvZF4P#Vg9!dV-|jXR$Zu-EeG{MYXe zqdy)P)>>!41IJeWF3uH&iQ6wJ=W*`|PUkvxe}P zh3RkdS2w1npH~Md0&DbH#mHX^g|;}xahWK#&LslgQ1)f58{ECUb-zi$aRz@=Hy`a~xZSB$ zt*HGyRyX_E+h0cYYWOBCefxrpdpZ-~_aktVZcfXXYfpL@5h%XG1xK9`Y-2zT9YQ~u ziBC7D)F`@u!4ii!>|s>e5ioSOe>&A~aa+{?;F(}D6^XBe6m!r5%L%9#*xvkkbGC#z zRXdY%veJD+Yxj0J5;Qh-!2ukI_UUnUeut9fQArsN+F39Q1}CIcmeg2(qu&?x*goAm zACuu$w~jss=mhqq`z;)xE${wK+1j*dvHTonzH8mL=9(hj)Xs5*c=-AY1}g96gfe`(-!;XOEd@ z4rapoC-S&K@8Mc8!a-9-EGECT+dg#iq3U**@qDd;-&3XQmV1&PA*v1ARv|mdk(fP? zA=}Eebr@WxEb5EJzo)xk`GHE-P?f!o9pK(5Pz6xe!iiyO3sfVv_Wi7a7}i|aD0QqR z6Y4S4Rj1;~a7d=p&jlxwAs;|pU_{spv!X*jEr1!O1DHNl{HD8Z*G6|?F&fMu~ zn5g;+AbL9+66E?887whInLj$NkKyzH3yLwR)2|-@r~)9e<7BmvdBu9E9WK}v?!H%9 zU9C$aoQgX@4V*=S&u`@^FT=X!GPKQ@4?Ji1#m?wT@zu5cl#v4qy*5w} zCbqju&#*}xARV0mn=biPj@Ne+##-734R5jslVF1J9~mumuh_G_&I~SV2HQ^l0QL9} z8H^aUaaisg{_2d!H-Gzg%_RfXI?xJN0lz{#2oHverSb{9i?p4jRHh6O=0*2UL@(enuuy zzd94Boq>D?sIse#`g%))xsVYh)T+f!EZORNY`y7ArC1KHn9Wtr-9z$@XTr0c`7XWj zO3#~#hbN~<@5j86Kc?dBsWl-xwGwNAPUko%YVn!HlnJmY+rHUT(E`2iqF1V?UTWv} zz1x(&b;@#8!rS}XM8S;wr-hja@LU*4sJT2?$BSLSGpI;_wLDlI_}rlBfzy2O9-%2= zi$XSWD_zI<3hN2QT$k=8dX{x;$D}kBq{vYurnM(+v^q$;3POp>p_2a%qOw`G80TVC4RkxnqI>@Gl%>*)i#4ux?^y+ z5cYTaO~q|*FD$J>ldAa)Iqze~ZK3+B3r;oFH@%mpuuWn8m_3;T(eWzBnb)_Sw%sBa z?SYYR2!241sq^rPB6>c;T&!uO&BIy!a$L|ZTk!dXokZ>7q4mxFrZXaNNSpqvFdCObGwO=t1u2de}q!X}h4AK%*1bO2-*kA|G|= z7tSXH&_CasmIwV8=amqGV(kugg<4_tBSwprH6?5vC@PWu6X^~hw4dR;+q z(;6T}GytLaj)Q;tg}!05c=<$Nok^AT zo|)Cg`obu%?yFL4UA4I(XjU>ifCc9Vyq6{gQFa*0@xYV^U@f4E*55zgRx%;#wY)iV zDEr=*Ie>!1VudJx zQ#riJ&KmeJrt>u{U6xvOA}9c#%~%LW*T`7T1Pmy6XApmuec+ir3}SPuI(%3cVKOw; za}C4DN=J8Y@z1*edu|*9jkbGzMzJFBPpX+R>3A@ZBCLUxyE4Ql1Q#lY)j)8;`O*PY zO$yHz><5*paCoSF&RGVDoHqVjTX3!XBV}rL#MX^?{i1B>G?QA24Yz9H94e_|#kM_Z zt5eVFZ1>~fay7mZjNxHNbg$|xP#U9U)ufp`ev2qlc&7 z9og4ET&&kl&?83|J%s-5p=rdX*@Xwh<&71*a`HIAJ~D<5s_(r0nEgoUWd%)FU5wP_ z0s?_~p`oEz*SHOfW_BSHoxx{s=UO#s>igfUiHoK--aBpi{rwGXP0bIznX;UOX1);)gQp z&I|Wjg^l>wBg5X*fCPFtUr%<42ppWelt;(@evHa+Pa{!)ga~5cwj$^FP!b<#{|z11 zNIiNCbDMKTy$?Z`COXZHG`F&J&?7_pHNzMg?)Bs51Ogv>JB6FGEd2wfwux&J^73qa=Og`gO0Hd0I#Ry(xZD>QEYT~tFbk;A<@yPg z72OC+>NX3R=d8BG-g_qvwcD$`$<2 z#5d^YlGxGWf6ux5eFlf0kDROnPxl^iUubgzy$3MzXG-;R&UeWJGFEf7@%JQ%mjhtFLxeo{SWb z-sy&HRMN!9+|I8Ne0URsY|)L+rz{Bxup(~-6?}bA6MR~F*J%#}7x8YzkdQ7uK2*0| zN}k-V%oo77q)+}J_Tqv`V;ir9fv(JIUYod_y35yBVBH7^YovnHm3`qOIe^Pun}IfS zN)?_p5p|h-(f5hJP$2oC!{&CZ2@8@_%modfBo%ze-_SwmoN<{%Y2R@os-7;$(ubF!Z&&{HLrCb_l(bD>7#B8sX!sVg`z6aADbp-zvq7rf1ROzL%w`csXfWizsQAIYH87&8}>J##CZ ze><}O0jTCz9@U{w4+y*qLA%Qn`&)cw#R!;=0K9kANa4S>wsLpNNla%%Y1470N)0CC z6NMfQG2r$zZFJe%U$WZ9Bx@U@a~ieoC>QmY3KRF8k)*)#`4lT|)@by@O^aiYn)lDd zCy)S5nH|B45jB3$BTG>G>e5sGO8?^43SaMM_M;9@>y$WLYn&*8F3Xrn8^*_~afy{a zV{FvTZkXD)3^S!#)^_L?WZ5!CIdtx1int8aw%(foIQgbm|4KGxGT%=IcdoUtJ%nOlP%xKA@p7HAD*vVa7zAZD}ekwbc z6g;O=(7CCynrI(sY4TqUXpcx>eM|Ou-A|hgN}yI{x<0=eVTb+FR7A$qOqP$ zAj{MSUNdFsy&|(y?HSasVJ2o@d~5gjW~|!*={|9A(+_j~K2*OVDemGi$NVvSWI0Gc z;02ddRME<_)wN%gw&Q)Jn8+b#)OEI7?lNcfZe*MP(mNqabWbZ?7MEC*T z_e`5*MOxaMqkMrj({1>t%~GfIPPegzBZQ& zHcv{_ddfuk4rXDh;@n(tEm^>AJRRolz!8uxZ^ua<~vWDe!TdmarH)|y9G zZcZ0+p9J;Ly}u!ur;;SZtDUF1@sPGeBx4;&^#qiO`Rs@2HCK(UbL(t02H!S)1Z~s3?2(>awwGM-xMD%YOG$8tUj3hrg3gc-D+N_u5zKr$}dUS%Jfrg#=cCg(sTp={#&(OAEPxZ#p?C^ia z{a@t%TSobxVaae1wEgTeJ5O)gF{ou|;9aNEoxOR}b*n3Zf%Y;y-3tZvX9zj-*Z&V- C|8mj* literal 0 HcmV?d00001 diff --git a/docs/configuration/settings.rst b/docs/configuration/settings.rst index 8c40ac72..c869f447 100644 --- a/docs/configuration/settings.rst +++ b/docs/configuration/settings.rst @@ -319,7 +319,7 @@ See :ref:`here` to set the Contact's Em Default frequency rule ====================== -* **Do not contact more than each ** - This limits the number of Marketing Messages a Contact receives in a certain period of time day, week, month. Transactional messages don't count towards this limit. You can adjust this at the individual Contact level, either manually or by Preference Center setting. +* **Do Not Contact more than each ** - This limits the number of Marketing Messages a Contact receives in a certain period of time day, week, month. Transactional messages don't count towards this limit. You can adjust this at the individual Contact level, either manually or by Preference Center setting. .. note:: @@ -448,7 +448,16 @@ Import settings :alt: Screenshot showing Import Settings Configuration in Mautic * **Automatically import in the background if the CSV has more rows than defined** - If there are more than the specified number of rows in an import file, the CSV automatically sets to import in the background which requires a :ref:`cron job` to trigger. Set to 0 if you want to always import files in the background recommended for performance optimization. - + +Export settings +=============== + +.. image:: images/export-settings.png + :width: 600 + :alt: Screenshot showing Export Settings Configuration in Mautic + +* **Automatically export Contacts to CSV in the background** - If set to Yes, Mautic processes CSV exports of Contacts in the background and Mautic sends an Email with a link to download the file when it's processed. + Segment settings ****************