Renewal Reminder. User Guide. Copyright 2009 Data Springs Inc. All rights reserved.

Transcription

1 Renewal Reminder User Guide Cpyright 2009 Data Springs Inc. All rights reserved.

2 Renewal Reminder 2.5 User Guide Table f cntents: 1 INTRODUCTION INSTALLATION PROCEDURE ADDING RENEWAL REMINDER MODULE TO A PAGE RENEWAL REMINDER MAIN MENU ADDING A NEW NOTIFICATION ITEM VIEWING ROLE REMINDER LOG MANAGING NOTIFICATION ITEMS Editing a ntificatin item Deleting a ntificatin item ACCESSING THE SCHEDULER MANAGING SETTINGS DELETING RENEWAL REMINDER MODULE TROUBLESHOOTING...20 List f figures: Figure 1: Installatin prcedure (step 1/6)...4 Figure 2: Installatin prcedure (step 2/6)...4 Figure 3: Installatin prcedure (step 3/6)...5 Figure 4: Installatin prcedure (step 4/6)...5 Figure 5: Installatin prcedure (step 5/6)...6 Figure 6: Installatin prcedure (step 6/6)...6 Figure 7: Adding a mdule t a page...7 Figure 8: Opening the mdule main menu...7 Figure 9: Opening the main menu...8 Figure 10: Adding a new ntificatin item (step 1/2)...9 Figure 11: Adding a new ntificatin item (step 2/2)...10 Figure 12: New ntificatin item successfully added...12 Figure 13: Viewing the rle reminder lg (step 1/2)...13 Figure 14: Viewing the rle reminder lg (step 2/2)...13 Figure 15: Managing ntificatin items...14 Figure 16: Editing a ntificatin item...14 Figure 17: Deleting a ntificatin item (step 1/2)...15 Figure 18: Deleting a ntificatin item (step 2/2)...15 Figure 19: Accessing the scheduler (1/3)...16 Figure 20: Accessing the scheduler (2/3)...16 Figure 21: Accessing the scheduler (3/3)...17 Figure 22: Chsing ptin "Settings"...18 Figure 23: Managing settings...18 Figure 24: Deleting Renewal Reminder Mdule (step 1/2)...19 Figure 25: Deleting Renewal Reminder Mdule (step 2/2)...19 Page: 2 / 20

3 1 INTRODUCTION Renewal Reminder prvides yu with the functinality t setup ntificatins fr users that their security rle will sn expire. After installing yur renewal / security rle reminder mdule yu can nw setup scheduled ntificatins t be distributed t yur users wh will sn be lsing ne f their security rles. The reminder ntificatin service can be used t ntify users that their security rle will sn expire and encurage them t renew their membership r subscriptin, take actin t keep their current level f security, r simply as a reminder t site administratrs when a users security rle will be expiring. Check ut all f the features belw. Features: Setup as few r as many reminder ntificatins as yu wuld like; each ntificatin is based n bth a security rle and als the number f days befre the users rle will expire Advanced prperties can be set fr each ntificatin including the frm, t, cc, bcc, pririty, and tkenized message Rle Expiratin (days) - specify the number f days that the user has left within the security rle befre they shuld receive the ntificatin Verificatin Delay - yu can specify the number f days that the system shuld nt ntify the user if they have been previusly ntified Fr example: if the ntificatin is setup t ntify the user that they are lsing their security rle within 14 days, and yu specify a verificatin delay f 7 days then the user wuld be ntified twice that their rle was abut t expire (assuming the renewal ntificatin schedule prcess ran nightly) If yu specify the verificatin delay and rle expiratin delay bth t 14 days then the user wuld nly be ntified nce All ntificatins are distributed via a scheduled prcess. Yu can cntrl the schedule and view detailed lgging fr each ntificatin message distributed Page: 3 / 20

4 2 INSTALLATION PROCEDURE Included in yur dwnlad are either ne (If yu nly purchased the PA) r tw (If yu purchased the PA and Surce Cde) zip files. One zip file is the surce cde t the applicatin, and the ther zip file is the mdule which yu can uplad t yur site. When yu extract the files, yu will ntice that it extracts tw zip files (nte: nly ne if yu just purchased the PA). DataSprings_ RenewalReminder_V10_DNN43PLUS.zip - file fr installing Renewal Reminder with yur DNN prtal. DataSprings_RenewalReminder_V10_SurceCde.zip - surce zip file yu can use in rder t make any changes t the applicatin (nte: meant fr advanced users) In rder t install yur Renewal Reminder mdule, lgin with an accunt t yur DNN site as a hst r administratr accunt. Once lgged in, Navigate t the Hst menu item, and click n the Mdule Definitin. Figure 1: Installatin prcedure (step 1/6) The fllwing screen will be displayed. Figure 2: Installatin prcedure (step 2/6) Click n the Uplad New Mdule t cntinue installing Renewal Reminder and the fllwing screen will be displayed. Page: 4 / 20

