Sage Abra HRMS

Sage Abra Alerts

Installation and Setup Guide
RY9U0602-1 09/09

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

Change the Data Source..............................................................................................9

ConnecttoanODBCSystemDSN..................................................................................................................10 ConnecttoanOLEDBDataSource................................................................................................................11 UpdatetheScriptingAgent .............................................................................................................................12

Predefined Processes..................................................................................................13
ToCopyorModifyaPredefinedProcess ......................................................................................................15

Create a New Process ................................................................................................16

GeneralTab ........................................................................................................................................................16 ProcessName..............................................................................................................................................16 Category ......................................................................................................................................................17 Comments ...................................................................................................................................................17 Enabled ........................................................................................................................................................17 ScheduleTab ......................................................................................................................................................17 AdvancedScheduleOptions ....................................................................................................................20 SettheDurationofProcessExecution.....................................................................................................20 SettheProcessTimeoutSettings..............................................................................................................20 IfaStepCausesaProcesstoAbort..........................................................................................................21 RestoreDefaults/Cancel ............................................................................................................................21 StepsTab .....................................................................................................................................................21 Stepsvs.Substeps .....................................................................................................................................21 ToAddaStep .............................................................................................................................................22

Installation and Setup Guide

Tips for Using Sage Abra Alerts .................................................................................. 26

MicrosoftJet....................................................................................................................................................... 26 CustomFieldReplacementinWordRTFdocuments ................................................................................. 26 CreatingDataMonitorSnapshots .................................................................................................................. 26

ii

Abra Alerts

Installation and Setup

Overview
TheInstallationandSetupGuideisprovidedtohelpyouinstallandsetupSageAbraAlerts.Itincludes thefollowingtopics: SystemRequirements InstallSageAbraAlerts5.1 ChangetheDataSource PredefinedProcesses CreateaNewProcess TipsforUsingSageAbraAlerts

ReviewtheSageAbraAlerts5.1ReleaseNotesforthelatestenhancementsandmodifications.

System Requirements
BeforeyouinstallSageAbraAlerts,reviewthefollowingsoftwareandhardwarerequirements. AserverrunningMicrosoftWindows2003Server,MicrosoftWindows2008Server,oroneofthe following: MicrosoftWindowsVista MicrosoftWindowsXPHomeorProfessionalEdition MicrosoftWindows2000AdvancedServerSP1orlater MicrosoftWindows2000ServerSP1orlater MicrosoftWindows2000ProfessionalSP1orlater MicrosoftWindowsNTServer4.0SP6orlater MicrosoftWindowsNTWorkstation4.0SP6orlater

MicrosoftDataAccessComponents,version2.6SR2orlater MicrosoftInternetExplorer5orgreater Aminimum200MHzPentiumprocessor Minimum128MBRAM

Installation and Setup Guide

Install Sage Abra Alerts 5.1

100MBstorageforprograminstallation MessagingApplicationProgrammingInterface(MAPI)andExchangesettingsrequireMicrosoft Outlook98orgreaterinstalledontheserverrunningSageAbraAlerts.ForOutlook2000and greater,CollaborativeDataObjects(CDO)Componentsmustbeselectedduringitsinstallation priortoinstallingtheDataAgentServer.AsofOutlook2007,CDOisnolongerincludedinthe Officesetup.CDOcanbedownloadedfromMicrosoftforthoseusingOutlook2007. SimpleMailTransferProtocol(SMTP)requiresanavailableSMTPserver. Note: IfyouareinstallingSageAbraAlertsandAbraWorkforceConnectionsonthesame server,youmustinstallSageAbraAlertsbeforeinstallingAbraWorkforceConnections.

Install Sage Abra Alerts 5.1

SagerequiresthatSageAbraAlertsbeinstalledbyaSagecertifiedBusinessPartner. Pleasereadthefollowingbeforeyoubegin! BackupyourcurrentProcessesandTemplatesfolders. Ifyouareupgradingfromversion4.X,donotuninstallSageAbraAlertspriortotheinstallation ofSageAbraAlerts5.1.Theinstallationprocesswilluninstallthepreviousversion4.1orearlier. YoumusthavefulladministrativerightstoinstallSageAbraAlerts. ConfirmyouhavethehardwareandsoftwarenecessarytoinstallSageAbraAlerts.Refertothe SystemRequirementsonpage1fordetails. SageAbraAlertsisdesignedandlicensedexclusivelyforusewiththeSageAbraHRMS databases. ReadtheReleaseNotestolearnaboutenhancementsandmodificationsincludedinversion5.1. TheReleaseNotesareincludedontheSageAbraAlertsDVDoryoucanaccessthemafterthe installationfromtheStartmenubyselectingAllPrograms>SageSoftware>AbraAlerts> ReleaseNotes. SageAbraAlertswillbeinstalledtotheSageSoftwareprogramsgroup.

