bigfish BF Admin Module Manage .doc Last Updated: 19-Nov-2013

Size: px

Start display at page:

Download "bigfish BF Admin Module Manage Email.doc Last Updated: 19-Nov-2013"

April Norman
10 years ago
Views:

1 bigfish BF Admin Mdule Manage .dc Last Updated: 19-Nv

2 TABLE OF CONTENTS 1 Mdificatin Histry Manage List Screen References Templates Technical Nte List Screen Detail Screen Cnfiguratin Technical Nte List Screen Detail Screen Technical Nte Text Message Templates Technical Nte List Screen Detail Screen Parameters Prcessing

..8 4.1 Technical Nte...8 4.2 List Screen...8 4.3 Detail Screen...8 4.4 Technical Nte.

3 1 Mdificatin Histry Date Wh Cmments 24-Aug-11 Slveda Split frm BF Admin Mdule Admin dcument 17-Oct-12 Slveda Links t Test cmpnent 26-Feb-13 Slveda Added text messaging capability 9-Oct-13 Slveda Ability t add a new r TXT template 19-Nv-13 Slveda Added status t Cnfiguratin 4-Apr-14 Slveda Added File vs Embedded cntent 3

messaging capability 9-Oct-13 Slveda Ability t add a new Email r TXT template

4 2 Manage 2.1 List Screen manage and text messages Manage Functin Templates Cnfiguratin Text Message Templates Parameters Descriptin Manage Templates that are used in all utging s Manage the Frm, T and ther attributes f utging s Manage Text Messaging Templates used in ntificatins t cell phnes Standard parameters used primarily fr styling the cntent 2.2 References Als see spec BF .dc 4

Templates Email Parameters Descriptin Manage Email Templates that are used in all utging emails Manage the Frm,

5 3 Templates 3.1 Technical Nte OFBiz Entity: CONTENT Cntent-ID = E_xxxxx Cntent-Type-ID = BF_ _TEMPLATE Nte: see the BF-Admin-Mdule-Cntent.dc spec fr details n managing the separatin f cntent by PRODUCT_STORE 3.2 List Screen templates list Templates Cntent ID Name Status Descriptin Active Date Created Date E_COMMON_STYLES Cmmn Styling Active This is the generic 08/01/11 07/27/11 styling fr all s. E_COMMON_HEADER Cmmn Header Active This is the standard 08/02/11 07/27/11 header definitin fr all utging s. E_COMMON_FOOTER Cmmn Fter Active This is the standard 08/02/11 07/29/11 fter definitin fr all utging s. E_NEW_CUSTOMER New Custmer Active New user that is 08/03/11 08/01/11 sent whenever a new custmer registers at yur site. E_FORGOT_PASSWORD Frgt Passwrd Active Sent when a custmer 08/03/11 08/01/11 clicks n the Frgt Passwrd link E_REQUEST_CATALOG Request Catalg Active Request Catalg 08/03/11 08/02/13 E_ETC Anther Active Etc 08/03/11 08/02/12 Add Template Srt Sequence: Cntent ID Clicking n the Cntent ID link will pass cntrl t the Detail Screen Add Template Redirect t the Detail Screen in add mde Actin Tltip is Test This will pass cntrl t the Test functin as described in the spec BF Admin Mdule Tls.dc 5

2 List Screen email templates list Email Templates Cntent ID Email Name Status Descriptin Active Date Created Date E_COMMON_STYLES Cmmn Styling Active This is the generic 08/01/11 07/27/11 styling fr

6 3.3 Detail Screen templates detail Cntent Detail: _CHANGE_CUSTOMER Cntent ID: Name: Descriptin: _CHANGE_CUSTOMER Change Custmer Sent whenever yur custmers update their persnal prfile. * 255 character limit (n characters left) Type: Cntent: Embedded File Reference <html> <sme tag> </sme tag> </html> Created Date: 07/27/11 at 9:00am Status: Active Set t Inactive Active Date: 08/01/2011 at 3:00pm Save Add Mde Cntent ID is an editable field Must cnfrm t an ID, see spec BF Admin Mdule General.dc Characters left cuntdwn Descriptin is limited t 255 characters Embedded vs File Reference See spec BF Admin Mdule Cntent fr prcessing rules Save message. Yur changes t [ -name] have been saved, return t List Screen Validatin: Name cannt be blank Errr: The Name field cannt be blank Descriptin cannt be blank 6

* 255 character limit (n characters left) Type: Cntent: Embedded File Reference <html> <sme tag> </sme tag> </html> Created Date: 07/27/11 at 9:00am Status: Active Set t Inactive Active Date:

7 Errr: The Descriptin field cannt be blank Cntent cannt be blank Errr: The Cntent field cannt be blank 7

8 4 Cnfiguratin 4.1 Technical Nte OFBiz Entity PRODUCT_STORE_ _SETTING ENUMERATION, ENUM_TYPE_ID = PARTY_ Multi-Stre Cnsideratin: Fr Multi Stre implementatins, the maintenance f the Cnfiguratins file needs t cnsider the active stre 4.2 List Screen cnfiguratin list Cnfiguratin Type Status Descriptin Subject Frm PRDS_CUST_REGIST Active Custmer Registratin Client.cm: Thank yu [email protected] PRDS_ABD_CART Active Abandned Cart Check yur cart! [email protected] ETC Active ETC etc! [email protected] Srt Sequence: Type Actin This will prvide additinal infrmatin as well as indicate which templates are assciated with the cnfiguratin item Users may click n an -template, this will pass cntrl t the apprpriate template detail screen Example: CC: [email protected] BCC: [email protected] Templates Used: E_HEADER E_ORDER_DETAIL E_FOOTER 4.3 Detail Screen cnfiguratin detail Detail: Custmer Registratin 8