5 Figure 3: Installatin prcedure (step 3/6) Click n the Brwse buttn and the dialg windw fr lcating the installatin file DataSprings_RenewalReminder_Installatin.zip will be displayed. Figure 4: Installatin prcedure (step 4/6) Lcate the DataSprings_RenewalReminder_Installatin.zip and click n the Open buttn. The fllwing screen will be displayed. Page: 5 / 20

6 Figure 5: Installatin prcedure (step 5/6) Click n the Install New Mdule link. The installatin will begin and in cuple f mments the screen infrming yu n successful cmpletin will be displayed. Figure 6: Installatin prcedure (step 6/6) Nte: please keep track f any errrs that appear during the installatin. These errrs can be helpful if yur mdule has prblems. Page: 6 / 20

7 3 ADDING RENEWAL REMINDER MODULE TO A PAGE In rder t add Renewal Reminder mdule t a desired page fllw these steps: 1. Select the Add New Mdule radi buttn 2. Chse Renewal Reminder frm the Mdule pull dwn menu 3. Click n the Add link (r the arrw icn ). Figure 7: Adding a mdule t a page The Renewal Reminder mdule will be added t the page. Click n the arrw next t the title f the mdule in rder t pen the main menu. Figure 8: Opening the mdule main menu Nte: see sectin 4 fr further infrmatin n main menu ptins. Page: 7 / 20

8 4 RENEWAL REMINDER MAIN MENU This sectin f the dcument will give the definitin f the Renewal Reminder main menu ptins. In rder t start using the main menu, click n the arrw next t the title Renewal Reminder. Figure 9: Opening the main menu The fllwing ptins are available inside this screen: Rle Reminder Lg ptin fr viewing the rle reminder lg (see sectin Errr! Reference surce nt fund.) Settings ptin fr managing settings (see sectin 9) Delete ptin fr deleting a mdule (see sectin 10) Mve ptin fr placing the mdule in the desired part f the page: Mve T leftpane Mve T bannerpane Mve T cntentpane Mve T rightpane Mve T bttmpane Mve T bttmpane1 Mve T bttmpane2 Page: 8 / 20

9 5 ADDING A NEW NOTIFICATION ITEM In rder t add a new ntificatin item, click n the Add link r within the main page. Figure 10: Adding a new ntificatin item (step 1/2) The fllwing screen will be displayed. Page: 9 / 20

10 Figure 11: Adding a new ntificatin item (step 2/2) The fllwing parameters are available inside this screen: Name enter the desired name fr this ntificatin item which will help yu differentiate it frm ther items in the list, this setting is simply used fr administrative purpses and is nt used fr any f the prperties Rle / Rle ID use this pull dwn menu t select the user Security Rle this ntificatin item will be applied t Days set the day system shuld send the ntificatin by entering the desired number f days prir t expiratin Page: 10 / 20

