You are on page 1of 210

Tidal Enterprise Scheduler

Tutorial Guide-Microsoft Windows

Tidal Enterprise Scheduler

Version 5.3

Tutorial Guide-Microsoft Windows

Copyright

Copyright20042007byTidalSoftware ,Inc.
TidalSoftware,Inc.2100GengRoad,Ste210,PaloAlto,California94303,U.S.A.
UnpublishedrightsreservedundertheCopyrightLawsoftheUnitedStates.Printedinthe
U.S.A.
Thisdocumentmaynotbestoredinaretrievalsystem,reproduced,ortransmittedinany
formorbyanymeans,eitherinwholeorinpart,withouttheexpresspriorwritten
permissionofanofficerofTidalSoftware,Inc(Tidal).Copyingincludestranslatinginto
anotherlanguageorformat.ThisdocumentcontainsproprietaryinformationofTidal.
TidalhaspreparedthisdocumentforuseonlybyTidalsemployeesandcustomersunder
Tidalscurrentcommerciallicenseandmaintenanceagreements.Theonlyundertakingsof
Tidalrespectingtheinformationinthisdocumentareascontainedinsuchcontracts,and
nothingcontainedinthisdocumentshallbeconstruedaschangingsaidcontracts.
Informationinthisdocumentissubjecttochangewithoutnoticeanddoesnotrepresenta
commitmentonthepartofTidal.Anyuseofthisinformationexceptasdefinedbyawritten
contractwithTidal,isnotauthorizedand,withrespecttoanysuchunauthorizeduse,
neitherTidalnoranyofthecontributorstothisdocumentmakesanyrepresentationor
warranty,norshallanywarrantybeimplied,astothecompleteness,accuracy,or
usefulnessoftheinformationcontainedinthisdocumentorthatsuchuseofsuch
informationmaynotinfringeprivatelyownedrights,nordotheyassumeany
responsibilityforliabilityordamageofanykindwhichmayresultfromsuchuseofsuch
information.
TidalEnterpriseSchedulerandTidalSoftwarelogoaretrademarksofTidalSoftware,
Inc.
MicrosoftWindows,NTandallvariationsoftheWindowsproductfamilyare
trademarksorregisteredtrademarksofMicrosoftCorporationintheUnitedStatesof
Americaandinseveralothercountries.
Allothertrademarksarepropertyoftheirrespectiveownersandareusedpurelyfor
informationalpurposes.
February 2007

CONTENTS

Preface
AboutthisGuide.......................................................8
Conventions....................................................8
AlertStatements................................................8
TidalProductDocumentation............................................9
DocumentationFormats .........................................9
GuidesandReleaseNotes ........................................9
OnlineHelp ....................................................9
TechnicalSupport .....................................................10
1

Scheduler Concepts
Overview .............................................................12
SystemConfigurations .................................................13
Masters .......................................................13
Clients........................................................14
Agents .......................................................14
JobDefinition.........................................................15
JobHierarchy.........................................................16
Dependencies .................................................16
Calendars .....................................................18
JobInstances ..................................................18
ProductionSchedule ...........................................18
Dashboard....................................................19
MasterStatusDisplay ..........................................19
1

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

EventsandActions.............................................19
Queues.......................................................21
QueueFilters...........................................22
AgentLists....................................................22
SecurityPolicies ...............................................22
LogsandReports ..............................................23
2

Offset Concepts in Production Scheduling


Overview .............................................................26
DefiningaProductionDaywithPositiveOffset(LateStart) .................27
DefiningaProductionDaywithNegativeOffset(EarlyStart) ...............28
SchedulingBasedonAgentTimeZone...................................29
UsingaPositiveProductionDayOffset(AgentRunningAheadoftheMaster).31
UsingaPositiveProductionDayOffset(AgentRunningBehindtheMaster)...32
UsingaNegativeProductionDayOffset(AgentRunningAheadoftheMaster) 33
UsingaNegativeProductionDayOffset(AgentRunningBehindtheMaster)..34
DefiningaCompileOffset ..............................................35

Creating Your First Job


Overview .............................................................38
StartingtheClient..............................................38
SettingDefaultJobParameters...................................40
CreatingtheReportJobDefinition ...............................41
AddingYourJobtotheProductionSchedule ..............................44
MonitoringYourJob...................................................45
JobActivityPane ..............................................46
BarChartPane ................................................48
BarChartColorPreferences ..............................48
JobOutputOptions....................................................51
SpecifyingtheDispositionofJobOutput ..........................51

Contents

ViewingJobOutput ............................................51
4

Using Scheduler Calendars


Overview .............................................................54
BuildingtheFirstWorkdayCalendar.....................................55
BuildingtheWorkDayCalendar ........................................58
BuildingtheFiscalWeekEndCalendar ...................................60
AlternateMethodofCreatingaCalendar.................................64
BuildingtheQuarterEndCalendars .....................................65
FiscalQuarterEnd .............................................65
CalendarQuarterEnd..........................................67
SchedulingtheReportJobwithaCalendar................................68

Setting Up a Job Dependency


Overview .............................................................72
DefiningaJobforOperatorRelease......................................73
SettingtheRequireOperatorReleaseOption ......................73
AddingaJobwithaDependency ................................77
MonitoringYourJobs ..................................................79
ViewingDependenciesfromtheJobActivityPane .................80
ReleasingtheJobs .....................................................81

Scheduling Jobs in Groups


Overview .............................................................84
JobGroupHierarchy ...................................................85
JobGroupScheduling ..................................................85
AddingaJobGroup ...................................................86
CreatingJobsthatBelongtoaJobGroup..................................87
CreatingtheAp31ChildJob .....................................87
CreatingtheAp32ChildJobwithaDependency...................90

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

SchedulingtheJobGroup...............................................94
SchedulingaJobthatDependsonaGroup ................................95
AddingaJobGroupDependency ........................................97
ReleasingaJobGroup ..................................................99
7

Creating a File Dependency


Overview ............................................................102
CreatingaJobwithaFileDependency ..................................103
ViewingtheJobinProduction ..................................106
CreatingaFiletoSatisfytheDependency ........................108
MonitoringtheJobinProduction ...............................108

Detecting Job Event Conditions


Overview ............................................................110
UnderstandingActions ................................................110
CreatinganAlertAction .......................................111
AssociatingtheActiontotheJob ................................113
Changingtheedi.batfiletoFail .................................116
ChangingtheStatusoftheAlert ................................119

Creating Variable Dependencies


Overview ............................................................122
CreatingaVariable ...................................................124
CreatingtheVariableUpdateAction....................................126
CreatingaJobEventfortheGatherReportJob............................128
CreatingtheGatherOrdersJobGroup...................................129
CreatingaRepeatingJobandAssociatingaJobEvent .....................130
CreatingaJobDependentontheGatherOrdersVariable ..................135
SchedulingandMonitoringtheGatherOrdersJobs .......................137

Contents

10

Managing Jobs in the Production Schedule


Overview ............................................................142
CreatingtheParentJobGroup..........................................143
CreatingThreeChildJobs..............................................144
ViewingtheJobsintheJobActivityPane ........................148
JobSorting ...................................................148
RemovingaJobfromtheProductionSchedule ....................149
InsertingaJobIntotheProductionSchedule......................150
CancellingaJobintheProductionSchedule......................152
PlacingaJobonHold..........................................153
RemovingtheJobOutofHeldStatus ............................154
OverridingaDependency ......................................155
EstimatedandExcessiveDurations .....................................156

11

Managing Command Parameters


Overview ............................................................158
PassingCommandParameters .........................................159
SpecifyingCommandParametersandViewingtheBatchFile .......159
TrackingMethods ....................................................162
UsingtheExitCode...........................................163
CreatingtheReportingJobGroup ...............................164
SettingtheReportWriter1JobtoSucceed ........................165
SettingtheReportWriter2JobtoFail............................166
AddingtheReportingJobGrouptotheProductionSchedule.......167
SettingReportWriter2toCompleteNormally ....................168

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

12

Setting Up Queues
Overview ............................................................172
SettingUptheInventoryWeeklyJobGroup..............................174
CreatingJobsfortheInventoryWeeklyJobGroup ................175
DuplicatingaJobDefinition ....................................177
SettingUpaQueue...................................................178
AddingtheInventoryWeeklyJobGrouptoProduction ............182
MonitoringtheJobGroupinProduction.........................182
ChangingtheQueueLimit.....................................184
ResubmittingtheInventoryWeeklyJobGroup ...................185

13

Reviewing the Dashboard


Overview ............................................................188
CustomizingtheDisplay ..............................................188
ViewingtheDashboard ........................................189
EditingtheDashboardView....................................190
AddingaNewPanetotheDashboard...........................191
EditingaDashboardPane......................................193

14

Using Scheduler Agents


Overview ............................................................196
DefiningAnAgentConnection .........................................197
AddingaJobthatRequiresOperatorRelease .............................199
AddinganAgentJobDependency ......................................200
ReleasingtheAgentJobs...............................................203
Summary ............................................................203

PREFACE

TOPICS

COVERED IN THIS PREFACE


About this Guide (page 8)
Tidal Product Documentation (page 9)
Technical Support (page 10)

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

About this Guide


Conventions
Thefollowingconventionsareobservedthroughoutthisdocument:

Boldsansseriftextisusedtodesignatefileandfoldernames,dialog

titles,namesofbuttons,icons,andmenus,andtermsthatareobjectsof
auserselection.

Italictextisusedtoindicatedefinedterms,userspecifiedtext,
documenttitles,andwordemphasis.

Monospacetext(Courier)isusedtoshowliteraltextasyouwould
enterit,orasitwouldappearonscreen.

Alert Statements
ThealertstatementsNote,Caution,andWarningareformattedinthe
followingstyles:
Note

Information that is incidental to the main text flow, or to an important


point or tip provided in addition to the previous statement or
instruction.

Caution

Advises of machine or data error that could occur should the user
fail to take or avoid a specified action.

Warning

Requires immediate action by the user to prevent actual loss of


data or where an action is irreversible, or when physical damage
to the machine or device is possible.

Preface
Tidal Product Documentation

Tidal Product Documentation


Documentation Formats
Documentationisprovidedinthefollowingelectronicformats:

AdobeAcrobatPDFfiles

Onlinehelp

YoumusthaveAdobeReaderinstalledtoreadthePDFfiles.Adobe
Readerinstallationprogramsforcommonoperatingsystemsareavailable
forfreedownloadfromtheAdobeWebsiteatwww.adobe.com.

Guides and Release Notes


YoucandownloadtheInstallationGuide,UserGuideandReleaseNotesin
PDFformatfromtheproductinstallationCD.

Online Help
YoucanaccessonlinehelpbyclickingtheHelpbuttonfromwithinthe
application,orclickingStart>Programs>Tidal
Software>Scheduler>Client>Client Help.

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Technical Support
Tidaliscommittedtoprovidingsuperiorserviceandsupporttoour
customers.Wetakepersonalprideinlivinguptothiscommitmentandto
developinghighquality,highvalueproductsthatimprovedatacenter
operations.
Telephoneassistanceisavailabletocustomerswithcurrentmaintenance
contractsduringstandardofficehoursof7:00a.m.to7:00p.m.CST,
MondayFriday.
FormoreinformationoncontactingTidalSoftware,refertotheinformation
belowortotheTidalSoftwarewebsite:www.tidalsoftware.com

10

Department

Contact Info

Support

6504754600
support@tidalsoftware.com
tidaltraining@tidalsoftware.com

ProfessionalServices

6504754600
consulting@tidalsoftware.com

Sales

87755TIDAL(8775584325)
sales@tidalsoftware.com

Headquarters

TidalSoftware,Inc.
2100GengRoad,Suite210
PaloAlto,CA94303
Main:6504754600
Fax:6504754700

1
SCHEDULER CONCEPTS

TOPICS

COVERED IN THIS CHAPTER


Overview (page 12)
System Configurations (page 13)
Job Definition (page 15)
Job Hierarchy (page 16)

11

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
WelcometoScheduler!Thistutorialwillintroduceandguideyouthrough
thefeaturesandfunctionsoftheworldspremiernetworkscheduling
solution,Scheduler.
Eachchapterinthisguidebuildsuponthefoundationofpreviouslessons.If
thisisyourfirsttimeworkingwithproductionschedulingsoftware,oryour
firsttimeusingScheduler,youshouldworkthrougheachchapter
consecutively.Moreexperiencedusersmightwanttomovedirectlytothe
lessoninwhichtheyareinterested;however,manyexercisesutilizethe
resultsofpreviousexercises.
Asyouprogressthroughthetutorial,moreadvancedanddetailedtopics
arecovered.Bytheendofthismanual,youwillbefamiliarwithmostofthe
majorfeaturesofScheduler,andyouwillhavetheknowledgetocreateand
maintainyourownproductionschedules.

12

Chapter 1 Scheduler Concepts


System Configurations

System Configurations
Schedulerusesaclientservermodeltoscheduleandmanagejobson
severaldifferentsystemsevendifferentoperatingsystemsthrougha
singleoperatorstation.Thissinglepointofcontrolmeansthatyouhave
onlyoneclientinterfacerunningonyourPCtomanagejobsacrossmultiple
systems.Mastersarethecentralpointforschedulingjobsonassociated
agents.Schedulerjobscanonlyrunonlicensedagents.

Figure 1

Multiple Client-Master-Agent Connections

Masters
ThemasteristheWindowsorUNIXsystemonwhichyouinstallthe
brainsofyourSchedulernetwork.Youinteractwiththemasterusingthe
Schedulerclient,whichpassesrequeststothemaster.Themasterperforms
therequestedserviceonalocalorremoteagent,andthenreturnsupdated
informationtotheclientthatdisplaystheresults.

13

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Themasterlaunchesjobsonmachineslicensedasagents.Anagentis
softwareonanothermachineinthesamenetworkasthemaster,andruns
jobsonbehalfofthemaster.Theclientdoesnotconnectdirectlytothe
agent,butschedulesandmanagesitsjobsthroughthemaster.

Clients
Theclientsoftwareusesagraphicaluserinterface(GUI)toperformthe
schedulingfromyourlocalPCrunningWindowsNTorWindows2000.You
caneasilymonitorandcontrolschedulesacrossyournetworkwithout
leavingtheclientinterface.Clientsaccessonlymasters.Multipleclientscan
communicatewiththesamemaster.
Forexample,individualsindifferentdepartmentscanscheduleand
managetheirownjobs,independentofeachanother,whiletheoperator
monitorsalljobactivitiesandonlyintervenesifresourceconflictsarise.

Agents
TheagentisanymachinethatrunsjobsonbehalfofaSchedulermaster.The
masterandtheagentcommunicatewitheachothertoexecutejobsremotely.
MultipleScheduleragentsprovidegreaterproductionreliabilityshouldthe
masterbecomeunavailableforsomereason.
Jobcommandsthatrunontheagentshouldbeaccessibletotheagent
machineonyournetwork.Theyarescheduledonthemaster,andinitiated
ontheagentbythemasterwhenscheduledependenciesaresatisfied.
Agentsoperateindependentlyfromthemaster.Thisallowscontinued
processingofanyworkthatisalreadysentbythemasterifeitherthemaster
scheduleorthecommonsharednetworkbecomesunavailable.Theagent
relaystheresultsofthejobitcontinuedprocessingwheneitherthenetwork
connectionorthemasterisavailableagain.

14

Chapter 1 Scheduler Concepts


Job Definition

Job Definition
Thejobdefinitioniscentraltojobscheduling.Itisasetofjobrulesthat
defines:

Whichcommandtorun

Wherethecommandruns

Whentorunthejob

Howtohandledependencies

Whethertoissueactionsbasedonpredefinedjob events

Thejobpriorityrelativetootherjobs

Whenyouwanttoscheduleacommandtobeexecuted,youuseajob.Once
ajobisdefined,youcankeepthedefinitionandrunthejobrepetitively
accordingtoitsspecifiedcalendar,orasneeded.
Eachjobisassignedtoonlyonecommand.Thecommandcanbean
executable,abatchfile(Windowsonly),ashellscript,acommandfileor
anyotherexecutableprocess.Youcanspecifyparameterstobepassedtothe
command.Thisenablesyoutouseonecommandindifferentways,based
upontheparametersthatyoupasstoit.
Forexample,ajobcanbackupfilestotape,runaprogramtopost
transactionstoadatabaseorrunasetofreports.InScheduler,yougiveeach
jobaname,and,ifthejobisrepetitive,acalendarbywhichitruns.Youcan
alsodefinedependenciesthatmustbemetbeforethecommandisexecuted.
Usingthecalendar,Schedulerautomaticallylaunchesjobseachtimethey
arescheduledtorun,butonlyafteralloftheirdependencieshavebeenmet.

15

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Job Hierarchy
Jobsarebuiltonahierarchyofjobandjobgroupownership.Ajob groupis
acontainerforasetofjobs,usuallypartofacommonapplicationor
department.Thejobgrouphasitsownnameandsetofruntime
instructions.
Youcanusejobgroupstosubmitjobsthateitherdependoneachother,or
shouldruntogether.Forexample,allthejobsinpayrollcanbelongtoa
groupcalledPayroll.Thejobgroupcanprovidedefaultsettingstoallthe
childjobsthatbelongtoit.JobsandjobgroupsaredisplayedintheJobs
pane.Jobgroupscansaveyouthetimeittakestosetupjobdefinitions
becauseeachjobinthejobgroupcaninheritthecharacteristicsofthatjob
group.Whenyouwanttocreateseveraljobswithsimilarscheduling
characteristics,youcandefinethosejobswithinajobgroupandsetthe
schedulingcharacteristicsinthejobgroupdefinition.Itisalsopossibleto
changeschedulingcharacteristicsatthejobleveleventhoughthejob
belongstoagroup.
Forexample,ifajobgroupisdefinedtoruneveryFriday,theneveryjobin
thatjobgroupisautomaticallydefinedtorunonFriday.Ifonejobinthejob
groupmustrunonSaturday,thenthatonejobcanbechangedtotheproper
rundaywithoutaffectingtheotherjobsaslongasyoudisinheritthejob
groupcalendarandchangethecalendarfromwithinthatjob.
Theultimateownershipofajoborjobgroupbelongstoeithertheuserora
workgroup.Aworkgroupisacollectionofuserswhocanshareaccessto
thesamejobs.WorkgroupsaredisplayedintheWorkgroupspane.

Dependencies
Dependenciesareprerequisiteconditionsthatmustbemetbeforeajobcan

run.
Date and Time Dependencies

ThemostcommondependencyisthedateandtimewhenScheduler
executesajob.
Forexample,youcanscheduleajobtoruneveryTuesdayafter6:00pm,
exceptonholidayswhenitisnottorun.Datedependenciesarebuiltusing
calendars.Timedependenciesarespecifiedwithinajobsdefinition.

16

Chapter 1 Scheduler Concepts


Job Hierarchy

Job Dependencies

Jobscanalsodependonotherjobsreachingaparticularstatus.
Forexample,youcanrunJob51afterJob101andJob207havereachedthe
statusofCompleted Normally.Duringthejobslifecycle,Scheduler
recognizesthecurrentstatusofajob,suchas:
Table 1

Job Status

Status

Description

Waiting on Dependencies ThejobiswaitingonDate,Time,Job,and/orFile

dependencies.
Waiting on Resources

Thejobiswaitingforanexecutionslot.All
Dependencieshavebeenmet.

Waiting on Operator

Allthejobsdependenciesaremetandthejobis
waitingfortheoperatortoreleaseit.

Active

ThejobisactivelyrunningintheProduction
Schedule.

Completed Normally

Thejobcompletednormally.

Completed Abnormally

Thejobcompletedabnormally.

Error Occurred

Aninternalerroroccurredwhichpreventedthe
jobfromrunning.

File Dependencies

Ajobcanalsodependonthestatusofafile.Thestate,size,creationor
modificationdateofthefilecanallbetakenintoconsideration.
Forexample,youcanrunJob101iftheWindowsfile
C:\payroll\data\trandata:

