STANDARD DATA DICTIONARY #779.3 -- HLO PROCESS REGISTRY FILE 3/24/25 PAGE 1
STORED IN ^HLD(779.3, (16 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1.6)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
The process registry is used by the HLO process manager to start, stop, and manage all of the processes used by the HLO system.
PRIMARY KEY: A (#64)
Uniqueness Index: D (#91)
File, Field: 1) PROCESS NAME (779.3,.01)
CROSS
REFERENCED BY: PROCESS NAME(B), ACTIVE(C)
INDEXED BY: ACTIVE (C), PROCESS NAME (D)
779.3,.01 PROCESS NAME 0;1 FREE TEXT (Required) (Key field)
INPUT TRANSFORM: K:$L(X)>30!(X?.N)!($L(X)<3)!'(X'?1P.E) X
LAST EDITED: NOV 15, 2004
HELP-PROMPT: Give the type of process a unique name, 3-30 characters.
DESCRIPTION:
A unique name for the type of process.
CROSS-REFERENCE: 779.3^B
1)= S ^HLD(779.3,"B",$E(X,1,30),DA)=""
2)= K ^HLD(779.3,"B",$E(X,1,30),DA)
FIELD INDEX: D (#91) REGULAR IR LOOKUP & SORTING
Unique for: Key A (#64), File #779.3
Short Descr: Uniqueness Index for Key 'A' of File #779.3
Set Logic: S ^HLD(779.3,"D",X,DA)=""
Kill Logic: K ^HLD(779.3,"D",X,DA)
Whole Kill: K ^HLD(779.3,"D")
X(1): PROCESS NAME (779.3,.01) (Subscr 1)
779.3,.02 ACTIVE 0;2 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: NOV 06, 2008
HELP-PROMPT: Enter 1 to activate these processes, 0 to inactivate.
DESCRIPTION: A flag that indicates whether or not this type of process is active under the HLO Process Manager.
Some processes may not apply to some systems, for example, a particular site may not use the
Taskman multi-listener.
CROSS-REFERENCE: 779.3^C
1)= S ^HLD(779.3,"C",$E(X,1,30),DA)=""
2)= K ^HLD(779.3,"C",$E(X,1,30),DA)
Used to find active process types.
FIELD INDEX: C (#90) REGULAR IR LOOKUP & SORTING
Short Descr: Used to find active entries in the process registry.
Set Logic: S ^HLD(779.3,"C",X,DA)=""
Set Cond: S X=$S('X(1):0,1:1)
Kill Logic: K ^HLD(779.3,"C",X,DA)
Whole Kill: K ^HLD(779.3,"C")
X(1): ACTIVE (779.3,.02) (Subscr 1) (forwards)
779.3,.03 MINIMUM ACTIVE PROCESSES 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<0)!(X?.E1"."1.N) X
LAST EDITED: AUG 05, 2005
HELP-PROMPT: How many of these processes should be running at a minimum when HL7 messaging is on?
DESCRIPTION: This field indicates the minimum number of concurrent processes of this type. The exact number
changes as the HLO Process Manager starts and stops processes in response to changes in workload.
779.3,.04 MAXIMUM ACTIVE PROCESSES 0;4 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<1)!(X?.E1"."1.N) X
LAST EDITED: SEP 07, 2004
HELP-PROMPT: How many of these processes should be running at a maximum when the HL7 messaging system is on?
779.3,.05 SCHEDULING FREQUENCY (minutes) 0;5 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: SEP 19, 2005
HELP-PROMPT: This is how long the Process Manager should wait between checks to see if another process of this
type should be started. Enter 0 to 9999.
DESCRIPTION: This is how long the Process Manager should wait between checks to see if another process of this
type should be started.
779.3,.06 DT/TM LAST STARTED OR STOPPED 0;6 DATE
INPUT TRANSFORM: S %DT="ESTR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: NOV 15, 2004
HELP-PROMPT: DT/TM the process manager last started or stopped one of these.
DESCRIPTION:
The date and time when a process of this type was last started or stopped.
779.3,.07 HANG TIME (seconds) 0;7 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<0)!(X?.E1"."1.N) X
LAST EDITED: NOV 15, 2004
HELP-PROMPT: If the process cannot find work, how many seconds should it hang before looking again?
DESCRIPTION:
This is how long a process should wait between attempts to find work to do.
779.3,.08 GET WORK FUNCTION (TAG) 0;8 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: NOV 15, 2004
HELP-PROMPT: What function will this process call to find work (optional routine entry point)
DESCRIPTION:
The M entry point to the GET WORK function for this process type.
779.3,.09 GET WORK FUNCTION (ROUTINE) 0;9 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: NOV 15, 2004
HELP-PROMPT: What function should this process call to find work? (routine name only)
DESCRIPTION:
The routine in which this process type has located its GET WORK function.
779.3,.1 DO WORK FUNCTION (TAG) 0;10 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: NOV 15, 2004
HELP-PROMPT: What function should this process call to do its work? Enter the optional entry point only in this
field.
DESCRIPTION:
The M entry point for the process's DO WORK function.
779.3,.11 DO WORK FUNCTION (ROUTINE) 0;11 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: NOV 15, 2004
HELP-PROMPT: What function should this process call to do its work? Enter the routine name only in this field.
DESCRIPTION:
The routine in which the process's DO WORK function is located.
779.3,.12 MAX TRIES FINDING WORK 0;12 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999)!(X<0)!(X?.E1"."1.N) X
LAST EDITED: NOV 15, 2004
HELP-PROMPT: How many times should the process look for work before giving up?
DESCRIPTION: How many times should the process look for work and then quit if it cannot find anything to do?
It'll hang between attempts the specified length of time.
779.3,.13 PERSISTENT 0;13 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: NOV 15, 2004
HELP-PROMPT: Should processes of this type be restarted automatically if they die?
DESCRIPTION: Setting this field to YES results in the process being made persistent via the Taskman persistent
parameter.
779.3,.14 DEDICATED LINK 0;14 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<3) X
LAST EDITED: JUL 06, 2005
HELP-PROMPT: If this process is a listener, you must enter the name of an HL LOGICAL LINK that is a listener and
whose TCP/IP PORT (OPTIMIZED) field contains the correct port number.
DESCRIPTION: The primary use of this field is for TCP/IP listener processes, and indicates which port (via the
HL Logical Link) that the process should be listening on. However, it could be used to dedicate a
client link process to a particular link.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
779.3,.15 VMS TCP SERVICE 0;15 SET
'1' FOR YES;
'0' FOR NO;
LAST EDITED: SEP 23, 2004
HELP-PROMPT: If this process is a listener, enter YES if it is a VMS TCP service rather than a Taskman process.
DESCRIPTION: VMS services are not started or stopped via the HL7 Process Manager. However, on a VMS system,
these services are an important part of the HL7 system, and so an entry in the HL7 Process Registry
should be created for them. The Process Manager will use the PING functionality to verify that the
listener is running.
779.3,.16 BOX-VOLUME PAIR 0;16 POINTER TO TASKMAN SITE PARAMETERS FILE (#14.7)
LAST EDITED: MAR 24, 2010
HELP-PROMPT: Select the node that this process should run on (optional).
DESCRIPTION: The BOX-VOLUME PAIR field (#13) in the HLO SYSTEM PARAMETERS file (#779.1) may be used to
optionally specify the node that the HL7 (optimized) software should run on.
The BOX-VLUME PAIR field (#16) of the HLO PROCESS REGISTRY file (#779.3) may be used to optionally
specify the ndoe that a specify type of HL7 (optimized) software should execute on. If this field
has a value, it will override the value in the HLO SYSTEM PARAMETERS file (#779.1) for this type of
HLO process.
It is generally not necessary to designate which node an HLO process will execute on. The primary
exception may be to allow a Cache/NT site to utilize multiple listeners running on multiple nodes.
Cache/VMS sites should not utilize listeners running under the HLO Process Manager. Instead, those
sites should utilize the VMS TCPIP Services. If desired for load balancing, such a service may be
run on multiple nodes. The BOX-VOLUME PAIR parameters do NOT affect listeners that utilize the VMS
TCPIP Services.
FILES POINTED TO FIELDS
TASKMAN SITE PARAMETERS (#14.7) BOX-VOLUME PAIR (#.16)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):