Abra Alerts

Install Sage Abra Alerts 5.1

Follow the checklist below to prepare for installation

CreateanNTaccount. CreateanemailaccountforSageAbraAlerts. ObtaintheSageAbraAlertsserialnumber. ObtainnamesfortheMAPIExchangeserverandmailbox. ObtainthenamesfortheSMTPmailserverandFromaddress.

Create an NT account for Sage Abra Alerts WerecommendthatthedomainAdministratorcreateaspecialdomainlevelaccount(sothatit canaccessnetworkresources)tobeusedonlyforadministeringSageAbraAlerts.Thisincludes administrativeaccesstotheDatafolder.WerefertothisastheSageAbraAlertsAdministrator account. ThisaccountmustbelongtotheserversAdministratorgroup.Duringinstallation,thefollowing advanceduserrightsareautomaticallyassignedtotheaccount: LogonasaService ActasaPartoftheOperatingSystem LogonasBatch

Theserights,aswellasmembershipinthelocaladministratorgroup,arenecessaryforthe accounttoruntheservice. Create an E-mail Account WerecommendthatyoucreateanemailaccountspecificallyforSageAbraAlerts.Contactyour systemadministratororpostmasterforthisinformation.

To Install Sage Abra Alerts

1. Tohelpensureacompleteanderrorfreeinstallation,closeanyWindowsorDOS applicationsyouhaverunning. InserttheSageAbraAlerts5.1InstallationCDintoyourCDROMdrive.IfAutorunis enabledonyoursystem,theInstallationdialogboxopens.IftheInstallationdialogboxdoes notautomaticallyopen,browsetoyourCDROMdrive,anddoubleclickSetup.exe.

2.

Installation and Setup Guide

Install Sage Abra Alerts 5.1

3.

IntheWelcomedialogbox,clickNext.

IfyoualreadyhaveSageAbraAlerts4.1installed,thefollowingstepsadreplacesteps47. Ifamessageappearsindicatinganapplicationiscurrentlyactive,clickClose,andthenclick Next. a. AmessageappearsindicatingthattheinstallationfoundSageAbraAlerts4.1on yoursystem.TouninstallSageAbraAlerts4.1andcontinuewiththeSageAbra Alerts5.1installation,clickOK.

b. AfteryouclickOK,amessageappearsforyoutoconfirmuninstallingSageAbra Alerts4.1.

c. ClickYestocontinueorNotoexittheSageAbraAlerts5.1installation.

Abra Alerts

Install Sage Abra Alerts 5.1

Note: IfyouareusingSageAbraAlerts4.0or4.1,installingSageAbraAlerts5.1in thedirectorywherethepreviousversionwasinstalledwilluninstallversion4.0or 4.1.UninstallingSageAbraAlerts4.1doesnotremovethealertsdefinedinthe4.1 version.TheywillappearinthenewlyinstalledSageAbraAlerts5.1 d. Continueinstallationprocessatstep8. 4. IntheEnterSerialNumberdialogbox,enteryourName,Company,SerialNumber,and LicenseKey.ClickNext.

5. IntheSelectDestinationDirectorydialogbox,selectthepathanddirectorywhereyouwant SageAbraAlerts5.1installed.ClickNext.

Installation and Setup Guide

Install Sage Abra Alerts 5.1

6.

IntheInstallSageAbraAlerts5.1fordialogbox,selectthetypeofdatabaseinstalledforyour SageAbraHRMSsystem,eitherFoxProorSQLServer.ClickNext.

7. IntheServiceAccountInformationdialogbox,entertheDomain,Login,andPasswordand Passwordconfirmationoftheaccounttheserviceshouldusetorununder.ClickNext.

Abra Alerts

Install Sage Abra Alerts 5.1

8.

IntheReadytoInstalldialogbox,clickInstalltoproceedwiththeinstallation.