11 Fr example: enter 5 if yu want the system t send the ntificatin 5 days befre the rle/subscriptin expires Tip: Yu can setup as many rle ntificatins per rle as yu wuld like, s a user culd receive 1 ntificatin 30 days ut, anther 10 days ut, and a final ne a day befre the rle expires. Frm enter the frm address fr the message Tip: if yu leave this setting blank the administratrs address will be used as the frm address T enter the address f the user the ntificatin shuld be sent t Tip: if yu leave this setting blank the users will be replaced at run time, s leaving the t blank will the subscriber themselves Tip: The t prperty, as well as all prperties, can include tkens based n the listbx alng the right hand side f the message. Fr example yu can specify the t as $( Address) r yu culd separate it semi clumns such as $( Addres);Yur @yurdmain.cm CC/BCC use these fields t specify the CC and BCC fields the ntificatin shuld be sent t Tip: The cc/bcc prperty, as well as all prperties, can include tkens based n the listbx alng the right hand side f the message. Fr example yu can specify the t as $( Address) r yu culd separate it semi clumns such as $( Addres);Yur @yurdmain.cm Pririty chse the desired pririty f the message frm this pull dwn menu Subject chse the desired subject f the message Tip: The cc/bcc prperty, as well as all prperties, can include tkens based n the listbx alng the right hand side f the message. Fr example yu can specify the t as $( Address) r yu culd separate it semi clumns such as $( Addres);Yur @yurdmain.cm Message use this text area t enter the bdy f the message Nte: yu can use any f the tkens t further custmize the message (e.g. put the [FirstName] inside the bdy f the message t address the users by their First name i.e. their first name will be extracted frm the database and inserted int the message Verificatin Delay - yu can specify the number f days that the system shuld wait befre ntifying the user again in case the user has been previusly ntified Fr example: if the ntificatin is setup t ntify the user that their security rle will expire within 14 days, and yu specify a verificatin delay f 7 days then the user wuld be ntified twice within 14 days i.e. nce every 7 days n the ther hand if yu specify the verificatin delay and rle expiratin delay bth t 14 days then the user wuld nly be ntified nce The verificatin delay setting is prbably ne f the mst imprtant prperties fr each rle definitin, if the scheduler prcess is setup t run daily yu wuldn t want the user t be ntified every single day that their rle was abut t expire, s the verificatin delay wrks t make sure that nce a user has been ntified they will nt receive anther ntificatin until the verificatin delay has passed. After setting the desired parameters, click n the "Save link and the new ntificatin item will be added. Page: 11 / 20

12 Figure 12: New ntificatin item successfully added Page: 12 / 20

13 6 VIEWING ROLE REMINDER LOG In rder t view the rle reminder lg, chse that ptin frm the main menu. Figure 13: Viewing the rle reminder lg (step 1/2) The fllwing screen will be displayed. Figure 14: Viewing the rle reminder lg (step 2/2) The fllwing parameters are available inside this screen: Lg ID ID number f the specific lg Rle ID the security rle the item in the lg is related t the address ntificatin item has been sent t Rle Name the name f the ntificatin item Date Time Sent the date ntificatin item has been sent Delete use this ptin t delete the desired ntificatin item frm the lg Clear All use this ptin t clear all infrmatin frm the reminder lg Page: 13 / 20

14 7 MANAGING NOTIFICATION ITEMS This sectin f the dcument will utline all available ptins fr managing ntificatin items. Figure 15: Managing ntificatin items The fllwing parameters and ptins are available: Fields chse the field the filter will be applied t frm this pull dwn menu Filter Value enter the desired value fr the filter, i.e. the keywrd the system will use in rder t filter the results (e.g. Subscribers ); nce yu define the desired keywrd, click n the refresh icn t display the results Page Size select the desired number ntificatin items yu wish t display per page - click n this icn next t the desired ntificatin item t edit its cntents (see sectin 7.1) - click n this icn next t the desired ntificatin item in rder t delete it (see sectin 7.2) Add click n this icn t add a new ntificatin item (see sectin 5) 7.1 Editing a ntificatin item In rder t edit the desired ntificatin item, click n this icn next t its name in the list. Figure 16: Editing a ntificatin item Page: 14 / 20

15 The same screen as when creating the new ntificatin item with all the item parameters will be displayed where yu will be able t make the desired changes. See sectin 5 fr further infrmatin abut the available parameters. 7.2 Deleting a ntificatin item In rder t delete the desired ntificatin item, click n this icn next t its name in the list. Figure 17: Deleting a ntificatin item (step 1/2) The fllwing cnfirmatin dialg will be displayed. Figure 18: Deleting a ntificatin item (step 2/2) Click n the OK buttn and the ntificatin buttn will be deleted. Page: 15 / 20

16 8 ACCESSING THE SCHEDULER In rder t access the scheduler, chse ptin Schedule frm the Hst menu. Figure 19: Accessing the scheduler (1/3) The fllwing page will be displayed. Figure 20: Accessing the scheduler (2/3) Click the Histry link next t the Rle reminder scheduler and the scheduler histry will be displayed. Page: 16 / 20

17 Figure 21: Accessing the scheduler (3/3) Page: 17 / 20

18 9 MANAGING SETTINGS In rder t start managing the standard mdule settings chse ptin Settings frm the main menu. Figure 22: Chsing ptin "Settings" The fllwing screen will be displayed. Figure 23: Managing settings Page: 18 / 20

19 10 DELETING RENEWAL REMINDER MODULE In rder t delete Renewal Reminder mdule, chse ptin Delete frm the main menu. Figure 24: Deleting Renewal Reminder Mdule (step 1/2) The fllwing screen will be displayed. Figure 25: Deleting Renewal Reminder Mdule (step 2/2) Click n the OK buttn and the mdule will be deleted. Page: 19 / 20

20 11 TROUBLESHOOTING Fr the purpses f trubleshting it is best t always enter an administratr s address fr the t prperty. This way the actual user will nt be ntified. s nt ging ut? Sme servers require the Frm t match the dmain name. Renewal Reminder uses the same functins as DtNetNuke, s a gd rule f thumb is t try sending an under Admin, Newsletters with the same T and Frm as yu are attempting fr the Renewal Reminder Detailed lgs f each distributin are kept when the scheduler executes. Yu can find these lgs under Hst -> Scheduler and click View Histry fr the renewal reminder scheduler prperty Fr further assistance, please review the Renewal Reminder prduct frums: guage/en-us/default.aspx Page: 20 / 20