source: FOIAVistA/trunk/r/HEALTH_LEVEL_SEVEN-HL/HLEVSTUP.m@ 1231

Last change on this file since 1231 was 628, checked in by George Lilly, 16 years ago

initial load of FOIAVistA 6/30/08 version
File size: 7.4 KB
Line 
1HLEVSTUP ;O-OIFO/LJA - Event Monitor SETUP ;02/04/2004 14:42
2 ;;1.6;HEALTH LEVEL SEVEN;**109**;Oct 13, 1995
3 ;
4E7761 ; Enter/Edit 776.1...
5 N DA,DIC,DIE,DR,IEN,X,Y
6 D HD,EX
7 F D QUIT:IEN'>0
8 . W !
9 . S IEN=$$ASKIEN^HLEVREP(776.1,"L") QUIT:'IEN ;->
10 . W !!,$$CJ^XLFSTR("---------------- editing entry ----------------",IOM)
11 . W !
12 . D EDIT(776.1,IEN,"[HLEV MONITOR ENTER/EDIT]")
13 . W !
14 . D ASKRUN^HLEVAPI1(+IEN)
15 . D HD,EX
16 Q
17 ;
18E7769 ; Edit 776.999...
19 N DA,DIC,DIE,DR,IEN,X,Y
20 W @IOF
21 D EDIT(776.999,1,"[HLEV MASTER JOB ENTER/EDIT]")
22 W !
23 S X=$$BTE^HLCSMON("Press RETURN to exit... ")
24 Q
25 ;
26EDIT(FILE,IEN,DR) ; Edit entry...
27 N DA,DIE
28 S DA=+IEN,DIE=FILE
29 D ^DIE
30 Q
31 ;
32HD W @IOF,$$CJ^XLFSTR("Event Monitoring System Enter/Edit",IOM)
33 W !,$$REPEAT^XLFSTR("=",IOM)
34 QUIT
35 ;
36EX N I,T F I=1:1 S T=$T(EX+I) QUIT:T'[";;" W !,$P(T,";;",2,99)
37 ;;You may now enter new entries, and edit existing entries. Enter a new entry
38 ;;now, or select the existing entry to be edited.
39 QUIT
40 ;
41HELP(FILE,FLD) D HELPM
42 ;;776.1^2^HD^STATUS (#2)
43 ;;776.1^2^TX^Enter ACTIVE to make this event monitor "available" to the master job for
44 ;;776.1^2^TX^queuing. When set to ACTIVE the master job will run this event monitor
45 ;;776.1^2^TX^according to the REQUEUE FREQUENCY (that you will be asked several prompts
46 ;;776.1^2^TX^from now.)
47 ;;776.1^2^TX^
48 ;;776.1^2^TX^NOTE: If you're entering this event monitor for the first time, you should
49 ;;776.1^2^TX^ set this field to INACTIVE until all fields have been filled in. Then,
50 ;;776.1^2^TX^ change this field back to ACTIVE.^1
51 ;;
52 ;;776.1^3^HD^SHORT DESCRIPTION (#3)
53 ;;776.1^3^TX^Enter a short description for this event monitor; something that is more
54 ;;776.1^3^TX^complete and descriptive than the NAME.^1
55 ;;
56 ;;776.1^4^HD^REQUEUE FREQUENCY (#4)
57 ;;776.1^4^TX^The master job will run this event monitor as often as you specify. And, this
58 ;;776.1^4^TX^field is the way you specify rerun frequency. Enter the number of minutes
59 ;;776.1^4^TX^that should elapse after this event monitor runs until it is run again.
60 ;;776.1^4^TX
61 ;;776.1^4^TX^NOTE: Enter '0' if you want this event to run every time the master job
62 ;;776.1^4^TX^ checks this monitor.^1
63 ;;
64 ;;776.1^5^HD^REMOTE REQUESTABLE
65 ;;776.1^5^TX^Some monitors can only be started locally at a site. Some monitors can be
66 ;;776.1^5^TX^started locally, and also requested remotely. (A remote request occurs when
67 ;;776.1^5^TX^someone at another site or location sends a Mailman message to your site - to
68 ;;776.1^5^TX^your site's HL7 Event Monitor's server option - requesting that the monitor be
69 ;;776.1^5^TX^run.)^1
70 ;;776.1^5^TX^WARNING!! Does this monitor return a report to the requester containing
71 ;;776.1^5^TX^ sensitive information? If so, you should not, under any
72 ;;776.1^5^TX^ circumstances, set this field to YES.^1
73 ;;776.1^5^TX^Please specify now whether this monitor can be requested remotely. Enter YES
74 ;;776.1^5^TX^to allow remote users to run this monitor. Enter NO if remote requests should
75 ;;776.1^5^TX^ignored.^1
76 ;;
77 ;;776.1^6^HD^M STARTUP LOCATION
78 ;;776.1^6^TX^The master job uses this field to determine how to start this event monitor.
79 ;;776.1^6^TX^So, enter the M location (subroutine and routine) where the event
80 ;;776.1^6^TX^should be queued. Enter it in the SUBROUTINE~ROUTINE format, substituting
81 ;;776.1^6^TX^a tilde (~) for the up-arrow.
82 ;;776.1^6^TX^
83 ;;776.1^6^TX^The M location you enter now is the location where queued jobs start.^1
84 ;;
85 ;;776.1^7^HD^M START CHECK (EXTRINSIC FUNCTION)
86 ;;776.1^7^TX^Normally, the master job uses the monitor's requeue frequency in order to
87 ;;776.1^7^TX^determine whether a new monitor job should be queued. Alternately, you may
88 ;;776.1^7^TX^call an extrinsic function to determine whether a new monitor job should be
89 ;;776.1^7^TX^started. Entry of the M check extrinsic function is optional.
90 ;;776.1^7^TX^
91 ;;776.1^7^TX^Extrinsic functions must follow these rules:
92 ;;776.1^7^TX^
93 ;;776.1^7^TX^ * Syntax = $$TAG~ROUTINE (where TAG and ROUTINE do not exceed 8 characters.)
94 ;;776.1^7^TX^ * $$TAG~ROUTINE returns a 1 or 0.
95 ;;776.1^7^TX^
96 ;;776.1^7^TX^The extrinsic function should return '0' if a new monitor job should not be
97 ;;776.1^7^TX^started, or a '1' to start a new monitor job.^1
98 ;;
99 ;;776.1^41^HD^PARAMETER NOTES
100 ;;776.1^41^TX^Enter description and documentation of the just entered parameters.^1
101 ;;
102 ;;776.1^50^HD^EVENT MONITOR NOTES
103 ;;776.1^50^TX^Enter overall comments about this event monitor.^1
104 ;;
105 ;;776.1^51^HD^MAIL GROUPs, USERs, REMOTE USERs
106 ;;776.1^51^TX^Enter the mail groups and local users and remote users to which notification
107 ;;776.1^51^TX^messages are to be sent. If no notification message will ever be sent, leave
108 ;;776.1^51^TX^these fields blank.^1
109 ;;
110 ;;=====================================================================
111 ;;776.999^.01^HD^MONITORING SYSTEM NAME
112 ;;776.999^.01^TX^You may change the name of the monitoring system if you like. (But, it
113 ;;776.999^.01^TX^makes no difference to the monitoring system!)^1
114 ;;
115 ;;776.999^2^HD^MASTER JOB STATUS
116 ;;776.999^2^TX^Set this field to ACTIVE to enable the master job to run and monitor your
117 ;;776.999^2^TX^system. (The master job is started and stopped using the 'Turn on/off
118 ;;776.999^2^TX^monitoring system [HLEV EDIT MASTER ON-OFF]' menu option.) Set this field
119 ;;776.999^2^TX^to INACTIVE to stop the master job (if it is running), and to ensure that
120 ;;776.999^2^TX^the master job does not start^1
121 ;;
122 ;;776.999^3^HD^MASTER JOB INTERVAL (MINUTES)
123 ;;776.999^3^TX^The master job is started every MASTER JOB INTERVAL minutes to evaluate your
124 ;;776.999^3^TX^system. Enter the number of minutes now that should elapse between every
125 ;;776.999^3^TX^"run" of the master job.^1
126 ;;
127 ;;776.999^4^HD^PURGE LIMIT FOR DATA
128 ;;776.999^4^TX^Whenever the master job runs, data is created in the HL7 Monitor Master Job
129 ;;776.999^4^TX^file (#776.2.) Whenever the master job spawns off a new background job for
130 ;;776.999^4^TX^an event monitor, data is created in the HL7 Monitor Job file (#776.) Purging
131 ;;776.999^4^TX^of this data occurs automatically. This parameter controls how much data to
132 ;;776.999^4^TX^retain. For example, if you enter '96' now, then no data less than 96 hours
133 ;;776.999^4^TX^old will be purged.^1
134 ;;
135 ;;776.999^6^TX^
136 ;;776.999^6^TX^
137 ;;776.999^6^TX^ --- EVENT MONITORING FIELDS ---
138 ;;776.999^6^TX^
139 ;;776.999^6^HD^STATUS OF EVENT MONITORING
140 ;;776.999^6^TX^The master job periodically "fires off" event monitors. If you set this field
141 ;;776.999^6^TX^to INACTIVE, the master job will continue to start and run, but no events
142 ;;776.999^6^TX^will be started. When this field is set to ACTIVE, the master job will be
143 ;;776.999^6^TX^able to run event monitors.^1
144 ;
145 Q
146 ;
147HELPM ; Display of HELP logic...
148 N I,INFO,J,T,TYP
149 F I=1:1 S T=$T(HELP+I) Q:T'[";;" D
150 . S T=$P(T,";;",2,999)
151 . I +T=FILE,$P(T,U,2)=FLD D
152 . . S TYP=$P(T,U,3),INFO=$P(T,U,4)
153 . . W:TYP="HD" !!,$$CJ^XLFSTR(" "_INFO_" ",IOM,"=")
154 . . W:TYP="TX" !,INFO
155 . . W:TYP="FT" !,$$REPEAT^XLFSTR("=",IOM)
156 . . I $P(T,U,5)>0 F J=1:1:$P(T,U,5) W !
157 Q
158 ;
159IMPLEMNT ; Not yet implemented API...
160 N OPT
161 S OPT=$P($G(XQY0),U,2)_" ["_$P($G(XQY0),U)_"]"
162 W !!,$$CJ^XLFSTR("This '"_OPT_"' menu option",IOM)
163 W !,$$CJ^XLFSTR("is not yet implemented.",IOM)
164 W !
165 S X=$$BTE^HLCSMON("Press RETURN to return to menu...")
166 Q
167 ;
168EOR ;HLEVSTUP - Event Monitor SETUP ;5/16/03 14:42
Note: See TracBrowser for help on using the repository browser.