The Master Data Model for Veteran Care

Developer Documentation » VDM » Domain-4_2

Domain (4.2)

This file is used to name all of the domains to which MailMan messages may be routed. Each name in this file corresponds to the right side of a MailMan address-the part following the “@”. Domains may have synonyms, allowing users to name sites with one name, while MailMan uses the more formal Domain Naming conventions. This file also controls whether messages are queued for immediate transmission and into what queue they are dropped. Any domain may have a relay domain, which controls the routing as follows: If a domain has a named relay domain, the message is put in the queue for the relay domain. If not, and the domain has a TRANSMISSION SCRIPT, then the message is put in the queue for that domain. Otherwise, the message is put in the queue for the Parent domain, as defined at MailMan initialization time.

Global: ^DIC(4.2,

Domain: Non-Clinical

Properties

Label/Field Name Field # Description Datatype Attributes Range
Name
  name
.01 This name is the exact name of the domain, as used in network addressing.
It consists of “.” (dot) pieces that are formed hierarchically starting at
the right. Domains with dot pieces to the left are administered by the
domain whose domain name consists of its name less the 1st dot piece.
For example: A.DOMAIN.COM is administered by DOMAIN.COM.

The domain name may be from 1 to 64 characters.

Each dot piece may be up to 20 characters, and must begin with an alpha
or numeric, and be composed of only alpha, numeric, or “-“ characters.
STRING INDEXED
REQUIRED
 
Flags
  flags
1 The flags field controls the flow of messages to this domain from the
local node. Flags are:

S = Send. MailMan should start a TaskMan task to transmit the message
as soon as the message is received.

C = Close. MailMan will not allow users to address mail to this domain.

Q or “” (the null string) = Queue. MailMan will not deliver until a
task is explicitly created to deliver the mail.

P = Poll. A TaskMan task will poll all domains with this flag.

N = NO-forward. MailMan will not allow messages to be forwarded to this
domain.

T = Talkman enabled. The presence of this flag allows Talkman to be
used at your site. It is also necessary to put a ‘T’ command into
the script so that TalkMan will be invoked properly.
STRING    
Security Key
  security_key
1.5 This field, if defined, names a security key which must be held by the
sender. If the sender does not have this key, then he may not address this
domain.
STRING    
Validation Number
  validation_number
1.6 This field is used for security. If filled in any messaging services
that contact you will need to know the value of this field, or their
requests will be ignored. Messaging services = other MailMan domains.
NUMERIC    
New Validation Number
  new_validation_number
1.61 This field is used for security. It is a temporary value, it is set when
a new validation number is negotiated with another Domain. It is moved to
the Validation Number, field 1.6, after it is confirmed by the other Domain.
NUMERIC    
Disable Turn Command
  disable_turn_command
1.7 This field, if set to “YES”, means that a remote domain calling this
domain will not be able to execute the SMTP TURN command. This means
that the sending domain must open the link. This allows an extra
measure of security, to insure that the sending domain establishes the
link.
BOOLEAN   false: n
true: y
Relay Domain
  relay_domain
2 This is the name of the domain, if any, to which messages are to be
always routed. For example, if traffic from Los Angeles to Washington
is always to be routed through San Francisco, then the RELAY DOMAIN for
Los Angeles is defined to be San Francisco.

The relay domain overides any other path determination processes, such
as scripts and parent domains.
POINTER   Domain-4_2
Transmission Script
  transmission_script
4 See the Technical Description for how this field is used in implicit
routing by the name server. This field should always have at least one
Script command in it unless implicit routing is desirable.
Each line of this text field is interpreted by the MailMan script processor.

There are commands to be used:

Open
Device
Wait
Xecute
Call

These commands are described in other documentation.
OBJECT   Transmission_Script-4_21
Notes
  notes
4.2 NETWORK NOTES should be used to document idiosyncracies
which occur when communicating with the domain in question.
STRING    
Synonym
  synonym
5 Other names by which this domain is known. STRING    
Station
  station
5.5 This is the domain’s station. STRING    
Mcts Routing Indicator
  mcts_routing_indicator
6 This is a three character routing indicator for the VADATS network’s
MCTS terminal system.
statistics reflect the messages as they are actually transmitted, not
as they are addressed.
STRING    
Dhcp Routing Indicator
  dhcp_routing_indicator
6.2 This field is used to route messages when they arrive at the
central data collection point at the domain FOC-AUSTIN.DOMAIN.EXT.
STRING INDEXED  
Mailman Host
  mailman_host
6.5 This field contains a logical or physical address of a remote domain
so that a connection can occur.
STRING    
Ftp Blob Ip Address
  ftp_blob_ip_address
6.6 This field contains the IP address of this host so that it can be
used as the to address for files that will be sent to this domain.
STRING    
Tcp/ip Poll Flag
  tcp_ip_poll_flag
6.61 This is the information needed to log in the FTP service of this site
if the standard route needs to be overridden.
.
This field is required. Set the value of it to zero (“0” Do Not Poll)
unless you know that you are using the XMRTCP TCP/IP poller.
ENUMERATION INDEXED DO NOT POLL: 0
POLL: 1
Ftp
  ftp
6.62 This is the information needed by to log into an FTP service to send
files. It is overridden by the site if they wish in their Kernel Site
Parameters and sent to the sender in real time.

There are really two pieces of data in this field separated by a “;”.
Piece number 1 is the username. Piece number 2 is the password.
STRING    
Ftp Blob Directory
  ftp_blob_directory
6.7 This field contains the directory into which a file should be put
by a domain sending it files to attach to multimedia messages.
STRING    
*outgoing Message Count
  outgoing_message_count
7 This is a count of the number of messages which have been transmitted to this
domain since the counter was last set to zero.

As of Kernel 7 this field was *‘d and it will be deleted 18 month from the
date that the community was notified (6/5/90).
NUMERIC DEPRECATED  
*outgoing Line Count
  outgoing_line_count
8 This is a count of the number of lines of text which have been transmitted
to this domain since the counter was last set to zero.

SEE FIELD 7 ABOUT ‘*’.
NUMERIC DEPRECATED  
*incoming Message Count
  incoming_message_count
9 This is a count of the number of messages which have been received from this
domain since the counter was last reset.

SEE FIELD 7 ABOUT ‘*’.
NUMERIC DEPRECATED  
*incoming Line Count
  incoming_line_count
10 This is the count of the number of lines which have been received from this
domain since the counter was last reset.

SEE FIELD 7 ABOUT ‘*’.
NUMERIC DEPRECATED  
*error Last Reported
  error_last_reported
11 This is the date/time at which a physical link error was last reported
to the network log device. This timestamp is checked by the error
reporting programs to insure that too many error messages are not
sent.

SEE FIELD 7 ABOUT ‘*’.
DATE-TIME DEPRECATED  
*number Of Recoverable Errors
  number_of_recoverable_errors
12 This is a count of the number of recoverable errors which have occurred
while sending or receiving messages to or from this domain, since the
counter was last set to zero.
Recoverable errors are errors which are detected by checksums, etc, which
require retransmission of the line.

SEE FIELD 7 ABOUT ‘*’.
NUMERIC DEPRECATED  
*progress Report
  progress_report
13 This field contains the time (in $H format) of the last time a queue
dump routine reported its progress. If this field is undefined, or
more than 5 minutes old, then the queue is assumed to be inactive.
If not, then the MESSAGE IN TRANSIT and LAST LINE TRANSMITTED fields
indicate the current status of the queue transmission.

SEE FIELD 7 ABOUT ‘*’.
STRING DEPRECATED  
*message In Transit
  message_in_transit
14 If this field exists, it indicates the message number of message currently
being transmitted.

SEE FIELD 7 ABOUT ‘*’.
NUMERIC DEPRECATED  
*line Last Transmitted
  line_last_transmitted
15 If this field exists, it indicates the line number of the MESSAGE IN TRANSIT
which was sent just prior to the last PROGRESS REPORT.

SEE FIELD 7 ABOUT ‘*’.
NUMERIC DEPRECATED  
*errors This Transmission
  errors_this_transmission
15.4 Number of “soft” errors (non-fatal) that have been encountered during the
course of the current transmission. This is the total number of soft
errors encountered during entire transmission.

SEE FIELD 7 ABOUT ‘*’.
NUMERIC DEPRECATED  
*rate Of Transmission
  rate_of_transmission
15.5 Transmission rate (in seconds) since the posting of the last progress
report. This number is based on the number of lines trasmitted since
the last progress report and the number of seconds since the last
progress report.

SEE FIELD 7 ABOUT ‘*’.
NUMERIC DEPRECATED  
*characters Rec'd
  characters_recd
15.6 This is the number of characters received during the current process and
is for the current message.

SEE FIELD 7 ABOUT ‘*’.
NUMERIC DEPRECATED  
*characters Sent
  characters_sent
15.7 This is the number of characters in the current message that have been
sent so far.

SEE FIELD 7 ABOUT ‘*’.
NUMERIC DEPRECATED  
Poll List
  poll_list
16 If this domain belongs to a poll list, then it will be activated when
a background poller is activated to send mail to this list.
NUMERIC    
Physical Link Device
  physical_link_device
17 This field is used for network mail ONLY.
If there is no device named in field 1.3 of the TRANSMISSION SCRIPT,
then this device is used. If no device is named in this field, then
the device named in field 8.25 of file 4.3 is used. If there’s no
device named in that field, then there is no device.
If this domain has a physical link such as a miniengine port,
a direct line to another cpu, a modem, etc., this port should be named
in this field to direct network mail to the proper output device.
There must be an entry in the DEVICE file for this cpu port. The name
field of the DEVICE file can be a literal (such as MINIENGINE-OUT or
CPU B LINK) but the $I field must match with the correct cpu $I.
If the link is physically located on a cpu other than the one the network
mail is being sent from, the local DEVICE file MUST reflect that in the
OTHER CPU field of the device file if the transmission is to take place
immediately. If it is not identified properly, the message will go into
a queue to be processed the next time a network message is sent from or
recieved on the processor with the physical link.
NOTE: The DEVICE files on all cpu’s must have matching device names
to correctly route the message to the proper cpu for sending.
STRING    
*network Device
  network_device
24 SEE FIELD 7 ABOUT ‘*’. STRING DEPRECATED  
*transmission Task#
  transmission_tasknumber
25 The transmission task# points to the TaskMan task that has been generated
to handle delivery of messages to the domain in background.

SEE FIELD 7 ABOUT ‘*’.
NUMERIC DEPRECATED  
Directory Requests Flag
  directory_requests_flag
50 This field controls whether or not the XMMGR-DIRECTORY-ALL option
will send a message requesting the user directory for the domain.

If the value is null or zero, no request will be made.
If the value is a positive integer, a request will be made
at the same time as other domains with the same number in this
field are made. A task must be set up and scheduled for each
number assigned using the XMDIR-REQUEST-ALL option, which is then
run every 90 days (or according to what you change the reschedule
value to).
NUMERIC INDEXED  
*message Statistics Month
  message_statistics_month
100 Message statistics are collected by month.

SEE FIELD 7 ABOUT ‘*’
STRING DEPRECATED  

↑ Return to top

Sub-Files

Transmission Script (4.21)

ID
Transmission_Script-4_21

Properties

Label/Field Name Field # Description Datatype Attributes Range
Transmission Script
  transmission_script
.01 This is the name of the transmission script. STRING INDEXED
REQUIRED
 
Priority
  priority
1 This field is used by MailMan to decide which script to play when trying
to transmit messages in background. The higher the number the lower the
priority for being chosen. See also the Number of Attempts field.
When MailMan is transmitting using the TCP/IP Poller (XMRTCP), it
assumes that there is only one possible TCP/IP connection per domain and
does not look for multiple scripts to roll over to. This field is only
operable for SMTP type scripts (using standard asynchronous WAN connections).
PRIORITIES can go from 0 to 9999 where 0 is the highest and 9999 is the
lowest. If the field has no value, 9999 is assumed.
NUMERIC INDEXED  
Number Of Attempts
  number_of_attempts
1.1 MailMan tests against this field to determine how many times it should
try a particular protocol before giving up and trying the next one.
This field is used in conjunction with the Priority field. When the
the Number of tries to transmit the messages in the queue exceeds the value
of this field, a Transmission Failure bulletin is sent to the Postmaster.
This field is only active with the SMTP type of transmission script.
NUMERIC    
Type
  type-1_2
1.2 Each transmission script must be given a type so that it
can be handled properly.
asynchronous connections on the WAN are of the type IDCU. These scripts
may compete with each other according to their priorities (See the
PRIORITY field). Scripts that use TCP/IP channels should be marked
with the type TCPCHAN so that they are ignored during prioritization
unless the TCP/IP enabled CPUs have Task Manager running on them, in
which case they should be made SMTP type.

In other words, if the physical link is on a CPU that Task Manager runs
on the transmission script can be of the type SMTP. If it is not on such
a CPU another type must be chosen.

Other types are TELNET (used for TalkMan or other interactive scripts),
FTP (for File Transfers) and Other.
ENUMERATION   TCP/IP Channel: TCPCHAN
File Transfer Protocol: FTP
Interactive / TalkMan: TELNET
Simple Mail Transfer Protocol: SMTP
OTHER: OTHER
Physical Link / Device
  physical_link___device
1.3 The physical link is the channel that the transmission will take place
on. This field is always a free text pointer to the device file.
See field 17 / Physical Link Device for more information.
STRING    
Network Address (mailman Host)
  network_address_mailman_host
1.4 The network address is that identifier that, used appropriately on the
physical link, allows specification of the system to be contacted.
STRING    
Out Of Service
  out_of_service
1.5 This is the preferred field to set to take a script out of service,
to prevent it from being used.
ENUMERATION   out of service: 1
in service: 0
Text
  text
2 This is the text of the script. See description above. STRING    
Transmission Script Notes
  transmission_script_notes
99 Keep notes that are important for systems management here. STRING    

↑ Return to top


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