The Master Data Model for Veteran Care

Developer Documentation » VDM » Device-3_5

Device (3.5)

This file defines all input/output devices that can be accessed from this CPU (definitions are not account-specific). Each device is identified with a unique name. Each is associated with a $I value which may correspond with a hardware port or, on layered systems, a host file or directory. If there are several devices for the same volume set and $I, one may be given sign-on system status. Devices may also be assigned to hunt groups to share work. This file is cross-referenced by name, $I, volume set(CPU), and sign-on/system device. It is also cross-referenced by hunt group, local synonym, mnemonic, subtype, and form currently mounted.

Global: ^%ZIS(1,

Domain: Non-Clinical

Properties

Label/Field Name Field # Description Datatype Attributes Range
Name
  name
.01 This is the name of the device. It is used at the ‘DEVICE’ prompt
to select this device. It should not be the internal name for
the device but a logical one.
It must start with 1 uppercase and not contain lowercase.
STRING INDEXED
REQUIRED
 
Location Of Terminal
  location_of_terminal
.02 This is a free text description of where the device is located,
e.g. Ward 2A nurse station, etc.
STRING REQUIRED  
Mnemonic
  mnemonic
.03 These are alternate names which may be used to select the device. STRING    
Local Synonym
  local_synonym
.04 This is an alternate name which may be used to select the device.
When using the LOCAL SYNONYM to select the device, selection can only
occur on the local CPU. For example, if you assigned a LOCAL SYNONYM
to one device on the local CPU, and the same name to a device on
the remote CPU, selection using the LOCAL SYNONYM will return
the device on the local CPU.
STRING INDEXED  
Purge Old Print Queue Files
  purge_old_print_queue_files
.13 This field determines whether old HFS files associated with entries in the
PRINT QUEUE JOB (#3.52) file should be deleted. It only applies to devices
of the PRINT QUEUE type. For print queues, an intermediate host file is
created in the PRINT_QUEUES subdirectory.

Normally, these files are automatically deleted once they have been submitted
to the print queue. For those files that are not automatically deleted,
there is a scheduled option that will periodically delete host files that
have been somehow left in existence past their usefulness.

Setting this field to NO will prevent the purge option from deleting HFS files
created via this device. Setting this field to NO should only be done on
a temporary basis while troubleshooting a problem involving a print queue.

The default value for this field is YES.


BOOLEAN   false: N
true: Y
$i
  i
1 This field holds the Hardware port name that the OS can identify when
referencing a port on a CPU.
On layered systems where opening of host files is supported,
this field may hold the host file name.
When defining a spool device entry(TYPE=”SPL”) on VAX DSM or MSM-Unix,
enter the name of directory where spool host files will be created.
STRING INDEXED
REQUIRED
 
Volume Set(cpu)
  volume_setcpu
1.9 This field holds the name of the CPU to which this device belongs.
This field holds the name of the CPU where the physical port resides.
On DSM-11, VAX DSM, this field may hold the name of the Volume Set.
On M/11+, this field may hold the name of the Directory Set.

If no name has been entered for this field, this device is assumed
to be accessible from all CPUs in the network. In other words,
when this device is referenced, the device handler will operate
as if this device is resident on the local CPU.

For example, if there is a device that uses the same $I on each CPU,
one entry can be made in the Device File by leaving the ‘Volume
Set(CPU)’ Field null. This shortcut will work only if the same $I
has been associated with this device on every CPU.
STRING    
Sign-on/system Device
  signon_system_device
1.95 If answered ‘YES’, this field identifies that this entry is the primary
device among those device entries that have the same $I with the same
VOLUME SET(CPU).

Among those device entries that have a common $I and CPU,
only one of these entries can have this field set to ‘YES’.
If none of the common device entries are set to ‘YES’, the
default device will be identified by the first device on
the CPU x-ref. The default device is used when the device
handler is invoked with $I as the device to be selected.
BOOLEAN   false: 0
true: 1
Type
  type-2
2 This field has the general type of device on the CPU. ‘TRM’ is the most
common entry.
TRM – Terminal devices such as most crts and printers
should be associated with a corresponding device entry
with a type of ‘TRM’.
HFS – Host File Server is only available on mumps platforms
that exists on a layered system(e.g.: VMS, UNIX, NT, etc.).
This type and the associated functionality provides
the vehicle to read and write to host level files.
Instead of directing reports to a printer, the results
could be placed into a VMS, NT or UNIX file. This would
allow a non-mumps based statistical package or spreadsheet
to use data produced by the mumps based application by
simply extracting data from the host file.
VTRM – Virtual Terminal Server devices are those that are associated
with a dynamically created mumps port identification($I).
A generic device entry with a device type of ‘VTRM’
can be established for users who log into the system
through terminal servers.
RES – Resources is a type used for special sequencing of tasks
that do not require a particular device.
CHAN – Network Channels are high speed devices that use network
protocols such as TCP/IP.
OTH – Other devices that do not fit a particular category
should be given a type of ‘OTH’.
MT – Magtape device should have a type of ‘MT’.
SPL – Spool device is a predefined allocated disk space similar
to SDP. However, access to the spool device can be achieved
from multiple users simultaneously.
BAR – Bar code reader. This type identifies the device
as a barcode reader.
SDP – Sequential Disk Processor is a predefined allocated
disk space used for sequential processing. On DSM-11
and M/11+ systems, devices 59 thru 62 are reserved for SDP.
On MSM, the Sequential Block Processor(SBP) is essentially
the same as SDP. This has been replaced with HFS.
IMPC – Imaging work station device(reserved for future use for
DHCP Imaging Project).
PQ – Print Queues. This type of device will be used on
Cache/VMS,Linux, or Unix systems to create host files and
pass them to a print server. Print Queue devices are
not used on Windows systems.

ENUMERATION REQUIRED SPOOL: SPL
BARCODE READER: BAR
SDP: SDP
VIRTUAL TERMINAL: VTRM
NETWORK CHANNEL: CHAN
PRINT QUEUE: PQ
TERMINAL: TRM
MAGTAPE: MT
OTHER: OTH
IMAGING WORK STATION: IMPC
HOST FILE SERVER: HFS
RESOURCES: RES
Subtype
  subtype
3 This field tells what type of terminal is on a terminal port.
It has a great impact on whether the proper terminal control codes
get sent to the terminal.
POINTER REQUIRED Terminal_Type-3_2
Ask Device
  ask_device
4 This field controls if the ‘DEVICE’ question is asked when a call
is made to ^%ZIS.
BOOLEAN   false: 0
true: 1
Ask Parameters
  ask_parameters
5 On devices of TYPE ‘TRM’ and ‘VTRM’, this field controls
if the ‘RIGHT MARGIN’ question is asked after selecting the device.
On devices of TYPE ‘MT’, ‘SDP’, ‘BAR’, and ‘OTH’, this field controls
if the ‘ADDRESS/PARAMETERS’ question is asked after selecting the device.
BOOLEAN   false: 0
true: 1
Ask Host File
  ask_host_file
5.1 Answer ‘yes’ if ‘HOST FILE NAME:’ should be asked when the device
is selected. TYPE must be ‘HFS’. Only applicable on layered systems
that support host files.
BOOLEAN   false: 0
true: 1
Ask Hfs I/o Operation
  ask_hfs_i_o_operation
5.2 For systems that support host files, this field may be used instead
of ‘ADDRESS/PARAMETERS’ to specify more general parameters.

If ‘Ask Parameters’ is null or ‘NO’, set this field to ‘YES’ and the
device handler will ask for INPUT/OUTPUT OPERATION upon selecting a
device.
BOOLEAN   false: 0
true: 1
Queuing
  queuing
5.5 When this field is set to FORCED and queuing is allowed by the calling
program (%ZIS[“Q”), the Device Handler will return IO(“Q”)=1 upon
device selection and the job will be queued. That is, the user
does not need to enter “Q” to invoke queuing and will not be prompted
with the question about wanting output queued. If the program
does not allow queuing (%ZIS’[“Q”), the user will see the following
message: Sorry, QUEUING is required for this device.

Set this field to NOT ALLOWED if queuing is not possible or desired
for this device.

Set this field to ALLOWED if queuing is possible for this device.
When this field is set to ALLOWED, the application/user will determine
if queuing is desired. Setting this field to null is the same as
setting this field to ALLOWED.
ENUMERATION   FORCED: 1
NOT ALLOWED: 2
ALLOWED: 0
Out-of-service Date
  outofservice_date
6 If entered then this device cannot be selected if the current date is
greater than, or the same as, the date specified.
DATE-TIME    
Nearest Phone
  nearest_phone
7 The location of the telephone nearest to this device. STRING    
Key Operator
  key_operator
8 The name of the person who usually uses this device. STRING    
Margin Width
  margin_width
9 This field if it has data will override the Right Margin field value
from the Terminal type file.
Leave this field blank unless you are sure that you need to have a
different Right Margin than what is in the terminal type file.
NUMERIC    
Page Length
  page_length
11 This field, if it has data, will override the Page Length field value
from the Terminal type file.
Leave this field blank unless you are sure that you need to have a
different Page Length than what is in the terminal type file.

If this is a CRT then this is the number of lines which can
be displayed on the screen, otherwise, for printers, it is
the number of print lines per page.
NUMERIC    
Suppress Form Feed At Close
  suppress_form_feed_at_close
11.2 This field is used flag devices that should not have form feeds issued
at the time the device is closed.
This field should be answered ‘YES’ for label printers.
BOOLEAN   false: 0
true: 1
Security
  security
15 The users DUZ(0) (fileman access) must contain at least one of the
characters in this field for the user to be able to select this device.
STRING    
Closest Printer
  closest_printer
16 This is the name of the nearest printer, it is selected at the
“DEVICE” prompt simply by entering “P”.
POINTER   Device-3_5
Form Currently Mounted
  form_currently_mounted
17 This describes the type of form currently in the printer. STRING INDEXED  
Open Parameters
  open_parameters
19 These parameters are used to open a device with specified
characteristics/addresses.
This field is primarily used with non-terminal devices such
as magtape and SDP.
For SDP, use (block:0) on M/11; (0:block:drive) on DSM.
For Magtape, use (“VAL4”:0:2048) on both M/11 and DSM.
STRING    
Close Parameters
  close_parameters
19.3 This field holds the parameters to be used in a MUMPS CLOSE statement. STRING    
Use Parameters
  use_parameters
19.5 This field holds the parameters to be used in a MUMPS USE statement. STRING    
Pre-open Execute
  preopen_execute
19.7 This is the Xecutable MUMPS code which is used by %ZIS before opening
the device. Setting %ZISQUIT=1 in the PRE-OPEN EXECUTE code
will signal %ZIS to reject the selected device.
STRING    
Post-close Execute
  postclose_execute
19.8 This is the Xecutable MUMPS code which is used by %ZISC after closing
the device.
STRING    
Micom Printer Contention Port
  micom_printer_contention_port
21 This field is reserved for future use to determine whether the device
uses printer contention. It would be a preliminary check to decide
whether it is necessary to invoke the printer contention programs.
BOOLEAN   false: 0
true: 1
Modem
  modem
23 If this device is connected to a modem, this is the name of the type
of modem, as found in the TERMINAL TYPE file. Modem names must begin
with “M-“. This field is used by MailMan for controlling the auto-dialer.
If the device is used only for dial-in (receives calls only, never places
them), then this field is not necessary.
POINTER   Terminal_Type-3_2
Priority At Run Time
  priority_at_run_time
25 This field, if set, will be used by the Task Manager to set a job’s
operating system run priority. Lowest priority is 1, and 10 is the
highest.
NUMERIC    
Taskman Print A Header Page
  taskman_print_a_header_page
26 If this field is set to YES then, Taskman will print a header page
before the job is started to form a break between reports.
BOOLEAN   false: n
true: y
Password
  password
27 Passwords are used for an additional level of security on devices such as
modems. If a value is entered in this field, all users trying to log on to
this device will be prompted for the password before being prompted for the
access code.
STRING    
Slaved From Device
  slaved_from_device
28 This field may permit queuing to slaved devices. Given hard-wiring such
that a display terminal may be identified with a device name, queuing may
take place to the slaved device ($I=0). Enter the device name of the
display terminal in this field.
POINTER   Device-3_5
Auto Despool
  auto_despool
31 Answer ‘YES’ if the report is to be automatically despooled. BOOLEAN   false: 0
true: 1
Despool Devices
  despool_devices
32 This is the list of printers that reports will be printed during
the despool process for the named spool device.
OBJECT   Despool_Devices-3_532
Generate Spl Doc Name
  generate_spl_doc_name
33 Answer ‘YES’ to this field if the spool document name is to be
automatically generated.
BOOLEAN   false: 0
true: 1
Resource Slots
  resource_slots
35 Enter a value that will identify the limit of concurrent jobs
that may own the same resource. If no data is entered, the
device handler will use a default value of 1.
NUMERIC    
Global Lock
  global_lock
36 This field tells the device handler if it should use a global lock
to control access to a device.
BOOLEAN   false: 1
true: 0
Open Count
  open_count
51 This field holds a count of the number of times that %ZIS has
successfully open this device.
The reason is to find LAT devices that are still in use.
NUMERIC    
Timed Read (# Of Seconds)
  timed_read_number_of_seconds
51.1 The number of seconds for timed reads at this device. It is overridden
by the Timed Read specification in the USER File.
NUMERIC    
*reserved
  reserved
51.12   STRING DEPRECATED  
*reserved
  reserved-51_13
51.13   STRING DEPRECATED  
*reserved
  reserved-51_14
51.14   STRING DEPRECATED  
*reserved
  reserved-51_15
51.15   STRING DEPRECATED  
# Of Attempts
  number_of_attempts
51.2 The number of sign-on attempts before the device is locked from use.
This may be ignored by setting the BYPASS DEVICE LOCK-OUT field in
the KERNEL SITE PARAMETERS File. The minimum value is set by the VA
INFORMATION SYSTEM ACCOUNT AND PASSWORD MANAGEMENT POLICY.
NUMERIC    
Lock-out Time
  lockout_time
51.3 This is the amount of time that the device must be idle before
the lock will release. This may be ignored by setting the BYPASS
DEVICE LOCK-OUT field in the KERNEL SITE PARAMETERS File.
The minimum value is set by the VA INFORMATION SYSTEM ACCOUNT AND PASSWORD
MANAGEMENT POLICY.
NUMERIC    
Multiple Sign-on
  multiple_signon
51.4 Specifies whether or not the user of this device can be already signed
on the system. It is overridden by the Multiple Sign-on specification in
the USER File.
ENUMERATION   NOT ALLOWED: 0
ALLOWED: 1
Ask Device Type At Sign-on
  ask_device_type_at_signon
51.5 This field (if filled in) will over ride the ones in the KERNEL site
parameter file. This is overridden by the same specification in the
NEW PERSON File.
It controls if the user/terminal should be asked for a terminal type during
sign-on.
If set to YES then a is sent to the terminal to collect the answer back
message, if valid the terminal type is set to this. Otherwise the user is
prompted.
If set to NO then the one from the Last Sign-on field or device subtype will
be used.
ENUMERATION   YES, ASK: 1
NO, DON'T ASK: 0
Auto Menu
  auto_menu
51.6 This field controls whether the Auto-menu function will be turned on
for this device. If it is turned on, it acts just as if the user
types a “?” before each prompt. This is overridden by the same
specification in the USER File.
ENUMERATION   NO MENUS GENERATED: 0
MENUS GENERATED: 1
*reserved
  reserved-51_7
51.7   STRING DEPRECATED  
Tied Routine
  tied_routine
51.8 This field, if filled in, has the name of a routine that is run
before the ‘ACCESS CODE’ question is asked. Use with care.
STRING    
Type-ahead
  typeahead
51.9 Should the user of this device have ‘Type-Ahead’ turned on or off.
This will be overridden by the same specification in the USER File.
ENUMERATION   NOT ALLOWED: N
ALLOWED: Y
Perform Device Checking
  perform_device_checking
51.91 This field, if set, will override the default in the KERNEL SITE
PARAMETERS File.

Device checking involves checking for device lockout, prohibited access
times, etc. If turned off, logon will be faster.
BOOLEAN   false: 1
true: 0
Secondary $i
  secondary_i
52 This field holds the $IO value to be used if this is the secondary system
in a mixed OS environment. It is not used otherwise.
It is only used for output devices.
STRING    
Lat Server Node
  lat_server_node
61 This is the DECserver/terminal server node name that the device is on.
It is used by XTLATSET to build data files for VMS startup.
STRING    
Lat Server Port
  lat_server_port
62 This is the port on the DECserver/terminal server that this device is
connected to. It can be entered in the LC-2-5 form or 31 form.
On EQUINOX it is in the PORT_31 form.
This field is used by XTLATSET to build VMS datafiles for startup.
STRING    
Vms Device Type
  vms_device_type
63 This is a flag that is passed into the file LT_PTR.DAT by the routine
XTLATSET to select how this port should be setup in VMS by the
SYS$MANAGER:SYSPRINT.COM file when it runs.
ENUMERATION   PASTHRU/NOWRAP: p
HOSTSYNC/NOWRAP: m
LAB INSTRUMENT: l
YES SPOOLED: y
NOT SPOOLED: n
NOWRAP: w
Lat Port Speed
  lat_port_speed
64 This field holds the value that will be passed to the TSC_LOAD.COM
file for loading the DECserver permanent database.
ENUMERATION   3: 300
12: 1200
24: 2400
48: 4800
96: 9600
192: 19200
Print Server Name Or Address
  print_server_name_or_address
65 This field contains the FQDN (fully qualified domain name) or specific
TCP/IP address of a remote server (e.g., for LPD/LPR printing) or device
(e.g., for telnet printer).
STRING    
Telnet Port
  telnet_port
66 This field contains the telnet port of a remote device (e.g., a telnet
printer). The allowable range is a number between 2000 and 65534.
NUMERIC    
Remote Printer Name
  remote_printer_name
67 This is the Name of the Remote Printer that is referenced by
the “PRINT SERVER NAME OR ADDRESS” and “TELNET PORT” fields.
STRING    
Windows Network Printer Name
  windows_network_printer_name
75 This is the Windows network name for the printer (e.g.,
’\vhaistfpc4\IST-HP4525-1’). It is used by Windows applications that
interact with VistA and need a printer identified for output purposes.
STRING    
Lab Label Printer
  lab_label_printer
101 This field is used only if the current device has a label printer associated
with it.
POINTER   Device-3_5
Primary Menu Option
  primary_menu_option
201 This field, if filled in, contains the primary menu that is run from this
device. It overrides the user’s primary menu.
POINTER   Option-19
Barcode Avail
  barcode_avail
646 This field is used by Augie Turano’s pharmacy barcode software. BOOLEAN   false: N
true: Y
Prohibited Times For Sign-on
  prohibited_times_for_signon
2009 This field allows a device to be locked out for certain periods of the
day. The time period for which logons will be prohibited is specified
in the form HHMM-HHMM. For example, 1630-0800 would lock out the device
from 4:30 PM to 8:00 AM.

If device checking is bypassed for this device, these times are ignored.
STRING    
Use Timeout On Opens
  use_timeout_on_opens
2009.5 This field determines whether a timeout will be used
to open the device.
BOOLEAN   false: y
true: n
Open Timeout
  open_timeout
2010 If a specific timeout is needed when an open is performed,
enter the value of the timeout into this field. This will enable %ZIS
to “hang” for the number of seconds specified in this field to achieve
a connection rather than using the default of zero.
NUMERIC    
Nvs Passover Flag
  nvs_passover_flag
18000 This field is a flag which will allow for the devices so selected to be
skipped in the NVS TEST ACCOUNT initialization process. If the test
database has a different path to the device in question, some editting may
be needed.
BOOLEAN   true: 1

↑ Return to top

Sub-Files

Despool Devices (3.532)

ID
Despool_Devices-3_532

Properties

Label/Field Name Field # Description Datatype Attributes Range
Despool Devices
  despool_devices
.01 The printer used in the despool process associated with
the current spool device.
POINTER INDEXED
REQUIRED
Device-3_5
Copies
  copies
1   NUMERIC    

↑ Return to top


Document generated on August 31st 2017, 2:55:41 pm