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

Transcription

1 bigfish BF Admin Mdule Tls.dc Last Updated: 5-Jan

2 TABLE OF CONTENTS 1 Mdificatin Histry Admin Tls Technical Nte List Screen Message Area Admin Labels and Captins BigFish Parameters Overview Search and List: Visual Guideline Actins Helpers and Warnings Detail Screen Manage CSS Files Visual Guideline Prcessing Rules Edit CSS File Pre-Prcessing Prcessing Rules Sitemap XML Overview UI Guideline Prcessing: Cnsideratin fr Variants Rbts TXT UI Guideline Prcessing: SEO Friendly URL Overview UI Guideline Prcessing Cnsideratin fr Variants Clear BigFish Cache UI Guideline SOLR Indexing UI Guideline Entity Sync Prduct Delete Tl UI Guideline Prcessing: Cmpare Tl: Labels and Captins Intrductin UI Guideline

3 13.3 Cmpare Functin: Cmpare Results Cmpare Tl: DIV Sequences Intrductin UI Guideline Cmpare Functin: Cmpare Results Cmpare Tl: System Parameters Intrductin UI Guidelines Cmpare Functin: Cmpare Results (Stre t Stre): Manage Custm Party Attributes Intrductin List Custm Attributes Detail Screen Manage DIV Sequencing Catalg Asset Checker UI Guideline Prcessing System Cnfiguratin Files Technical Nte Available Files List Screen Detail Screen Test Prcessing Overview UI Guideline General Prcessing Template Prcessing Sending the Simple Text: Messages Template: Messages Text Message Test Prcessing Overview UI Guideline General Prcessing Text Template Prcessing Sending the Text Messages Technical Nte BigFish XML Exprter UI Guideline Prcessing Messages Tech Ntes

4 23 System Health Check

5 1 Mdificatin Histry Date Wh Cmments 11-Jun-12 Slveda Split frm dc BF-Admin-Mdule-Admin (see Md Histry in that spec fr relevant Tls changes) 18-Jun-12 Slveda Request t lad DIV-Sequencer int memry (25958); s Clear- Cache has been expanded. 20-Jun-12 Slveda Cache reset als includes the SEO-Friendly-URL, change t descriptin nly. 22-Jun-12 Slveda Details fr rbts.txt functin 28-Jun-12 Slveda Split DIV-Sequencer int new dc BF-Admin-Mdule-DIV- Sequencer 3-Jul-12 Slveda Added DIV-Sequence Cmpare Tl 5-Jul-12 Slveda Expanded Clear-Cache functin 6-Jul-12 Slveda Enhancements fr variant prducts in SEO-Friendly and sitemap.xml 12-Jul-12 Slveda Included System Cnfiguratin Files in the Tls sectin 30-Jul-12 Slveda Added Test functin 14-Aug-12 Slveda Added mre system cnfiguratin files fr view. 15-Aug-12 Slveda Test enhancements 15-Aug-12 Slveda Added Health Check functin 24-Aug-12 Slveda Added BigFish XML Exprter functin 12-Sep-12 Slveda Added Catalg Asset Checker 3-Oct-12 Slveda Cnslidated the CSS management functins; re-sequenced the Tls menu t be alphabetical 16-Oct-12 Slveda Requirements fr Test, when called frm the Templates screen. 14-Dec-12 Slveda Intrduced synchrnize feature in all Cmpare functins. 26-Feb-13 Slveda Added test text message functin 26-Feb-13 Slveda Added text templates t the Exprt functin 14-Mar-13 Slveda Disallw editing f a cmpressed CSS file 18-Apr-13 Slveda Added Manage Custm Attributes 20-Jun-13 Slveda Added Prduct Delete Tl functin. Used mainly during testing, t remve all Prducts prir t a new prduct lad. Equivalent functinality has been remved frm Prduct-Lader. 20-Sep-13 Slveda Added Payment-Gateway, Shipping and Taxes t exprter 10-Oct-13 Slveda BigFish Parameter maintenance screens 15-Oct-13 Slveda Added Parameter XML files t ManageXMLUrlCache 22-Oct-13 Slveda Added Page Tagging t the exprter 23-Oct-13 Slveda Added Stres t the exprter 31-Dec-13 Slveda Added Prmtins t the exprter 5-Jan-15 Slveda Added a prduct image reference t the Sitemap.xml generatr 5

6 2 Admin Tls 2.1 Technical Nte Multi-Stre Cnsideratin: Fr Multi Stre implementatins, the Admin Tls functins need t cnsider the active stre 2.2 List Screen admin tls Admin Tls Functin Admin Labels and Captins BigFish Parameters BigFish XML Exprter Clear BigFish Cache CSS Management Tls Entity Sync Manage Custm Party Attributes Manage DIV Sequences Prduct Delete Tl SOLR Indexing Cmpare Tls Functin Cmpare Tl: DIV Sequences Cmpare Tl: Labels and Captins Cmpare Tl: System Parameters Descriptin Manage Admin displayed labels and captins. Maintain varius XML based parameter files. Includes Recurrence Rules, Styles. Varius functins t exprt data, mainly fcused n cntent, frm the database t an XML frmat. These XML files will be suitable fr lad int anther OFBiz database instance. This functin will clear varius memry cache that are used within the BigFish slutin. These resurces are laded int memry nce and if changes are made in these areas then cache needs t be cleared fr the changes t take affect. This allws fr the editing, lading r replacement f CSS files fr either the ecmmerce implementatin r the Admin Mdule. This functin will synchrnize cntent frm a STAGING surce instance t a PRODUCTION target instance. This functin allws the mdificatin f the Custm Party Attributes XML definitin file. All data is held in the file OSafeCustmPartyAttributes.xml This functin allws the mdificatin f the Custm Party Attributes XML definitin file. This functin will maintain the sequencing f DIV tags, by screen. All data is held in the file OSafeUiSequence.xml This functin will remve all Prducts and related data. Typically used during the develpment life-cycle s that new Prduct Lads can refresh the database. This functin will re-index SOLR. It shuld be executed whenever the Prduct Catalg is updated s that PLP, PDP and Faceted Navigatin is refreshed. Descriptin This tl will cmpare the DIV-Sequencing file installed n this server (the A versin) with anther instance (the B versin). Access t the B versin is required. This tl will cmpare the Label / Captins file installed n this server (the A versin) with anther instance (the B versin). Access t the B versin is required. This tl will cmpare the SYSTEM_PARAMETERS database entity 6