Hasbeenmodifiedinthelasttwelvehours

Hasafilesizegreaterthan1024KB

Variable Dependencies

Ajobcanalsodependonthevalueofauserdefinedvariable.Schedulerhas
arepositoryofuserdefinedvariablesthatcanbeupdatedorincremented
eithermanuallyorthroughanactionassociatedwithajobeventorsystem
event.

17

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Forexample,youcansetajobtorunwhen:

VariablePrinter OnlineissettoYes.ThePrinter Onlinevariable


couldbesetbyajobthatchangesprintersettingsandthenissuesan
actionchangingthevariablefromNotoYes.

VariablePayroll Jobs isincrementedto15byanotherjobthat


incrementsthevariableeachtimeitruns.

Calendars
Calendarsareusedtodeterminewhentorunthejobs.Calendarsletyou

schedulejobstorunonaperiodicyetintelligentbasis.
Forexample,LaborDayintheUnitedStatesiscelebratedonthefirst
MondayinSeptemberwhichfallsonadifferentdateeachyear.Bydefining
LaborDayasthefirstMondayinSeptember,youavoidtheneedto
manuallyredefineiteveryyear.
Youcanalsodefinecalendargroupsthatcombineindividualcalendars.
Forexample,the1st Half HolidayscalendargroupcanincludetheNew
Years Day,Presidents Day,andMemorial Daycalendars.

Job Instances
Ajobinstanceisaspecific,scheduledrunofajobdefinition(job)by
Scheduler.Onejobcancreatemanyinstances.
Forexample,ifajobisdefinedtoruneveryMonday,Wednesdayand
Friday,thenSchedulercreatesoneinstanceforMonday,oneforWednesday,
oneforFriday,oneforthenextinstanceofMondayandsoon.
Jobscanentertheproductionscheduleonascheduledorunscheduled
basis.Forexample,youmayhavesomejobsyouexpecttorunattheendof
eachmonth,andotherjobsthatyourunonlyondemand.

Production Schedule
Theproduction scheduleisthetimelineSchedulerusestomanage
instances.Youcontrolthespanoftimecoveredbytheproductionschedule,
typicallybetweenafewdaysandseveralweeks.Jobinstancesaredisplayed
intheJob Activitypane.

18

Pastjobinstancesremainavailableforauserdefinedperiodoftime.

Chapter 1 Scheduler Concepts


Job Hierarchy

Presentjobinstancesandtheirstatuses(i.e.Waiting,Active,
Completed Normally,etc.)aredisplayedintheJob Activitypane
defaultview.

Futurejobinstancesdefinedintheproductionspanappearonthe
futuredatesintheJob Activitypane.

Astimeprogresses,theproductionscheduleisrecorded,andautomatically
updatesjobinstancesforthedefinednumberofdaysforthepast,current
andfutureruns.Theconceptsoftimeoffsetsandbasingtheproduction
scheduletimesonagenttimezonesareexploredinChapter2:Understanding
OffsetConceptsinProductionScheduling.

Dashboard
Thedashboardisacustomizablegraphicalrepresentationofthe
productionschedule.Fromthedashboard,youcaninstantlyseejobsand
theirstatusesrepresentedbyapiechart.Youcanalsoseejobprogress,
systemutilizationandalertstatususingvariousmeters,linecharts,bar
graphsandtables.
Thedashboardisidealformanagerstogetaquickviewoftheoverall
productionschedule.Itisalsousefultomonitorsystemresourceutilization,
suchasdeterminingwhetheraparticularmachineorsetofmachinesis
overorunderutilizedforschedulingpurposes.

Master Status Display


Doubleclickingthemasterstatuslightatthebottomoftheconsolebrings
upthemasterstatusdisplay.Inthisarea,continuallyupdatedstatistics
relatedtoSchedulercomponentsdisplay,suchasconnectionsandthe
mastersstatus.

Events and Actions


Schedulermonitorsjobsthroughouttheirlifecycleforpredefinedevents
suchaswhenthejoblaunches,whenitcompletes,ifitfailsandmany
others.Youconfigureanexceptionconditioncalledaneventto
automaticallyrespondwhentheeventisdetectedbytriggeringanaction.
Whenyouconfigureaevent,youspecify:

Systemconditionsthatwilltriggertheevent

19

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Oneormoreactionstotakeinresponse

Jobstowhichtheeventapplies(forjobevents)

Ascheduleoftimeintervalswhentheeventisactive(file,emailand
variableevents)

Eventscanbeinternallygeneratedbyconditionswithinthesystem(joband
systemevents)ortheycanbegeneratedbyconditionsthatareoutsidethe
system(file,emailandvariableevents).Todetectexternalconditions,you
mustcreateaneventmonitortowatchforthosedefinedconditions.
Job eventscombineeventtriggerswithactionssuchasstoppingor

restartingajobwhileinproduction.
Commonevent triggersincludeabnormaltermination,excessiveruntime
andfailuretocompletebyaspecifictime.Youcantakethefollowingtypes
ofactions:

Sendemailmessages

ControlajobinstanceintheJobActivityConsole

Alertanoperatortoajobcondition

SendSNMPmessages

Launchanunscheduledjob(newjobaction)

Issuealogmessage

Updateauserdefinedvariable

Forexample,youcandefineajobeventthatistriggeredeverytimeajobis
cancelledbyanoperator.Whenajobcancellationoccurs,youcanhavean
emailsenttoyouandamessagesenttoyourSNMPmanagementsoftware
notingthisevent.
Asystem eventoperatesidenticallytoajob event,exceptthatthemaster
originatestheeventratherthanajob.Systemeventsdefineglobal
conditionsversusajobeventdefiningconditionsthataffectjobs.For
example,ifanagentshutsdown,asystem eventcanbetriggeredtonotify
usersoftheproblem.
Anemail eventisthedetectionofaspecifiedtextstringinanemailthat
arrivesatadesignatedemailaccountonandesignatedExchangeserver.An
emailmonitoriscreatedtowatchforthespecifiedemail.
Afile eventisthedetectionofafileonanagentreachingaspecifiedstate.
Afilemonitoriscreatedtowatchforafilethematchesthespecified
conditions.

20

Chapter 1 Scheduler Concepts


Job Hierarchy

Avariable eventisthedetectionofavariablereachingaspecifiedvalue,
whetherthevariableisonalocalorremotemaster.Avariablemonitoris
createdtowatchforthevariabletoreachthedesiredvalue.

Queues
Queuesletyouoptimizethroughputandallocatesystemresourcesfor

scheduledandunscheduledjobs.TheSchedulerqueuemanagerassigns
jobstoqueueswhenalltheirdependencieshavebeenmet,anddecides
whentolaunchjobsbasedupontheavailablesystemresourceslots.The
maximumnumberofslotsavailableisdeterminedeitherbythelimitthat
yousetinthesystemqueue,thesumofeachqueueslimitorthesumof
eachlicensedagentsjoblimit.
Queuescanlimitthenumberofjobsrunningonacomputeroranetworkof
computersatagiventime.

Ifthesystemisnotrunningatitscapacity,ajobcanrunimmediately
providedthatallofitsdependenciesaremet.

Ifthesystemisrunningatitscapacity,theSchedulerQueueManager
decideswhichjobslaunchbasedonaprioritystructurethatincludes
thefollowinginorderofimportance:
Table 2

Queue Priorities

Status

Description

Queueprioritylevels

Jobsinactiveandopenqueuesathigherpriority
levelsrunfirst.

Queuelimits

Onlyjobsinqueuesnotrunningattheirallowable
limitcanbelaunched.

Agentjoblimits

Onlyjobsassignedtoagentsnotrunningattheir
allowablelimitcanbelaunched.

Jobprioritylevels

Jobswiththehighestpriority(assignedinthejob
definition)inthequeuearerunfirst.

Queuesaredisplayedinahierarchy.Eachiteminthehierarchyisa
queueandcancontainjobs.Youdefinethequeuelimittosetthe
numberofjobsthatcanlaunchfromanyindividualqueue.Youalso
defineapriorityforeachqueue.

21

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Queue Filters

Jobsaredirectedtoaqueuebasedonthequeuefiltersthatyoudefine.These
filtersdescribethejobpropertiesthatmustexistforthequeuemanagerto
assignajobtoaparticularqueue.Someexamplesofthequeuefiltersthat
directjobstoqueuesare:

Jobclass

Jobname

Jobowner

Jobestimatedruntime

Agent Lists
Schedulerextendsitscapabilityforautomaticjobmanagementthrough
agent lists.Anagentlistdescribesasetofnodesonyournetworkavailable
torunjobs.Agentlistsdesignatenodesasprimaryoralternatenodesforjob
submission,andallowjobstobebroadcastacrossallavailablenodes.
Workloadbalancingalgorithmscandistributejobsevenlyamongall
availablenodes.

Security Policies
SecuritypoliciesrestrictaccesstocertainSchedulerfunctions.Thedefined
accessrightscanbesavedasasecuritypolicy,andthenassignedtooneuser
ormultipleusers.
Forexample,theremightbedifferentsetsofuserswho:

AdministerScheduler

Createandschedulejobsforthemselvesandothers

Operatethejobschedule

Usingsecuritypolicies,theusersthatcreateandschedulejobscanbe
restrictedfrommodifyingtheschedules.Likewise,theoperatorscanbe
restrictedfromcreatingjobs.
Schedulerincludesdefaultsecuritypolicytemplatesthatcanbemodifiedto
createyourownsecuritypolicies.Eachuserwithinthesuppliedworking
modelhasadefinedsetofSchedulerfunctions.Whenallthedefault
securitypoliciesareinuse,allaspectsofschedulingarecoveredand
available.

22

Chapter 1 Scheduler Concepts


Job Hierarchy

Thefollowingtableliststhesystemfeaturesavailableforeachofthedefault
securitytemplate:
Table 3

Scheduler Security Policies

Default Security Policy

Available System Features

Scheduler_Admin

Thedefaultfornewinstallations.Thisincludesall
availablefunctions.

Administrator

Configuresusers.

User

Creates,edits,andsubmitsjobs.Createsworkgroups
anduserdefinedvariables.

Scheduler

Editsandtestsjobschedules.

Operator

Runsandcontrolsjobs.Respondstoalertsthatjobs
mayissue.

Inquiry

Viewsjobsandresources.Cannotperform
modification.

Logs and Reports


Schedulerincludesaloggingmechanismthatkeepstrackofalluseredits,
jobstatusinformation,anderrormessages.IntheLogspane,youcanview,
filterandsearchallmessagesforaspecifictimeframe.
Forexample,ifyouwanttoseewhomodifiedJob A recently,youcangoto
theLogspane,searchonJob Aandviewallinstanceswhenthejobwas
edited.
Scheduleralsosupportsnumerousreports,suchas:

Datadisplayedineverywindow

Operatoralertsandresponses

Jobstatuses

Eventhistory

Dependencycrossreferences

Productionschedulesummary

23

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

24

2
OFFSET CONCEPTS IN
PRODUCTION SCHEDULING

TOPICS

COVERED IN THIS CHAPTER


Overview (page 26)
Defining a Production Day with Positive Offset (Late Start)
(page 27)
Defining a Production Day with Negative Offset (Early Start)
(page 28)
Scheduling Based on Agent Time Zone (page 29)
Using a Positive Production Day Offset (Agent Running Ahead of
the Master) (page 31)
Using a Positive Production Day Offset (Agent Running Behind
the Master) (page 32)
Using a Negative Production Day Offset (Agent Running Ahead
of the Master) (page 33)
Using a Negative Production Day Offset (Agent Running Behind
the Master) (page 34)
Defining a Compile Offset (page 35)

25

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
Schedulerv.5.3followscertainconceptswhenitcompilesaproduction
schedule.Theconceptsarebasicbutcanresultincomplicatedtiming
scenarioswithdateshiftsthatcauseconfusionamonguserswhenputinto
practice.Themostcomplextimingissuesarisefromtheshiftingofthestart
oftheproductiondaythroughaseriesoftimeoffsetsasscheduledjobsrun.
Schedulercompilesaproductionschedulefromyourjobrulesforeachmaster.
Thisproductionschedulecoversatleastthecurrentdaybutmayextendto
multipledays.Youdeterminethedurationofeachschedulebyspecifying
thenumberofdaystoinclude.Eachmasterinyournetworkhasitsown
productionschedule,soscheduledurationscanvary.Theactiveproduction
scheduleforamasterincludeshistorydata(fordatespast),thecurrentdate
andanyremainingdaysintheschedule(future).
Total Production Schedule
Mon
May 22

Tue
May 23
History

Figure 2

Wed
May 24

Fri
May 26

Thu
May 25

Current
date

Future
dates

Example of a Normal Schedule Length

Theproductiondaycontainsallofthejobrulesthatarescheduledtorun
duringtheproductionday.Aproductiondayalwayscontains24hoursand
bydefaultstartsatmidnightandendsat23:59:59PM.(Forsimplicityssake,
wewillusethe24hourtimeformatinthisdiscussionso11:59PMis2359.)
Toaccommodatealloftheprocessingneedsofabusiness,aproductionday
oftendiffersfromthecalendarday.Youcandesignatethattheproduction
daystartatanytime.Forinstance,youmightspecifythattheproduction
daystartsat0500insteadofstartingatmidnighttoallowforthecompletion
ofthepreviousdaysjobs.Thisiscalledaproductiondayoffset.
Iftheoffsetispositive,thefiscaldaybeginsatsometimeaftermidnightand
continuesintothenextcalendarday.Iftheoffsetisnegative,thefiscalday
beginsatsometimebeforemidnight.Themaximumoffsetthatyoucan
defineis23hoursand55minutes.Schedulerusesthedesignatedstartofthe

26

Chapter 2 Offset Concepts in Production Scheduling


Defining a Production Day with Positive Offset (Late Start)

productiondaytodeterminewhentheproductiondaystarts,andtoselect
andlaunchjobsaccordingly.

Defining a Production Day with Positive Offset


(Late Start)
Ifyouwantyourproductiondaytobeginat1200noonandcontinueuntil
1200noonthefollowingday,youdefinethestartoftheproductiondayas
1200(+1200).Whenoffsettingthestarttime,itisimportanttorememberthat
notimeislost,thehoursbetweenthestartofthecalendardayandthestart
oftheproductiondayaremerelyshiftedfromthebeginningofthe
productiondaytoitsend.Therearestill24hoursintheday.
Thefollowingfigurecomparesthecalendardaytoaproductiondaywith
anoffsetof+1200.Usingthisproductionoffset,ajobscheduledtolaunchat
0800(8:00A.M.)onJune10th(productiondate)willnotactuallylaunchuntil
0800onJune11th(calendardate).

Figure 3

Production Offset Defined As +1200 (Master and Agent in


Same Time Zone)

27

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Defining a Production Day with Negative Offset


(Early Start)
Ifyouwantyourproductiondaytobeginat2045(8:45P.M.),andcontinue
until2045thefollowingday,definetheproductiondayoffsetas0315.
Thefollowingfigureillustratesthecalendarandproductiondayswithan
offsetof0315.Usingthisproductiondayoffset,ajobscheduledtolaunchat
2115onJune12th(productiondate)launchesat2115onJune11th(calendar
date)

Figure 4

28

Production Offset Defined As -0315 (Master and Agent in


Same Time Zone)

Chapter 2 Offset Concepts in Production Scheduling


Scheduling Based on Agent Time Zone

Scheduling Based on Agent Time Zone


Whilejobsnormallyrunfromthemasterstimereference,youcanlaunch
jobsaccordingtowhattimeitisintheagentstimezone.SelectingtheUse
Agent Time ZoneoptionontheMastertaboftheSystem Configuration
dialogwilllaunchjobsaccordingtothetimewheretheagentresides.While
thejobswilllaunchattheintendedtimesintheagentstimezone,the
mastersviewpointwillbecompiledinforthejobtimewindowsandstart
time.Sincethemasterwillcompensatefortheoffset,usersshouldnotthink
aboutthedifferencebetweenthedifferentmasterandagenttimezones
whendefiningjobsrules.Inanutshell,usingthemastertimezoneimposes
anabsolutetimereferencewhileusingtheindividualagenttimezones
imposesarelativetimereference.
Thefollowingexampleillustratesthedifferencestobeaccountedforwhen
themasterandtheagentresideindifferenttimezones.Themasterinthis
exampleisthreetimezonesaheadoftheagent.Ajobdefinedtorunat2300
ontheproductiondayofAugust10thwillactuallybelaunchedbythe
masterat0200ontheproductiondayofAugust11thtoaccountforthe
differenceintimezones.

Figure 5

Agent Residing Three Time Zones Behind the Master (No


Production Date Offset)

Hereisanotherexampleofthemasterandagentindifferenttimezones
withoutaproductionoffset.Thisexampleshowsamasterthatisseven
hoursbehindtheagent.Ajobdefinedtorunat0500ontheproductionday

29

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

ofAugust11thisactuallylaunchedbythemasterat2200ontheproduction
dayofAugust10thtoaccountforthedifferenceintimezones.

Figure 6

30

Agent Residing Seven Time Zones Ahead of Master (No


Production Date Offset)

Chapter 2 Offset Concepts in Production Scheduling


Using a Positive Production Day Offset (Agent Running Ahead of the Master)

Using a Positive Production Day Offset (Agent


Running Ahead of the Master)
Settingapositiveproductiondayoffsetmovesthestartoftheproduction
dayforward.Intheexamplebelow,thedifferencebetweentimezonesis
showninasolidlineandtheproductiondayoffsetisshowninadotted
line.

Figure 7

Positive Production Day Offset With the Agent Running Ahead


of the Master

Thisexampleshowsanagentthatisfivehoursaheadofthemaster.A
productiondayoffsetofpositivethree(+3)shiftsthestartoftheproduction
day(0000)threehoursaheadincalendartimeforbothmasterandagent.A
jobdefinedtorunat0500ontheproductiondayofAugust11thlaunchesat
0000onAugust10thonthemastersproductionday.

31

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Using a Positive Production Day Offset (Agent


Running Behind the Master)
Settingapositiveproductiondayoffsetmovesthestartoftheproduction
dayforward.Intheexamplebelow,thedifferencebetweentimezonesis
shownwithasolidarrowandtheproductiondayoffsetisshownwitha
dottedarrow.Thisexamplehasapositiveproductiondayoffsetoftwo
hoursaheadwiththeagentrunningeighthoursbehindthemaster.Thusa
jobdefinedtorunat2200ontheproductiondayofAugust10thislaunched
at0600onAugust11thduetothedifferenceintimezones.

Figure 8

32

Positive Production Day Offset With the Agent Running


Behind the Master

Chapter 2 Offset Concepts in Production Scheduling


Using a Negative Production Day Offset (Agent Running Ahead of the Master)

Using a Negative Production Day Offset (Agent


Running Ahead of the Master)
Settinganegativeproductiondayoffsetmovesthestartoftheproduction
daybackfrommidnight.Intheexamplebelow,thedifferencebetweentime
zonesisshownwithasolidarrowandtheproductiondayoffsetisshownin
adottedarrow.Theexampleshownbelowhasanegative4offsetsothe
startoftheproductiondayismovedbackfourhoursbehindthestartofthe
calendarday.Ajobdefinedtorunat2200ontheproductiondayofAugust
11thislaunchedat1600onAugust10thonthemasterduetothetime
difference.

Figure 9

Negative Production Day Offset With an Agent Running


Ahead of the Master

33

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Using a Negative Production Day Offset (Agent


Running Behind the Master)
Settinganegativeproductiondayoffsetmovesthestartoftheproduction
daybackfrommidnight.Inthefollowingexample,thereisanegativefour
hourproductionoffsetmovingthestartoftheproductiondayfourhours
behindthestartofthecalendarday.Intheexamplebelow,thedifference
betweentimezonesisshownwithasolidarrowandtheproductionday
offsetisshownwithadottedarrow.

