issue #31 template example

main/}bedrock.chore.execution.check.pro

@@ -4,7 +4,7 @@
 586,
 585,
 564,
-565,"rDv9z?c`Uh]WWtXAoqake_3Vp5E\`Tf5A1g21YpjKdL1P8>HEycM<\s3J:i3<2l9xJw[PF_T8ezxezwavDvFNkJ<tPl=GjjuGTr5tlecwlB[h_8_CNC9G;AFVp6h^[=@mp]fTxD>^enWu`Ph2::x:M7wI:S>@589WAyjNgy7EQ:AY:yPWZea_btAWyfN8GoetHZZ_vVE"
+565,"tx3Udn0LYhpGbmed11HiaVSmoLvLQqaoj2R@Qi=wQVxjp6zJXzsJsC7>8AGPQF<Ix02=tfovj9KYmhp<SX0je[M6czy6GGw>y@zYTsmzJxj\1O3:8zqyZDv0of=mms2y7\DUzKuD5dHH_FTF=?m`iP[y5ZDl[@Ig_=ty_HBMlL^<muirxTmGvoRIOD^AicZ3MGWAJzDZ"
 559,1
 928,0
 593,
@@ -60,8 +60,19 @@ pEndTime,"Optional: Time to finish chore being able to start in 24 hr time (Blan
 581,0
 582,0
 603,0
-572,185
-
+572,196
+#Region CallThisProcess
+# A snippet of code provided as an example how to call this process should the developer be working on a system without access to an editor with auto-complete.
+If( 1 = 0 );
+ExecuteProcess( '}bedrock.chore.execution.check', 'pLogOutput', pLogOutput,
+    'pMonthDays', '',
+    'pWeekDays', '',
+    'pDelim', '&',
+    'pStartTime', 0,
+    'pEndTime', 24
+);
+EndIf;
+#EndRegion CallThisProcessExample
 #****Begin: Generated Statements***
 #****End: Generated Statements****
 
@@ -76,17 +87,17 @@ pEndTime,"Optional: Time to finish chore being able to start in 24 hr time (Blan
 # The chore would then kick off every day but this TI will perform a ProcessExitByChoreQuit function on all days NOT mentioned in pWeekdays.
 
 # Use case: For productive systems.
-# 1/ A chore should run every 30 minutes between 8am & 8pm on weekdays. Schedule chore for every 30 minutes and include this process 1st in chore with parameters pWeekDays=MON&TUE&WED&THU&FRI pStartTime=8 pEndTime=20.
-# 2/ A chore should run only on 1st calendar day of each month. Schedule chore for daily execution and include this process 1st in chore with parameters pMonthDays=1.
+# 1. A chore should run every 30 minutes between 8am & 8pm on weekdays. Schedule chore for every 30 minutes and include this process 1st in chore with parameters pWeekDays=MON&TUE&WED&THU&FRI pStartTime=8 pEndTime=20.
+# 2. A chore should run only on 1st calendar day of each month. Schedule chore for daily execution and include this process 1st in chore with parameters pMonthDays=1.
 
 # Note:
-# This process will quit a chore if any time bound conditions which define when the chore should NOT run are met.
-# Specify only the parameter(s) needed.
-# The intention is to only quit on scheduled execution. The checks are bypassed if a chore is manually executed by a user. This is done by checking the TM1User function.
-# Time conditions are checked using these parameters in the following order of priority.
-#   pMonthDays              Days in month when chore is allowed to run. Enter delimited list of days e.g. 1&2&30&31 (blank = no restriction on allowed days of month).
-#   pWeekDays               Days in week when chore is allowed to run Enter delimited list of weekdays e.g. MON&FRI (blank = no restriction on allowed weekdays).
-#   pStartTime & pEndTime   Time of day when chore is allowed to run e.g. pStartTime=7, pEndTime=22 execution will be allowed between 7AM & 10PM ( blank = no time-bound restrictionss).
+# * This process will quit a chore if any time-bound, weekday-bound or date-bound conditions which define when the chore should NOT run are met.
+# * Only the parameter(s) needed shoudl be specified.
+# * Only scheduled executions will be quit outside the parameters. The checks are bypassed if a chore is manually executed by a user. This is done by checking the TM1User function.
+# * Time conditions are checked using these parameters in the following order of priority.
+#   1. pMonthDays : Days in month when chore is allowed to run. Enter delimited list of days e.g. 1&2&30&31 (blank = no restriction on allowed days of month).
+#   2. pWeekDays : Days in week when chore is allowed to run Enter delimited list of weekdays e.g. MON&FRI (blank = no restriction on allowed weekdays).
+#   3. pStartTime & pEndTime : Time of day when chore is allowed to run e.g. pStartTime=7, pEndTime=22 execution will be allowed between 7AM & 10PM ( blank = no time-bound restrictionss).
 #EndRegion @DOC
 
 ### Global Variables