TCP/IP link to the mainframe

# Begin Module Header ==========================================================
#
#——
# Name:
#——
#
# upoc_tran_client.tcl
#
#———
# Purpose:
#———
#
# Protocol UPOC for moving DMS documents into TRAN via TCP/IP
#
#
#——–
# Inputs:
#——–
#
# ARGS.IP   – hostname or IP of TRAN server
# ARGS.PORT – port number on the TRAN server to connect to
#
#
#——-
# Notes:
#——-
#
#———
# History:
#———
#
# 199?.??.?? intial version written prior to 1998
#
# 2006.12.28 Russ Ross
#
#          – added a header section to this proc so the history can be tracked
#
#          – send out email notification everytime a DMS document was too large for TRAN
#            and was truncated in the Xlate which can be determined by checking
#            the USERDATA metadata keyed entry (DMS_document_too_large_for_TRAN)
#
#          – modfied email addresses to use these aliases defined in /etc/aliases
#
#            tran_nak
#            tran_truncation
#
# 2007.01.03 Russ Ross
#          – added date time stamps to all echo statements
#
# 2007.01.11 Russ Ross
#          – added a check to be sure the USERDATA key was found
#            before invoking the logic to see if the document was truncated
#
# End Module Header ============================================================

proc upoc_tran_client {args} {
  keylget args MODE mode
  keylget args CONTEXT context

  global hostname
  global port
  global trxid
  global trhb_retries
  global msg_retries
  global email_addresses_for_nak
  global email_addresses_for_truncation
  global env HciConnName
  set module “upoc_tran_client v_2007.01.11”

  switch -exact — $mode {
     start {
        keylget args ARGS.IP   hostname
        keylget args ARGS.PORT port
        set trxid TRHB
        set trhb_retries 5
        set msg_retries 1
        set email_addresses_for_nak        “tran_nak”
        set email_addresses_for_truncation “tran_truncation”
        return “”
     }
     run {

        #—————–
        # Retrieve message
        #—————–

        keylget args MSGID msgid
        set msg [msgget $msgid]
        set msg [string trimright $msg ” “]
        set message_rc “”
        set msg_retry_cnt 0
        set conn_flag 0

        while {$msg_retry_cnt < $msg_retries} {            if {$message_rc == "“} {break}

           #——————————————————————–
           #  Sleeps one second and retries for 9 times to connect to the server
           #  If no connection made it breaks out of the loop sends page and
           #  Shuts down the thread.
           #——————————————————————–

           set cntr 0
           set break_point 0

           while {$cntr < 9} {               #---------------------------------------               # Set up file handles for read and write               #---------------------------------------               echo n[exec date] ($module / $HciConnName): CONNECTING to $hostname on port $port               set code [catch {set file_hd [server_open $hostname $port]}]               if [cequal $code 0] {break}               incr cntr               sleep 1               echo n[exec date] ($module / $HciConnName): Alert Number of Tries $cntr to connect to $hostname               if [cequal $cntr 9] {                  set break_point 1               }            }            if [cequal $break_point 1] {               set message_rc "could not connect to $hostname"               echo n[exec date] ($module / $HciConnName): $message_rc               set conn_flag 1               break            }            set fd_gets [lindex $file_hd 0]            set fd_puts [lindex $file_hd 1]            #-----------------------------------------            # Send TRHB to MVS and get Acknowledgement            #-----------------------------------------            echo n[exec date] ($module / $HciConnName): WRITING $trxid to SOCKET $fd_puts            puts $fd_puts $trxid            flush $fd_puts            echo n[exec date] ($module / $HciConnName): READING SOCKET $fd_gets            set ret_val [gets $fd_gets]            echo n[exec date] ($module / $HciConnName): TRXIDRETVAL $ret_val            echo n[exec date] ($module / $HciConnName): "--------------------------------------------------"            #-----------------------------------------            # Check for TRHB ACK.  If not one, resend.            #-----------------------------------------            set trhb_retry_count 0            while {$ret_val != "” && $trhb_retry_count < $trhb_retries} {               echo n[exec date] ($module / $HciConnName): RETURNVAL $ret_val               echo n[exec date] ($module / $HciConnName): RESENDING $trxid               puts $fd_puts $trxid               flush $fd_puts               set ret_val [gets $fd_gets]               incr trhb_retry_count            }            #------------------------------------------------------------            # ACK received.  Write message to MVS and get Acknowledgement            #------------------------------------------------------------            if {$ret_val == "“} {
              echo n[exec date] ($module / $HciConnName): WRITING message to SOCKET $fd_puts
              puts $fd_puts $msg
              echo n[exec date] ($module / $HciConnName): FLUSHING message from SOCKET $fd_puts
              flush $fd_puts
              echo n[exec date] ($module / $HciConnName): READING message from SOCKET $fd_gets
              set message_rc [gets $fd_gets]
              echo n[exec date] ($module / $HciConnName): MESSAGERETVAL $message_rc
              echo n[exec date] ($module / $HciConnName): “————————————————–”
           }

           close $fd_puts
           close $fd_gets
           incr msg_retry_cnt
        }

        if {$message_rc != “” || $conn_flag} {

           #—————————————————————————–
           # if we ever get here, it means the message got Naked 5 times
           # or we were unable to connect to the server so
           # save message to a file, turn off alerts, send email, and shutdown the thread
           #—————————————————————————–

           echo n[exec date] ($module / $HciConnName): MAX RETRIES DONE

           #————————————————–
           # build file names as julian date.counter.extension
           #————————————————–

           set saveDir $HciConnName
           append saveDir “_NAKS/”
           set julian [fmtclock [getclock] %Y%j]
           set fileCounter [format %05d [CtrNextValue “.test_tran_client.$HciConnName”]]
           set NakFileSpec $saveDir$julian.$fileCounter.nak
           set MsgFileSpec $saveDir$julian.$fileCounter.msg

           #———————————————–
           # create the save directories if they dont exist
           #———————————————–

           if {![file exists $saveDir]} {
              echo n[exec date] ($module / $HciConnName): creating $saveDir
              exec mkdir $saveDir
           }

           #—————————————————
           # save the Nak message in a file with extension .nak
           #—————————————————

           set Nakfd [open $NakFileSpec a+]
           puts $Nakfd $message_rc
           close $Nakfd

           #—————————————————-
           # save the original msg in a file with extension .msg
           #—————————————————-

           set Msgfd [open $MsgFileSpec a+]
           puts $Msgfd $msg
           close $Msgfd

           #——————————–
           # turn off alerts for this thread
           #——————————–

           # Next line of code uncommented out by Russ Ross 2001.08.28

           system “touch ../../../Alerts/$HciConnName.off”

           #——————————————————————-
           # append a time stamped entry to the alerts log file for this thread
           #——————————————————————-

           set logfile “../../../Alerts/$HciConnName.log”
           set logfh [open $logfile a+]
           set ts [fmtclock [getclock] “%a %b %d %Y %r “]
           set email_subject_for_nak “shutdown $HciConnName because $message_rc”
           puts $logfh “$ts($email_subject_for_nak) ($email_addresses_for_nak)”
           close $logfh

           #——————————————————–
           # send email notification that the thread has been NACKed
           #——————————————————–

           system “echo “Subject: $email_subject_for_nak\n.” | sendmail $email_addresses_for_nak”
           echo n[exec date] ($module / $HciConnName): recieved 5 Naks for the following message,
           stoping thread!!! n$msg

           #————
           # stop thread
           #————

           # Next 3 lines of code uncommented out by Russ Ross 2001.08.28

           set process [file tail [pwd]]
           echo n[exec date] ($module / $HciConnName): Stopping the Thread: $HciConnName
           system “hcicmd -p $process -c “$HciConnName pstop””
        }

        #—————————————————————————-
        # at this point TRAN has received the document and sent back an ACK
        #
        # send out email notification everytime a DMS document was too large for TRAN
        # and was truncated in the Xlate which can be determined by checking
        # the USERDATA metadata keyed entry (DMS_document_too_large_for_TRAN)
        #—————————————————————————-

        set datum_list [datlist]
        set USERDATA_metadata [msgmetaget $msgid “USERDATA”]
        set USERDATA_key_was_found [keylget USERDATA_metadata DMS_document_too_large_for_TRAN USERDATA_metadata_value]
        if {$USERDATA_key_was_found} {
           if { [string match -nocase $USERDATA_metadata_value “Y”] } {

              set document_number “GRM_problem”
              if {![catch {set ghd [grmcreate -msg $msgid frl tran_dms]} cerr]} {
                 if {![catch {set fhd [lindex [grmfetch $ghd txa12_udn_document] 0]}]} {
                    set document_number [datget $fhd VALUE]
                 } else { echo n[exec date] ($module / $HciConnName): GRM fetch problem!!!n$cerrn }
              } else { echo n[exec date] ($module / $HciConnName): GRM create problem!!!n$cerrn }

              set email_subject_for_truncation “DMS document ($document_number) was too large for TRAN and has been truncated!!!”
              system “echo “Subject: $email_subject_for_truncation\n.” | sendmail $email_addresses_for_truncation”
              echo n[exec date] ($module / $HciConnName): $email_subject_for_truncation
              echo n[exec date] ($module / $HciConnName): below is a msgdump for debugging and on-call support purposesn
              msgdump $msgid
              if {[info exists ghd]} {grmdestroy $ghd}
           }
        }
        hcidatlistreset $datum_list

        #————————————————
        # CONTIUE message so SMAT will be able to save it
        #————————————————

        echo n[exec date] ($module / $HciConnName): “ABOUT TO CONTINUE message to SMAT”
        return “{CONTINUE $msgid}”

     }

shutdown {
   # Doing some clean-up work
}
     default {
        echo n[exec date] ($module / $HciConnName): Invalid Mode $mode
     }
  }
}

proc upoc_nothing { args } {
   keylget args MODE mode               ;# Fetch mode
   global HciConnName

   set dispList {} ;# Nothing to return

   switch -exact — $mode {
       start {
           # do nothing
       }

       run {
           # do nothing
       }

       time {
           # do nothing
       }

shutdown {
           # do nothing
}

       default {
   error “Unknown mode ‘$mode’ in tps_numfile_ob”
       }
   }

   return $dispList
}

proc connection {mysock ip port} {
  global sock
  set sock $mysock
}
socket -server connection 8888

proc newgets {sock {seconds 10}} {
  global responded _data

  set responded 0
  after [expr $seconds * 1000] set done 1
  fileevent $sock readable “gets $sock _data; set responded 1; set done 1”
  vwait done

  fileevent $sock readable {}
  after abort {set done 1}

  if {$responded} {
return $_data
  } else {
error “timeout on read of socket ‘$sock'”
  }
}

Thu Dec 20 17:53:22 CST 2007 (upoc_tran_client v_2007.01.11 / ob_tran_3004): CONNECTING to 143.111.65.11 on port 3004

Thu Dec 20 17:53:22 CST 2007 (upoc_tran_client v_2007.01.11 / ob_tran_3004): WRITING TRHB to SOCKET sock32

Thu Dec 20 17:53:22 CST 2007 (upoc_tran_client v_2007.01.11 / ob_tran_3004): READING SOCKET sock31

Thu Dec 20 17:53:22 CST 2007 (upoc_tran_client v_2007.01.11 / ob_tran_3004): TRXIDRETVAL

Thu Dec 20 17:53:22 CST 2007 (upoc_tran_client v_2007.01.11 / ob_tran_3004): ————————————————–

Thu Dec 20 17:53:22 CST 2007 (upoc_tran_client v_2007.01.11 / ob_tran_3004): WRITING message to SOCKET sock32

Thu Dec 20 17:53:22 CST 2007 (upoc_tran_client v_2007.01.11 / ob_tran_3004): FLUSHING message from SOCKET sock32

Thu Dec 20 17:53:22 CST 2007 (upoc_tran_client v_2007.01.11 / ob_tran_3004): READING message from SOCKET sock31

Thu Dec 20 17:53:22 CST 2007 (upoc_tran_client v_2007.01.11 / ob_tran_3004): MESSAGERETVAL

Thu Dec 20 17:53:22 CST 2007 (upoc_tran_client v_2007.01.11 / ob_tran_3004): ————————————————–

Thu Dec 20 17:53:22 CST 2007 (upoc_tran_client v_2007.01.11 / ob_tran_3004): ABOUT TO CONTINUE message to SMAT