Skip to content

Commit 47db8f0

Browse files
author
Yehonatan Bauminger
committed
Add Event Documentation
1 parent 8696520 commit 47db8f0

32 files changed

+566
-115
lines changed

‎docs/_sources/notebooks/jobproperties.ipynb.txt‎

Lines changed: 122 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"cells": [
33
{
4+
"attachments": {},
45
"cell_type": "markdown",
56
"metadata": {},
67
"source": [
@@ -17,6 +18,7 @@
1718
]
1819
},
1920
{
21+
"attachments": {},
2022
"cell_type": "markdown",
2123
"metadata": {},
2224
"source": [
@@ -97,6 +99,7 @@
9799
]
98100
},
99101
{
102+
"attachments": {},
100103
"cell_type": "markdown",
101104
"metadata": {},
102105
"source": [
@@ -203,6 +206,7 @@
203206
]
204207
},
205208
{
209+
"attachments": {},
206210
"cell_type": "markdown",
207211
"metadata": {},
208212
"source": [
@@ -214,6 +218,7 @@
214218
]
215219
},
216220
{
221+
"attachments": {},
217222
"cell_type": "markdown",
218223
"metadata": {},
219224
"source": [
@@ -243,6 +248,7 @@
243248
]
244249
},
245250
{
251+
"attachments": {},
246252
"cell_type": "markdown",
247253
"metadata": {},
248254
"source": [
@@ -266,6 +272,7 @@
266272
]
267273
},
268274
{
275+
"attachments": {},
269276
"cell_type": "markdown",
270277
"metadata": {},
271278
"source": [
@@ -289,6 +296,7 @@
289296
]
290297
},
291298
{
299+
"attachments": {},
292300
"cell_type": "markdown",
293301
"metadata": {},
294302
"source": [
@@ -311,6 +319,7 @@
311319
]
312320
},
313321
{
322+
"attachments": {},
314323
"cell_type": "markdown",
315324
"metadata": {},
316325
"source": [
@@ -333,6 +342,7 @@
333342
]
334343
},
335344
{
345+
"attachments": {},
336346
"cell_type": "markdown",
337347
"metadata": {},
338348
"source": [
@@ -356,6 +366,7 @@
356366
]
357367
},
358368
{
369+
"attachments": {},
359370
"cell_type": "markdown",
360371
"metadata": {},
361372
"source": [
@@ -380,6 +391,7 @@
380391
]
381392
},
382393
{
394+
"attachments": {},
383395
"cell_type": "markdown",
384396
"metadata": {},
385397
"source": [
@@ -436,6 +448,7 @@
436448
]
437449
},
438450
{
451+
"attachments": {},
439452
"cell_type": "markdown",
440453
"metadata": {},
441454
"source": [
@@ -447,6 +460,7 @@
447460
]
448461
},
449462
{
463+
"attachments": {},
450464
"cell_type": "markdown",
451465
"metadata": {},
452466
"source": [
@@ -482,6 +496,7 @@
482496
]
483497
},
484498
{
499+
"attachments": {},
485500
"cell_type": "markdown",
486501
"metadata": {},
487502
"source": [
@@ -500,6 +515,7 @@
500515
]
501516
},
502517
{
518+
"attachments": {},
503519
"cell_type": "markdown",
504520
"metadata": {},
505521
"source": [
@@ -518,6 +534,7 @@
518534
]
519535
},
520536
{
537+
"attachments": {},
521538
"cell_type": "markdown",
522539
"metadata": {},
523540
"source": [
@@ -536,6 +553,7 @@
536553
]
537554
},
538555
{
556+
"attachments": {},
539557
"cell_type": "markdown",
540558
"metadata": {},
541559
"source": [
@@ -554,6 +572,7 @@
554572
]
555573
},
556574
{
575+
"attachments": {},
557576
"cell_type": "markdown",
558577
"metadata": {},
559578
"source": [
@@ -572,6 +591,7 @@
572591
]
573592
},
574593
{
594+
"attachments": {},
575595
"cell_type": "markdown",
576596
"metadata": {},
577597
"source": [
@@ -597,6 +617,7 @@
597617
]
598618
},
599619
{
620+
"attachments": {},
600621
"cell_type": "markdown",
601622
"metadata": {},
602623
"source": [
@@ -618,6 +639,7 @@
618639
]
619640
},
620641
{
642+
"attachments": {},
621643
"cell_type": "markdown",
622644
"metadata": {},
623645
"source": [
@@ -640,6 +662,7 @@
640662
]
641663
},
642664
{
665+
"attachments": {},
643666
"cell_type": "markdown",
644667
"metadata": {},
645668
"source": [
@@ -660,6 +683,7 @@
660683
]
661684
},
662685
{
686+
"attachments": {},
663687
"cell_type": "markdown",
664688
"metadata": {},
665689
"source": [
@@ -671,6 +695,7 @@
671695
]
672696
},
673697
{
698+
"attachments": {},
674699
"cell_type": "markdown",
675700
"metadata": {},
676701
"source": [
@@ -694,6 +719,7 @@
694719
]
695720
},
696721
{
722+
"attachments": {},
697723
"cell_type": "markdown",
698724
"metadata": {},
699725
"source": [
@@ -717,6 +743,7 @@
717743
]
718744
},
719745
{
746+
"attachments": {},
720747
"cell_type": "markdown",
721748
"metadata": {},
722749
"source": [
@@ -741,6 +768,7 @@
741768
]
742769
},
743770
{
771+
"attachments": {},
744772
"cell_type": "markdown",
745773
"metadata": {},
746774
"source": [
@@ -767,6 +795,7 @@
767795
]
768796
},
769797
{
798+
"attachments": {},
770799
"cell_type": "markdown",
771800
"metadata": {},
772801
"source": [
@@ -792,6 +821,7 @@
792821
]
793822
},
794823
{
824+
"attachments": {},
795825
"cell_type": "markdown",
796826
"metadata": {},
797827
"source": [
@@ -816,6 +846,7 @@
816846
]
817847
},
818848
{
849+
"attachments": {},
819850
"cell_type": "markdown",
820851
"metadata": {},
821852
"source": [
@@ -843,6 +874,7 @@
843874
]
844875
},
845876
{
877+
"attachments": {},
846878
"cell_type": "markdown",
847879
"metadata": {},
848880
"source": [
@@ -852,6 +884,7 @@
852884
]
853885
},
854886
{
887+
"attachments": {},
855888
"cell_type": "markdown",
856889
"metadata": {},
857890
"source": [
@@ -877,6 +910,7 @@
877910
]
878911
},
879912
{
913+
"attachments": {},
880914
"cell_type": "markdown",
881915
"metadata": {},
882916
"source": [
@@ -903,6 +937,7 @@
903937
]
904938
},
905939
{
940+
"attachments": {},
906941
"cell_type": "markdown",
907942
"metadata": {},
908943
"source": [
@@ -932,12 +967,98 @@
932967
]
933968
},
934969
{
970+
"attachments": {},
935971
"cell_type": "markdown",
936972
"metadata": {},
937973
"source": [
938974
"## Variables\n",
939975
"\n"
940976
]
977+
},
978+
{
979+
"attachments": {},
980+
"cell_type": "markdown",
981+
"metadata": {},
982+
"source": [
983+
"## Events\n",
984+
"Events can be generated by Control-M or can trigger jobs. Events are defined by a name and a date.\n",
985+
"\n",
986+
"Here is a list of the various capabilities of event usages:\n",
987+
"\n",
988+
" A job can wait for events before running, add events after running, or delete events after running. See [WaitForEvents](#WaitForEvents), [AddEvents](#addevents), and [DeleteEvents](#deleteevents)\n",
989+
"\n",
990+
"You can set events for a Job, Folder, or SubFolder.<br>\n",
991+
"For \"Date\", you can use the following values:\n",
992+
"\n",
993+
"|Date Type | Description | \n",
994+
"| --------------- | --------------- |\n",
995+
"| AnyDate | Any scheduled date | \n",
996+
"| OrderDate | Control-M scheduled date.If you do not specify a Date value, this is the default. | \n",
997+
"| PreviousOrderDate | Previous Control-M scheduled date |\n",
998+
"| NextOrderDate | Next Control-M scheduled date | \n",
999+
"| MMDD | Specific date Example: \"0511\" | \n",
1000+
"\n"
1001+
]
1002+
},
1003+
{
1004+
"attachments": {},
1005+
"cell_type": "markdown",
1006+
"metadata": {},
1007+
"source": [
1008+
"### WaitForEvents\n",
1009+
"The following example shows how to define events that the job must wait for before running:"
1010+
]
1011+
},
1012+
{
1013+
"cell_type": "code",
1014+
"execution_count": 32,
1015+
"metadata": {},
1016+
"outputs": [],
1017+
"source": [
1018+
"waitForEventList = WaitForEvents(\"WaitForEvent\", events=[Condition(event=\"e1\"),Condition(event=\"e2\"), Condition(event=\"e3\", date=Event.Date.AnyDate)])\n",
1019+
"job = JobCommand('Job1', command='echo Hello')\n",
1020+
"job.wait_for_events_list.insert(0, waitForEventList)"
1021+
]
1022+
},
1023+
{
1024+
"attachments": {},
1025+
"cell_type": "markdown",
1026+
"metadata": {},
1027+
"source": [
1028+
"### AddEvents\n",
1029+
"The following example shows how to specify events for the job to add after running:"
1030+
]
1031+
},
1032+
{
1033+
"cell_type": "code",
1034+
"execution_count": 33,
1035+
"metadata": {},
1036+
"outputs": [],
1037+
"source": [
1038+
"addEventListObject = AddEvents('eventsToAdd', events=[ConditionOutAdd(event=\"e4\",date=Event.Date.NoDate)])\n",
1039+
"job = JobCommand('Job1', command='echo Hello')\n",
1040+
"job.add_events_list.insert(0, waitForEventList)"
1041+
]
1042+
},
1043+
{
1044+
"attachments": {},
1045+
"cell_type": "markdown",
1046+
"metadata": {},
1047+
"source": [
1048+
"### DeleteEvents\n",
1049+
"The following example shows how to specify events for the job to remove after running:"
1050+
]
1051+
},
1052+
{
1053+
"cell_type": "code",
1054+
"execution_count": 34,
1055+
"metadata": {},
1056+
"outputs": [],
1057+
"source": [
1058+
"deleteEventListObject = DeleteEvents('eventsToDelete', events=[ConditionOutDelete(event=\"e5\",date=Event.Date.NextOrderDate)])\n",
1059+
"job = JobCommand('Job1', command='echo Hello')\n",
1060+
"job.delete_events_list.insert(0, deleteEventListObject)"
1061+
]
9411062
}
9421063
],
9431064
"metadata": {
@@ -956,7 +1077,7 @@
9561077
"name": "python",
9571078
"nbconvert_exporter": "python",
9581079
"pygments_lexer": "ipython3",
959-
"version": "3.10.4"
1080+
"version": "3.8.9"
9601081
},
9611082
"orig_nbformat": 4,
9621083
"vscode": {

0 commit comments

Comments
 (0)