Figure 10

Negative Production Day Offset With the Agent Running


Behind the Master

Thisconfigurationhasanagentthatisrunningfivehoursbehindthe
master.Ajobdefinedtorunat2300ontheproductiondayofAugust10this
launchedbythemasterat0300onAugust11th.

34

Chapter 2 Offset Concepts in Production Scheduling


Defining a Compile Offset

Defining a Compile Offset


CompilingtheproductionschedulemayconsumeenoughCPUresourcesto
seriouslyaffectyoursystemsperformanceandhinderotherworkthatmay
begoingonconcurrently.Itmaybebettertoschedulesucharesource
intensiveoperationlikecompilingyourschedule,atamoreconvenienttime
whenyoursystemhasalighterworkload.Oncethescheduleiscompiled,it
issaveduntilneededwhenthenewproductiondaystarts.Youcan
manuallycompileanewscheduleatanytimebyselectingtheCreate
ScheduleoptionintheActivitiesmainmenu.
Thecompileoffsetiscalculatedfromthestartoftheproductionday.The
schedulewillbecompiledforthecurrentdayandalldaysthatbelongtothe
futuredaystoincludeintheschedule.Anyfuturedaythatwasalready
scheduled(notforecast)willnotgetrecompiledtoreflectanyjob
modificationsoradditionsthatwerenotcommittedtothescheduleafterthe
operation.Toincludeanymodificationsthatwerenotcommittedtothe
schedule,wemusteitherrecompilethealreadyscheduleddaysorrevert
theseschedulestoaforecasttypetoforceacompilebeforethedayrollsinto
production.

35

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

36

3
CREATING YOUR FIRST JOB

TOPICS

COVERED IN THIS CHAPTER


Overview (page 38)
Adding Your Job to the Production Schedule (page 44)
Monitoring Your Job (page 45)
Job Output Options (page 51)

37

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
ThischapterdescribeshowtousetheSchedulerclientgraphicalinterfaceto
create,runandviewtheresultsofajob.
Caution

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)

Select the Super User option in your User definition

Configure a default agent

Create and have available the work day calendar

Beforeyoubeginthetutorial,youmustinstallatleasttwoagentinstances
anddefineconnectionstothem.Refertothechaptersoninstallingagentsin
theInstallationandConfigurationGuideformoreinformation.Thesetwo
agentsmustbeinstalledandrunningtoperformtheexercisesinthis
tutorial.

Starting the Client


TheSchedulerclientprovidesaccesstothefeaturesandfunctionsofthe
product.Whenyoustarttheclient,youareautomaticallyloggedinto
Schedulerunderthesameusernameusedtologintotheworkstation.
Note

For each section of this tutorial, the very first step is to start the client.
The instructions continue from that point.

X To start the client:


1

Select Start and selectPrograms>TIDAL


Software>Scheduler>Client.
TheLicense Informationdialogdisplays.

38

ClicktheRegister LicensebuttontodisplaytheLicense Registration


dialog.

Ifusingademolicense,clicktheDemo Licensebutton,enterthe
democodeandclickOK.

Ifusingaproductionlicense,clicktheLoad Licensebuttonand
browsetothelocationofthelicensefileyoureceived.

Chapter 3 Creating Your First Job


Overview

Ifyoudonothavealicense,callSupport.Youcannotcontinue
withthistutorialwithoutalicenseofsometype.

TheSchedulerclientinterface displays.

Figure 11
Note

Scheduler Client with Console Window Open

If this is the first time you run the client, and the database is not
online, it may take 20-40 seconds for the client database engine to
connect to the master database. Also, the Master status light at the
bottom of the console must be green and Agents status light must be
yellow or green indicating that network connections are functioning. If
the Agents light is yellow, it indicates that at least one of the defined
agents is not available. As long as you use an agent with a valid
connection, you can successfully complete the tutorial exercises.

Iftheconsolewindowisnotopen,selectNew ConsolefromtheFile
menu.

39

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Setting Default Job Parameters


ManyparameterscanbesetfromtheSystem Configurationdialog.We
willusetheSchedulerdefaultsthroughoutmostofthistutorial.
Beforeajobcanrun,Schedulermustknowwhichagentwillcarryo
X To check, and if necessary, to change the default agent:
1

FromtheActivities menu,selectConfigure Schedulertodisplaythe


System Configurationdialog.

ClicktheDefaultstab.

Figure 12

Defaults Tab of the System Configuration Dialog

Tochangethedefaultagent,selectavalidagentfromtheAgent Name
list.
3

40

ClickOK.

Chapter 3 Creating Your First Job


Overview

Creating the Report Job Definition


X To create the Report Job definition:
1

StarttheSchedulerclient.

Ifaconsolewindowisnotopen,selectNew ConsolefromtheFile
menu.

FromtheNavigatorpane,selectDefinitions>Jobs todisplaytheJobs
pane(Figure 11).
Unlessotherusershavealreadycreatedjobdefinitions,thedisplay
doesnotshowanydataatthistime.

RightclickintheJobspaneoftheconsoleandselect Add Jobfromthe


contextmenu,orclicktheAdd Jobbutton

onthetoolbar.

TheJob Definition dialogdisplays.

Figure 13

Job Definition Dialog

IntheJob Namefield,enterReportasthenameofyournewjob.

IntheCommandfield,clicktheellipsis
Program dialog.

todisplaytheSelect

41

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
7

Navigatetothe Tutorial directoryintheAgentfolderwithinthe


Schedulerfolder,anddoubleclicktheReport batchfile.
Thefullpathto Report.bat nowappearsintheCommandfield.

8
Note

ClickOK.
Report.bat is a batch file which executes the sleep.exe program for
30 seconds.

Aconfirmationdialogdisplays.

Figure 14

Confirmation Dialog

Thisconfirmationdialogremindsyouthatsinceacalendarisnot
associatedwiththejob,itwillnotbescheduledtorunautomatically.
Wedidnotselectacalendarbecausewearegoingtosubmitthejob
manually.
9

ClickYes.
TheReport jobdisplaysintheJobspanewithyourusernameasthe
owner.

42

Chapter 3 Creating Your First Job


Overview

Figure 15

Reports Job Displayed on the Console

43

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Adding Your Job to the Production Schedule


Youcannowaddthejobtotheproductionschedule.
X To add the job to the production schedule:
1

RightclicktheReportsjobandselectInsert Job Into Schedulefrom


thecontextmenu.
TheInsert Job Into Scheduledialogdisplays.

Figure 16

44

Insert Job Into Schedule Dialog

ClickOK.

IntheNavigatorpane,selectOperations>Job Activity tomonitor


yourjob.

Chapter 3 Creating Your First Job


Monitoring Your Job

Monitoring Your Job


TheJob Activitypaneisakeycomponentinmonitoringyourproduction
schedulewithScheduler.Allcrucialjobschedulinginformationisavailable
ataglancefromtheJob Activitypane.Theeasytoreadlayoutallowsyou
tofocusontheareaofthedisplaythatisofinteresttoyou.Thecolumnsand
panesareresizable.Scrollbarsfacilitateaccesstothedatayouneed.
FromtheJob Activitypane,youcan:

seewhenjobsareaddedorscheduled

removejobs(ifyouhavesufficientsecurityprivileges)

monitortheprogressofajobfromascheduledstatethroughexecution
ofthejob

controljobexecution

SomeofthejobstatisticsavailablefromtheJob Activitypaneare:

thejobowner

theScheduleragentassignedtorunthejob

estimateddurationofthejob

theexitcodeofthecompletedjob

theactualcommandthatthejobrepresents

thenextdateonwhichthejobwillrun

thecalendarassociatedwiththejob(ifany)

thequeueassociatedwiththejob(ifany)

thejobsprioritylevel

thejobgroupassociatedwiththejob(ifany)

Whenjobsarescheduled,theJobspaneinthecenteroftheconsoleshows
onejobperline,plusthejobnumber,jobname,jobstatus,etc.Therightside
ofthedisplay,theBar Chart pane,showsthesamejobsinabarchart
format.Individualjobsdisplayascoloredbarsindicatingtheirstatus.The
lengthofthebaracrossthehorizontaltimelineindicatesthejobsestimated
elapsetime(beforethejobcompletes)oractualelapsedtime(afterthejob
completes).Ifthebarchartisnotvisible,adjustthebottomscrollbarand/or
therightsashlinetoincreasethesizeoftheBar Chartpane.

45

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Job Activity Pane


TheJob Activitypaneiscomprisedofthefollowingelements.Youcan
modifyitsappearanceaccordingtoyourpreference.

Figure 17

Job Activity Preferences

X To adjust the pane size:


1

Movethecursoratoponeofthesashlinesdividingthewindowinto
threepanes.
Thecursorchangestoadoublearrow

46

Presstheleftmousebuttonwhiledraggingthesashlinetoanew
position.

Tosavethenewsettings,gototheViewmenuandselectSave
Desktop.

Toreverttotheoriginalsettings,gototheViewmenuandselect
Restore Desktop.

Chapter 3 Creating Your First Job


Monitoring Your Job
X To change display settings:
1

FromtheViewmainmenu,selectPreferences or rightclickJob
ActivityintheNavigatorpaneandselectPreferencesfromthemain
menu.

Figure 18
2

Job Activity Preferences Dialog

ClicktheColumnstab.TheColumnstaballowsyoutoselectand
arrangethosecolumnsyouwantdisplayedintheJob Activitypane.
Acheckmarkinthecheckboxofacolumntitledisplaysthecolumn.
Deselectingthecheckboxnexttothecolumntitleomitsitfromthe
display.

Draganddropthecolumnsintotheorderyouprefer.

ClicktheStatus Colorstab.
FromtheStatus Colorstabyoucansetthecolorsthatrepresenteach
availablestatus.ThesesettingsalsoaffecttheBar Chartdisplay.
TheBar Chartsettingsareexplainedinthenextsectionofthischaper.

ClicktheOthertab.
Hereyoucanselectwhetheryourdefaultjobgroupdisplaysettingwill
becollapsedorexpandedtodisplaythejobscontainedwithinthe
group.

ClickOK.
TheJob Activitypanewillreflectthechangesyoumade.

47

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Bar Chart Pane


TheBar ChartpaneislocatedtotherightoftheJob Activitypane.TheBar
Charthelpsyouvisualizethetiming,dependenciesanddurationofjob
occurrences.Thepositionofthebarsrepresentseachjobsstartandfinish
times,bothestimatedandactual,andalsodisplaysthejobsstatus.Thejobs
arerepresentedgraphicallyasfollows:
Table 4

Bar Chart Representations

Status

Description

WaitStatus

Whenajoboccurrenceiswaitingintheproduction
schedule,itsbarintheJob Activitypaneshowsthe
estimatedstart,durationandfinishtimesinthecolor
selectedforthestatus.

LaunchorActiveStatus

Whenajobisactive,itsbarshowsitsactualstarttime,
andtheestimateddurationandfinishtimesinthecolor
selectedforthestatus.

CompletedStatus

Whenajobhascompleted,itsbarshowsitsactualstart,
durationandfinishtimesinthecolorselectedforthe
completionstatus.

Bar Chart Color Preferences

Asajobruns,itscolorchangestocorrespondtoitscurrentstatus.Status
colorsaresetontheStatus ColorstaboftheJob Activity Preferences
dialog.ThecoloroftextintheJob ActivitypaneandofthebarsintheBar
Chart panesignifiestherepresentedjobscurrentstatus.
Table 5

48

Default Color Representations

Status

Description

Red

Aborted,AgentInactive,AgentUnavailable,Cancelled,Completed
Abnormally,ErrorOccurred,ExternallyDefined,Orphaned,
Skipped,TimedOut

Green

Active,Launched

Blue

CompletedNormally

Gray

Deferred,TimedOutForDay,WaitingOnGroup

Chapter 3 Creating Your First Job


Monitoring Your Job
Table 5

Default Color Representations

Status

Description

Purple

Held,Stopped,WaitingOnOperator

Black

Scheduled,WaitingOnDependencies

X To change the Bar Chart color settings:


1

FromtheViewmainmenu,selectPreferences.

ClicktheStatus Colors tabandmakeyourchanges.

Figure 19

Job Activity Preferences Dialog, Status Colors Tab

X To change the Grid Background Color settings:


1

FromtheViewmainmenu,selectPreferences.

ClicktheGrid Background Color tabandmakeyourchanges.

49

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 20

Job Activity Preferences Dialog, Status Colors Tab

X To change the Bar Chart time units:


1

FromtheViewmainmenu,selectPreferences.

ClicktheBar Chart tab.

Figure 21
3

50

Job Activity Preferences Dialog, Bar Chart Tab

FromtheDisplay Unitlist,selectthetimeunitofyourchoice.
SchedulersdefaultisQuarter Hour.

Chapter 3 Creating Your First Job


Job Output Options

Job Output Options


Therearethreejoboutputoptions:

DiscardDiscardsalljoboutputs.Therewillbenooutputlog
availableforreview.

AppendSavesjoboutputsbyappendingthecurrentoutputtoa

singlelog.

ReplaceCreatesanewoutputfileeachtimethejobruns,replacing

thepreviouslog.
Note

Schedulers default is to discard output.

Specifying the Disposition of Job Output


X To specify the disposition of job output:
1

FromtheActivities main menu,selectConfigure Scheduler.

ClicktheDefaultstab.

IntheSave Output Optionsection,checkDiscard,Appendor


Replace.Fortheexercisesinthistutorial,checkReplace.

ClickOK

Note

To be able to view the output of a job, the Append or Replace option


for job output must be selected prior to running the job.

Viewing Job Output


YoucanviewtheoutputofajobatanytimeifyouselectedtheAppendor
Replaceoptionforjoboutputpriortorunningthejob.
X To view job output:
1

GototheJob Activitypane.

TodisplaytheJob Detaildialog,eitherdoubleclicktheReportjobor
rightclicktheReportjobandselectDetailsfromthecontextmenu.

51

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
3

ClicktheOutputtab.IfyoudonotselecttheSave Output option


beforerunningajob,youwillseeaSchedulermessageratherthan
actualjoboutput.

Figure 22
4

52

ClickOK.

Job Detail Dialog, Output Tab

4
USING SCHEDULER
CALENDARS

TOPICS

COVERED IN THIS CHAPTER


Overview (page 54)
Building the First Workday Calendar (page 55)
Building the Work Day Calendar (page 58)
Building the Fiscal Week End Calendar (page 60)
Alternate Method of Creating a Calendar (page 64)
Building the Quarter End Calendars (page 65)
Scheduling the Report Job with a Calendar (page 68)

53

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
Inthepreviousexercise,youcreatedanunscheduledjob.Inthischapter
youwillcreateascheduledjobbycreatingacalendar,andaddingittothe
job.Scheduledjobsrunonaregularbasisaccordingtothedatesintheir
calendar.Someschedulesaresimplewithjobsrunningeverydayfrom
MondaythroughFriday,oronthefirstdayofeverymonth.Othersaremore
involved,withjobsrunningonirregularaccountingperiods,holidaysor
fiscalperiodoffsets.
Schedulerusescalendarstodefinethesetofdatesonwhichjobsrun.
Schedulercontainsfivedifferentmethodsforcreatingcalendars,depending
ontheperiodinwhichyouneedyourjobtorepeat.Forexample,youmay
needyourjobtorunasneededona,daily,weeklyormonthlybasis.Each
methodaddressesaparticularperiod.
Thischapterdescribeshowtobuildfourcalendars:

first wkdyAlistcalendar(asneeded)representingthefirstworkday
ofeachweek.

work dayAdailycalendarrepresentingMondaythroughFriday.

Fiscal Week EndAcalendartousewhenyourworkweekendsona

Thursday.

Fiscal Quarter EndAcalendarforschedulingonthelastbusiness

dayofaquarter
Youwillthenscheduleajobusingthework day calendar,andconfirmthat
itisscheduledproperly.
Caution

54

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)

Select the Super User option in your User definition

Configure a default agent

Create and have available the work day calendar

Chapter 4 Using Scheduler Calendars


Building the First Workday Calendar

Building the First Workday Calendar


Inthisexercise,youwillbuildalistcalendarcalledfirst wkdywhichrefers
tothefirstworkdayineveryweek.IntheList Calendar dialog,youchoose
eachdaythatthejobistobescheduled.
X To build a List calendar:
1

FromtheNavigatorpane,selectDefinitions>Calendarstodisplaythe
Calendarspane.

ClicktheAddbutton
ontheSchedulertoolbarorrightclicka
calendarandselectAdd Calendar>Listfromthecontextmenuto
displaytheList Calendar Definitiondialog.

Figure 23

List Calendar Definition Dialog

IntheCalendar Namefield,typefirst wkdy.

Inthecalendarview,doubleclickthedatesthatrepresentMondayof
eachweekforthecurrentmonth,orrightclickfromwithinthe
Calendarsviewtodisplaythelist,andselectSelect Day of
Week>Monday.

55

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 24

Entered Dates in the Detail Tab of the List Calendar

AllselecteddatesappearundertheSelected Dates sectiontotheright


ofthecalendar.
Note

To add scheduling dates to other months, use the inner right arrow
buttons. To add scheduling dates to other years, use the outer right
arrow buttons.

ClickOKafteryouhavecompletedyourselections.
TheCalendarswindowshouldlooksimilartoFigure 25below
displayingthenewlycreatedcalendarfirst wkdy.

56

Chapter 4 Using Scheduler Calendars


Building the First Workday Calendar

Figure 25

Calendars View Showing first wkdy

Congratulations,youjustcreatedyourfirstlistcalendar!
Youcancreateacalendarforanydatesyouspecify.Thiscalendarcan
beassociatedwithajobfromwithintheJob Definitiondialog,butwill
notbeusedinanyfuturetutorialexercises.

57

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Building the Work Day Calendar


Nowyouwillcreatethework daydailycalendartouseforschedulinga
job.Thework daydailycalendarschedulesyourjobtorunoneach
weekday.
X To build a Work Day calendar:
1

FromtheNavigatorpane,selectDefinitions>Calendarstodisplaythe
Calendarspane.

ClicktheAddbutton
ontheSchedulertoolbarorrightclicka
calendarandselectAdd Calendar>Daily fromthecontextmenuto
displaytheList Calendar Definitiondialog.

Figure 26
3

Daily Calendar Definition Dialog

IntheCalendar Namefield,typework day.


NoticethePublicoptioninthelowerleftcornerofthedialog.Selecting
thisoptionmakesthecalendaravailabletoallSchedulerusers.
WewillbeacceptingthedefaultsintheDetailstab.Thedefaults
automaticallysetthecalendartogeneratedatesforMondaythrough
Fridayofeachweek.

58

Chapter 4 Using Scheduler Calendars


Building the Work Day Calendar
4

ClicktheForecasttabtogeneratethecalendar.

Figure 27

Daily Calendar Definition Dialog, Forecast Tab

ThistabdisplaysallthedatescalculatedfromtheDetailstab.The
ForecasttabisviewedthesamewayasintheList Calendardialog,
whenthecalendarfirst wkdaywasentered.Youcanaddindividual
datesfromthistabbydoubleclickinginthecalendarviewonthedates
youwanttochange.Youcandeletedatesbyselectingthedatein
Selected DatesandeitherrightclickingthedatetoselectDeleteor
clickingtheDeletebutton.Theforecastdisplaysafouryeartime
window,butthecalendarextendsindefinitely.
Note

This step can take from a few seconds to a minute, depending on your
systems configuration.

ClickOK.

TheCalendarsviewdisplaysthetwocalendarsyoucreated.Bydefault,the
rowsofthedisplayaresortedalphabeticallyaccordingtocalendarname
(theNamecolumn).Youcanalsosortbyothercolumnsbyclickingthe
columnname.Forexample,ifyouclicktheOwnernameatthetopofthe
Ownercolumn,calendarsaregroupedbytheircreator.Ifyouclickthe
ModifiedlabelatthetopoftheModifiedcolumn,yournewestcalendarsare
groupedtogether

