Bugzilla – Attachment 61885 Details for
Bug 11897
Stock Rotation for Koha
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Bug 11897: Add documentation for the cron script.
Bug-11897-Add-documentation-for-the-cron-script.patch (text/plain), 3.19 KB, created by
Alex Sassmannshausen
on 2017-04-05 13:11:52 UTC
(
hide
)
Description:
Bug 11897: Add documentation for the cron script.
Filename:
MIME Type:
Creator:
Alex Sassmannshausen
Created:
2017-04-05 13:11:52 UTC
Size:
3.19 KB
patch
obsolete
>From 16f501c573b219a54c2b52b41f9a6d6fc512253b Mon Sep 17 00:00:00 2001 >From: Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com> >Date: Wed, 5 Apr 2017 15:03:07 +0200 >Subject: [PATCH] Bug 11897: Add documentation for the cron script. > >* misc/cronjobs/stockrotation.pl: Add documentation. >--- > misc/cronjobs/stockrotation.pl | 52 +++++++++++++++++++++++++++++++++++++++--- > 1 file changed, 49 insertions(+), 3 deletions(-) > >diff --git a/misc/cronjobs/stockrotation.pl b/misc/cronjobs/stockrotation.pl >index df1a9c7290..0926b9eb05 100755 >--- a/misc/cronjobs/stockrotation.pl >+++ b/misc/cronjobs/stockrotation.pl >@@ -55,9 +55,55 @@ if they are elible for processing. > > it should be run from cron like: > >- stockrotation.pl >- -OR- >- stockrotation.pl -h >+ stockrotation.pl --report email --send-email --execute >+ >+Prior to that you can run the script from the command line without the >+--execute and --send-email parameters to see what reports the script would >+generate in 'production' mode. This is immensely useful for testing, or for >+getting to understand how the stockrotation module works: you can set up >+different scenarios, and then "query" the system on what it would do. >+ >+Normally you would want to run this script once per day, probably around >+midnight-ish to move any stockrotationitems along their rotas and to generate >+the email reports for branch libraries. >+ >+Each library will receive a report with "items of interest" for them for >+today's rota checks. Each item there will be an item that should, according >+to Koha, be located on the shelves of that branch, and which should be picked >+up and checked in. The item will either: >+- have been placed in transit to their new stage library; >+- have been placed in transit to be returned to their current stage library; >+- have just been added to a rota and will already be at the correct library; >+ >+In the last case the item will be checked in and no message will pop up. In >+the other cases a message will pop up requesting the item be posted to their >+new branch. >+ >+=head2 What does the --execute flag do? >+ >+To understand this, you will need to know a little bit about the design of >+this script and the stockrotation modules. >+ >+This script operates in 3 phases: first it walks the graph of rotas, stages >+and items. For each active rota, it investigates the items in each stage and >+determines whether action is required. It does not perform any actions, it >+just "sieves" all items on active rotas into "actionable" and "non-actionable" >+baskets. We can use these baskets to perform actions against the items, or to >+generate reports. >+ >+During the second phase this script then loops through the actionable baskets, >+and performs the relevant action (initiate, repatriate, advance) on each item. >+ >+Finally, during the third phase we revisit the original baskets and we compile >+reports (for instance per branch email reports). >+ >+When the script is run without the "--execute" flag, we perform phase 1, skip >+phase 2 and move straight onto phase 3. >+ >+With the "--execute" flag we also perform the database operations. >+ >+So with or without the flag, the report will look the same (except for the "No >+database updates have been performed."). > > =cut > >-- >2.11.1
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 11897
:
25887
|
58207
|
58208
|
58209
|
58210
|
58211
|
58212
|
58213
|
58214
|
58215
|
58216
|
58217
|
58218
|
58219
|
58280
|
58281
|
58687
|
58692
|
58693
|
58694
|
58695
|
58696
|
60175
|
60715
|
61825
|
61826
|
61827
|
61828
|
61829
|
61830
|
61831
|
61832
|
61833
|
61834
|
61835
|
61836
|
61837
|
61838
|
61839
|
61885
|
62730
|
62750
|
62751
|
62752
|
62753
|
62754
|
62755
|
62756
|
62757
|
62758
|
62759
|
62760
|
62761
|
62762
|
62763
|
62764
|
62765
|
62766
|
62767
|
63063
|
63064
|
63065
|
63066
|
63067
|
63068
|
63069
|
63070
|
63071
|
63072
|
63073
|
63074
|
63075
|
63076
|
63077
|
63078
|
63079
|
63080
|
63114
|
64850
|
64851
|
65715
|
65716
|
65717
|
65718
|
65719
|
65720
|
65721
|
65722
|
65723
|
65724
|
65725
|
65726
|
65727
|
65728
|
65729
|
65730
|
65731
|
65732
|
65733
|
65734
|
65735
|
65736
|
65737
|
65738
|
65739
|
65740
|
65741
|
65742
|
65743
|
65744
|
65745
|
65746
|
65747
|
65748
|
65749
|
65750
|
65751
|
65752
|
65753
|
65754
|
65755
|
65756
|
65757
|
65758
|
66381
|
70496
|
70497
|
70498
|
70499
|
70500
|
70501
|
70502
|
70503
|
70504
|
70505
|
70506
|
70507
|
70508
|
70509
|
70510
|
70511
|
70512
|
70513
|
70514
|
70515
|
70516
|
70517
|
70518
|
70519
|
70520
|
70521
|
70522
|
70523
|
70524
|
72124
|
72125
|
72126
|
72127
|
72128
|
74003
|
74004
|
74005
|
74006
|
74007
|
74008
|
74010
|
74011
|
74012
|
74013
|
74014
|
74015
|
74016
|
74017
|
74197
|
74198
|
74199
|
74200
|
74201
|
74202
|
74203
|
74204
|
74205
|
74206
|
74319
|
74320
|
74360
|
74459
|
74460
|
74461
|
74462
|
74463
|
74464
|
74465
|
74466
|
74467
|
74468
|
74469
|
74470
|
75409
|
75410
|
75411
|
75412
|
75413
|
75414
|
75415
|
75416
|
75417
|
75418
|
75419
|
75420
|
76121
|
76122
|
76123
|
76124
|
76125
|
76126
|
76127
|
76128
|
76129
|
76130
|
76131
|
76132
|
76133
|
76134
|
76135
|
76144
|
76706
|
76707
|
76708
|
76709
|
76710
|
77623
|
77624
|
77625
|
77626
|
78387
|
78388
|
78389
|
78390
|
78391
|
78392
|
78393
|
78394
|
78404
|
78405
|
78406
|
78407
|
78408
|
79040
|
79041
|
79042
|
79043
|
79044
|
79738
|
79739
|
79740
|
79741
|
79742
|
79746
|
79747
|
79748
|
79749
|
79750
|
79964
|
79965
|
79966
|
79967
|
79968
|
79969
|
79970
|
79971
|
79972
|
79973
|
79974
|
79975
|
80068
|
80087
|
80088
|
80089
|
80090
|
80091
|
80092
|
80093
|
80094
|
80095
|
80096
|
80097
|
80098
|
80099
|
80100
|
80118
|
80260
|
80261
|
80262
|
80263
|
80264
|
80265
|
80266
|
80267
|
80268
|
80269
|
80270
|
80271
|
80272
|
80273
|
80274
|
80275
|
80289
|
80298
|
80299
|
80300