7 n this server (the A versin) with anther instance (the B versin). Access t the B database is required. SEO Tls Functin Rbts TXT Generatr SEO Friendly URL Sitemap XML Generatr Utilities Functin Test Text Message Test Catalg Asset Checker System Cnfiguratin Files System Health Check Descriptin This will generate a recmmended rbts.txt and display the results within this brwser. Yu may then save, edit and deply the file as apprpriate. This functin will refresh the SEO Friendly URL Mapping File (XML) This functin will generate a sitemap.xml and display the results within this brwser. Yu may then save and deply the file as apprpriate. Sitemap URL s will include all active Prduct Catalg data and Static Pages. Descriptin This functin will use yur OFBiz and BigFish prperties and send ut a test . This functin will use yur Text Messaging cnfiguratins and send ut a test text message. This tl will review all Categry and Prduct image references in the Catalg and verify if there is an available image asset. View system cnfiguratin files t cnfirm high-level settings and peratinal cnfiguratins. A general functin that can perfrm sme cmmn health checks and take crrective actins. Back 2.3 Message Area Fr the Admin Tls functinality, each subsequent page will display the apprpriate success r errr message. Messages styling will cnfrm t the frmat defined in the BF-Admin-Mdule-General sectin as fllws: Errr Message Success Message 7

8 3 Admin Labels and Captins This functin will behave the same as the standard Labels and Captins functin See spec BF Admin Mdule Admin.dc fr mre details The fllwing exceptins will apply: File t be maintained is the OSafeAdminUiLabels.xml file The H1 tag shuld read Admin Labels and Captins 8

9 4 BigFish Parameters 4.1 Overview This functin will allw fr the maintenance f varius BigFish Parameter files Files are lcated in the directry: \ht-deply\safe\cnfig\ Files are named Parameters_xxxx.xml Pre-prcessing shuld identify all files that match the pattern Parameters_*.xml and ppulate the Parameter File drp-dwn n the search screen All files are defined in a similar frmat, fr example the Parameters_ _Styles.xml: <prperty key="default_table_body"> <descriptin>default styling fr inner tables</descriptin> <value>"clr:#000000;fnt-family:arial;fnt-size:12px;"</value> </prperty> <prperty key="logo"> <descriptin>lg styling</descriptin> <value>"display:blck;padding:10px;"</value> </prperty> <prperty key="link"> <descriptin>default styling fr inner tables</descriptin> <value>"text-decratin: nne;clr:#bf0000;"</value> </prperty> <prperty key="main_content"> <descriptin>default styling fr inner tables</descriptin> <value>"padding:10px;"</value> </prperty> <prperty key="label"> <descriptin>default styling fr inner tables</descriptin> <value>"clr:#666666;fnt-weight: 700;"</value> </prperty> Accessed frm ther functins: This functin shuld e written s that it can be called frm ther functins within the Admin Mdule. Fr example: The Manage s sectin will have a link s that users can mdify their Parameters Prcessing shuld pre-select the Parameters_ _Styles.xml file frm the Parameter File drp-dwn The drp-dwn shuld be nn-editable Data shuld be retrieved and the list shuld display all existing values See spec BF Admin Mdule Manage .dc fr mre infrmatin 4.2 Search and List: Visual Guideline 9

10 manage bigfish parameters Manage BigFish Parameters Parameter File: Drp-dwn Search Initial display will nly shw the sectin abve, the list will be shwn upn Search Inf Text Includes all files matching the pattern Parameters_*.xml lcated in the \htdeply\safe\cnfig\ directry. Matching will hnr case. Search this will find all matching entries fr the Parameter File selected and display the sectin belw: File: Parameters_ _Styles.xml Key Descriptin Value DEFAULT_TABLE_BODY Default table styling "clr:#000000;fnt-family:arial;fnt-size:12px;" LOGO Lg styling "display:blck;padding:10px;" LINK Link styling "text-decratin: nne;clr:#bf0000;" MAIN_CONTENT General default styling "padding:10px;" LABEL Label Styling "clr:#666666;fnt-weight: 700;" Back Save Add 4.3 Actins Save Update the XML file Display message Yur changes t [Parameter File] have been saved. Yu will need t reset cache in Admin/Tls fr yur changes t take effect. Remain n this screen Hide the list sectin f the display Add Redirect t the detail screen in Add mde 4.4 Helpers and Warnings Warning Text Yu will need t reset cache in Admin/Tls fr yur changes t take effect 10

11 Tltip is set t Exprt t XML This shuld effectively write the active XML file t a brwser tab, s that users can save t their lcal file system 4.5 Detail Screen parameter detail Parameter Detail Key: Descriptin: DEFAULT_TABLE_BODY Default table styling Value: "clr:#000000;fnt-family:arial;fnt-size:12px;" Back Save Delete Add Mde All attributes are available fr entry Key: must have an entry, n spaces r special characters Descriptin: must have an entry Value: entry is ptinal Edit Mde Key is read-nly Descriptin is editable Value is editable Delete, will prmpt fr cnfirmatin Deleting a Parameter may cause serius harm t yur ecmmerce implementatin. Are yu sure yu want t delete the Parameter [Key]? Yes / N Save message: Yur changes t [key] have been saved. Yu will need t reset cache in Admin/Tls fr yur changes t take effect. Back, return t List Screen Warning Text See List screen 11

12 5 Manage CSS Files 5.1 Visual Guideline manage CSS files [message-area] Manage CSS Files ecmmerce Mdule Admin Mdule Available [ecmmerce Mdule] CSS Files n safe_theme/css directry BigFishSkin.css Edit CSS MnchrmeTheme.css Make Active Edit CSS RedWhiteBlueTheme.css Make Active Edit CSS SpecialXmasSkin.css Make Active Edit CSS Brwse Back Lad CSS 5.2 Prcessing Rules Main selectr: ecmmerce r Admin This will dynamically retrieve the available CSS files fr the specific mdule Available CSS files will be displayed in the list screen Actins Make Active The selected CSS file shuld be used as the active file Tech Nte: change the reference in the attribute VISUAL_THEME_RESOURCE.RESOURCE_VALUE Edit CSS This will redirect t the Edit CSS File functin Lad CSS Lad a new CSS file nt the server in the apprpriate lcatin Helper Text 12