59

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Building the Fiscal Week End Calendar


WewillcreatetheFiscal Week End calendartouseforschedulingajobto
runwhenyourfiscalweekendsonThursdayevening.IfThursdayisa
holiday,thejobwillexecuteonWednesdayevening,throughtheuseofa
conditiondefinition.
X To build a Fiscal Week End calendar:
1

FromtheActivitiesmenu,selecttheConfigure Scheduler option.

Figure 28

60

System Configuration Dialog, Master Tab

IntheWeek Beginslist,selectFriday.Thissetsyourfiscalweekto
startonFridayandendonThursday.

ClickOK.

ClickOKwhentheWarningdialogdisplays.Thiswarningdisplays
wheneveryouchangethecalendarweekstartingday.

Chapter 4 Using Scheduler Calendars


Building the Fiscal Week End Calendar

Figure 29
Note

Warning Dialog

The Recalculate Calendars option, available from the Calendars


pane context menu, will change all calendars to begin on the new
Week Begins day. If you do not recalculate calendars, existing
calendars are not changed; only those calendars created selecting the
new Week Begins day are affected.

FromtheNavigatorpane,selectDefinitions>Calendarstodisplaythe
Calendarspane.

ClicktheAddbutton
ontheSchedulertoolbarorrightclicka
calendarandselectAdd Calendar>Subset fromthecontextmenuto
displaytheCalendar Subset Definitiondialog.

Figure 30

Calendar Subset Definition Dialog

IntheCalendar Name field,enterFiscal Week End.

IntheOccurrencelist,selectEvery.

IntheCalendarlist,selectFriday.

61

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
10 IntheTime Frame list,selectWeek.
11 TheBased on Fiscallistisoptional.Multiplefiscalcalendarscanbe

definedforScheduler.Youcanchoosetobaseacalendardefinitionon
afiscalyear,ratherthanastandardJanuarythroughDecember
calendaryear.
Makingnoselectioninthe Based on Fiscal listresultsintheuseofa
standardcalendar.Forthisexercise,leavethefieldempty.
12 Now,weneedtosetaconditiontoletSchedulerknowwhattodoifa

holidayoccursonThursday.ClicktheConditionstab.

Figure 31

Calendar Subset Definition Dialog, Conditions Tab

13 ClickAddtodisplaythe Conditiondialog.

Figure 32

Condition Dialog

14 FromtheIf conflicts with calendar list,selecttheHolidayscalendar.


15 FromtheTake actionlist,select Previous Calendar.

62

Chapter 4 Using Scheduler Calendars


Building the Fiscal Week End Calendar
16 TheCalendarfielddefineswhichcalendartouseandhowmanydays

inthepasttogo.Thedefaultis0 days.Selectavalueof1,andinthe
adjacentlist,selectWorkdays.
17 ClickOK.

TheconditionnowdisplaysintheConditionsview.

Figure 33

Calendar Subset Definition Dialog, Conditions Tab

NowifaholidayfallsonFridayoftheFiscal Week End,Scheduler


willscheduletheFiscal Week EndcalendarforWednesday.
18 ClicktheForecasttab(Figure 27)toverifythedatesSchedulerhasset.
19 ClickOK.TheFiscal Week Endcalendarnowappearsinthe
Calendarsview.

63

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Alternate Method of Creating a Calendar


Inmostcases,thereismorethanonewaytodefineacalendarsuchasour
Fiscal Week End.Thefollowingisanexampleofanotherwaytocreatethe
Fiscal Week End calendar.Wewillcallthiscalendar Fiscal Week Ending,
sothattheresultsofbothexerciseswillbevisible.
X To create a calendar:
1

FromtheNavigatorpane,selectDefinitions>Calendarstodisplaythe
Calendarspane.

ClicktheAddbutton
ontheSchedulertoolbarorrightclicka
calendarandselectAdd Calendar>Weekly fromthecontextmenuto
displaytheWeekly Calendar Definitiondialog.

Figure 34

64

Weekly Calendar Definition Dialog

IntheCalendar Namefield,enterFiscal Week Ending.

ClicktheDetailstab.IntheInclude the following dayssection,de


selectMonday,Tuesday,WednesdayandThursdayoptions.

ClicktheConditionstab,andthenclickAdd.

IntheIf conflicts with calendarlist,selecttheHolidayscalendar.

IntheTake actionlist,selectPrevious Calendar.

Chapter 4 Using Scheduler Calendars


Building the Quarter End Calendars
8

TheCalendarfielddefineswhichcalendartouseandhowmanydays
inthepasttogo.Thedefaultis0 days.Selectavalueof1,andinthe
adjacentlist,selectWorkdays.

ClickOK.

10 ClickForecasttoverifythedatesthatSchedulerhaschosen.
11 ClickOKintheWeekly Calendar Definitiondialog.

Now,boththeFiscal Week EndandtheFiscal Week Ending


calendarsarevisibleintheCalendarsview.

Building the Quarter End Calendars


WewillcreatetheFiscal Quarter EndandCalendar Quarter End
calendarstouseforschedulingjobstorunwhenyourfiscalquarterendson
thelastworkdayofthequarter.Ifthequarterendsonaholiday,the
calendarshouldexecuteonthepreviousworkday.Forthisexercise,wewill
considerthefiscalyeartorunfromNovembertoOctober.

Fiscal Quarter End


Wefirsthavetodefineafiscalcalendarperiod,tobeusedindocumenting
theFiscal Quarter Endcalendar.Manycompaniesrunproductionfrom
morethanonefiscalcalendarperiod.
X To define a Fiscal calendar period:
1

FromtheNavigatorpane,selectDefinitions>Fiscal Calendarsto
displaytheFiscalCalendarspane.

ClicktheAddbutton
ontheSchedulertoolbarorrightclicka
calendarandselectAdd Fiscal Calendar fromthecontextmenuto
displaytheFiscal Calendar Definitiondialog.

65

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 35
3

IntheFiscal Calendar Name field,enterCorporate Fiscal Year.

IntheStarting Month list,selectNovember.Keepthedefaultvalues


fortheremainingtextfields.

ClickOK.

FromtheNavigatorpane,selectDefinitions>Calendarstodisplaythe
Calendarspane.

ClicktheAddbutton
ontheSchedulertoolbarorrightclicka
calendarandselectAdd Calendar>Subset fromthecontextmenuto
displaytheCalendar Subset Definitiondialog.

Figure 36

66

Fiscal Calendar Definition Dialog

Calendar Subset Definition Dialog

IntheCalendar Namefield,enterFiscal Quarter End.

Ifnotalreadyselected,clicktheDetailstab.

Chapter 4 Using Scheduler Calendars


Building the Quarter End Calendars
10 FromtheOccurrencelist,selectLast.
11 FromtheCalendarlist,selectWorkdays.
12 FromtheTime Framelist,selectQuarter.
13 IntheBased on Fiscallist,selectCorporate Fiscal Year. Leavethe
adjust by ... days fieldat0.

14 WehavecompletedthedefinitionfortheFiscal Quarter End calendar.

ClicktheForecasttabtoverifythedatesthatwillbeselectedfor
productionexecutionandthenclickOK.
Thecalendardefinitionsarereadytobeusedinproduction.

Calendar Quarter End


Tocreateaquarterendcalendarthatwillworkonthelastbusinessdayof
thecalendarquarter,wherethefiscalyearstartsinJanuary,justrepeatSteps
6through12abovewiththefollowingexceptions:

InStep 8,changetheCalendarNametoCalendar Quarter End.

InStep 12,leavetheBased on Fiscalfieldblank.

Youhavecreatedtwoquarterlycalendars,onebasedonafiscalyear
calendarandonebasedonastandardcalendaryearstartinginJanuary.

67

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Scheduling the Report Job with a Calendar


Now,returntotheReportjobandscheduleitusingthework day calendar.
X To schedule the Report job using the word day calendar:
1
2

FromtheNavigatorpane,selectDefinitions>JobstodisplaytheJobs
pane.
RightclicktheReportjobandselectEdit Job/Groupfromthecontext
menutodisplaythe Job Definitiondialog.

Figure 37

68

Job Definition Dialog

Chapter 4 Using Scheduler Calendars


Scheduling the Report Job with a Calendar
3

ClicktheScheduletabontheJob Definitiondialog.

Figure 38

Job Definition Dialog, Schedule Tab

IntheCalendar Name list,selectwork day.

Toviewthedatesinthecalendar,clicktheForecastbuttonandthen
clickOK.

Figure 39

Calendar Forecast Dialog

69

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
6

ClickOKagainontheJob DefinitiondialogtodisplaytheEffective
Datedialog.

Figure 40

Effective Date Dialog

TheEffective Datedialogdisplaysaskingyouwhenthejobshould
entertheproductionschedule.Thedatesrepresentthecurrentspanof
theproductionschedule.
7

ClickOK toacceptthedefault(today).
AnotheroccurrenceoftheReportjobenterstheproductionschedule.

FromtheNavigatorpane,selectOperations>Job Activity todisplay


theJob Activity pane.
Thejobrunsaccordingtothework daycalendar.Itwillruntoday
(unlessyouarerunningthistutorialonaweekend).Yourwindowmay
appearslightlydifferent.
YouwillalsoseethepreviousoccurrenceoftheReportjobthatwas
addedtotheschedulemanuallyinthepreviouschapter.Thejob
occurrencehasbeenrenamedReport(2)toreflectthefirstoccurrence
ofthesamejob(Report)thatranearlier.

70

5
SETTING UP A JOB
DEPENDENCY

TOPICS

COVERED IN THIS CHAPTER


Overview (page 72)
Defining a Job for Operator Release (page 73)
Monitoring Your Jobs (page 79)
Releasing the Jobs (page 81)

71

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
Inmanycases,ajobshouldrunonlyaftersomeexternalrequirementsare
satisfied.Forexample,ajobmayneeddatageneratedbyanotherjob,orit
canrunonlyafteranotherjobhascompletedsuccessfully.
Schedulerhastheflexibilitytoencompassthedifferentschedulingneeds
encounteredinabusinessenvironment.Youusejobdependenciesto
preventajobfromrunninguntiltheprecedingjobcompletesorentersa
predefinedstatus.Youcanalsosetjobstorunonlywhenmanuallyreleased.
Inthischapter,wearegoingtodefine(add)ajobcalledInv21.Wewill
assignacalendartothisjob,butwewillalsomakeitRequire operator
release.Evenifaccordingtoitscalendar,thejobisduetorun,itdoesnot
rununtilitisreleasedfromWaiting on Operator status.Wewilldefinea
secondjob,Inv22,whichdependsonInv21.Inv22doesnotrununtil
Inv21completesnormally.Finally,wereleaseInv21,andbothjobsend
withaCompleted Normallystatus.

Figure 41

72

Interdependence of Inv21, Inv22, and the Operator

Chapter 5 Setting Up a Job Dependency


Defining a Job for Operator Release

Thischapterdescribeshowto:

Defineajobthatwaitsforanoperatortoreleaseit

Defineajobthatdependsonthecompletionofanotherjob

Monitorjobsandjobdependencies

Releaseajobthatrequiresoperatorintervention

Caution

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)

Select the Super User option in your User definition

Configure a default agent

Create and have available the work day calendar

Defining a Job for Operator Release


Youcandefineajobrequiringanoperatortoreleaseitmanuallybefore
running,afterallitsotherdependenciesaresatisfied.Beforethejobis
released,itenterstheWaiting on Operatorstatus.Thejobdefinitioncan
includeinstructionsfortheoperator.
Requiringanoperatorreleaseisagoodtechniquewhentestingajoboraset
ofsequentialjobsforthefirsttime.Thisisalsogoodforjobsrequiring
operatorstoverifyanevent,orperformarelatedoperationexternalto
Scheduler.

Setting the Require Operator Release Option


X

To set the Require Operator Release option:

FromtheNavigatorpane,selectDefinitions>Jobs todisplaytheJobs
pane.

RightclickintheJobspaneoftheconsoleandselect Add Jobfromthe


contextmenu,orclicktheAdd Jobbutton

ontheSchedulertoolbar.

TheJob Definition dialogdisplays.

73

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 42
3

Note

74

Job Definition Dialog

Setthefollowingoptions:
a

IntheJob Namefield,enterthenameInv21.

IntheCommandfield,clicktheellipsisbutton
Opendialog.

NavigatetotheTutorial directory,anddoubleclicktheInv21
batchfile.

Thefullpathto Inv21.batnowappearsintheCommandfield.

todisplaythe

Although the command executable has the same name as the job in
this case, this is not required. The job Name is any logical name that is
meaningful to you. However, the command name refers to the physical
file and must match the actual command.

ClicktheScheduletab.

Chapter 5 Setting Up a Job Dependency


Defining a Job for Operator Release
5

IntheCalendar Namelistandselectthework daycalendar.

Figure 43
6

Job Definition Dialog, Schedule Tab

ClicktheOptionstab.

75

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 44

Job Definition Dialog, Options Tab

SelecttheRequire operator releaseoption.

ClickOKtosavethejobdefinition.

ClickOKintheEffective Date dialogtosubmitthejobintotodays


schedule.

10 FromtheNavigatorpane,selectOperations>Job Activity todisplay

theJob Activity pane.


Inv21displaysaWaiting On Operator status.

Wewillleavethisjobfornow,andreleaseittotheProductionSchedule
lateraftercreatingasecondjobwithadependencyonInv21
completingnormally.

76

Chapter 5 Setting Up a Job Dependency


Defining a Job for Operator Release

Adding a Job with a Dependency


WewillnowcreatetheInv22 jobdefinitionwithadependencyonthe
Inv21 jobalreadyintheproductionschedule.
X

To create the Inv22 job definition with a dependency on the


Inv21 job:

FromtheNavigatorpane,selectDefinitions>Jobs todisplaytheJobs
pane.

RightclickintheJobspaneoftheconsoleandselect Add Jobfromthe


contextmenu,orclicktheAdd Jobbutton

ontheSchedulertoolbar.

TheJob Definition dialogdisplays.


3

Setthefollowingoptions:
a

IntheJob Name field,typethenameInv22.

IntheCommandfield,clicktheellipsisbutton
Opendialog.

NavigatetotheTutorial directory,anddoubleclicktheInv22
batchfile.

todisplaythe

Thefullpathto Inv22.batnowappearsintheCommandfield.
4

ClicktheScheduletab.

IntheCalendar Namelist,selectthework daycalendar.

77

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
6

DisplaytheDependenciestab,byclickingitstabontheJob
Definitiondialog.

Figure 45
7

ClicktheAddbuttontodisplaythelist.

SelecttheAdd Job DependencyoptiontodisplaytheJob


Dependency Definition dialog.

Figure 46

78

Job Definition Dialog, Dependencies Tab

Job Dependency Definition Dialog

Chapter 5 Setting Up a Job Dependency


Monitoring Your Jobs
9

GototheJob/Group list,clickthedownarrow button


Inv21.ItwillappearintheJob/Group field.

andselect

10 AcceptthedefaultsandclickOK.Thedefaultsarepresettosatisfythe

dependencywhenInv21completesnormally.
NowInv21showsasadependencyforInv22.TheInv21dependency
ispartofthejobdefinitionofInv22.
11 ClickOKintheJob Definitiondialogtocloseit.
12 ClickOKintheEffective Date dialog.

TheInv22jobisaddedtotheproductionschedule.

Monitoring Your Jobs


Bothjobsarenowscheduledandreadytorun.UsetheJob Activitypaneto
monitorthem.
FromtheNavigatorpane,selectOperations>Job Activity todisplayyour
scheduledjobs.

Figure 47

Job Activity Pane

79

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Noticethatbothjobsareinwaitingmode.Inv21needsmanualintervention
beforeitcanrun(WaitingOnOperator)andInv22iswaitingforInv21 to
completenormally (WaitingOnDependencies).

Viewing Dependencies from the Job Activity Pane


X

To view the dependence Inv22 has on Inv21:

DoubleclicktheInv22jobintheJob ActivitypanetodisplayitsJob
Detail dialog.

clicktheDependenciestab.Thedependencyappearsinthe
Predecessorsfield.

Figure 48

Job Detail Dialog, Dependencies Tab

ThisshowsthatInv22iswaitingforInv21tocompletenormally.
CurrentlyInv21isinWaiting on Operator status.Inv22cannotrun
untilInv21goestoCompleted Normallystatus.
3

80

ClickOK.

Chapter 5 Setting Up a Job Dependency


Releasing the Jobs

Releasing the Jobs


X

To release the jobs:

ClicktheInv21jobintheJob Activity pane.

Rightclickthejobtodisplaythecontextmenu.

SelecttheJob Control optionandthenchoosetheRelease/Resume


optiontoreleasethejob.

Figure 49

Selecting the Release/Resume Menu Option

TheConfirmdialogdisplays.

Figure 50

Confirm Dialog

81

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
4

ClickYes.
NowInv21isfreetorun.Oncecomplete,Inv21entersaCompleted
Normallystatus.ThecolorofInv21changestogreenandthentoblue
(ifusingthedefaultstatuscolors),andthenInv22runs.Inv22
displayssimilarstatusandcolorchanges.

Figure 51
5

Inv21 and Inv22 Jobs Running in Job Activity Pane

ClickOKwhentheInformationdialogdisplays.

Congratulations!Inthischapter,youhavedefinedjobsrequiringmanual
releaseandajobdependency.Youhavescheduledandmonitoredyourjobs
throughthevariousstatesuntilcompletion.

82

6
SCHEDULING JOBS IN
GROUPS

TOPICS

COVERED IN THIS CHAPTER


Overview (page 84)
Job Group Hierarchy (page 85)
Job Group Scheduling (page 85)
Adding a Job Group (page 86)
Creating Jobs that Belong to a Job Group (page 87)
Scheduling the Job Group (page 94)
Scheduling a Job that Depends on a Group (page 95)
Adding a Job Group Dependency (page 97)
Releasing a Job Group (page 99)

83

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
Schedulerletsyouorganizeyourjobsintojobgroupstomakeiteasierto
manageandcontroljobs,andtomakeitmoreefficienttosetjobattributes.
Jobscaninheritcharacteristicssuchasdependenciesandcalendarsfrom
theirassociatedjobgroup,eliminatingtheneedtospecifycommonjob
detailsforeachjob.
Whenajobgroupisaddedtotheschedulemanually,allofitsmemberjobs
(calledchildjobs)areaddedaswell,savingyouadditionalworkand
reducingthepotentialformistakes.Ajobgroupcanbeconfiguredtheway
asinglejobcanbetodependonanotherjoborjobgroup.
Inthisexercise,wewillcreateajobgroupcalledapmonth.apmonthwill
consistoftwojobs,Ap31andAp32.WewillmaketheAp32jobdependent
ontheAp31jobcompletingsuccessfully.Oncetheapmonthjobgrouphas
completednormally,Glfinalwillrun.

Figure 52

84

Interdependency of Glfinal, apmonth, Ap31 and Ap32

Chapter 6 Scheduling Jobs in Groups


Job Group Hierarchy

Thischapterdescribeshowto:

Defineajobgroup

Createjobsthatbelongtothegroup

Schedulethejobgroup

Createajobthatdependsonagroup

Releasethejobgroup

Caution

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)

Select the Super User option in your User definition

Configure a default agent

Create and have available the work day calendar

Job Group Hierarchy


Ajobgroupisrepresentedwithacoloredbackgroundandaplus(+)ora
minus()signnexttoit.Allofagroupschildjobsareindentedunderneath
thegroupname.Eachjobgroupcanincludejobsandotherjobgroups,
whichinturncanincludeotherjobsandjobgroups.Thewindowhelpsyou
visualizeandnavigatethroughthehierarchyofjobgroups.Whenyouclick
the symboltotheleftofajobgroupname,thedisplayexpandstoshow
allofthejobsandjobgroupswithintheselectedjobgroup.