9. Whentheinstallationiscomplete,the(email)Settingsdialogboxdisplays.Allemployeesto whomyouwantSageAbraAlertstosendemailmessagesmusthaveemailaddresses.

Installation and Setup Guide

Install Sage Abra Alerts 5.1

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.

SMTP(SimpleMailTransferProtocol)isaprotocolforsendingandreceivingemail messagesontheinternet. SomeSMTPemailsystemsdonotsendmailunlessavalidemailaddressappearsin theFrom:sectionofamessage.Werecommendsettingupaseparateemail accountfortheEmailAgent,thensettingtheDefaultFromAddresstothis account.

Abra Alerts

Change the Data Source

10. Whentheinstallationhascompleted,clickFinish.

Change the Data Source

InordertousethepredefinedalertsprovidedwithSageAbraAlerts,youmustcreateadatasourceto provideaccesstoyourdatabaseandchangethedatasourceineachprocessyouwanttouse. IfyouareusingSQLServer,youmustcreateanODBCSystemDSNnamedAbraHRMSAlerts. IfyouareusingFoxPro,youmustcreateanOLEDBProvidernamedAbraHRMSAlerts.

Installation and Setup Guide

Change the Data Source

Connect to an ODBC System DSN

1. FromtheStartmenu,selectSettings>ControlPanel>AdministrativeTools>DataSources (ODBC).TheODBCDataSourceAdministratordialogboxopens.

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

Change the Data Source

11. Ifyoureceiveamessagethatyourdatasourcehaschangedsinceyoucreatedthequery,click No.

12. Repeatsteps711foreachprocess.

Connect to an OLE DB Data Source

1. FromtheStartmenu,select(All)Programs>SageSoftware>AbraAlerts>AbraAlerts5.1. TheProcessManageropens. Fromthemenu,selectService>StartService. Fromthemenu,selectView>AgentControlPanel>DataSources.TheDataSources Managerdialogboxopens. ClickAdd.TheAddNewDataSourcedialogboxopens. EnterAbraHRMSAlertsasthenameforyourdatasourceandclickConfigure.TheData LinkPropertiesdialogboxopens. SelectMicrosoftOLEDBProviderforVisualFoxProandthenclickNext. Note: IfMicrosoftOLEDBProviderforVisualFoxProdoesnotappearinthelistof providers,obtainitfromtheMicrosoftWebsite.Currently,theversionforMicrosoft OLEDBProviderforVisualFoxProisversion9.0.Thisversioniscompatiblewithall previousversions. 7. 8. OntheConnectiontab,clickBrowse.TheConfigureConnectiondialogboxopens. SelectFreeTableDirectoryandthenclickBrowse.TheSelectDirectoryContainingFree Tablesdialogboxopens. IntheFolderssection,navigatetotheDatafolderinyourSageAbraHRMSdirectory.Click OK. Note: IfyouhavecreatedanyqueriesthatuseFoxProspecificfunctionsthatarenotthe sameinSQLServer,youmustchangetheselectioncriteria.

2. 3.

4. 5.

6.

9.

Installation and Setup Guide

11

Change the Data Source

Update the Scripting Agent

UpdatetheScriptingAgentforthoseprocessesthatusescripting.Forexample,ifyouareusingone ofthepredefinedalertsthatusescripting,youmustcompletethesestepsforeach.Inaddition,you mustcompletethesestepforallofyourcustomprocessesthatusescripting. Note: TheScriptingAgentcanbeusedinastepintheprocess(Process>Properties>Steps)or inasubstepforthemonitoringagent(monitoringagentdialogbox>Stepstab).Youwillneedto befamiliarwithyourcustomprocessesinordertomakesurethatallprocessesusingthe ScriptingAgentareupdated. 1. 2. 3. 4. 5. FromtheProcesseslist,doubleclickthealert. Selectthesteporsubstepthatusesscripting. ClickEdit. ClickInsertFromFile. GototheC:\TemplatesfolderandselecttheappropriateVBSfile(*.VBS)fortheprocess. ClickOpen. ClickOKtosavethescript. Repeatsteps16foreachalertthatusesscripting. Restartallprocessesthatyoupreviouslyhadrunning: a. FromtheProcessManagerpage,doubleclickthealert.

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.

Installation and Setup Guide

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.