13 Lad new file cmpnent: Use Brwse buttn t find a new CSS file. Then click Lad- CSS t lad int the system. 5.3 Edit CSS File edit CSS file [message-area] Editing file: bigfishclientskin.css Replace With: Brwse Replace Text Back Save and Refresh Save and Return 5.4 Pre-Prcessing Cmpressed CSS File A CSS file that is in cmpressed frmat shuld nt be allwed direct editing If a CSS file is cmpressed it is cnsidered a prductin versin Cmpressin remves all cmments and unnecessary spaces frm a CSS file If a CSS des NOT cntain tw cnsecutive spaces then: Display infrmatin message The CSS file has been ptimized and cmpressed and cannt be edited Disable Save and Refresh, Replace Text, Save and Return 5.5 Prcessing Rules Functinal Overview 13

14 Allws the direct editing f a CSS file Allws fr the text f the active CSS file t be replaced with text frm anther CSS file n the lcal file system Allws the saving f a new CSS file n the server that can be used in the Switch CSS functin Actins Replace With prmpts fr a file n the lcal file system use default extensin f.css the Brwse functin will cpy a file frm the lcal file system t the server using a temprary name NOTE: the temprary file shuld be remved upn entering this functin s that the user cannt mistakenly replace the text with previusly updated text the Replace Text will cpy the cntents f the temprary file int the Edit Bx Save and Refresh Perfrm Save actin and remain n this screen s that additinal edits can be made Save and Return Perfrm Save actin and if successful return t the Admin menu screen 14

15 6 Sitemap XML 6.1 Overview The generatin f the sitemap.xml file is tied very clsely t the SEO Friendly URL functin 6.2 UI Guideline sitemap XML generatr [message-area] Sitemap XML Generatr This functin will generate a sitemap.xml and display the results within this brwser. Yu may then save and deply the file as apprpriate. Sitemap URL s will include all active Prduct Catalg data and Static Pages. Back Generate XML Sitemap 6.3 Prcessing: Prducts: The Prduct Catalg shuld be traversed and all active categries and prducts identified and added t the sitemap.xml file. Prducts that are nt yet intrduced r are discntinued shuld NOT be included All buyable prducts shuld be cnsidered Variants Virtual=N Variant=Y Finished Gds Virtual=N Variant=N If a main image is available, then a specific image reference shuld be included in the sitemap.xml file. Static Pages: Static cntent shuld be included in the sitemap.xml Example: <?xml versin="1.0" encding="utf-8"?> <urlset xmlns=" <url> <lc> </lc> </url> 15

16 <url> <lc> </lc> </url> <url> <lc> </lc> </url> <url> <lc> </lc> <image:image> </image:image> </url> <url> <lc> </lc> <url> </urlset> Viewing the sitemap.xml file The generated sitemap.xml file shuld be displayed in a new tab in the brwser It is the user s respnsibility t save and deply the sitemap.xml as apprpriate System Parameters Name Key Descriptin Value (example) SITEMAP_CLP_URL SITEMAP Sitemap starting URL fr Categry List Pages SITEMAP_PLP_URL SITEMAP Sitemap starting URL fr Prduct List Pages SITEMAP_PDP_URL SITEMAP Sitemap starting URL fr Prduct Detail Pages SITEMAP_STATIC_URL SITEMAP Sitemap starting URL fr Static Pages Errr Message Errr Message: ERROR: An errr ccurred while trying t generate the sitemap.xml file + [OFBiz-Errr] 6.4 Cnsideratin fr Variants Sme clients will require a mre granular SEO-Friendly slutin that cnsiders variants The sitemap.xml generatin needs t cnsider this requirement The system parameter that cntrls this is: 16

17 Name Key Descriptin Value (example) SITEMAP_VARIANT_FEATURES SITEMAP Defines a list f features that may be used t extend the SITEMAP and SEO-Friendly- URL functins t include variant prducts. Fr example: Leave blank t include t primary (Virtual) prducts nly. COLOR 17