Job Group Scheduling


Inthischapterwewilldevelopasetofjobsunderajobgroup,then
schedulethejobsbysubmittingthejobgrouponly.Wewilldothisby
initiallysettingupthejobgroupanditsjobsasunscheduled(withoutan
assignedcalendar).Thiswillpreventthejobsfromenteringtheschedule
beforeallthedefinitionsarecomplete.Wewillthengivethejobgroupa
calendar.Wewillsetthechildjobstoinheritthecalendarsothatallthejobs
inthejobgroupwillbescheduledinonestep.

85

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Adding a Job Group


X

To add a job group:

FromtheNavigatorpane,selectDefinitions>Jobs todisplaytheJobs
pane.

RightclickintheJobspaneoftheconsoleandselect Add JobGroup


fromthecontextmenu,orclicktheAdd JobGroup button
Schedulertoolbar.

onthe

TheJob Group Definition dialogdisplays.

Figure 53

Job Group Definition Dialog

TheJob Group Definition dialogissimilar,butnotthesame,asthe


Job Definitiondialog.TheJob Group Definition dialogdoesnothave
afieldforspecifyingthecommandtoexecute,becauseajobgroupisa
containerforjobs.

86

IntheJob Group Namefield,enterapmonth.

ClicktheOptionstab,andselecttheRequire operator releaseoption.


Thiscausesthegrouptowaitforamanualreleasebeforeitwilllaunch.

Chapter 6 Scheduling Jobs in Groups


Creating Jobs that Belong to a Job Group
5

ClickOK.
AConfirmdialogdisplays.

Figure 54
6

Confirm Dialog

ClickYes.TheapmonthjobgroupisaddedtotheJobspane.

Creating Jobs that Belong to a Job Group


Now,youwilladdchildjobswithinthejobgroupthatyoujustcreated.
Becauseyouareaddingjobswithinthejobgroup,inheritableproperties
willbesetforthejobsfromthejobgroup,suchastheagentthatthejobswill
runon.

Creating the Ap31 Child Job


X

To create the Ap31 child job belonging to the apmonth job


group:

FromtheNavigatorpane,selectDefinitions>Jobs todisplaytheJobs
pane.

Selecttheapmonth jobgroup.

ClicktheAdd Job button ontheSchedulertoolbarorrightclickthe


Jobspaneandselect Add Job fromthecontextmenutodisplaythe
Job Definition dialog.

EnterAp31intheJob Namefield.
NoticethattheapmonthjobgroupisdisplayedintheParent Group
field.Youcanalsospecifyapmonthasthejobgroupbyselecting
\apmonthfromtheParent Grouplist.

87

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
5

Clicktheellipsisbutton
Program dialog.

Navigatetothe Tutorial directoryanddoubleclicktheAp31 batch


file.ThefullpathtoAp31.batappearsintheCommandfield.

Figure 55
7

intheCommandfieldtodisplaytheSelect

Creating the Ap31 job in the Job Definition Dialog

ClickOK.
AConfirmdialogdisplays.

88

ClickYes.

Now,whentheapmonthjobgroupisdisplayedinthejobswindow,it
willhaveeitheraplus(+)oraminus()signtotheleftofit,inthefirst
columnofthedisplay.Theplussignindicatestherearejobsand/or
morejobgroupsunderneathitthatarenotcurrentlyvisible.Clicking
theplussignexpandstheselectedjobgroup,showingthechildjobs
and/orjobgroupsbelongtoit.Clickingtheminussigncollapsesthejob
group.

Chapter 6 Scheduling Jobs in Groups


Creating Jobs that Belong to a Job Group

Jobsdonothaveexpand(+)orcollapse()symbolsnexttothem
becauseajobissingularandcannothavechildjobs
Note

Ap31 is identified as a Level 2 job, meaning it is nested on the next


level below apmonth. The indentation of the job name also serves as a
visual cue of the hierarchy. Apmonth is at Level 1 (or root) level.

Figure 56

apmonth Job GroupCollapsed View

Allofthejobsandjobgroupswithinapmonth willbelistedbeneathit.
Iftheyarenot,expandthe apmonth listingbyclickingtheexpandsign
nexttoit.

89

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 57

apmonth Job GroupExpanded View

Creating the Ap32 Child Job with a Dependency


Now,wewillcreatetheAp32childjobthatdependsontheAp31job.This
jobalsobelongstotheapmonthjobgroup.

90

To create the A932 child job with a dependency:

FromtheNavigatorpane,selectDefinitions>Jobs todisplaytheJobs
pane.

Selecttheapmonth jobgroup.

ClicktheAdd Job button ontheSchedulertoolbarorrightclickthe


Jobspaneandselect Add Job fromthecontextmenutodisplaythe
Job Definition dialog.

IntheJob Namefield,enterthejobnameAp32.Theapmonthjob
groupshouldbedisplayedintheParent Groupfield.Ifitdoesnot
appear,select\apmonthfromtheParent Grouplist.

Chapter 6 Scheduling Jobs in Groups


Creating Jobs that Belong to a Job Group
5

Clicktheellipsisbutton
Program dialog.

NavigatetotheTutorial directory,doubleclicktheAp32 batchfile.


ThefullpathtoAp32.batappearsintheCommandfield.

ClicktheDependenciestab.

ClickAddandselectAdd Job Dependency todisplaytheJob


Dependency Definitiondialog.

Clickthedownarrowbutton
Ap31 job.

Figure 58

intheCommandfieldtodisplaytheSelect

intheJob/Grouplistandselectthe

Making Ap31 a job dependency of Ap32

10 ClickOK.
Ap31isnowdisplayedontheDependenciestaboftheJob Definition
dialog.NoticethattheTypeofdependencyisidentifiedasJOB.

91

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 59

Ap32s Job Definition Dialog, Dependencies Tab

11 ClickOK.

TheConfirm dialogdisplays,remindingyouthatacalendarhasnot
beenspecified.
12 ClickYestoacceptthejobdefinitionwithoutassigningitacalendar.

TheAp32jobappearsalongwithAp31inthehierarchyunderthe
apmonthjobgroup.

92

Chapter 6 Scheduling Jobs in Groups


Creating Jobs that Belong to a Job Group

Figure 60

apmonth Job Group With its Member Jobs

93

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Scheduling the Job Group


Wehavecreatedtwochildjobsunderthejobgroupcalledapmonth,butno
jobshavebeenscheduled.Wewillnowassignacalendartothejobgroup,
andwhenclosed,thejobgroupandallitschildjobswillentertheschedule
torunbasedonthecalendar.
X

To schedule the job group:

Doubleclicktheapmonthjobgrouptoopenitsdefinition.

IntheCalendar Namelist,selecttheDailycalendar.
Sincechildjobsdefaulttoinheritingtheparentgroupsattributes,by
settingthisoptionforthegroup,youareeffectivelyassigningaDaily
calendartoeachchildjob.

Figure 61
3

apmonth Job Group Definition Dialog, Schedule Tab

ClickOK.TheEffective Datedialogappears.Acceptthedefaultsand
clickOK.
ThejobgroupandjobsaresubmittedanddisplayedintheJob
Activitypane.

94

Chapter 6 Scheduling Jobs in Groups


Scheduling a Job that Depends on a Group

Scheduling a Job that Depends on a Group


Oneofthebenefitsofusingjobgroupsisthatyoucanworkwithmultiple
jobsasthoughtheywereonebigjob.Youcanschedulejobsthatdependon
thestatusofthejobgroup.Youdonthavetodeterminetheorderinwhich
thejobswillcomplete,orsetadependencyoneachindividualjob.
Thestatusofthejobgroupisdeterminedbyitschildjobs.Forexample,a
jobgroupcannotreachcompletedstatusuntileveryjobinthejobgrouphas
completed.
X

To schedule a job that depends o a group:

FromtheNavigatorpane,selectDefinitions>Jobs todisplaytheJobs
pane.

Verifythatnojobgroup(suchasapmonth)ishighlighted,clickthe
Addbutton
ontheSchedulertoolbarorrightclickintheJobspane
andselectAdd Job fromthecontextmenu.

TheJob Definitiondialogdisplays.

Figure 62

Defining the Glfinal Job

95

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
3

IntheJob Namefield,enterGlfinal.
LeavetheParent Group fieldempty.

IntheCommandfield,clicktheellipsisbutton
Program dialog.

NavigatetotheTutorial directoryanddoubleclicktheGlfinal batch


file.

todisplaytheSelect

ThefullpathtoGlfinal.batwillappearintheCommandfield.
6

ClicktheScheduletab.

SelecttheDailycalendarfromtheCalendar Namelist.

Figure 63

96

Job Definition Dialog, Schedule Tab

Chapter 6 Scheduling Jobs in Groups


Adding a Job Group Dependency

Adding a Job Group Dependency


Now,youcanaddthedependencythatcausesjobGlfinaltowaituntilthe
apmonthjobgroupcompletesnormally.
X

To add a job group dependency:

ClicktheDependenciestabintheJob Definition dialog.

ClickAdd,andselectAdd Job DependencytodisplaytheJob


Dependencydialog.

GototheJob/Group field,andclickthedownarrowbutton

Selecttheapmonthjobgroup.

Figure 64

Selecting a Job Group For a Job Dependency

Thedependencywillbemetwhentheapmonthjobgroupreaches
Completed Normally status.Eachjobinthegroupmustcomplete
normallyforapmonthtocompletenormally.
5

ClickOKtoreturntotheJob Definition dialog.Noticethat,totheright


ofapmonth,theTypeofdependencyisidentifiedasGROUP.

97

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 65
6

Glfinals Job Definition Dialog, Dependencies Tab

ClickOK,thenclickOKagainintheEffective Date dialogtoacceptthe


currentproductionschedule.
The Glfinaljobnowdisplaysinthehierarchy.

98

Chapter 6 Scheduling Jobs in Groups


Releasing a Job Group

Figure 66

apmonth Job Group and the Glfinal Job

Releasing a Job Group


X

To release a job group:

FromtheNavigatorpane,selectOperations>Job Activity todisplay


theJob Activitypane.
TheapmonthjobgroupandtheGlfinaljobarenowintheproduction
schedule.apmonthisWaiting on Operator,andtheGlfinaljobis
waitingforthenormalcompletionofallthejobsintheapmonth
group.

Highlightandthenrightclicktheapmonthjobgrouptodisplaythe
contextmenu.

SelecttheJob Control option,thenselecttheRelease/Resumeoption


toreleasethejobgroup.
TheConfirmdialogdisplays.

ClickYes.

99

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

TheInformationdialogdisplays.
5

ClickOKintheInformationdialog.
ApmonthwillenterActivestatus.Then,theAp31jobruns,andAp32
followsafterAp31completesnormally.WhenAp32completes,the
apmonthjobgroupshowsaCompleted Normallystatus.Thenthe
Glfinaljobruns.Thetotalprocessshouldtakeafewminutes.

100

7
CREATING A FILE
DEPENDENCY

TOPICS

COVERED IN THIS CHAPTER


Overview (page 102)
Creating a Job with a File Dependency (page 103)

101

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
Jobdependenciesmeanthatjobsdependonthestatus(suchasCompleted
Normally)ofotherjobstorun.Usingfiledependencies,youcanhavejobs
dependontheavailabilityandstatusoffilesasaconditionofexecution.File
dependenciesaresetupusingtheFile Dependencydialogwhichis
accessiblewhenyoucreateoreditajobdefinition.
Inthischapter,wewillcreateajob(EDI_Download)thatisdependenton
theexistenceoftheEDI_File.txtfile.

Figure 67

EDI_Download Job Depends on the Existence of the EDI_File


File

Toproperlycompletethisexercise,youneedtohaveasolidunderstanding
ofthefollowingconcepts:

Howtoaddandcreateanewjobdefinition

HowtonavigatetoandbetweentheJobspaneandthe Job Activity


pane

Thischapterdescribeshowto:

102

Createajobwithafiledependency

Createafiletosatisfythedependency

Chapter 7 Creating a File Dependency


Creating a Job with a File Dependency

Caution

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)

Select the Super User option in your User definition

Configure a default agent

Create and have available the work day calendar

Creating a Job with a File Dependency


X

To create a job with a File dependency:

FromtheNavigatorpane,selectDefinitions>Jobs todisplaytheJobs
pane.

RightclickintheJobspaneoftheconsoleandselect Add Jobfromthe


contextmenu,orclicktheAdd Jobbutton

onthetoolbar.

TheJob Definition dialogdisplays.

Figure 68

Job Definition Dialog

103

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
3

IntheJob Name field,typeEDI_Download.


a

OntheProgramtab,clicktheellipsisbutton
field.

Inthe Tutorial directory,doubleclicktheEdi batchfile.


ThefullpathtoEdi.bat nowappearsintheCommandfield.

intheCommand

ClicktheScheduletabandfromtheCalendar Namelistselectthe
work daycalendar.

ClicktheDependenciestab.

DisplaytheFile Dependency dialogbyclickingtheAdd buttonand


selectingAdd File Dependency field.
a

EnterC:\Program Files\<Installation
Directory>\Agent\Tutorial\Edi_File.txt intheFile Name field.
Thefullpathtothisfilemustbetypedinbecausethefiledoesnt
yetexist.Wewillcreate Edi_File.txt later,inthesectionCreating
aFiletoSatisfytheDependencyonpage 108.

TheAgent NamefieldshouldalreadyhaveaWindowsagent
listedtheagentyouselectedasyourdefaultagentatthe
beginningofthistutorial.Ifthereisnoagentlistedoranagent
otherthantheWindowsagentisselected,thenselectyourlocal
WindowsagentfromtheAgent Namelist.

Figure 69

104

File Dependency Definition dialog

Chapter 7 Creating a File Dependency


Creating a Job with a File Dependency
7

ClickOKtoacceptthedefaultsettings.Schedulersdefaultisthatthe
dependencyismetafterthefileiscreated.

ClicktheDependenciestab.

Figure 70

File Dependency Displayed on the Dependency Tab

ThefullpathtoEDI_File.txt appearsintheDependency Name


column.TheTypeofdependencyislistedasFILE toindicatethatitisa
filedependency.
9

ClickOKtosavethejobdefinitionforEDI_Download.

10 ClickOKintheEffective Date dialogtoaddthejobtotheschedule.

105

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Viewing the Job in Production


X

To view the job in production:

OpentheJob Activitypane.

TheEDI_Download jobfirstappearswithaWaiting on
Dependencies status.Itgoesthroughdifferentstagesandendsina
Scheduledstatus.

Figure 71

106

EDI_Download Job Scheduled to Run

SelecttheEDI_Downloadjoboccurrence.

RightclicktheEDI_DownloadjobandselectDetailsfromthecontext
menutoseeitsJob Detaildialog.

Chapter 7 Creating a File Dependency


Creating a Job with a File Dependency

Figure 72
5

Job Detail Dialog, Status Tab

ClicktheDependenciestabtoviewthefiledependencystatus.

Figure 73

Job Detail Dialog Showing Status of File Dependency

TheJob Detaildialogdisplaysthefiledependencyforthisjob.
6

ClickOKtoclosethedialog.

107

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Creating a File to Satisfy the Dependency


Inthisexample,thedependencyonlyrequiresthatthefileexistsanddoes
notrequireanyspecificdata.Forthisexercise,wejustcreateanemptyfile
sincethejobdoesnotrequireanydatafromthefile.Normally,however,this
kindofdependencyissetupbecausethejobusesthedatafromthefiles
input.
X

To create a file to satisfy the dependency:

Openanewdocumentinatexteditororwordprocessingprogram,
suchasNotepadorMicrosoftWord.

SavethefileasEDI_File.txtinthelocationthatyouspecifiedwhen
definingthefiledependency(C:\Program Files\<Installation
Directory>\Agent\Tutorial EDI_File.txt),substitutingthenameof
thedirectorywhereSchedulerisinstalledfor <Installation
Directory>. Somesoftwarewillsupplyafileextensionforyou,suchas
.textor.doc.Foryourfiletosatisfythedependency,thenamemust
matchexactly.Savingasaplain textfilehelpsensurethecorrectfile
name.

Doublecheckthatthefileexists,iscorrectlynamedandinthecorrect
directory.

Monitoring the Job in Production


OpentheJob Activitypane.
YoucanseethatthefiledependencyfortheEDI_Downloadjobismetand
thejobgoesfromaWaiting on DependenciesstateintoanActivestate.
Note

Scheduler polls every minute (by default) for the file dependency data.
Therefore, it may take up to one minute for the job to become active
after you create the file.

Congratulations!Inthischapter,youhavecreatedajobwithafile
dependency,andfulfilledthatdependencyrequirementbycreatingthefile.
Bythistime,youshouldalsofeelcomfortablewithmovingbetweentheJob
ActivitypaneandJobspane,andwiththebasicprocedureforaddingajob.

108

8
DETECTING JOB EVENT
CONDITIONS

TOPICS

COVERED IN THIS CHAPTER


Overview (page 110)
Understanding Actions (page 110)

109

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
UsingSchedulerjobeventsallowsyoutoautomaticallytriggeractions
whenevercertaineventtriggers(jobconditions)arise.Actionsincludeuser
notificationviaemail,consolealertmessages,launchingnewjobs,job
controlcommands,variableupdates,logmessagepostingandSNMPtraps
toHPOpenVieworothernetworkmanagers.Thischapterdescribeshowto:

Defineanoperatoralertaction

AddtheactiontothejobbyusingtheJob Events dialog

Submitthejobtoproductionandwatchtheoperatoralertactionoccur

Caution

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)

Select the Super User option in your User definition

Configure a default agent

Create and have available the work day calendar

Understanding Actions
Anactionisapredefinedresponsetoajobeventthatistriggeredbyajobin
theproductionschedule.YoudefineeventtriggersforjobsintheJob
Eventsdialogandassociatethemtoactions.Actionscanbelinkedto
multiplejobsandjobgroups.
TherearedifferenttypesofactionsthatcanbedefinedwithinScheduler.
SomeoftheseactionsEachtypeofactioncanbetriggeredbasedonanyjobs
status,jobcontrolbyanoperatorand/oraneventtriggeredbythesystem.
Furthermore,youcanpersonalizeactionsfromasetofincludedvariables
suchassystem,job,jobevent,actionanduserdefinedinformation.

110

Chapter 8 Detecting Job Event Conditions


Understanding Actions

Creating an Alert Action


Inthefollowingexercise,youdefineanactionthatsendsanalerttotheJob
ActivitypanewhenthejobEDI_Download (createdintheprevious
chapter)endswithaCompleted Abnormallystatus.

To create an Alert action:

FromtheNavigatorpane,selectDefinitions>Actions>Alertto
displaytheAlertActionspane.

ClicktheAdd Action buttonontheSchedulertoolbarorrightclick


theAlert ActionspaneandselectAdd Actionfromthecontextmenu
todisplaytheAction Definition: Alertdialog.

Figure 74

Action Definition: Alert Dialog

Inthe Action Namefield,enterJob Failed.

IntheSeverity Levelsection,checkError.

111

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
5

Typethefollowingmessageandselectthevariablesshowninangle
bracketsfromtheVariableslist.Thevariablesappearbetweenthe
bracketsas<variable>.
The Job <Jobname>, owned by <JobOwner> went to
<JobStatus> status on <SysDate.M/d/yy>. <JobOwner>s pager
number is <JobPager>

Note

This dialog does not accept carriage returns. Text automatically wraps
to the next line.

Table 6

Variables Used in Step 7

Variable

Path

Description

<JobName>

Job
Variables\JobNAME

Thenameofthejobthat
triggeredtheaction.

<JobOwner>

Job
Variables\JobOWNER

Thenameoftheuserthat
ownsthejob.

<JobStatus>

Job
Variables\JobSTATUS

ThestatustheJobisinatthe
timeofthemessage.

<SysDate.M/d/yy>

SystemVariables\
SystemDate\M/d/yy

Theday,month,date,year
actionwastriggered