PerformanceReviewDueThisalertnotifiessupervisorsofemployeeswhohavereviewsduein 60days.Youmaywanttoincludeattachmentsbutnoneisprovidedwiththealert.Thestepin thisprocessincludesMonitortheNextPerformanceReviewDate.Itisscheduledtorunonthe firstdayofeverymonthat5A.M. TerminationNoticeThisalertnotifiesadesignatedperson,suchassomeoneinMIS,when employeesareterminated.Theemailaddressofthedesignatedpersonmustbeaddedtothee mailinorderforthealerttoworkcorrectly.ThestepinthisprocessincludesMonitorfor EmployeeTerminations.Itisscheduledtoruneveryweekdayat5A.M.

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.

W4ChangeVerificationThisalertnotifiesanemployeewhenanyoftheirW4information changes.TheemailincludesanattachmentthatcontainstheW4information.Thestepinthis processincludesMonitorW4changes.Itisscheduledtorundaily,startingat5A.M.every weekday.

To Copy or Modify a Predefined Process

Tocopyormodifyapredefinedprocess,followthesesteps: 1. FromtheProcessManager,rightclicktheprocessandthenselectCopyProcess.TheCopy Processdialogboxopens. EnteranamefortheprocessandclickOK.ThecopiedprocessisaddedtotheProcesslist. Openthecopiedprocess.TheProcessPropertiesdialogboxopens. Enterinformationoneachtab(General,Schedule,Steps)asneeded. ClickOK.

2. 3. 4. 5.

Installation and Setup Guide

15

Create a New Process

Create a New Process

1. FromtheFilemenu,selectNewProcess.YoucanalsoclicktheNewProcessicon taskbarbelowthemenu.TheProcessPropertiesdialogboxopens. Enterinformationoneachtab(General,Schedule,Steps)asneeded. UsetheGeneraltabtonameanddescribetheprocessandtobeginexecutionoftheprocess schedule. UsetheScheduletabtosetuptheprocessschedule. UsetheStepstabtoassignagentstocarryoutyouralertprocess. ClickOK. inthe

2. 3.

4. 5. 6.

General Tab
TheGeneraltabenablesyoutoprovidegeneralinformationabouttheprocess.

Process Name Enteradescriptivenameforyournewprocess.Itisimportanttodevelopasetofconsistentrules fornamingprocesses.Asyoubecomefamiliarwiththeprogramitislikelythatyouwillcreate quiteafewprocesses.Consistentnamingenablesyoutosort,identify,andmanagetheprocesses astheyexecuteandwhenreviewingalogfile.

16

Abra Alerts

Create a New Process

Category Thisisauserdefinedfieldthathelpsyoukeeptrackofthedatabasethattheprocesswillbe monitoring.Italsohelpsinsortingprocessesandloggingdata.Uponinitialinstallation,thelist containsacategoryforeachSageAbraHRMSproduct. However,ifyouneedtoaddanothercategory,simplyenteritinthefield.Itwillthenbeaddedto thelistforfutureuse.Forexample,youmightwanttoadd: Accountingprocessescreatedfortheaccountingdepartment YearEndprocessesrunonlyattheendoftheyear

Comments Enterdescriptivecommentsasneededforyournewprocess. Enabled SelecttheEnabledcheckboxtoenablethealert.Bydefault,newprocessesareenabled.However, thepredefinedprocessesarenotenableduntilyouenablethem.

Schedule Tab
TheScheduletaboffersyouawiderangeofschedulingoptions.SelectaScheduleTypeand completetheinformationinthedialogbox.Theoptionsdisplayedwillvarybasedonwhatyouselect intheScheduleTypefield.

Installation and Setup Guide

17

Create a New Process

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

Create a New Process

ScheduleTypeandOptions The(x)(day/week...)of(Jan/Feb...) Startrunningon Donotrunafter11:59PMon Continuously StartTime Every(x)minutes Startrunningon Donotrunafter11:59PMon

Description Theprocessrunsonthespecifiedday. Thedateofthefirstprocessrun. Thelastdatetheprocessshouldrun. Thetimeofdaytheprocessshouldrun. Theintervalinwhichtheprocessshouldrun. Thedateofthefirstprocessrun. Thelastdaytheprocessshouldrun.

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.

Installation and Setup Guide

19

Create a New Process

Advanced Schedule Options ClickAdvancedontheScheduletabtoopentheAdvancedScheduleOptionsdialogbox.

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

Create a New Process

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.

Installation and Setup Guide

21

Create a New Process

To Add a Step 1. OntheStepstab,clickAddtoopentheAddStepdialogbox:

Note: Ifyouareeditingasteporsubstep,youcanchangeanyelementwiththe exceptionoftheagentthatisused.Tochangetheagent,youmustdeletethestep completelyandaddanewstep. 2. SelectanAgenttobeusedinthesteporsubstep.Althougheachagentisunique,the stepstosetuptheagentsaresimilar.

3. EntertheStepName.Thisnamewillbedisplayedinthelogfilerecord;entera descriptivenamesoyoucaneasilyidentifyeachstep. SelectaPerformStepForfromthelist.Thisdefinestheconditionsunderwhichthestep shouldberun.

4.

22

Abra Alerts

Create a New Process

ThePerformStepsForoptionsaredifferentwhenyouareaddingasubstepbecause theydependontheparentstep. Whenyouaddastep,theoptionsrelatetotheexecutionoftheprocess. Whenyouaddasubstep,theoptionsrelatetotheexecutionofthemonitor agent.

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

Installation and Setup Guide

23

Create a New Process

Option Unchangedrecords

Agent Database Monitor

Effect Iftheresultsetreturnedfromthequeryonthe monitoreddatabasecontainsnochangesin anyofthemonitoredfields,thesubstepagent istriggered. FileMonitor FileMonitor

Allfiles/Allrecords SageAbraAlertstriggers thesubstepagent whenevertheprocessis executed.Nofilesare ignored;theresultset returnedisnotignored, regardlessofitsstatus.

Database Monitor Deletedfiles

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

Create a New Process

6.

SpecifytheOnProcessError.Thisspecifieshowthesystemshouldrespondtoerror conditionsthatoccurwhilerunningthisstep.Thefollowingtabledescribesthese options.

Option Ignoreandrunthisstep anyway Dontrunthisstep Stoptheprocess Effect Thissteprunsevenifanerrorconditionisencountered. Thestepstopsexecutingifanerrorconditionisencountered. However,theremainingstepsintheprocessareexecuted. Thisstepstopsexecutingandallremainingstepsintheprocessare cancelled(forexample,arenotrun)ifanerrorconditionis encounteredinthisstep.

7.

ClickEditConditionifyouwanttoaddaconditionunderwhichthestepshouldrun.

To Manually Enter an Expression:

a. SelecttheAndorOrradiobutton. b. FromtheFielddropdownlist,selectacategory,forexampleRunTime. c. FromtheOperatorsdropdownlist,selectanoperator,forexamplelessthanor equalto. d. IntheValuefield,enteravalueforthecondition. e. ClickAdd.TheexpressionisaddedtotheCriteriaforStepfield.

Installation and Setup Guide

25

Tips for Using Sage Abra Alerts

f. ClickOK.
To Use the Edit Expression Dialog Box to Enter an Expression:

a. Ifyouwanttoselectspecificdatabasefieldsorglobalfields,clickEdit.TheEdit Expressiondialogboxopens. b. CompletetheexpressionandclickOK. c. ClickAdd.TheexpressionisaddedtotheCriteriaforStepfield. d. ClickOK. 8. 9. EnteroptionalcommentsintotheCommentsfield. ClickOK.TheSetuppagefortheselectedagentopens.

Tips for Using Sage Abra Alerts

Microsoft Jet
ToinstallSageAbraAlertsonaserverwithMDAC2.6installedasthefirstandonlyversionof MDAC,youcanfirstinstalltheOLEDBProviderforJet4.0fromtheinstallationCD (\MDAC\jet40sp3_comp.exe)andtheninstallSageAbraAlerts.

Custom Field Replacement in Word RTF documents

Wordassumesthatanythingwithan@symbolisanemailaddressandmakesitahyperlink.This causesaproblemwithcustomfieldsembeddedinthedocument.Toworkaroundthis,afterinserting thecustomfield,rightclickonitinthedocument,selectthehyperlink,andremovethehyperlink.

Creating Data Monitor Snapshots

IfyouencounterproblemswhencreatingasnapshotwhichstatesPrimaryKeysarenotunique,the recommendationsare: 1. Checkyourquery;ifyouareusingajoin,includefieldsfromalltablesinthejointomakethe recordunique. CheckyourdatabaseconfigurationandthedatausingPreview.Somefieldsmaybenull whichcancauseduplicatekeys. Somedatabaseswillreportthisifitneedstobereindexed.

2.

3.

26

Abra Alerts