18 7 Rbts TXT 7.1 UI Guideline rbts TXT generatr [message-area] Rbts TXT Generatr This functin will generate a baseline rbts.txt and display the results within this brwser. Yu may then save and deply the file as apprpriate. Back Generate TXT File 7.2 Prcessing: The rbts.txt file infrms search engines t ignre certain pages r directries This is typically used t ignre image directries and ther URL s that will nt add any value t the crawling functin This functin effectively creates a baseline rbts.txt file that clients can fine tune t suit their needs The file cnsists f 4 basic lines: User-agent: standard first line fr the file Disallw filtergrup: this will infrm all web crawlers t ignre faceted navigatin pathways Disallw /safe_theme/images: this will infrm all web crawlers t ignre the image directries Sitemap: this reinfrces the lcatin f the sitemap.xml file. [dmain-name] shuld reflect the prductin URL Example: User-agent: * Disallw: /*&filtergrup Disallw: /safe_theme/images Sitemap: 18

19 8 SEO Friendly URL 8.1 Overview The SEO Friendly URL functinality is tied very clsely t the sitemap.xml generatin functin 8.2 UI Guideline SEO friendly URL refresh [message-area] SEO Friendly URL Refresh This functin will refresh the SEO Friendly URL Mapping File (XML) Back SEO Friendly URL Refresh 8.3 Prcessing Prducts: The Prduct Catalg shuld be traversed and all active categries and prducts identified and added t the SEO Friendly URL mapping file Prducts that are nt yet intrduced r are discntinued shuld NOT be included Example: <?xml versin="1.0" encding="utf-8"?> <file xmlns=" <mapping> <bigfish_url>ecmmercelistpage?categry=11098</bigfish_url> <friendly_url>synthetic-wigs</friendly_url> </mapping> <mapping> <bigfish_url>ecmmercelistpage?categry=11099</bigfish_url> <friendly_url>herbal-tame</friendly_url> </mapping> <mapping> <bigfish_url>ecmmerceprductpage?categry=11098?prduct=22012</bigfish_url> <friendly_url>synthetic-wigs/acrn-wig</friendly_url> </mapping> <mapping> <bigfish_url>ecmmerceprductpage?categry=11098?prduct=22013</bigfish_url> <friendly_url>herbal-tame/herbal-tame-14z</friendly_url> </mapping> </file> 19

20 Viewing the updated xml file The generated xml file shuld be displayed in a new tab in the brwser System Parameters Name Key Descriptin Value (example) SITEMAP_CLP_URL SITEMAP Sitemap starting URL fr Categry List Pages SITEMAP_PLP_URL SITEMAP Sitemap starting URL fr Prduct List Pages SITEMAP_PDP_URL SITEMAP Sitemap starting URL fr Prduct Detail Pages SITEMAP_STATIC_URL SITEMAP Sitemap starting URL fr Static Pages Messages: Errr Message: ERROR: An errr ccurred while trying t generate the SEO.xml file + [OFBiz-Errr] 8.4 Cnsideratin fr Variants Sme clients will require a mre granular SEO-Friendly slutin that cnsiders variants Fr example Since the implementatin may have multiple selectable features a new system parameter will be used t identify which features shuld be used t generate additinal SEO Friendly entries: Name Key Descriptin Value (example) SITEMAP_VARIANT_FEATURES SITEMAP Defines a list f features that may be used t extend the SITEMAP and SEO-Friendly- URL functins t include variant prducts. Fr example: Leave blank t include t primary (Virtual) prducts nly. COLOR 20

21 9 Clear BigFish Cache 9.1 UI Guideline clear bigfish cache [message-area] Clear BigFish Cache Cache Type Labels and Captins SEO Friendly URLs DIV Sequencing Custm Party Attributes Page Tagging System Parameters BigFish Parameters (Recurrence, Style, Clickatell etc.) Back Cache Stre prperties.utilprpertiesbundlecache prperties.utilprpertiesbundlecache safe.managexmlurlcache safe.managexmlurlcache entitycache.entity-list.default.xpixeltracking entitycache.entity.default.xprductstreparm entitycache.entity-list.default.xprductstreparm prperties.utilprpertiesbundlecache The Clear actin will prmpt fr a cnfirmatin message: Yu are abut t clear [cache-type]. In a PRODUCTION envirnment, clearing cache can have a serius impact n perfrmance. Yu shuld be abslutely sure that the specific cache needs t be cleared. Are yu sure? The [cache-type] shuld shw the primary cache type frm the list abve. Fr example General XML Cache Messages: Errr Message: ERROR: An errr ccurred while trying t clear the Cache + [cache-type. Errr is: [OFBiz-Errr] Success Message: Cache clear f [cache-type] successfully cmpleted Helper Text Fr additinal infrmatin n Cache yu can use the Webtls / Cache and Debug Tls in OFBiz. WARNING: clearing database entity cache can have a serius impact n the perfrmance f an ecmmerce implementatin. 21

22 Technical Ntes: OFBiz Services: FindUtilCacheClear?UTIL_CACHE_NAME=[cache-stre] When clearing cache the system can clear a whle cache bject (ex. Util.PrpertiesBundleCache) r remve a specific file frm the cache bject (ex. OsafeSeFriendlyMap) Whenever pssible the minimum amunt f data shuld be cleared s if the request is t clear the SEO Friendly URL Cache then we shuld remve the FILE frm within the PrpertiesBundleCache 22

23 10 SOLR Indexing 10.1 UI Guideline SOLR indexing [message-area] SOLR Indexing This functin will re-index SOLR. It shuld be executed whenever the Prduct Catalg is updated s that PLP, PDP and Faceted Navigatin is refreshed. All entity and entity-list cache will be cleared upn successful executin f the re-indexing prcess. Back Re-Index SOLR Re-Index SOLR: this shuld initiate the SOLR re-indexing service OFBiz cache shuld be cleared after successful executin f the re-indexing Messages: Errr Message: ERROR: An errr ccurred while trying t Re-Index SOLR + [OFBiz- Errr] Success Message: The Re-Index SOLR jb has successfully cmpleted 23

24 11 Entity Sync See spec BF Mdule Admin Entity Sync.dc 24

25 12 Prduct Delete Tl 12.1 UI Guideline prduct delete tl [message-area] Prduct Delete Tl This functin will remve all Prducts and related data. Typically used during the develpment lifecycle s that new Prduct Lads can refresh the database. Back Delete Prducts 12.2 Prcessing: The Delete Prducts actin will prmpt fr a cnfirmatin message: *** WARNING **** Yu are abut t delete all Prducts frm the database. This will PERMANENTLY DELETE all Prducts and related data. This includes the cmplete remval f PRODUCTS, ORDERS, SHIPPING infrmatin, INVOICE data, and ther assciated data. IF THIS IS A PRODUCTION INSTANCE YOU SHOULD CANCEL NOW. Are yu sure? Tw buttns shuld be ffered: Yes, Delete Prduct Data N, Cancel Transactin Prcessing: All database delete actins shuld be executed within a SINGLE transactin If any errrs ccur a rllback shuld be used t restre the data and the errr message displayed Errrs shuld include all relevant infrmatin s that research can take place t reslve Messages Success: SUCCESS: Prduct Data has been deleted 25

26 Errr Message: ERROR: An errr ccurred while trying t delete Prduct Data [OFBiz-Errr] [DB-Errr] 26

27 13 Cmpare Tl: Labels and Captins 13.1 Intrductin This tl will cmpare the lcal Label file with a file identified by the user It will be a valuable guide t check if all Labels are included in the lcally deplyed envirnment. Similarly, the tl will identify Labels that may n lnger be required but still remain in the lcal envirnment UI Guideline cmpare tl: labels and captins [message-area] Cmpare Tl: Labels and Captins This tl will cmpare the Label / Captins file installed n this server (the A versin) with anther instance (the B versin). Access t the B versin is required. Yur File [A]: safe_admin/dir/labelui.xml Cmpare T File [B]: sme-directry/labelui.xml Brwse Back Cmpare Labels Brwse buttn: ffers a standard dialg t find an accessible file, extensin shuld be set t.xml Validatin: Check that the Yur-Label-File exists Errr The Yur-Label-File des nt exist, please cntact yur Administratr Check that the Cmpare-T-File exists Errr The Cmpare-T-File des nt exist, please check the file name and try again 13.3 Cmpare Functin: Bth files shuld be read, laded int memry and srted by Key The functin will detect items where: The Key in the Yur-Label-File is NOT in the Cmpare-T-File Pseud Cde: i = 0 27

28 lp j = 0 d until DONE If i > n_f_rws_in_yurlabelfile AKey = ZZZZZZ Else AKey = yurlabelfile.key (i) If j > n_f_rws_in_cmparetfile BKey = ZZZZZZ Else BKey = cmparetfile.key (j) If AKey = ZZZZZZ And BKey = ZZZZZZ DONE Return If AKey < BKey KEY is in A, but nt n B i++ Return If AKey > BKey KEY is in B, but nt n A j++ Return KEY exists in bth A and B i++ j Cmpare Results These displays fllw-n frm the same page Label and Captins Cmparisn Shw: Keys that exist n [A] but d NOT exist n [B] Keys that exist n [B] but d NOT exist n [A] Keys that exist n BOTH Files Refresh Where: [A] identifies the currently implemented versin Example: Yur-File-A [OsafeUiLabels.xml] 28

29 [B] is the cmpare t versin f the file Example: Cmpare-t-File-B [Master_Label_File.xml] These rules shuld be applied n bth the cmpnent abve, the Result screen and the tltip cmparisn ppup Results Key Cmpare Results CntactUsTitle Key is n [A] but nt n [B] PageH1Text Key is n [B] but nt n [A] ErrrMessage Key exists n BOTH files AntherLabel Key exists n BOTH files Back Actin All Refresh will re-evaluate the results and display based n the check-bx selectins Hver ver: is displayed when Key exists n BOTH files but the values d nt match is displayed fr all ther cnditins Hver ver will display the fllwing: [A] Key: Categry: Value: [B] Key: Categry: Value: CntactUsTitle TITLE Cntact Us Nt Present (in the header) Will select all checkbxes in the display This behaves as a tggle Is displayed fr the cnditin Key exists n BOTH files but the values d nt match Tltip will display Synchrnize Key [key] and set value t [Value] Clicking n this actin icn will pass cntrl t the Label Detail page in Edit mde, passing the new Value (and pre-ppulating the Value n the Label Detail page) If the user clicks n Save n the Label-Detail-Page then cntrl is passed back t this screen Is displayed fr any n [B] nt n [A] cnditin Tltip will display Add Key [keyname] t [A] Clicking n this actin icn will pass cntrl t the Labels and Captins Detail page in Add mde, passing all apprpriate entries and pre-ppulating the Label Detail page 29

30 If the user clicks n Save n the Label-Detail-Page then cntrl is passed back t this screen Actin All Will take the apprpriate actin (add new label r mdify label value) fr all items where the checkbx is clicked Page is refreshed after the infrmatin is updated Display apprpriate success r failure message upn cmpletin 30

31 14 Cmpare Tl: DIV Sequences 14.1 Intrductin This tl will cmpare the lcal DIV-Sequence XML file with a file identified by the user OR cmpare the DIV-Sequence files between 2 stres in the same implementatin It will be a valuable guide t check if all DIV-Sequences are included in the lcally deplyed envirnment. Similarly, the tl will identify DIV-Sequences that may n lnger be required but still remain in the lcal envirnment UI Guideline cmpare tl: DIV-Sequence [message-area] Cmpare Tl: DIV-Sequence This tl will cmpare the DIV-Sequence file installed n this server (the A versin) with anther instance (the B versin). Access t the B versin is required. Yur File [A]: safe_admin/dir/divsequence.xml Cmpare T File [B]: sme-directry/divsequence.xml Brwse Back Cmpare DIV-Sequence Brwse buttn: ffers a standard dialg t find an accessible file, extensin shuld be set t.xml Validatin: Check that the Yur-DIV-Sequence-File exists Errr The Yur- DIV-Sequence-File des nt exist, please cntact yur Administratr Check that the Cmpare-T-File exists Errr The Cmpare-T-File des nt exist, please check the file name and try again 14.3 Cmpare Functin: Bth files shuld be read, laded int memry and srted by the Screen and Key values Cmpare lgic is very similar t that described in the Labels and Captins Cmpare Tl NOTE: a unique key is the cmbinatin f the Screen and Key tag; key values may be duplicated fr multiple screens 14.4 Cmpare Results 31

32 These displays fllw-n frm the same page DIV-Sequence Cmparisn Shw: Keys that exist n [A] but d NOT exist n [B] Keys that exist n [B] but d NOT exist n [A] Keys that exist n BOTH Files Refresh Where: [A] identifies the currently implemented versin Example: Yur-File-A [OsafeDIVSeq.xml] [B] is the cmpare t versin f the file Example: Cmpare-t-File-B [FH_DIV_Seq_File.xml] These rules shuld be applied n bth the cmpnent abve, the Result screen and the tltip cmparisn ppup Results Screen Key Cmpare Results PDP mainimage Key is n [A] but nt n [B] PDP prductname Key is n [B] but nt n [A] PDP nlineprice Key exists n BOTH files PDP listprice Key exists n BOTH files Back Actin All Refresh will re-evaluate the results and display based n the check-bx selectins Hver ver: is displayed when Key exists n BOTH files but the values d nt match is displayed fr all ther cnditins Hver ver will display the fllwing: [A] Screen: Key: Value: [B] Screen: Key: Value: PDP mainimage Cntact Us Nt Present (in the header) Will select all checkbxes in the display This behaves as a tggle 32

33 Is displayed fr the cnditin Key exists n BOTH files but the values d nt match Tltip will display Synchrnize Key [parm_name] and set value t [Value] Clicking n this actin icn will pass cntrl t the DIV Sequence Detail page in Edit mde, passing the new Value (and pre-ppulating the Value n the DIV Sequence Detail page) If the user clicks n Save n the DIV-Sequence-Detail-Page then cntrl is passed back t this screen Is displayed fr any nt fund mismatch Tltip will display Add Key [keyname] t Stre-x [stre-name] Clicking n this actin icn will pass cntrl t the DIV-Sequence Detail page in Add mde, passing all apprpriate entries and pre-ppulating the DIV-Sequence Detail page If the user clicks n Save n the DIV-Sequence-Detail-Page then cntrl is passed back t this screen Actin All Will take the apprpriate actin (add new label r mdify label value) fr all items where the checkbx is clicked Page is refreshed after the infrmatin is updated Display apprpriate success r failure message upn cmpletin 33

34 15 Cmpare Tl: System Parameters 15.1 Intrductin This tl will cmpare the lcal System Parameter database table (PROD_STORE_PARM) with an XML file identified by the user It will be a valuable guide t check if all System Parameters are included in the lcally deplyed database. Similarly, the tl will identify System-Parameters that may n lnger be required but still remain in the lcal database UI Guidelines cmpare tl: system parameters [message-area] Cmpare Tl: System Parameters This tl will cmpare the System Parameters database entity (X_PRODUCT_STORE_PARM) n this server (the A versin) with an XML file versin (the B versin). Yur Database [A]: [Stre Name] Cmpare T File [B]: sme-directry/bigfishparameters.xml Brwse Back Cmpare System Parameters Brwse buttn: ffers a standard dialg t find an accessible file, extensin shuld be set t.xml Validatin: Check that the Cmpare-T-File exists Errr The Cmpare-T-File des nt exist, please check the file name and try again 15.3 Cmpare Functin: Bth files shuld be read, laded int memry and srted by the Parameter Name Cmpare lgic is very similar t that described in the Labels and Captins Cmpare Tl 15.4 Cmpare Results (Stre t Stre): These displays fllw-n frm the same page System Parameters Cmparisn 34

35 Shw: Parameters that exist n [A] but d NOT exist n [B] Parameters that exist n [B] but d NOT exist n [A] Parameters that exist n BOTH Files Refresh Where: [A] identifies the entity X_PRODUCT_STORE_PARM fr the current stre Stre Example: Stre-A [Fashin Huse] Example: [Stre-Name] (X_PRODUCT_STORE_PARM) [B] is the cmpare t versin f the file Example: Cmpare-t-File-B [ES_SysParms.xml] These rules shuld be applied n bth the cmpnent abve, the Result screen and the tltip cmparisn ppup Results Parameter Name Cmpare Results FORMAT_ADDRESS Parameter is n [A] but nt n [B] GOOGLE_ANALYTICS_KEY Parameter is n [B] but nt n [A] REVIEW_ACTIVE_FLAG Key exists n BOTH [A] and [B] SOME_OTHER_ONE Key exists n BOTH [A] and [B] Back Actin All Refresh will re-evaluate the results and display based n the check-bx selectins Hver ver: is displayed when Key exists n BOTH files but the values d nt match is displayed fr all ther cnditins Hver ver will display the fllwing: [A] Parameter Name: Categry: Value: [B] Key: Categry: Value: Nt Present REVIEW_ACTIVE_FLAG REVIEW FALSE (in the header) Will select all checkbxes in the display This behaves as a tggle 35

36 Is displayed fr the cnditin Key exists n BOTH files but the values d nt match Tltip will display Synchrnize Key [key] and set value t [Value] Clicking n this actin icn will pass cntrl t the System Parameter Detail page in Edit mde, passing the new Value (and pre-ppulating the Value n the System Parameter Detail page) If the user clicks n Save n the System-Parameter-Detail-Page then cntrl is passed back t this screen Is nly displayed fr any nt fund mismatch (key is n the cmpare asset but NOT n the current implementatin Tltip will display Add Key [parm_name] t Stre-x [stre-name] Clicking n this actin icn will pass cntrl t the System Parameter Detail page in Add mde, passing all apprpriate entries and pre-ppulating the System Parameter Detail page If the user clicks n Save n the System-Parameter-Detail-Page then cntrl is passed back t this screen Actin All Will take the apprpriate actin (add new label r mdify label value) fr all items where the checkbx is clicked Page is refreshed after the infrmatin is updated Display apprpriate success r failure message upn cmpletin 36

37 16 Manage Custm Party Attributes 16.1 Intrductin The Custm Party Attribute feature allws an implementatin t specify additinal attributes t be cllected at Custmer Registratin Fr mre infrmatin see BF Custmer Accunt management.dc The Manage Custm Party Attributes functin will allw the client business expert the ability t cntrl which custm attributes are included in the Registratin prcess 16.2 List Custm Attributes manage custm party attributes [message-area] Manage Custm Party Attributes Attr Name Seq# Captin Type Req? RING_SIZE 10 Ring Size: RADIO_BUTTON Y SHOE_SIZE 20 She Size: DROP_DOWN Y WEDDING_DATE 30 Wedding Date: ENTRY N Back Save Add Save: Re-sequence (Seq#) in multiples f 10 Update the XML file Display message Custm Party Attribute Update Successful. Yu will need t reset cache in Admin/Tls fr yur changes t take effect. Remain n this screen Helper Text Seq#: Set t 0 (zer) if nt required r hidden Warning Text Yu will need t reset cache in Admin/Tls fr yur changes t take effect 16.3 Detail Screen custm party attribute detail Custm Party Attribute: RING_SIZE Attr Name: RING_SIZE 37

38 Seq#: Captin: Ring Size: Type: RADIO_BUTTON Entry Frmat: Drp-dwn Max Length: Value List: Required? Yes N Required Message: Yu must select a Ring Size frm the drp dwn values available Back Save Type: drp-dwn with the fllwing values: ENTRY (single line edit field) ENTRY_BOX (multi line bx edit field) RADIO_BUTTON CHECKBOX DROP_DOWN (single select) DROP_DOWN_MULTI DATE_MMDD DATE_MMDDYYYY DATE_DDMM DATE_DDMMYYYY Entry Frmat is nly valid if the Type is ENTRY drp-dwn with the fllwing values: ANY NUMERIC ALPHA_NUMERIC MONEY Max Length Is nly applicable if Type is ENTRY r ENTRY_BOX Value List Is nly applicable if Type is RADIO_BUTTON, CHECKBOX, DROP_DOWN r DROP_DOWN_MULTI Required Message Is nly applicable if Required is Yes 38

39 Validatin Attr Name Required. Errr message: The Attr Name is a required field Fllws the same validatin as a standard ID field, see spec BF Admin Mdule General.dc fr details. Errr Message: The attribute name cannt cntain spaces and must be alpha characters, numbers, hyphens r underscres nly Seq# Required, must be between 0 and 1000 Errr message: Seq# is a required field and must be a numeric value between 0 and 1000 Captin Required. Errr message: The Captin is a required field Max Length Required. Must be numeric greater than 0 Errr message: Max Length is a required field and must be a number greater than 0 Value List Required Errr message: The value list must cntain at least ne ptin Required Message Required Errr message: The Required Message is a required field Save: Re-sequence (Seq#) in multiples f 10 Update the XML file Display message Custm Party Attribute Update Successful. Yu will need t reset cache in Admin/Tls fr yur changes t take effect. Return t the List screen Helper Text Seq#: Set t 0 (zer) if nt required r hidden Value List: Enter a cmma separated list f allwable values Warning Text Yu will need t reset cache in Admin/Tls fr yur changes t take effect 39

40 17 Manage DIV Sequencing See spec BF Admin Mdule DIV Sequencer.dc 40

41 18 Catalg Asset Checker 18.1 UI Guideline catalg asset checker [message-area] Catalg Asset Checker This functin will read the entire catalg structure all active categries and prducts. Fr each, a further check will be made t see which catalg items have URL references t server based asset (images, 360-views and vides). Fr any references fund, the functin will further verify if the asset is actually available based n the URL reference. All missing assets will be displayed. Back Run Catalg Asset Checker 18.2 Prcessing High level prcessing: NOTE: all the cntent ID s used are defined in the spec BF Prduct Prcessing.dc in the Prduct Images sectin Walk thru all active Categries Fr each categry Check fr all image cntent/resurce references in the database If there is a reference, check fr the existence f the asset If the asset des NOT exist then stre fr subsequent display in the results cmpnent Walk thru all related active Prducts Fr each Prduct Check fr all image cntent/resurce references in the database If there is a reference check fr the existence f the asset if the asset des NOT exist then stre fr subsequent display in the results cmpnent 41

42 If there is a NULL r reference Stre fr subsequent display in the results cmpnent Clumn Asset URL Reference will display *** BLANK OR NULL *** Active Categries and Prducts are defined by the FROM and THRU date If ALL asset references are verified then cmplete with a success message: All assciated assets have been verified If ne r mre assets are nt fund then display a results bx as fllws: Catalg Entries With NO Assciated Asset Type ID Descriptin Asset Type Asset URL Reference Categry Apparel THUMBNAIL_IMAGE_URL Prduct, Virtual Bluse DETAIL_IMAGE_URL *** BLANK OR NULL *** Prduct, Variant Bluse VIDEO_URL 42

43 19 System Cnfiguratin Files 19.1 Technical Nte Multi-Stre Cnsideratin: Fr Multi Stre implementatins, the display f the BF System Cnfiguratin files needs t cnsider the active stre Maintainability It is preferable that the list f available files t view are maintained in an external resurce. If new files are added t this list it becmes a simple mdificatin 19.2 Available Files File client-deplyment.prperties entityengine.xml general.prperties widget.prperties security.prperties serverstats.prperties cache.prperties debug.prperties fbiz-cntainers.xml url.prperties Descriptin BigFish cnslidated Prperty file used t update many f the OFBiz files. OFBiz file, framewrk/entity/cnfig/entityengine.xml. Defines database cnnectivity parameters. Updated frm client-deplyment.prperties. OFBiz file, framewrk/cmmn/cnfig/general.prperties. Defines general parameters such as default settings and currency. Updated frm client-deplyment.prperties. OFBiz file, framewrk/widget/cnfig/widget.prperties. T ease develpment (Out Of The Bx, OFBiz is cnfigured in develpment mde) the cmpresshtml prperties in general.prperties if OFF. If yu prefer t strip unnecessary whitespace frm HTML utput yu can set it n ON (uncmment the line "#cmpress.html=true"). Nte that, it is NOT the same thing as gzipped HTTP 1.1 cmpressin. Updated frm clientdeplyment.prperties. OFBiz file, framewrk/security/cnfig/security.prperties. Defines username case and encryptin. There are varius settings yu might want t cnfigure in this file, but fr mst prductin use it can remain unchanged. Updated frm client-deplyment.prperties. OFBiz file, framewrk/webapp/cnfig/serverstats.prperties. OFBiz file, framewrk/base/cnfig/cache.prperties. This file is cnfigured t be develpment friendly t relad resurces frequently. Fr prductin use the expire times fr the caches in the last sectin f the file shuld all be cmmented ut by putting a pund sign "#" at the beginning f each line. The prperties in questin start with "minilang.", "script.", "webapp.", "widget." And "template.". OFBiz file, framewrk/base/cnfig/debug.prperties. This file is used t enable/disable different lgging levels and used t cnfigure Lg4J lgging level and utput settings. Fr mst prductin use it can stay asis. Disabling the "inf" and "timing" level prperties can save sme resurces n the server, but we recmmend leaving all f the thers enabled. T d this just change the values f the "print.inf" and "print.timing" prperties t anything except "true". OFBiz file, framewrk/base/cnfig/fbiz-cntainers.xml. Defines varius prt settings fr http etc. Updated frm client-deplyment.prperties. OFBiz file, framewrk/webapp/cnfig/url.prperties. These prperties are used t cnfigure the settings t send t the client brwser. The prt and hst settings may be different than the prt and hst settings f the lcal machine if it is running thrugh Apache thrugh AJP, thrugh any prxy, r thrugh a lad balancer f any srt. The settings in this file shuld be 43

44 web.xml serviceengine.xml shipment.prperties prdsearch.prperties startfbiz.bat startfbiz.sh set t what the client brwser will see when cmmunicating with yur system. Updated frm client-deplyment.prperties. OFBiz file, safe/webapp/safe/web-inf/web.xml. Defines high-level Stre settings. Updated frm client-deplyment.prperties. OFBiz file, framewrk/service/cnfig/serviceengine.xml. Mst f the settings in this file can remain unchanged fr prductin deplyments, but there are sme default server lcatins that refer t prt 1099 (JRMP, fr RMI) and 8080 (HTTP). These are in the "service-lcatin" tags in the file. OFBiz file, applicatins/prduct/cnfig/shipment.prperties OFBiz file, applicatins/prduct/cnfig/prdsearch.prperties OFBiz file, Ofbiz/startfbiz.bat OFBiz file, Ofbiz/startfbiz.sh 19.3 List Screen system cnfiguratin files System Cnfiguratin File client-deplyment.prperty entityengine.xml ETC Descriptin BigFish cnslidated Prperty file used t update many f the OFBiz files. OFBiz file, framewrk/entity/cnfig/entityengine.xml. Defines database cnnectivity parameters. Updated frm clientdeplyment.prperties. Anther file Back Srt by file name 19.4 Detail Screen system cnfiguratin files client-deplyment.prperty ############################# # Database Prperties ############################# main.datasurce.name=lcalmysql database.name=fbiz_gmh jdbc.username=fbiz jdbc.passwrd=fbiz ############################# # Windws Service Prperties 44

45 ############################# service.name=ofbiz GMH ####################################### # General Prperties fr Settings ####################################### defaultfrm address=custmerservice@gldmedalhair.cm mail.ntificatins.enabled=y mail.smtp.relay.hst=mail.salmnllc.cm mail.smtp.auth.user= mail.smtp.auth.passwrd= mail.ntificatins.redirectt=custmerservice@gldmedalhair.cm currency.um.id.default=usd ETC Back Read nly Scrll bar s that cntents can be viewed 45

46 20 Test 20.1 Prcessing Overview The Test functin, when accessed via the Admin/Tls sectin, is a simple test f s t ensure that the SMTP server is peratinal The Test functin can als be accessed via the -Templates functin see spec BF Admin Mdule Manage .dc fr mre infrmatin if accessed via the -Templates screen then: Set the Test Mde t Template Set the Template t the apprpriate value 20.2 UI Guideline test [message area] Test Test Mde: Simple Test Template Template: E_ORDER_CHANGE [drp-dwn] Custmer#: Order#: Frm: nline-sales@client.cm T: Subject: CLIENT DEV: Test Text: This is a test Back Send Test The icn will prmpt fr a Custmer using the Generic Custmer Picker (see spec BF Admin Mdule Custmers.dc ) 20.3 General Prcessing Simple Test vs Template 46

47 Attribute Simple Test Template Template Hide Shw, ffer all available Templates Custmer# Hide Shw, see rules belw Order# Hide Shw, see rules belw Frm Shw, see defaults Shw, see defaults T Shw, see defaults Shw, see defaults Subject Shw, see defaults Shw, see defaults Text Shw Hide Defaults: Applies fr Simple-Text and -Template Frm: Retrieve frm system parameter _CLNT_REPLY_TO T: Leave blank fr client entry Subject: Derive as system parameter _CLNT_NAME + : Test Text: This is a test (if shwn) Template Prcessing Prmpt fr Custmer r Order: Template Custmer# Order# E_ABANDON_CART Hide Shw E_CHANGE_CUSTOMER Shw Hide E_CONTACT_US Hide Hide E_FORGOT_PASSWORD Shw Hide E_MAILING_LIST Hide Hide E_NEW_CUSTOMER Shw Hide E_ORDER_CHANGE Hide Shw E_ORDER_CONFIRM Hide Shw E_ORDER_DETAIL Hide Shw E_REQUEST_CATALOG Hide Hide E_SCHED_JOB_ALERT Hide Hide E_SHIP_REVIEW Hide Shw Prcessing Rules: Template E_ABANDON_CART E_CHANGE_CUSTOMER E_CONTACT_US E_FORGOT_PASSWORD E_MAILING_LIST E_NEW_CUSTOMER E_ORDER_CHANGE E_ORDER_CONFIRM Prcessing Rules Use entered Order# t build up the cntent f the Use entered Custmer#, send Send withut the nrmal parameters that wuld be cmpleted n the Cntact Us Frm Send , withut resetting the passwrd r expsing the actual passwrd in the cntent f the Send withut the nrmal parameters that wuld be cmpleted n the Mailing List Frm Use entered Custmer#, send Use entered Order#, send Use entered Order#, send 47

48 E_ORDER_DETAIL E_REQUEST_CATALOG E_SCHED_JOB_ALERT E_SHIP_REVIEW Use entered Order#, send Send withut the nrmal parameters that wuld be cmpleted n the Request Catalg Frm TBD Use entered Order#, send Validatin Custmer#, if prmpted Must be a valid Custmer# entered Errr The Custmer# [CUSTOMER_NO] cannt be fund in the database. Please retry. Order#, if prmpted Must be a valid Order# entered Errr The Order# [ORDER_NO] cannt be fund in the database. Please retry Sending the Simple Test: The primary purpse is t test the capability f the SMTP Server installed Therefre, all prcessing must bypass the standard template / merging prcessing and simply send the using the standard OFBiz send prcess Template: Template prcessing must take place in rder t pre-fill custmer and rder infrmatin as apprpriate 20.6 Simple Text: Messages If the send is successful: Check the client-deplyment.prperties file: If the mail.ntificatins.enabled = N then display: The was sent successfully. HOWEVER, the mail.ntificatins.enabled is set t N in the client.prperties file s the cntent was stred as a COMMUNICATION_EVENT in the database and n real was delivered. If the mail.ntificatins.enabled = Y and mail.ntificatins.redirectt has an entry, then display The was sent successfully. HOWEVER, the mail.ntificatins.redirectt is set t [ -address] s all s will be sent here. Check the client-deplyment.prperties file. Specific prperties are listed in the General Prperties sectin. Fr mre infrmatin check the Help functin Hw T Set Up BigFish s. 48

49 If the mail.ntificatins.enabled = Y and mail.ntificatins.redirectt has n entry, then display The was sent successfully. If fr sme reasn it was nt delivered, check the client-deplyment.prperties file. Specific prperties are listed in the General Prperties sectin. It is pssible that these are nt cnfigured crrectly. Fr mre infrmatin check the Help functin Hw T Set Up BigFish s. If the functin returns an errr: An errr ccurred attempting t send an . Errr is [technical errr text]. Check the client.prperties file. Specific prperties are listed in the General Prperties sectin. It is pssible that these are nt cnfigured crrectly. Fr mre infrmatin check the Help functin Hw T Set Up BigFish s Template: Messages If the send is successful: The was sent successfully using the Template [ _TEMPLATE]. If the functin returns an errr: An errr ccurred attempting t send an . Errr is [technical errr text]. 49

50 21 Text Message Test 21.1 Prcessing Overview The Text Message Test functin, when accessed via the Admin/Tls sectin, is a simple test t ensure that the current cnfiguratin can send a text message t a device The Text Message Test functin can als be accessed via the Text-Templates functin see spec BF Admin Mdule Manage .dc fr mre infrmatin if accessed via the Text-Templates screen then: Set the Test Mde t Text Message Template Set the Text Template t the apprpriate value 21.2 UI Guideline text message test [message area] Text Message Test Test Mde: Simple Test Text Message Template Text Template: TXT_ORDER_CONFIRM (drp-dwn) Custmer#: Order#: T Cell: Text: This is a test Back Send Text Message 21.3 General Prcessing Simple Test vs Text Template Attribute Simple Test Text Template Text Template Hide Shw, ffer all available Text Templates Custmer# Hide Shw, see rules belw Order# Hide Shw, see rules belw 50