<JobPager>

JobVariables\
Thepagernumberofthe
OwnersPagerNumber owner

Thisactionistriggered,andanalertrecordissenttotheJob Activity
panefortheoperatortotakeaction.
6

112

ClickOKtoaccepttheaction.TheactionisdisplayedintheActions
pane.

Chapter 8 Detecting Job Event Conditions


Understanding Actions

Associating the Action to the Job


YoucanassigntheactiontotheEDI_Downloadjobthroughthe Job Events
dialog.
X

To associate the action to the job:

FromtheNavigatorpane,selectDefinitions>Events>Job Events to
displaytheJob Events pane.

ClicktheAdd Event
buttonontheSchedulertoolbarorrightclick
theEventspaneandselectAdd Eventfromthecontextmenuto
displaytheJob Event Definitiondialog.

Figure 75

Associating a Defined Action With a Job Event

IntheJob Event Namefield,enterJob Failed.

FromtheEvent Triggerlist,selectJob Completed Abnormally.

IntheAvailable Action(s)list,highlightJob Failedandclicktheleft


arrowbuttonordraganddropthe Job FailedactiontotheSelected
Action(s)field.

113

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
6

NowtoassociatetheEDI_Downloadjobtothejobevent,clickthe
Associated Job(s)tab.

Figure 76

Job Event Definition Dialog, Associated Job(s) Tab

DisplaytheavailablejobsintheCommand listandselectthe
EDI_Downloadjobbydoubleclickingit.

SelectthePublicoption,ifnotalreadyselected.Thismakesyourevent
availabletootherSchedulerusers.

ClickAdd andthenclick OK.


TheEDI_DownloadjobisnowlinkedtotheJob Failed alertaction
throughtheJob Failed jobevent.

114

Chapter 8 Detecting Job Event Conditions


Understanding Actions

Figure 77

Job Events Pane With Defined Job Event

115

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Changing the edi.bat file to Fail


X

To change the edi.bat file to Fail:

IntheJobspane,doubleclickEDI_Download orrightclickitand
select Edit Job/Groupfromthecontextmenu.

Figure 78
2

116

Editing a Job Definition

Clicktheellipsisbutton
Programdialog.

intheCommandfieldtodisplaytheSelect

Chapter 8 Detecting Job Event Conditions


Understanding Actions

Figure 79
3

Select Program Dialog

RightclicktheEdi batchfileandfromthecontextmenu,selectEdit.
The Edi.bat fileopensinMicrosoftNotepad.

Figure 80

Selecting the Edi.bat File to Edit

Changethelastlineofthefileocsexit 0toocsexit 1.

FromNotepadsFilemenu,selectExit.

WhentheNotepaddialogdisplays,clickYestosaveyourchanges.

ClicktheOpenbuttonintheSelect Program dialog.

117

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
8

ClickOKintheJob Definition dialog.

ClickOKintheEffective Datedialog.

10 Now,letsinsertthejobintotheschedulebyrightclickingthe
EDI_Download jobandselectingInsert Job into Schedule fromthe

contextmenu.

Figure 81

Inserting a Job Into the Production Schedule

11 ClickOKintheInsert Job Into Scheduledialog.

Figure 82

118

Insert Job Into Schedule

Chapter 8 Detecting Job Event Conditions


Understanding Actions
12 FromtheNavigatorpane,selectOperations>Job Activity todisplay

theJob Activity pane.


WatchasthejobgoesintotheActivestateandruns.Thejobeventually
terminateswithanCompleted Abnormallystatus,initiatingtheaction
youdefinedandchangingtheAlertsstatuslightatthebottomofthe
consoletored.

Changing the Status of the Alert


X

To change the status of the alert:

DoubleclicktheAlertslightatthebottomofthe Job Activitypaneto


displaytheAlertspane.

DoubleclickthealerttodisplaytheAlert Detaildialog.

SelecttheAcknowledged option.

YoucanenteraresponseorcommentintheResponsefield.

ClickOKtoclosethedialog.
TheAlertslightatthebottomoftheSchedulerwindowchangesto
yellow.

119

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

120

9
CREATING VARIABLE
DEPENDENCIES

TOPICS

COVERED IN THIS CHAPTER


Overview (page 122)
Creating a Variable (page 124)
Creating the Variable Update Action (page 126)
Creating a Job Event for the Gather Report Job (page 128)
Creating the Gather Orders Job Group (page 129)
Creating a Repeating Job and Associating a Job Event (page
130)
Creating a Job Dependent on the Gather Orders Variable (page
135)
Scheduling and Monitoring the Gather Orders Jobs (page 137)

121

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
Inthepreviouschapter,wecreatedanalertmessagethatusedsystem
variables.Inthischapter,wewillcreateajobthatdependsonthevalueofa
userdefinedvariable.Auserdefinedvariableisavariableyoucreate
manually.Ajobcanchangethevalueofavariableyouhaveassignedtoitby
usingavariableupdateaction.Ajobcanbedependentuponthevalueofa
variable.Usinguserdefinedvariables,youaregivenunlimitedcontrolover
theconditionalstructuringofjobs.
Forexample,ajobcanrun,andsetavariabletoaspecificdate.Anotherjob
canbetriggeredtorunbasedonthatvariablesdate.Whenthespecificdate
arises,thesecondjobruns.
Inthischapter,youwillincrementavariablewiththeactionofJobAand
makeJobBdependentonthatvariablereachingaspecificvalue.The
variablewillstartwithavalueof0andincrementby1eachtimeJobAruns.
JobBwilldependonthevariableequalling3.AfterJobArepeats3times,
JobBwillstart.Youcouldsetupajobtostartafteranydefinednumberof
previousdependencyjobscomplete.
Thefollowingfigureillustrateshowthisprocessworks:

122

Chapter 9 Creating Variable Dependencies


Overview

Caution

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)

Select the Super User option in your User definition

Configure a default agent

Create and have available the work day calendar

123

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Creating a Variable
X

To create a variable:

IntheNavigatorpane,selectDefinitions>Variablestodisplaythe
Variablespane.

DisplaytheVariable DefinitiondialogbyeitherclickingtheAdd
Variablebutton
orbyrightclickingintheVariablepaneand
selectingAdd Variable fromthecontextmenu.

IntheNamefield,enterGather Orders Var.

FromtheTypelist,selectNumber.

IntheValuefield,enterthenumber0.

IntheDescriptionfield,enterThe value will be incremented by 1


for each successful run of the Gather Job.

SelectthePublicfield,ifitisnotalreadyselected.

Figure 83
8

Defining the Gather Orders Var Variable

ClickOK.
ThenewlycreatedvariablenowappearsintheVariablespane.

124

Chapter 9 Creating Variable Dependencies


Creating a Variable

Figure 84

Variables Pane Displaying the Defined Variable

125

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Creating the Variable Update Action


X

To create the variable update action:

FromtheNavigatorpaneselectDefinitions>Actions>Variableto
displaytheVariable Actionspane.

SelecttheAdd Actionbutton
orrightclicktheVariable Actions
paneandselectAdd Actionfromthecontextmenutodisplaythe
Action Definition: Variabledialog.

Figure 85

126

Action Definition: Variable Dialog

Inthe Action Namefield,enterSet Gather Var.

FromtheVariable Namelist,selectGather Orders Var: Number.

IntheType of Updatelist,selectIncrement variable value by.

IntheValuefield,enter1ifitisnotalreadysetat1bydefault.

Chapter 9 Creating Variable Dependencies


Creating the Variable Update Action
7

ClickOK.
TheSet Gather Var actionnowdisplaysintheVariable Actionspane.

Figure 86

Variable Actions Pane With Defined Action

127

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Creating a Job Event for the Gather Report Job


X

To create a job event for the Gather Report job:

FromtheNavigatorpaneselectDefinitions>Events>Job Events to
displaytheJob Events pane.

SelecttheAdd Event button


orrightclicktheJob Events pane
andselectAdd EventfromthecontextmenutodisplaytheJob Event
Definition dialog.

Figure 87

128

Job Event Definition Dialog

IntheJob Event Namefield,typeEvent Action Gather.

IntheEvent Trigger list,selectJob completed normally.

HighlightSet Gather Var andclicktheleftarrowbuttonordragand


droptheSet Gather VarvariabletotheSelected Action(s)field.

ClickOK.

Chapter 9 Creating Variable Dependencies


Creating the Gather Orders Job Group

Creating the Gather Orders Job Group


X

To create the Gather Orders job group:

FromtheNavigatorpaneselectDefinitions>Jobs todisplaytheJobs
pane.

SelecttheAdd Job Group button


orrightclicktheJobs paneand
selectAdd Job Group fromthecontextmenutodisplaytheJob Group
Definition dialog.

Figure 88

Job Group Definition Dialog

IntheJob Group Namefield,enterGather Orders.

IntheCalendar Namelist,selectthework daycalendar.

ClickOK.

ClickOKattheEffective Datedialog

129

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
.

Note

When you click OK at this dialog, the job group enters the production
schedule, but nothing will run because there are no jobs associated
with the job group yet. Since you can manually add the job group to
the schedule later, clicking Cancel at this dialog is also acceptable.

Creating a Repeating Job and Associating a Job


Event
X

To create a repeating job and associate a job event:

IntheJobspane,selectthejobgroupGather Orders andclicktheAdd


Job button
orrightclickintheJobspaneandchooseAdd Job
fromthecontextmenutodisplaytheJob Definitiondialog.

Figure 89
2

130

Job Definition Dialog

Inthe Job Name field,enter Gather_ Report.

Chapter 9 Creating Variable Dependencies


Creating a Repeating Job and Associating a Job Event
3

IntheCommandfield,clicktheellipsisbutton
Program dialog.

SelecttheGather batchfileandclickOpen.

ClicktheScheduletab.

IntheRepeatssection,selecttheRun new occurrence everyoption.


Clickintheminutesfieldandenter2 (or usetheupanddownarrows)
andclickintheup to ___ timesfieldandenter5.

Figure 90

todisplaytheSelect

Job Definition Dialog, Schedule Tab

ClickOK.

ClickOKintheEffective Datedialog.

131

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
9

IftheGather Report jobisnotvisibleintheJobspane,expandthe


Gather Ordersjobgroupbyclickingtheplussign(+)toitsleft.

Figure 91

Expanding the Gather Report job group

TheGather Report jobwillruneverytwominutesforatotaloffive


times,activatingtheEvent Action Gather jobeventeachtime.Set
Gather Var istiedtoEvent Action Gatherandwillincrementby1
eachtimeGather Report runs.WhenSet Gather Var reaches3,itwill
havefulfilledtheconditionsnecessarytosetoffthenextjob,whichwe
willdefineasOrder ReportsinCreatingaJobDependentonthe
GatherOrdersVariableonpage 135.
TheOverviewonpage 122explainsingeneraltermsthe
interdependenceofGather Report(JobA),Set Gather Var(auser
definedvariable),andOrder Reports(JobB).

132

Chapter 9 Creating Variable Dependencies


Creating a Repeating Job and Associating a Job Event
10 RightclickGather Report andfromthecontextmenuselectEdit Job/
Group.

Figure 92

Editing a Defined Job

11 ClicktheJob Events tab.


12 ClickInserttodisplaytheSelect Job Eventdialog.

Figure 93

Select Job Event Dialog

13 SelecttheEvent Action Gather event.

133

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
14 ClickOK.ThejobeventdisplaysintheEventsfield.

Figure 94

Event Action Gather Job Event Assigned

15 ClickOKtoclosetheJob Definitiondialog.
16 ClickOK toconfirmtheEffective Datedialog.

EverytimetheGather Reportjobcompletesnormally,thevariable
Gather Orderswillbeincrementedby1.

134

Chapter 9 Creating Variable Dependencies


Creating a Job Dependent on the Gather Orders Variable

Creating a Job Dependent on the Gather Orders


Variable
X

To create a job dependent on the Gather Orders variable:

SelectthejobgroupGather Orders andclicktheAdd Jobbutton

orrightclickandselect Add Jobfromthecontextmenutodisplaythe


Job Definitiondialog.

Figure 95

Order_rpt.bat Displayed in the Command Field

IntheJob Namefield,enterOrder Reports.

IntheCommandfield,clicktheellipsesbutton
Programdialog.

SelecttheOrdr_rpt batchfileandclickOpen.

ClicktheDependenciestab.

todisplaytheSelect

135

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
6

clicktheAddbuttonandselectAdd Variable Dependency.

Figure 96

Adding a Variable Dependency

SelectGather Orders Var: Number fromtheVariable Namelist.

IntheOperatorlist,ifEquals (=) isnotalreadydisplayed,selectit.

IntheVariable Valuefield,typethenumber3.

10 ClickOKtoacceptthevariabledependency.

TheJob Definition dialognowdisplaysthenewdependency.

Figure 97

136

Order Reports Job Showing Gather Orders Var


Dependency

Chapter 9 Creating Variable Dependencies


Scheduling and Monitoring the Gather Orders Jobs
11 ClickOK.
12 ClickOKintheEffective Datedialog.

Scheduling and Monitoring the Gather Orders Jobs


Nowthatallthecomponentsaredefinedandconfigured,wewillrunthe
jobsandmonitorthemintheJob Activitypane.
X

To schedule and monitor the Gather Orders jobs:

IntheJobspane,doubleclicktheGather_Report jobtodisplaythe
Job Definitiondialog.

ClickOKtodisplaytheEffective Datedialog.

SelecttheStart todays repeating job(s) now optionatthebottomof


theEffective Datedialog;otherwise,Schedulerwillstartrepeatingthe
jobatthebeginningofitstimewindow,whichis12:00AMforthisjob.

Figure 98

Setting Jobs to Repeat Immediately in the Effective Date


Dialog

ClickOK.Thejobenterstheproductionschedule.

RightclicktheOrder Reportsjobandselect Insert Job into Schedule


fromthecontextmenuandclickOK.

ClickOKintheInformationdialog.

FromtheNavigatorpane,selectOperations>Job Activitytodisplay
theJob Activitypane.

DoubleclicktheOrder Reportsjoboccurrence.

137

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
9

ClicktheDependenciestab.

Figure 99

Job Detail Dialog Displaying Defined Dependency

Thevariabledependencyappearsshowingthepresentvalueofthe
variableandthevalueitneedsforthedependencytobemet.
10 ClickCancelandlookatthejobsintheJob Activitypane.

ThethreeoccurrencesoftheGather ReportjobrunbeforetheOrder
Reportsjobruns.

138

Chapter 9 Creating Variable Dependencies


Scheduling and Monitoring the Gather Orders Jobs

Figure 100 Monitoring the Gather Report and Order Reports Jobs

139

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

140

10
MANAGING JOBS IN THE
PRODUCTION SCHEDULE

TOPICS

COVERED IN THIS CHAPTER


Overview (page 142)
Creating the Parent Job Group (page 143)
Creating Three Child Jobs (page 144)
Estimated and Excessive Durations (page 156)

141

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
Inthischapteryoulearntousejobcontrol,typicallyperformedbyan
operator,tomanagethecurrentproductionschedule.Jobcontrolconsistsof
releasing,stopping,restartingandabortingjobs.Youcanalsorerunjobs,
overridetheirdependenciesandchangetheircompletionstatus.
Thischapterdescribeshowto:

Cancelajob

Removeajob

ReleaseajobgroupintheWaiting on Operatorstatus

PlaceajobonHold

Overrideajobdependency

Rerunajobthatfails

Caution

142

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)

Select the Super User option in your User definition

Configure a default agent

Create and have available the work day calendar

Chapter 10 Managing Jobs in the Production Schedule


Creating the Parent Job Group

Creating the Parent Job Group


X

To create the parent job group:

FromtheNavigatorpane,selectDefinitions>JobstodisplaytheJobs
pane.

RightclickintheJobspaneandselectAdd Job Groupfromthe


contextmenutodisplaytheJob Group Definitiondialog.

RightclickintheJobspaneandselectAdd Job Groupfromthe


contextmenutodisplaytheJob Group Definitiondialog.

Figure 101 Job Group Definition Dialog


4

IntheJob Group Namefield,enterProduction Jobs.TheParent


Groupfieldshouldbeempty.

IntheCalendar Namelist,selectwork day.

ClickOK.

ClickOKintheEffective Datedialog

143

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Creating Three Child Jobs


X

To create three child jobs:

Tocreateachildjobofajobgroup,selecttheProduction Jobsjob
groupontheJobspane.

ClicktheAdd Job button orrightclickandselectAdd Job fromthe


contextmenutodisplayaJob Definitiondialog.

IntheJob Namefield,enterProd Job 1.

IntheCommandfield,clicktheellipsisbutton todisplaytheSelect
ProgramdialoganddoubleclicktheAp31 batchfiletoselectit.

ClicktheOptionstab.

Figure 102 Job Definition Dialog, Options Tab


6

SelecttheRequire operator release option.

ClickOK and thenclickOKagainintheEffective Datedialog.


Thefirstjobhasbeencreated.

144

IntheJobspane,selecttheProd Job 1 jobifnotselected.

Chapter 10 Managing Jobs in the Production Schedule


Creating Three Child Jobs
9

RightclickProd Job 1 andselectCopy Job/Group fromthecontext


menu.

Figure 103 Production Jobs Job Group and the Prod Job 1 Child Job
10 AjobcalledCopy of Prod Job 1appearsintheJobspane.

145

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 104 Copy of Prod Job 1


11 WhiletheCopy of Prod Job 1jobisselected,clicktheEdit Job\Group

button
menu.

orrightclickandselect Edit Job\Group fromthecontext

12 IntheJob Namefield,changethenametoProd Job 2.


13 ClickOK and thenclickOKagainintheEffective Datedialog.

Thesecondjobhasbeencreated.
14 Createathirdjob,calledProd Job 3,thesamewaywecreatedProd
Job 2.

Forthisjob,wewilladdanunreasonabletimedependencytoshow
howwecanoverridethisdependencyintheJobActivitywindow.
15 DoubleclickProd Job 3.

146

Chapter 10 Managing Jobs in the Production Schedule


Creating Three Child Jobs
16 ClicktheScheduletaboftheProd Job 3definition.

Figure 105 Entering a Time Window in the Job Definition Dialog


17 CleartheInheritedoptionintheTime Window section.
18 EnteraTime Windowof11:45 PMto12:00 AM.
Note

If you set a time window that is before the present time, e.g., 12:00
AM to 12:15AM, the job will enter todays schedule with a Timed Out
status.

19 ClicktheOptionstab.
20 MakesuretheRequire operator releaseoptioniscleared.Thisjob

willwaitbasedonitstimewindow.(Weareassumingthatyouarenot
runningthistutorialatmidnight.)
21 ClickOK,thenclickOKagainintheEffective Datedialog.
22 Rightclickthenewjobgroupthatyoudefined,thenselectInsert Job
into ScheduleandclickOK.

23 ClickOKintheInformationdialog.

147

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Viewing the Jobs in the Job Activity Pane


FromtheNavigatorpane,selectOperations>Job Activitytodisplaythe
Job Activitypane.
Youseeallthreejobsinthejobgroupasinthefollowingfigure.

Figure 106 Production Jobs Job Group and its Children Jobs

Job Sorting
JobscanbesortedandfilteredbyanycolumnintheJob Activitypane.On
everyrefresh,sortingoccursonthecolumnwhichcontainsacaret(^)inthe
columnheader.Inthisexercise,wewillsetthedefaultsortcolumntobethe
Estimated Start Time.
clicktheEst Start Timecolumnheader.Thejobsaresortedbythe
estimatedstarttime.

148

Chapter 10 Managing Jobs in the Production Schedule


Creating Three Child Jobs

Figure 107 Jobs Sorted by Est Start Time

Removing a Job from the Production Schedule


Ifajobhasnotlaunched,youcanremoveitfromtheproductionschedule.
X

To remove a job from the production schedule:

OntheJob Activitypane,rightclicktheProd Job 1 job.