needs t cnsider the active stre 4.2 List Screen email cnfiguratin list Email Cnfiguratin Email Type Status Descriptin Subject Frm PRDS_CUST_REGIST Active Custmer Registratin Client.

9 Type: Descriptin: PRDS_CUST_REGISTER Custmer Registratin * 255 character limit (n characters left) Subject: Frm: CC: BCC: Created Date: Client.cm: Thank yu fr registering! [email protected] [email protected] [email protected] 07/27/11 at 9:00am Status: Active Set t Inactive Active Date: 08/01/2011 at 3:00pm Save Characters left cuntdwn Descriptin is limited t 255 characters Frm must be a valid frmat CC and BCC fields can cntain multiple addresses by using a, separatr. All addresses shuld be prperly frmatted s. Save message. Yur changes t [ -name] have been saved, return t List Screen Validatin: Frm: Must be a valid address: The FROM field must cntain a valid address Can nly be ONE address: The FROM field can nly cntain a single address CC valid frmat s Errr: The CC field must cntain valid addresses. Yu can use the, separatr fr multiple addresses BCC valid frmat s Errr: The BCC field must cntain valid addresses. Yu can use the, separatr fr multiple addresses Frm cannt be blank Errr: The Frm field cannt be blank Subject cannt be blank Errr: The Subject field cannt be blank 9

cm 07/27/11 at 9:00am Status: Active Set t Inactive Active Date: 08/01/2011 at 3:00pm Save Characters left cuntdwn Descriptin is limited t 255 characters Frm must be a valid frmat email CC and BCC

10 4.4 Helper Text Fr CC and BCC : T enter multiple s use a cmma (,) delimiter 4.5 Technical Nte T accmmdate the Active/Inactive a custm extensin will be added t the Ofbiz Entity PRODUCT_STORE_ _SETTING: STATUS_ID [related t STATUS_ITEM.CONTENT_STATUS] 10

11 5 Text Message Templates 5.1 Technical Nte OFBiz Entity: CONTENT Cntent-ID = TXT_xxxxx Cntent-Type-ID = BF_TXT_TEMPLATE Nte: see the BF-Admin-Mdule-Cntent spec fr details n managing the separatin f cntent by PRODUCT_STORE 5.2 List Screen text message templates list Text Message Templates Cntent ID Text Name Status Descriptin TXT_ABANDON_CART Abandned Cart Active Abandned Cart Text Message template TXT_NEW_CUSTOMER New Custmer Active New Custmer Text Message template TXT_ORDER_CHANGE Order Change Active Order Change Text Message template TXT_ORDER_CONFIRM Order Cnfirm Active Order Cnfirm Text Message template TXT_FORGOT_PASSWORD Frgt Passwrd Active Frgt Passwrd Text Message template TXT_SHIP_REVIEW Review Active Review Text Message template TXT_CHANGE_CUSTOMER Change Custmer Active Change CustmerText Message template Active Date Created Date 08/01/11 07/27/11 08/02/11 07/27/11 08/02/11 07/29/11 08/03/11 08/01/11 08/03/11 08/01/11 08/03/11 08/02/13 08/03/11 08/02/12 Add Template Srt Sequence: Cntent ID Clicking n the Cntent ID link will pass cntrl t the Detail Screen Add Template Redirect t the Detail Screen in add mde Actin Tltip is Test Text Message This will pass cntrl t the Text Test functin as described in the spec BF Admin Mdule Tls.dc 5.3 Detail Screen 11

2 List Screen text message templates list Text Message Templates Cntent ID Text Name Status Descriptin TXT_ABANDON_CART Abandned Cart Active Abandned Cart Text Message template TXT_NEW_CUSTOMER New

12 text message templates detail Cntent Detail: TXT_ORDER_CONFIRM Cntent ID: Name: Descriptin: TXT_ORDER_CONFIRM Order Cnfirm Order Cnfirm Text Message * 255 character limit (n characters left) Type: Cntent: Embedded File Reference Yur Order {$ORDER_NO} is cnfirmed fr {$TOTAL_AMOUNT} * 160 character limit (n characters left) Created Date: 07/27/11 at 9:00am Status: Active Set t Inactive Active Date: 08/01/2011 at 3:00pm Save Add Mde Cntent ID is an editable field Must cnfrm t an ID, see spec BF Admin Mdule General.dc Characters left cuntdwn Descriptin is limited t 255 characters Embedded vs File Reference See spec BF Admin Mdule Cntent fr prcessing rules Save message. Yur changes t [ -name] have been saved, return t List Screen Validatin: Name cannt be blank Errr: The Name field cannt be blank Descriptin cannt be blank Errr: The Descriptin field cannt be blank Cntent cannt be blank Errr: The Cntent field cannt be blank 12

Date: 08/01/2011 at 3:00pm Save Add Mde Cntent ID is an editable field Must cnfrm t an ID, see spec BF Admin Mdule General.

13 6 Parameters 6.1 Prcessing This will prvide a redirect t the general BigFish Parameter screen See the BigFish Parameters sectin in the spec BF Admin Mdule Tls.dc 13

bigfish BF Admin Module Tools.doc Last Updated: 5-Jan-2015

bigfish BF Admin Module Tools.doc Last Updated: 5-Jan-2015 bigfish BF Admin Mdule Tls.dc Last Updated: 5-Jan-2015 1 TABLE OF CONTENTS 1 Mdificatin Histry... 5 2 Admin Tls... 6 2.1 Technical Nte... 6 2.2 List Screen... 6 2.3 Message Area... 7 3 Admin Labels and