Professional Documents
Culture Documents
2009SageSoftware,Inc.Allrightsreserved.Sage,theSagelogos,andtheSageproductandservice namesmentionedhereinareregisteredtrademarksortrademarksofSageSoftware,Inc.,orits affiliatedentities.CrystalReportsisaregisteredtrademarkofBusinessObjectsintheUnitedStates and/orothercountries.NetLibisaregisteredtrademarkofCommunicationHorizons.OrgPlusisa trademarkofHumanConcepts,LLC.TextBridgeisaregisteredtrademarkofScanSoft,Inc.Microsoft, Outlook,Windows,WindowsNT,WindowsServer,the.NETlogo,WindowsVistaandtheWindows logoaretrademarksorregisteredtrademarksofMicrosoftCorporationintheUnitedStatesand/or othercountries.Thenamesofallotherproductsandservicesarethepropertyoftheirrespective holders. Sagehasmadeeveryefforttoensurethisdocumentationiscorrectandaccuratebutreservestheright tomakechangeswithoutnoticeatitssolediscretion.Use,duplication,modification,ortransferofthe productdescribedinthispublication,exceptasexpresslypermittedbytheSageLicenseAgreementis strictlyprohibited.Individualswhomakeanyunauthorizeduseofthisproductmaybesubjectto civilandcriminalpenalties. ForadditionalassistanceonthisandotherSageproductsandservices,visitourWebsiteat: www.sagenorthamerica.com
Table of Contents
Overview ........................................................................................................................1 System Requirements....................................................................................................1 Install Sage Abra Alerts 5.1...........................................................................................2
Followthechecklistbelowtoprepareforinstallation ...................................................................................3 CreateanNTaccountforSageAbraAlerts..............................................................................................3 CreateanEmailAccount ...........................................................................................................................3 ToInstallSageAbraAlerts ................................................................................................................................3
Predefined Processes..................................................................................................13
ToCopyorModifyaPredefinedProcess ......................................................................................................15
ii
Abra Alerts
ReviewtheSageAbraAlerts5.1ReleaseNotesforthelatestenhancementsandmodifications.
System Requirements
BeforeyouinstallSageAbraAlerts,reviewthefollowingsoftwareandhardwarerequirements. AserverrunningMicrosoftWindows2003Server,MicrosoftWindows2008Server,oroneofthe following: MicrosoftWindowsVista MicrosoftWindowsXPHomeorProfessionalEdition MicrosoftWindows2000AdvancedServerSP1orlater MicrosoftWindows2000ServerSP1orlater MicrosoftWindows2000ProfessionalSP1orlater MicrosoftWindowsNTServer4.0SP6orlater MicrosoftWindowsNTWorkstation4.0SP6orlater
100MBstorageforprograminstallation MessagingApplicationProgrammingInterface(MAPI)andExchangesettingsrequireMicrosoft Outlook98orgreaterinstalledontheserverrunningSageAbraAlerts.ForOutlook2000and greater,CollaborativeDataObjects(CDO)Componentsmustbeselectedduringitsinstallation priortoinstallingtheDataAgentServer.AsofOutlook2007,CDOisnolongerincludedinthe Officesetup.CDOcanbedownloadedfromMicrosoftforthoseusingOutlook2007. SimpleMailTransferProtocol(SMTP)requiresanavailableSMTPserver. Note: IfyouareinstallingSageAbraAlertsandAbraWorkforceConnectionsonthesame server,youmustinstallSageAbraAlertsbeforeinstallingAbraWorkforceConnections.
Abra Alerts
Create an NT account for Sage Abra Alerts WerecommendthatthedomainAdministratorcreateaspecialdomainlevelaccount(sothatit canaccessnetworkresources)tobeusedonlyforadministeringSageAbraAlerts.Thisincludes administrativeaccesstotheDatafolder.WerefertothisastheSageAbraAlertsAdministrator account. ThisaccountmustbelongtotheserversAdministratorgroup.Duringinstallation,thefollowing advanceduserrightsareautomaticallyassignedtotheaccount: LogonasaService ActasaPartoftheOperatingSystem LogonasBatch
2.
3.
IntheWelcomedialogbox,clickNext.
b. AfteryouclickOK,amessageappearsforyoutoconfirmuninstallingSageAbra Alerts4.1.
c. ClickYestocontinueorNotoexittheSageAbraAlerts5.1installation.
Abra Alerts
5. IntheSelectDestinationDirectorydialogbox,selectthepathanddirectorywhereyouwant SageAbraAlerts5.1installed.ClickNext.
6.
IntheInstallSageAbraAlerts5.1fordialogbox,selectthetypeofdatabaseinstalledforyour SageAbraHRMSsystem,eitherFoxProorSQLServer.ClickNext.
7. IntheServiceAccountInformationdialogbox,entertheDomain,Login,andPasswordand Passwordconfirmationoftheaccounttheserviceshouldusetorununder.ClickNext.
Abra Alerts
8.
IntheReadytoInstalldialogbox,clickInstalltoproceedwiththeinstallation.
9. Whentheinstallationiscomplete,the(email)Settingsdialogboxdisplays.Allemployeesto whomyouwantSageAbraAlertstosendemailmessagesmusthaveemailaddresses.
Thesettingsareusedtoupdatetheincludedlibraryofalertswithyourspecificemail settings.Enterthefollowing: AnemailprofilefortheSageAbraAlertsAdministratoraccount. Note: TheDefaultMailboxNamemustconformtotheformatinthe OutlookProfile.IfyouselectExchangeServerintheemailandyoudidnot enterthemailboxnameinthecorrectformat,SageAbraAlertswillnotsend theemailmessageandanerrormessagewillbeloggedthattheprofilemay beinvalid.Verifytheformatintheprofileandchangethemailboxname accordingly.ToverifytheprofileinOutlook,selectServices>Microsoft ExchangeServer>Properties.Theserverandmailboxnamedisplay. AMAPI(MessagingApplicationProgrammingInterface)orSMTP(SimpleMail TransferProtocol)forexchangingemail.Checkwithyoursystemadministratoror postmasterastowhichoneyoushouldsetup. MAPIisaMicrosoftWindowsprograminterfacethatallowsyoutoexchangeemail withvariousmessagingsystems,forexampleMicrosoftExchange,Microsoft Outlook,andEudora. ToenableautomatedsendingofMAPIandExchangeServeraccount messages,logontotheserverusingtheaccountusedtoruntheservice; then,usingthesamelogon,configureandtesttheemailclientthatthe AlertsProductNTservicewilluse. YourMAPIemailprogram,suchasOutlook,shouldbesettobethedefault emailhandler. Theemailprofilefortheaccountusedtoruntheserviceshouldbesettothe defaultprofilewhenstartingyouremailprogram.Youremailprogram shouldnotpromptforaprofiletousewhenstarting. IfyoucannotsendemailmessagesusingyourdefaultMAPIemail program,oryoudonotknowwhetheryoushoulduseMAPI,Exchange Server,orSMTP,thenseeyourpostmasterorsystemadministratorfor assistance.
Abra Alerts
10. Whentheinstallationhascompleted,clickFinish.
2. 3. OntheSystemDSNtab,clickAdd.TheCreateNewDataSourcedialogboxopens. SelectSQLServerandclickFinish.TheCreateaNewDataSourcetoSQLServerdialogbox opens. EnterAbraHRMSAlertsasthenameforyourdatasourceandselecttheSQLServertowhich youwanttoconnect.ClickNext. EntertheappropriateinformationontheremainingdialogboxesandclickFinish. FromtheStartmenu,select(All)Programs>SageSoftware>AbraAlerts>AbraAlerts5.1. TheProcessManageropens. FromtheProcessManager,rightclicktheprocessyouwanttouseandselectProperties.The ProcessPropertiesdialogboxopens. OntheStepstab,clickEdit.TheMonitoranODBCDataSourcedialogboxopens. ClickDataSource.TheSelectDataSourcedialogboxopens.
4.
5. 6.
7.
8. 9.
10. OntheMachineDataSourcetab,selectAbraHRMSAlertsandthenclickOK.
10
Abra Alerts
12. Repeatsteps711foreachprocess.
2. 3.
4. 5.
6.
9.
11
6. 7. 8.
b. OntheGeneraltab,selecttheEnabledcheckbox. c. ClickOK.
d. Repeatstepsacforeachalertthatwaspreviouslyrunning.
12
Abra Alerts
Predefined Processes
Predefined Processes
Thefollowinglistdescribeswhateachwilldo.Useeachprocessasatemplateorstartingpointandthen modifythemtosuityourcompanysneeds. Refertotheendofthissectionforstepbystepprocedurestomodifyapredefinedprocess. AbraAlertMaintenance(FoxProonly)Thisalertperiodicallydeletesallfileswithanextension oftmpintheC:\Tempfolderandpreventsthisfromoccurring.Itisrecommendedthatyou runthealertdailybutyoumayneedtorunitmoreoftendependingonthefrequencythatyou haveyouralertsscheduledtorun. AbraAlertsStatusThisalertprovidesnotificationonadailybasistoadesignatedpersoninHR orPayrollthatSageAbraAlertsisupandrunning. AddressorPhoneChangeVerificationThisalertnotifiesemployeeswhentheirHomeAddress orPhoneNumberhaschanged. ApplicantRejectionNoticeThisalertwillsendanotificationtoapplicantswhoarerejectedfor apositionforwhichtheyapplied.Thecriteriaforselectingapplicantsisthattheymusthavea LetterofRejectionspecifiedforthem(REJECT).Youwillneedtoinsertthenameofyour companyintheemail. ApplicationReceivedThisalertwillsendanemailtoapplicantsforwhomanapplicationor resumehasbeenreceived.ThecriteriaforselectingtheapplicantisthattheymusthaveaLetter ofAcknowledgementspecified(ACKNOWL).Youwillneedtoaddyourcompanynameand phonenumbertotheemail. AvailableBalanceHasReachedAccrualLimitThisalertnotifiesemployeeswhentheir AvailableBalancereachestheAccrualLimitofabenefitplan. CEUBalanceThisalertnotifiesanemployeeandtheirsupervisorthatacertificationbasedon CEUswillexpirein30days. ClassCompletionThisalertnotifiesanemployeessupervisorwhentheemployeehas completedatrainingclass. ClassConfirmationThisalertnotifiesanemployeeandthesupervisorwithin7dayspriorto thestartofatrainingclasstheemployeeisenrolledin. DeductionHasReachedGoalThisalertnotifiesanemployeewhenadeductiongoalhasbeen met. DirectDepositVerificationThisalertnotifiesanemployeewhenanewdirectdepositissetup oranexistingdirectdepositischanged.Theemployeeissentanemailalongwithanassociated attachment.Thealertdoesnotmonitorfordeletedrecords.
13
Predefined Processes
FMLAReturnThisalertsendsanemailtoanemployeessupervisor7daysbeforeanemployee istoreturnfromaFamilyorMedicalLeaveofAbsence.IfyouwouldlikeHRtobenotified,you willneedtoaddtheemailaddressofthatperson. I9RenewalThisalertnotifiesanemployeeandtheemployeessupervisor30dayspriortothe renewalofI9relatedinformation.IfyouwouldlikeHRtobenotified,youwillneedtoaddthe emailaddressofthatperson. NegativeAvailableBalanceThisalertnotifiesemployeeswhentheirAvailableHoursbecome negativeforVacationorIllnessattendanceplans. NewHireThisalertnotifiesemployeesofinformationthathasbeenenteredintotheAbra systemiftheyareanewhireorarehire.Theemployeeshouldreviewtheinformationandnotify theHRdepartmentofanychanges.AlsoattachedisaW4formfortheemployeetocomplete andreturn. OnDemandCheckProcessedThisalertisdesignedtobesenttoaseniormanagement accountingpersonanytimethereisanewondemandcheckcreated.Theemailaddressofthis personwillneedtobeaddedinorderforthealerttoworkcorrectly. OvertimeListingThisalertcreatesanExcelspreadsheetthatlistsallemployeeswhoworked overtimesincethelasttimethealertwasrun.AVisualBasicScriptpopulatesthespreadsheet basedonnewrecordsbeingaddedtotheEmployeeCheckHistorydatabase(PRCKHIST.DBF). Thespreadsheetisthensenttoadesignatedpersonwhoseemailaddressmustbeenteredin orderforthealerttoworkcorrectly. Notes: TheSendEmailwithOvertimeListingstepissetupasaprimarystep(nota substep).Thismeansthattheemailmessagewillbesenteverytimethe alertisscheduledregardlessofanydatachanges. MicrosoftExcelmustbeinstalledontheSageAbraAlertsserver;otherwise, thespreadsheetwillnotcontainanydata.
14
Abra Alerts
Predefined Processes
VoidedCheckListingThisalertcreatesanExcelSpreadsheetthatlistsallemployeeswhohave hadacheckordirectdepositvoidedsincethelasttimethealertwasrun.AVisualBasicScript populatesthespreadsheetbasedonnewrecordsbeingaddedtotheEmployeeCheckHistory database(PRCKHIST.DBF).Thespreadsheetisthensenttoadesignatedpersonwhoseemail addressmustbeenteredinorderforthealerttoworkcorrectly.Thestepsinthisprocessinclude MonitorforVoidedChecksandSendEmail.ItisscheduledtoruneveryMondayat5A.M. Notes: TheSendEmailwithVoidedCheckListingstepisaprimarystep.This meanstheemailmessagewillbesenteverytimethealertisscheduled regardlessofdatachanges. MicrosoftExcelmustbeinstalledontheSageAbraAlertsserver;otherwise, thespreadsheetwillnotcontainanydata.
2. 3. 4. 5.
15
2. 3.
4. 5. 6.
General Tab
TheGeneraltabenablesyoutoprovidegeneralinformationabouttheprocess.
16
Abra Alerts
Schedule Tab
TheScheduletaboffersyouawiderangeofschedulingoptions.SelectaScheduleTypeand completetheinformationinthedialogbox.Theoptionsdisplayedwillvarybasedonwhatyouselect intheScheduleTypefield.
17
Thefollowingtableshowseachscheduletypeanditsassociatedschedulingoptions.
ScheduleTypeandOptions RunOnce StartTime StartDate Hourly StartTime At(x)minutesafterthehour Startrunningon Donotrunafter11:59PMon Daily StartTime Every(x)day(s) Everyweekday Startrunningon Donotrunafter11:59PMon Weekly StartTime Every(x)week(s)on Sunday,Monday Startrunningon Donotrunafter11:59PMon Monthly StartTime Onthe(x)dayofthemonth Onthe(x)(xxx)ofthemonth SelectMonth(s)below Startrunningon Donotrunafter11:59PMon Quarterly StartTime Atthestartofeachquarter Attheendofeachquarter Startrunningon Donotrunafter11:59PMon Yearly StartTime Every(date) Thetimeofdaytheprocessshouldrun. Theprocessrunsonaspecificdateeachyear. Thetimeofdaytheprocessshouldrun. Theprocessrunsatthebeginningofthequarter. Theprocessrunsattheendofthequarter. Thedateofthefirstprocessrun. Thelastdatetheprocessshouldrun. Thetimeofdaytheprocessshouldrun. Thedayofthemonthfortheprocessrun. Furtherspecifytherundate:e.g.,1stweekdayor3rdSun. Themonthstheprocessshouldrun. Thedateofthefirstprocessrun. Thelastdatetheprocessshouldrun. Thetimeofdaytheprocessshouldrun. Thefrequency(everyweek,everyotherweek,etc.)atwhichthe processruns. Thedaysoftheweekonwhichtheprocessshouldrun. Thedateofthefirstprocessrun. Thelastdatetheprocessshouldrun. Thetimeofdaytheprocessshouldrun. Thefrequency(everyday,everyotherday,etc.)atwhichtheprocess runs. TheprocessonlyrunsMondaythroughFriday. Thedateofthefirstprocessrun. Thelastdatetheprocessshouldrun. Thefirsttimetheprocessshouldrun. Thespecifictimeeveryhourtheprocessshouldrun. Thedateofthefirstprocessrun. Thelastdatetheprocessshouldrun. Thetimeofdaytheprocessshouldrun. Thedateonwhichtheprocessshouldrun. Description
18
Abra Alerts
Tip: ContinuouslyScheduleType:Aprocessrunningagainstalargedatabasecantakesome timetocompleteandcanslowtheperformanceofthedatabase.Ifthetimenecessarytorunthe processislongerthanthetimeintervalspecified,thenextrunoftheprocessisqueueduntilthe precedingrunhascompleted. Therefore,youshouldmakesureyouhavesettheintervalintheEvery(x)minutesfieldtobelonger thanthelongestanticipatedruntimeoftheprocess.Ifyoudonotknowhowlongtheprocesswill run,runitonceandthenreviewthelogfiletodeterminehowlongtheprocesstook,thensetthe interval. Tip: Donotrunafter11:59pmonScheduleType: Youmightwanttousethisoptionfor weekends.Forexample,ifyoudonotwanttheprocesstorunovertheweekend,enterFridays date,andthentheprocesswillnotrunafter11:59P.M.onthatFriday.
19
Set the Duration of Process Execution Typically,youwantyourprocesstorununtilitiscomplete.However,ifyouwanttosetalimit onhowlongyouwanttheprocesstorun,selectLimitprocessexecutiontimeto<x>minutes andenterthelimitinminutes(60minutesisthedefault).Ifyouselectthisoption,andtheprocess runslongerthanthelimit,theprocessisterminated. Tip: Ifyouarerunningaprocessthattakesalongtimetocomplete,youwillprobablywant tosetalimitonitsdurationsinceyoudonotwanttotieupadatabaseforalongperiodof time.Toseehowlongaprocesswilltake,runitatleastonce,andcheckthelogtoseehow longittooktocomplete. Set the Process Timeout Settings TheSageAbraAlertsNTServiceperiodicallycheckstoseeiftheprocessisresponding.Ifthe ProcessTimeoutissettoNoLimit,theprocessdoesnothavetorespond.IfyouselectStop processafternotrespondingfor<x>seconds,theprocessisterminatedifithasnotresponded withintheselectedtimeframe. Note: Thissettingoverridesdefaultsettingsforprocesstimeouts.
20
Abra Alerts
If a Step Causes a Process to Abort Aprocesscanconsistofmanydifferentsteps,eachstepconsistingofadifferentagentconfigured toperformadifferenttask.Typically,thesestepsareinterrelated.Ifonestepfails,youmaywant toendtheprocess,oryoumaywanttotryagain. Youcandefinewhathappenstoaprocesswhenoneofitscomponentstepsfailsandprocess executionhalts.Theoptionsare: Dontreruntheprocess(default). Reruntheprocesseveryxminutes,wherexisanumberyoudefine(30isthedefault). Definehowmanytimesyouwanttoattempttoreruntheprocess.SelectLimitthe numberoftimestheprocessisrerunandsetthenumberoftimes(10isthedefault). Note: Youshouldnotsetprocessestorunduringapayrollprocess.Otherwise, databasescanlockupandcausedatacorruption.Therefore,westronglyrecommend youselectthedefaultDontreruntheprocess. Restore Defaults/Cancel ClickRestoreDefaultstoresetalloptionstotheirdefaultvalues.ClickCanceltoundochanges youhavemadesinceopeningthedialogboxorsinceyoulastsavedchanges. Steps Tab Eachprocessincludesoneormorestepsthatlaunchagents.Eachtimeaprocessruns,SageAbra Alertsrunsthestepssetupfortheprocess.Eachstepcanincludeoneormoresubstepsthat launchadditionalagentsbasedontheoutcomeofrunningthestep. Steps vs. Sub-steps Ifyouhavesetupastepthatlaunchesamonitoragent(fromtheStepstaboftheProcess Propertiesdialogbox),youcanalsosetupstepsforthemonitoragent(fromtheStepstabofthe MonitorAgentdialogbox).Forclarity,werefertoastepsetupforthemonitoragentasasub step. Thedirectionsarebasicallythesametoaddasteporsubstep.Anydifferencesarenoted.
21
4.
22
Abra Alerts
Thefollowingtablesdescribetheseoptions
Perform Step for: Step Options NormalExecution Error Successful Completion Effect Alwaysruns,regardlessoferrorsorsuccessfulcompletion.Thisisthe defaultoptionandwerecommendyouusethisforallsteps. Onlyrunsiftheprocesshasencounteredoneormoreerrorspriorto reachingthisstep. Onlyrunsiftheprocesshasencounterednoerrorspriortoreachingthis step.
Perform Step For: Sub-step Option Neworchangedfiles Agent FileMonitor Effect Ifadifferenceisdetectedbetweenthesource filesandthesnapshot,oranewfileis detected,thesubstepagentistriggered. Iftheresultsetreturnedfromthequeryonthe monitoreddatabasecontainsneworchanged recordsinoneofitsmonitoredfields,thesub stepagentistriggered. Ifanewfileisdetected(suchas.,onethatdoes notexistinthesnapshot),thesubstepagentis triggered. Iftheresultsetreturnedfromthequeryonthe monitoreddatabasecontainsnewrecordsin oneofitsmonitoredfields,thesubstepagent istriggered. Ifadifferenceisdetectedinanyofthesource filesincludedinthesnapshot,thesubstep agentistriggered. Iftheresultsetreturnedfromthequeryonthe monitoreddatabasecontainschangesinanyof themonitoredfields,thesubstepagentis triggered. Ifnodifferenceisdetectedinanyofthesource filesincludedinthesnapshot,thesubstep agentistriggered.
Neworchangedrecords
Database Monitor
Newfiles
FileMonitor
Newrecords
Database Monitor
Changedfiles
FileMonitor
Changedrecords
Database Monitor
Unchangedfiles
FileMonitor
23
Option Unchangedrecords
Deletedrecords Iftheagentdetectsthata filehasbeendeleted,the substepagentistriggered. (Onlythenameofthe deletedfilescanbe embeddedinmessages.) Iftheagentdetectsthata recordhasbeendeleted, thesubstepagentis triggered.(Onlythe contentsofUniqueFields fromthedeletedrecord canbeembeddedin messages.)
DatabaseMonitor
5.
SelectaLoggingLevel.Thisdefinesthelevelandtypeofinformationthatiswrittento thelogfile.Thefollowingtabledescribestheseoptions.
Option ErrorsOnly Effect Writesloginformationwhenitencountersanerrorcondition thathaltseithertheprocessoranindividualagents execution. Writesloginformationwhenitencountersanerrorora warningcondition.Awarningconditiondoesnothaltthe processoragent,butisnotentirelynormal. Writesloginformationwhenitencountersanerrorora warningcondition,andprovidesabriefmessageaboutthe stepsexecution.Thisisthedefaultoptionandwe recommendyouusethisforallsteps. Writesextensiveloginformation.Itisusefulwhentryingto figureoutwhyaprocessisnotrunningasexpected.Thelog growsveryquickly,sodonotleaveitselectedforgeneraluse.
WarningsandErrors
Information,Warningand Errors
Trace,Information, WarningsandErrors
24
Abra Alerts
6.
7.
ClickEditConditionifyouwanttoaddaconditionunderwhichthestepshouldrun.
25
f. ClickOK.
To Use the Edit Expression Dialog Box to Enter an Expression:
2.
3.
26
Abra Alerts