SelectDelete Job/Groupfromthecontextmenu.

WhentheConfirmdialogisdisplayedclickYes.

Note

You can also remove a job by clearing the Enabled option in the job
definition, or by deleting the job from the Jobs pane. You can only
remove a job from the production schedule if it is not currently running
or has not yet run.

149

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Inserting a Job Into the Production Schedule


X

To insert a job into the production schedule:

FromtheActivitiesmainmenu,selectInsert Job into Scheduleto


displaytheInsert Job Into Scheduledialog.

Figure 108 Insert Job Into Schedule Dialog

Thereareseveralwaystoenterajobinthisdialog.Forthisexercise,we
willuseSchedulerssophisticatedsearchfunction.
2

clicktheellipsesbutton

intheJob/GroupfieldtodisplaytheJob

Search dialog.

Figure 109 Job Search Dialog

150

Chapter 10 Managing Jobs in the Production Schedule


Creating Three Child Jobs
3

IntheNamefield,typeProd*.Leavetheothertextfieldsblank.
Theasterisk(*)isawildcardcharacter,sothissearchwillfindalljobs
thatstartwithProd.(Theasteriskmatchesanycharacteror
combinationofcharacters.)

ClicktheFindbutton

TheJob Search Results sectionshouldincludethethreeProd Jobs


andtheProduction Jobsjobgroup.
5

SelectProd Job 1.

Figure 110 Results of a Job Search on Prod* Criteria


6

ClickOK intheJob Searchdialog.

ClickOKintheInsert Job Into Scheduledialog.

ClickOKattheInformationdialog.
Thejobisaddedtothescheduleoutsideitsjobgroup.Notethatjobs
outsideofajobgrouparenotindentedunderthegroup.

RightclicktheProd Job 1 (1) jobandfromtheJob Controlmenu


selectRelease/Resume.

10 ClickYesintheConfirmationdialog.
11 ClickOKintheInformationdialog.

Thejobbeginstorun.

151

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Cancelling a Job in the Production Schedule


YoucancancelajobusingtheCancel/Abortcommandwhenitisinthe
Heldstate.YoucanabortajobusingtheCancel/Abort commandwhenitis
intheActivestate.Inthenextprocedure,wewillcancelajobthatisinthe
Heldstate.
X

To cancel a job in the production schedule:

FromtheNavigatorpane,selectOperations>Job Activitytodisplay
theJob Activitypane.

SelecttheProd Job 2 job.

RightclicktheProd Job 2 andfromtheJob Controlmenuselect


Cancel/Abort.

Figure 111 Selecting Cancel/Abort From the Job Control Submenu


4

152

ClickYesattheConfirmationdialog.

Chapter 10 Managing Jobs in the Production Schedule


Creating Three Child Jobs
5

ClickOKintheInformationdialog.
ThestatusofthejobchangestoCancelled.

Figure 112 Displaying Cancelled Prod Job 2 Job in Job Activity Pane

Placing a Job on Hold


Youcanputanyjobthatiswaitingondependenciesonhold.Evenifthe
dependenciesaremet,thejobwillnotrunwhileintheHoldstate.
X

To place a job on hold:

SelecttheProd Job 3 job.

RightclicktheProd Job 3jobandfromJob Control submenuselect


Hold/Stop.

ClickYesintheConfirmationdialog.

ClickOKintheInformationdialog.
ThejobentersHeldstatus.

153

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 113 Prod Job 3 Job Held In Production Schedule

Removing the Job Out of Held Status


X

To remove a job from Held status:

RightclicktheProd Job 3jobandfromtheJob Control submenu


selectRelease/Resume.

ClickYesintheConfirmationdialog,andthenclickOKatthe
Informationdialog.
ThejobreenterstheWaiting On Dependenciesstatus.Ifthejobs
dependenciesweremet,thejobwouldlaunch.

154

Chapter 10 Managing Jobs in the Production Schedule


Creating Three Child Jobs

Overriding a Dependency
Youcanalsooverridejob,file,timeandvariabledependencieswiththe
Overridecommand.Forthisexercise,wewilloverridethetime
dependency.
X

To override a dependency:

RightclicktheonProd Job 3jobandfromtheJob Control submenu


selectOverride.

ClickYesintheConfirmationdialog,andthenclickOKatthe
Informationdialog.Thejoblauncheseventhoughthedependencies
havenotbeenmet.

Figure 114 Overriding the Prod Job 3 Job


Note

When a dependency is overridden, the Job Detail dialog for the job
whose definition includes the dependency will show which dependency
was overridden.

155

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Estimated and Excessive Durations


Twoofthemostcommonquestionsaskedofsystemoperatorsand
schedulersareHowlongisthisjobgoingtorun?andWhichjobisgoing
torunnext?Tohelpanswerthesequestions,Schedulerprovidesthe
EstimatedDurationfeature.
Whenajobenterstheproductionscheduleforthefirsttime,ifanestimated
durationtimeisspecifiedintheJob Definitiondialog,thattimewillbe
displayedinthe Job Activity pane.TheEstimated Duration Timevalueis
automaticallyupdatedaftereachjoboccurrenceruns,creatingahistorical
averagethatisusedforsubsequentsubmissions.Ofcourse,youcan
overridethisvalueinthejobdefinitionatanytime.
Forunattendedoperations,youmaywantajob:

156

toterminateifitrunsoveritsmaximumtime

tonotifyanoperatorifitcompletesunderitsminimumtime

toperformotheractionsautomatically

11
MANAGING COMMAND
PARAMETERS

TOPICS

COVERED IN THIS CHAPTER


Overview (page 158)
Passing Command Parameters (page 159)
Tracking Methods (page 162)

157

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
Thischapterdescribeshowto:

Passcommandparameterstoanexecutable

Determinethejobcompletionstatusbasedonthejobsoutput

Definecommandparametersandenablealternativetrackingmethods

Inthischapter,youwillcreatetwojobs(Report Writer 1 andReport


Writer 2)thatusethesamebatchfilebutwithdifferentcommand
parameters.Thecommandiscodedtoechothecommandparameterstothe
output.Youusetheechoedvaluetodeterminethesuccessorfailureofthe
job.Thisexampleservestodemonstratetwoimportantfeatures:passing
inputanddeterminingthejobssuccessbyexaminingtheoutput.
Caution

158

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)

Select the Super User option in your User definition

Configure a default agent

Create and have available the work day calendar

Chapter 11 Managing Command Parameters


Passing Command Parameters

Passing Command Parameters


Thecommandparametersfeatureallowsyoutopassinformationtoa
commandwhenitislaunchedbyScheduler.Youcanalterparameterssuch
asdatesorotherdataatruntime,ratherthanhardcodingthecommandfile
itself.Youcanalsouseparameterstoaddflexibilitytothesamecommand.
Forexample,youmayhaveabatchfilethatcanprocessseveralfiles.By
specifyingitsfilenameasacommandparameter,thebatchfileknows
whichfiletoprocessatanygiventime.
SchedulerusesthestandardMSDOSorcommandpromptsyntaxfor
commandparameters.Thecommandparametersaresubstitutedintoa
commandfilecontainingthevariablenames%1,%2,etc.Throughthe
DOSprompt,parametersarepassedasalistofvaluesseparatedbyspaces
afterthecommand.InScheduler,thecommandparametersaredisplayedin
alistbelowthecommand.Thefirstvaluereplaces%1,thesecondvalue
replaces%2,andsoon,whenthebatchfileisexecuted.

Specifying Command Parameters and Viewing the Batch File


AfterspecifyingcommandparametersintheJob Definitiondialog,
sometimesitisusefultovieworeditthebatchfiletowhichthecommand
parametersapply.
X

To view or edit the batch file to which the command


parameters apply:

FromtheNavigatorpane,selectDefinitions>JobstodisplaytheJobs
pane.

ClicktheAdd Job button intheSchedulertoolbarorrightclickand


selectingAdd JobfromthecontextmenutodisplaytheJob Definition
dialog.

159

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 115 Specifying Command Parameters in the Commands


Field
3

YouspecifycommandparametersfromtheCommand Parameters
sectionintheProgramtab.
Clicktheellipsisbutton

160

intheCommandfield.

FromtheTutorialdirectory,rightclicktheArgdemo batchfileand
selectEditfromthecontextmenu.

Chapter 11 Managing Command Parameters


Passing Command Parameters

Figure 116 Editing a Script or Batch File

TheMicrosoftNotepadtexteditoropensthebatchfileandyouseethe
batchfiletextasshownbelow.Thecommandparametersspecifiedin
theJob Definitiondialogwillbeenteredintothebatchfileinthe
locations%1,%2,etc.

Figure 117 Argdemo.bat in Notepad Editor

161

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
5
Note

ExitNotepadandclickCanceltwicetoreturntotheJobspane.
For more information on batch processing, please refer to your
Windows or DOS documentation.

Tracking Methods
Ajobscompletionstatusisdeterminedbyitsexitcode.Theexitcodecanbe
setbyusingtheocsexitcommandattheendofabatchfile.Usingocsexit
tofacilitatejobtracking,thecompletionstatusofajobcanbe:

Completed Normallyindicatedbyanexitcodeof0tonotifythatthe

jobsucceeded

Completed Abnormallyindicatedbyanexitcode0tonotifythatthe

jobran,butfailed.
Note

Completion statuses of Skipped, Orphaned, Error Occurred and


Externally Defined are also possible but are not determined by the
exit code.

Thecompletionstatusisfrequentlyusedtocontroldependencies.For
example,youcansetupjobsthatrunifitspredecessorcompleteswitha
CompletedNormallystatus.
Schedulersupportsfourothertrackingmethods:

ExternalYoucanusethisoptionifyouneedtoinspectthejobbefore

determininghowthejobcompleted.SchedulersetsthestatustoSet
Externallywhenthejobcompletes.

162

Exit Code of cmd pipeYoucanusethisoptiontopipetheoutputof


yourjobasaninputtoacommand,suchastheWindowsFind
commandorotheroutputanalysistool.Schedulerthenusesthat
commandsexitcodeasthejobsexitcode.Youmusttypethe
commandthatinvokestheassociatedtool.

Scan Output: Normal StringSelectthisoptiontouseaparticular


textstringinthejoboutputtodetermineifthejobcompletednormally.
Entertheexacttextthatdeterminesnormalinthetextboxbelow.

Scan Output: Abnormal StringSelectthisoptiontouseaparticular


textstringinthejoboutputtodetermineifthejobcompleted
abnormally.Entertheexacttextthatdeterminesabnormalinthetext
boxbelow.

Chapter 11 Managing Command Parameters


Tracking Methods

ThetrackingselectionsarelocatedintheTrackingsectionoftheRuntabin
theJob Definition dialog.

Figure 118 Specifying Tracking in the Job Definition Dialog, Run Tab

Using the Exit Code


Inthissection,youwillcreateaReportingjobgroupwithtwojobs,Report
Writer 1andReport Writer 2. Eachjobwillusethesamecommand,but
willpassadifferentcommandparameter.Thecommandparameteristhen
echoedintheoutputofbothjobsaftertheycomplete.
Todeterminewhetherthejobscompletedsuccessfullyornot,bothjobswill
usetheExit code of cmd pipetrackingmethodusingtheWindowsFind
commandtosearchforthesavedoutput.TheresultoftheFindcommand
willdeterminethejobsfinalstatus.
YouwillsetupReport Writer 1 tosucceed,andReport Writer 2tofail.
YoudothisbysettingthecommandparameterforjobReport Writer 1to
OKandtheparameterforReport Writer 2 toFAILED.

163

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Creating the Reporting Job Group


X

To create the reporting job group:

FromtheNavigatorpane,selectDefinitions>JobstodisplaytheJobs
pane.

ClicktheAdd Job Groupbutton


Groupfromthecontextmenu.

Inthe Job Group Name field,enterReporting.

ClicktheScheduletab,ifnotalreadyselected.

FromtheCalendar Namelist,selectwork day.

orrightclickandselectAdd Job

Figure 119 Job Group Definition Dialog, Schedule Tab


6

ClickOKtosavethejobgroup.

ClickCancelattheEffective Datedialog.

Note

164

If you click OK at this dialog, the job group enters the production
schedule, but nothing will run because there are no jobs associated
with the job group yet. Clicking Cancel means the job group will be
added to the schedule manually.

Chapter 11 Managing Command Parameters


Tracking Methods

Setting the Report Writer 1 Job to Succeed


X

To set the Report Writer 1 job to succeed:

RightclicktheReportingjobgroupandselectAdd>Job fromthe
contextmenu.

Figure 120 Adding a Job to the Reporting Job Group


2
3

IntheJob Namefield,enterReport Writer 1.


Clicktheellipsesbutton

intheCommandfieldtodisplaytheSelect

Programdialog.

FromtheTutorialdirectory,doubleclicktheArgdemo batchfile.

EnterOKintheCommand Parameters field.ThispassesasArgument


1 (%1)tothebatchfile.

ClicktheRuntab.

Inthe Trackingsection,selecttheExit code of cmd pipeoption.

165

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
8

Inthetextfieldbelow,typeFind OK.ThistellsSchedulertosearch
throughtheoutputofthejobforthestringOK.SinceOKispassed
asacommandparameter,itwillappearintheoutput.

Figure 121 Specifying Exit Code of cmd pipe in Tracking Section


9

ClickOK.

10 ClickCancelintheEffective Datedialog.Thisjobwillenterthe

schedulewhenmanuallysubmititsjobgroup.

Setting the Report Writer 2 Job to Fail

166

To set the Report Writer 2 job to fail:

Rightclickthe Report Writer 1 jobinthejobsview.

SelectCopy Job/Group fromthecontextmenu.

DoubleclicktheCopy of Report Writer 1 jobtoopenitsdefinitionfor


editing.

IntheJob Namefield,changeCopy of Report Writer 1toReport


Writer 2.

Chapter 11 Managing Command Parameters


Tracking Methods
5

IntheCommand Parametersfield,changeOKtoFAILED.

Figure 122 Passing the FAILED Command Parameter

TheRuntabshouldcontainFind OKintheTrackingsection.This
wasinheritedwhenyoucopiedthejob.
6

ClickOK.

ClickCancelattheEffective Datedialog.

Adding the Reporting Job Group to the Production Schedule


X

To add the Reporting job group to the production schedule:

RightclicktheReportingjobgroup.

SelectInsert Job into Schedulefromthecontextmenu.

167

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 123 Insert Into Schedule


3

ClickOKinthe Insert Job Into Schedule dialog.

ClickOKintheInformationdialog.
Thejobsstartwithonecompletingnormallyandtheothercompleting
abnormally.ThejobgroupresultsinaCompleted Abnormallystatus
becauseoneofitsjobscompletedabnormally.

Setting Report Writer 2 to Complete Normally

168

To set Report Writer 2 to Complete Normally:

IntheJob Definition dialog,doubleclicktheReport Writer 2 job.

IntheJob Definition dialog,changetheCommand Parametervalue


fromFAILEDtoOK.

ClickOK.

ClickOKattheEffective Datedialog.

ResubmitthejobsbyaddingtheReportingjobgroupusingthe
Insert into Scheduleoption,fromtherightclickcontextmenuor
selectingtheoptionfromtheActionsmainmenu.

Chapter 11 Managing Command Parameters


Tracking Methods
6

ClickOKwhentheInsert Job Into Scheduledialogdisplays.

ClickOKintheInformationdialog.
BothReport Writer 1 andReport Writer 2completesuccessfully.

169

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

170

12
SETTING UP QUEUES

TOPICS

COVERED IN THIS CHAPTER


Overview (page 172)
Setting Up the Inventory Weekly Job Group (page 174)
Setting Up a Queue (page 178)

171

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
Thischapterexplainshowtosetupqueuessothatyourjobsrunefficiently
onyournetwork.Jobsenterqueueswhentheirdependenciesaremetand
arereleasedfromaqueuebythemaster.Inthepreviouschapters,thejobs
youcreatedranfromthedefaultqueues.
Queuesaremosteffectivewhenmorejobsarescheduledthanyouhave
resourcestohandlethem.Eachqueuehasajoblimitandaprioritythat
helpstodeterminefromwhichqueuejobsarelaunched.Whenaqueues
limitisreached,Schedulerselectsthenextqueuetorunjobsonaccordingto
queuepriorities.Withinaqueue,ajobsindividualprioritydetermines
whichjobinthequeueislaunchedfirst.
Queuesaredefinedinahierarchy,withtheSystem Queueatthetop.
ToviewSchedulerspredefinedjobqueues,selectScheduling>Queuesin
theNavigatorpane.

Figure 124 Queues Pane

Eachqueuecontainsasetofqueuefilters.Queuefiltersaredesignedto
acceptorrejectjobsbasedontheirproperties.

172

Chapter 12 Setting Up Queues


Overview

Besidesprioritizingtheexecutionoflargequantitiesofjobs,queuescanbe
usedforanumberofotherpurposes:

Tolimitthenumberofjobsofaparticulartypeorgrouprunning
concurrently

Tocontroltheflowofjobsexecuted,overallorbyanindividualqueue,
sothatsystemresourcesareusedmoreevenlyandpeakdemandsare
reduced

Tosinglethreadjobsrequiringaparticularresource,suchasexclusive
accesstoadatabase

Torestrictthehourswhenjobsruntoatimewindowdefinedbythe
queue,forexample,toallowbatchprocessingtooccurovernight

Tolaunchjobsimmediatelyforspecialcaseswhereitisrequired

Thischaptercovers:

SettinguptheInventory Weeklyjobgroup

CreatingthreejobsfortheInventory Weeklyjobgroup

Settingupaqueue

AddingtheInventory Weeklyjobgrouptoproduction

Monitoringthejobgroupinproduction

Changingthequeuelimit

ResubmittingtheInventory Weekly jobgroup

Caution

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)

Select the Super User option in your User definition

Configure a default agent

Create and have available the work day calendar

173

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Setting Up the Inventory Weekly Job Group


Inthisexample,wewilldesignaqueuetoacceptjobsofaparticularjob
group.Otherwise,therewillbenojobgrouptochoosefromwhenthe
queueiscreated.
X

To set up the Inventory Weekly job group:

FromtheNavigatorpane,selectDefinitions>Jobs todisplaytheJobs
pane.

RightclickintheJobspaneandselectAdd Job Groupfromthe


contextmenu.

Figure 125

174

Defining Inventory Weekly Job Group

IntheJob Group Namefield,enter Inventory Weekly.Makesurethe


Parent Groupfieldisempty.

ClicktheScheduletab,ifnotselected.

IntheCalendarlist,selectthework daycalendar.

ClicktheOptionstab.

SelecttheRequire operator releaseoption.

Chapter 12 Setting Up Queues


Setting Up the Inventory Weekly Job Group
8

ClickOK.

ClickCancel attheEffective Datedialog.(Thejobgroupshouldnot


enterthescheduleyet.)

Creating Jobs for the Inventory Weekly Job Group


Now,wewillcreatethreejobs(Inventory_10,Inventory_11and
Inventory_12)thatbelongtotheInventory Weeklyjobgroup,withno
dependencies.
X

To create jobs for the Inventory Weekly job group:

IntheJobspane,selecttheInventory Weeklyjobgroup.

ClicktheAdd Jobbutton
orrightclickandselect Add Job fromthe
contextmenutodisplaytheJob Definition dialog.

Figure 126

Job Definition Dialog

IntheJob Name field,enterInventory_10.

VerifythatInventory Weeklyisdisplayedinthe Parent Grouplist.If


not,selectit.

175

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
5

Clicktheellipsisbutton
Program dialog.

FromtheTutorial directory,doubleclicktheInv10batchfile.

ClicktheNotestab.WewillusetheNotestabtoenterashort
descriptionofthejob.

intheCommandfieldtodisplaytheSelect

TheNotestabisagoodplacetoaddspecialinstructionsor
explanatorycommentswithoutaffectingthejobsexecution.
8

IntheOther Notesfield,enterInventory Processing Program.

Figure 127
9

Inventory_10 Job Definition Dialog, Notes Tab

ClickOK.

10 ClickCancelattheEffective Datedialog.

176

Chapter 12 Setting Up Queues


Setting Up the Inventory Weekly Job Group

Duplicating a Job Definition


X

To duplicate a job definition:

SelecttheInventory_10 jobintheJobspaneifnotalreadyselected,
andeitherclicktheCopy Job/Groupbutton orrightclickand
selectCopy Job/Groupfromthecontextmenu.
AjobdisplaysintheJobspanenamedCopy of Inventory_10.

DoubleclickCopy of Inventory_10 andrenameittoInventory_11.

IntheCommandfield,changeInv10.battoInv11.bat usingthe
Select Program dialog.

ClickOK.

ClickCanceltopreventthejobfrombeingscheduled.

RepeatthestepsabovetocreateathirdjobcalledInventory 12
selectingthe Inv12.bat fileinthe Command field.

177

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Setting Up a Queue
WewillsetupaqueuenamedInv_Weeklyandgiveitaqueuelimitof
three.ThejobsintheInventory Weeklygroupwillruninthisqueue.The
queueconfigurationparameterswillsinglethread(runoneatatime)the
jobsinthegroup.
X

To set up a queue:

FromtheNavigatorpane,selectScheduing>Queuestodisplaythe
Queuespane.

RightclicktheSystem QueueandselectAdd Queuefromthecontext


menutodisplaytheQueue Definitiondialog.

Figure 128

178

Adding a Queue

Chapter 12 Setting Up Queues


Setting Up a Queue

Figure 129

Queue Definition Dialog

IntheQueue Name field,enterthenameInv_Weekly.

LeaveSystem QueueintheParentfield.
WedefinedInv_Weekly asadirectsubqueueofthesystemqueuein
thequeuehierarchy.Thismeanstherearenointermediatequeuesto
imposetheirownrestrictionsandaffectjobexecution.

ChangetheLimitvalueto3. Thisallowsamaximumofthreejobsfrom
thisqueuetorunconcurrently.

ChangethePriorityvalueto60.
Defaultqueueshaveaprioritysettingof50.Sincedefaultqueuescan
acceptthejobsthatyoucreated,thishigherpriorityvaluewillensure
thatthejobsenterthisqueue.Whenthequeuemanagerseestwoor
morequeuesthatcanacceptajob,italwaysassignsthejobtothequeue
withthehighestpriority.

179

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
7

OntheFilterstab,clicktheAdd button todisplayalistandselectJob


Group.
TheQueue Filter Conditiondialogdisplays.

Figure 130

Queue Filter Condition Dialog

SelecttheInventory Weeklyjobgroup.

ClickOK.ThefilterisenteredintotheFilterstab.

Figure 131

Queue Definition Dialog

TheAlwaysoptionintheHours Available sectionshouldbeselected


bydefault.ThismeansthattheInv_Weeklyqueuecanrunatany
time.IfyoudeselecttheAlwaysoption,youcanrestrictthequeueto

180

Chapter 12 Setting Up Queues


Setting Up a Queue

operatewithinaspecifictimewindow.Jobsassignedtothequeue
wouldthenrunonlyifthecurrenttimewerewithinthattimewindow.
10 ClickOK.Inv_Weeklyisaddedtothelistofqueuesonyoursystem.

Figure 132

Inv_Weekly Queue Displayed in the Queues Pane

181

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Adding the Inventory Weekly Job Group to Production


Now,submitthegroupInventory Weeklyintotheproductionschedule.
X

To submit the group into the production schedule:

IntheJobspane,rightclicktheInventory Weekly jobgroupand


selectInsert into Schedule fromthecontextmenu.

Figure 133

Inserting the Inventory Weekly Job Group into


Production

ClickOKintheInsert Job Into Schedule dialog.

ClickOKintheInformationdialog.

Monitoring the Job Group in Production


X

To monitor the job group in production:

FromtheNavigatorpane,selectOperations>Job Activity todisplay


theJob Activity pane.
YourjobgroupislistedinboldshowingtheWaiting On Operator
status.

182

Rightclickthe Inventory WeeklyjobgroupandfromtheJob Control


submenu selectRelease/Resumetostartthejobgroup.

ClickYesintheConfirmdialog.

ClickOKintheInformationdialog.

Chapter 12 Setting Up Queues


Setting Up a Queue

Figure 134

Job Activity Pane Showing All Three Jobs Starting At


Once

TheInventory Weeklyjobgroupgoesactive,alongwiththethree
jobs:Inventory_10,Inventory_11,andInventory_12.Becausethe
limitontheInv_ Weeklyqueueissetto3,allthreejobsinthegroup
Inventory Weeklyarelaunchedatonce,andnowruntocompletion.
5

ScrolltotherightintheJobspanetoviewtheQueuecolumn.
NotethattheInventory_10,Inventory_11andInventory_12jobs
arerunningfromtheInv_Weeklyqueue.

183

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 135

Job Activity Pane Showing All Jobs Running From Same


Queue

Changing the Queue Limit


Changingthequeuelimitfromanynumberto1 changesthequeuefrom
multipletosinglethreadedprocessing.

184

To change the queue limit:

FromtheNavigatorpane,selectDefinitions>Queuestodisplaythe
Queuespane.

DoubleclicktheInv_Weeklyqueuetodisplayitsdefinitiondialog.

LowertheLimitfrom3to1.

ClickOKtosavethechanges.

ThelimitchangeisdisplayedintheQueuespane.

Chapter 12 Setting Up Queues


Setting Up a Queue

Figure 136

Modifying the Inv_Weekly Queue

Re-submitting the Inventory Weekly Job Group


NowweresubmittheInventory Weeklyjobgroupintotheproduction
schedule.
X

To re-submit the job group:

FromtheNavigatorpane,selectDefinitions>JobstodisplaytheJobs
pane.

RightclicktheInventory Weeklyjobandfromthecontextmenu
selectInsert Job into Schedule.

ClickOKintheInsert Job Into Schedule dialog.

ClickOKintheInformationdialog.

FromtheNavigatorpane,selectOperations>Job Activitytodisplay
theJob Activity pane.
Youcannowseeanotheroccurrenceofyourjobgroupanditsjobsin
theJob Activitypane.

ClickthenewoccurrenceoftheInventory Weekly jobgroup.

185

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
7

RightclicktheoccurrenceoftheInventory Weekly andselectJob


Control fromthecontextmenu.

SelecttheRelease/Resumeoption.

ClickYesintheConfirmdialog.

10 ClickOKintheInformationdialog.

TheInventory Weeklyjobgroupgoesactive,andthejobswithinthegroup
runagaininnoparticularorder.Thistime,however,theyrunoneatatime
becausetheirassignedInv_Weeklyqueuehasalimitof1.Whiletheyare
running,ifyouinsertorrerunanyotherjobontheschedulethatbelongsto
adifferentqueue,itrunsimmediatelysinceitdoesnotbelongtothe
Inv_Weeklyqueueandisnotrestrictedbyitslimit.

186

13
REVIEWING THE
DASHBOARD

TOPICS

COVERED IN THIS CHAPTER


Overview (page 188)
Customizing the Display (page 188)

187

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
TheDashboardisacentralizedmanagementviewofjobsummary
information.Itconsistsofcustomizedgraphs,chartsandtablesshowingthe
currentproductionscheduleorresultsfrompreviousdays.

Customizing the Display


TheDashboardisdividedintotworowsconsistingofscrollingpanesof
information.Thelocation,titleandsizeofthepanesareconfigurable,asare
thetypeandfilter(s)foreachpane.
ThefollowingarethefivepanetypesthattheDashboardsupports.Each
panetypecanbeusedasatemplatetocreatedifferentpanesshowing
exactlytheinformationyouwanttosee.
Table 7

Dashboard Pane Types

Type

Description

Pane Configuration

StatusBreakdown Displaysasnapshotofjob Filterjobsbyjobclass,agent,


statusesinpiechartformat. queue,scheduledor
unscheduledandstatus.

188

AlertsBreakdown Displaysasnapshotof
Alertstatusesinbarchart
format.

Filteralertsbystatusandseverity
level.

JobStatistics

Displaysatableofkeyjob
statuscountsand
percentages.

Filterjobsbyjobclass,agent,
queue,scheduledor
unscheduledandstatus.

JobActivity

Displaysalinechartofjob
activityoverthecourseof
thedayin15minute
intervals.

Filterjobsbyjobclass,agent,
queue,scheduledor
unscheduledandstatus.

JobProgress

Displaysoveralljob
executionprogressona
meter.

Filterjobsbyjobclass,agent,
queue,scheduledor
unscheduledandstatus.

Chapter 13 Reviewing the Dashboard


Customizing the Display

Youcanconfigureseveralcustomizedpanesofthesametypetoviewjobsof
aparticularclass,agentorqueue.Forexample,supposeyouhavefive
agents,andyouwanttomonitorthenumberandstatusesofjobsrunning
oneach.UsingtheStatus Breakdownpanetype,youcancreatefivepanes
usingadifferentagentasafilterforeach.Thedisplayisupdatedevery20
seconds.
Inthisexerciseyouwillcreateandeditanewpane,andcompareittoan
existingdefaultpane.
Caution

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)
Select the Super User option in your User definition
Configure a default agent
Create and have available the work day calendar

Viewing the Dashboard


FromtheFilemenu,selectDashboard.ThedefaultDashboardviewis
displayed.

Figure 137 Default Dashboard View

189

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Editing the Dashboard View


X

To edit the Dashboard view:

FromtheDashboard,clicktheConfigure Dashboard button


displaytheDashboard Panesdialog.

to

Figure 138 Dashboard Panes Dialog

190

IntheTop Dashboard Rowsection,clearthecheckboxesforthe


Overall Status BreakdownandOverall Alert Breakdownpanes.

ClickOK.TheOverall Status BreakdownandOverall Alert


BreakdownpanesdisappearfromtheDashboardview.

Chapter 13 Reviewing the Dashboard


Customizing the Display

Figure 139 Dashboard with missing two default panes

Adding a New Pane to the Dashboard


X

To add a new pane to the Dashboard:

FromtheDashboard,clicktheConfigure Dashboard button


displaytheDashboard Panesdialog.

IntheTop Dashboard Row section,clicktheAddbutton.

SelecttheStatus Breakdown option.TheDashboard Pane Definition


dialogdisplays.

to

191

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 140 Dashboard Pane Definition Dialog


4

InthePane Titlefield,typeInv Weekly.IntheQueue list,selectInv_


Weekly.(Thesestepsareonlyapplicableifyouhavealreadycreateda
queuecalledInv Weekly.)

ClickOK.
YounowhaveanewpanecalledInv Weekly.Thenewpanewill
displaytheproductionstatusbreakdownforjobsassignedtotheInv
Weekly queue.

IntheTop Dashboard Rowsection,selectOverall Status Breakdown


option.

ClickOK.
YounowhaveanewlyaddedDashboardpanecalled Inv Weekly,and
youhavereshowntheOverall Status Breakdownpane.Now
comparetheinformationoftheInv WeeklypanetotheOverall
Status Breakdownpane.

192

Chapter 13 Reviewing the Dashboard


Customizing the Display

Figure 141 Dashboard With Added Inv_Weekly Pane

Asyoucansee,thethreejobsthatenteredthequeueInv Weeklyhave
runandcompletednormally,whiletheOverall Status Breakdown
paneshowsjobscompletingwithnormalstatuses.

Editing a Dashboard Pane


X

To edit a Dashboard pane:

ClicktheInv_WeeklypaneandselectEdit Panefromthecontext
menutodisplaytheDashboard Pane Definition dialog.

IntheStatuseslist,cleartheCompleted Normally option.


Thispanewilldisplaystatusinformationforalljobsexceptjobsthat
havecompletednormally.

ClickOK.
ViewtheInv_Weeklypaneandnoticethatitnolongershowsjobsthat
havecompletednormally.

193

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Figure 142 Inv_Weekly Pane Showing All Jobs That Did Not
Complete Normally

YouhavejustlearnedhowtoviewtheDashboard,andconfigureitspanes.
YouthencreatedthepaneInv_WeeklyanddisplayeditinDashboard,
madeeditstoit,andcomparedittotheOverall Status Breakdownpane.

194

14
USING SCHEDULER AGENTS

TOPICS

COVERED IN THIS CHAPTER


Overview (page 196)
Defining An Agent Connection (page 197)
Adding a Job that Requires Operator Release (page 199)
Adding an Agent Job Dependency (page 200)
Releasing the Agent Jobs (page 203)
Summary (page 203)

195

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

Overview
IfyouhaveinstalledtwoormoreTidalAgentsforWindowsonseparate
machines,youcanperformtheproceduresinthischapter.Ifyouhaveonly
oneagent,youmaystillwanttoreadthischaptertounderstandhowother
agentsareintegratedinScheduler.
Inpreviousexercises,youscheduledjobstorunontheSchedulermaster
systemwhichincludedanagentofitsown.Youcanalsorunjobson
multipleexternalagents.Agentsletyouexpandyourcomputingpowerand
flexibility,helpingyougetjobsdonemorequicklyandefficiently.
ForaSchedulermastertorecognizeanagent,theScheduleragentsoftware
mustbeinstalledonthatagentmachine,andavalidlicensefilemustexist
foritonthemaster.Refertotheinstallationguideformoreinformationon
licensingandregisteringagents.
TheSchedulermasterprovidescentralizedcontroloverschedulingina
distributedcomputingenvironment.Thereisnolimitonhowmanyagents
youcanattachtoamaster,ifyourlicensecontainstheunlimited(floating)
provisionforagents.Youcanalsoscheduleajobtorunonanyagentinyour
network.
Schedulerletsyougroupmultipleagentsintosetscalledagentlists.When
youassociateoneoftheselistswithajob,Schedulerlaunchesthatjob
dependingonthetypeoflist:

Ordered ListRunsonthefirstagentavailableinthelist,chosen
sequentiallyfromthetopofthelist

Balanced ListRunsontheagentwiththelightestloadatthetimethe

jobisreadytorun.

Random ListRunsonanagentpickedatrandomfromthelist.

Rotation ListRunsontheagentfollowingthelastagentusedfor

execution.

Broadcast ListRunsonallagentsinthelist.

Inthischapter,youlearnhowtorunajobonanexternalagent.Youwill
alsolearnhowtocreateaninteragentdependency,thatis,adependencyon
ajobthatrunsonadifferentmachine.Wewilladdanagentandrunajob
thatislocatedonit.

196

Chapter 14 Using Scheduler Agents


Defining An Agent Connection

Caution

To complete the exercises in this tutorial, you need to:

Install Scheduler in the default directory Scheduler (or the examples in


this tutorial will not work properly)
Select the Super User option in your User definition
Configure a default agent
Create and have available the work day calendar

Defining An Agent Connection


X

To define an agent connection:

FromtheNavigatorpane,selectAdministration>Connectionsto
displaytheConnectionspane.

DoubleclicktheagentconnectiontodisplaytheConnection
Definitiondialog.

Figure 143 Connection Definition Dialog

197

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
3

ClicktheConnectiontab.

Figure 144 Connection Definition Dialog, Connection Tab


4

IntheMachine Namefield,enterthemachinewiththeScheduler
agentinstalledonit.

IntheMaster-to-Agent Communication Portfield,entertheagents


listenerportnumberusedduringagentinstallation.Thedefaultport
numberforthefirstagentis5912butforsubsequentagent
installationsuseanincrementedportnumber(e.g.,5913forthe
secondagent,etc.).

SelecttheEnabled option,ifnotalreadyselected.

ClickOK.
Theagentwillbegintheconnectionprocess.Theagentstatuslightat
thebottomoftheclientisyellowuntiltheagentisconnected.The
statuslightthenturnsgreen.Thisnormallytakesabout45secondsor
less.

198

Chapter 14 Using Scheduler Agents


Adding a Job that Requires Operator Release

Adding a Job that Requires Operator Release


X

To add a job that requires operator release:

FromtheNavigatorpane,selectDefinitions>JobstodisplaytheJobs
pane.

ClicktheAdd Job button

todisplayaJob Definitiondialog.

Figure 145 Job Definition Dialog


3

IntheJob Namefield,enter Agent_Job1.

IntheCommandfield,clicktheellipsesbutton
Programdialog.

Navigatetothe Tutorial directoryandselectthe Inv21.bat file.

ClicktheScheduletabandselectwork day fromthe Calendar Name


list.

ClicktheRuntabandfromtheAgent Name list,selecttheremote


agentyouaregoingtouse.

ClicktheOptionstabandselecttheRequire operator releaseoption.

ClickOKtoclosethedialog.

todisplaytheSelect

199

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
10 ClickOK todisplaytheEffective Datedialog.

ThejobisplacedintheproductionschedulewithaWaiting on
Operator status.Wewillreleasethisjob,butfirstletscreateajobwith
adependencyonthisjobtoshowtheagentdependencyfeature.

Adding an Agent Job Dependency


Inthissection,youdefinearemoteagentjobdependency.Youwilluse
Agent_Job1,createdinthepreviousexercise,inthedependencycondition
forthenewjob.Definingajobthatdependsonajobrunbyaremoteagent
isthesameasdefininganyotherjobdependency.

200

To add an agent job dependency:

ClicktheAdd Job button

IntheJob Name field,enterAgent_Job2.

FromtheCommandfield,clicktheellipsisbutton
Select Programdialog.

DoubleclicktheInv22batchfileintheTutorialdirectory.Thisenters
thecommandfilenameintotheCommand Name field.

ClicktheScheduletabandintheCalendar Name list,selectthework


daycalendar.

ClicktheRuntabandselecttheagentthatexistsonthemaster.

OntheDependenciestab,clicktheAddbuttonandselectAdd Job
DependencyfromthelistofoptionstodisplaytheJob Dependency
Definitiondialog.

todisplayaJob Definitiondialog.

todisplaythe

Chapter 14 Using Scheduler Agents


Adding an Agent Job Dependency

Figure 146 Selecting Add Job Dependency


8

IntheJob/Group list,selecttheAgent_Job1job.

Figure 147 Job Dependency Definition Dialog


Note

Only jobs that have already been defined will appear in the menu. If
you have not defined any jobs, none will appear.

201

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows
9

ClickOKtoclosetheJob Dependency Definition dialog.Thisaccepts


thedefaultdependencycondition.
TheAgent_Job1jobdependencyappearsintheDependencysection.

Figure 148 Agent_Job1 Dependency


10 ClickOKtoclosetheJob Definition dialog.
11 ClickOKagainintheEffective Datedialog.

Whenthedialogcloses,theAgent_Job2jobappearsintheJobspane.

202

Chapter 14 Using Scheduler Agents


Releasing the Agent Jobs

Releasing the Agent Jobs


X

To release the Agent jobs:

FromtheNavigatorpane,selectOperations>Job Activity todisplay


theJob Activity pane.

SelecttheAgent_Job1job.

Rightclickthejob,andthenselectJob Control>Release/Resume
fromthecontextmenutoreleaseAgent_Job1fromtheWaiting on
Operator status.

ClickYesintheConfirmdialog.

ClickOKintheInformationdialog.
TheAgent_Job1runsontheexternalagent.Whenitcompletes
successfully,theAgent_Job2 runsonthelocalagent.

Summary
Congratulations!Withthecompletionofthischapter,youhavebuiltagood
foundationofknowledgeaboutScheduler.YouarereadyforSchedulerto
increaseandcomplementyourproductivity.
Ifyouneedanyfurtherinformationortraining,contact
support@tidalsoftware.com.

203

Tidal Enterprise Scheduler Version 5.3


Tutorial Guide-Microsoft Windows

204

2100 Geng Road, Suite 210


Palo Alto, CA 94303
support@tidalsoftware.com
www.tidalsoftware.com

Tidal Product Doc Covers 7x9.ind1 1

4/6/06 9:41:23 AM