iimwire

iimwire

IIMWIRE collects wire input that is in standard message format IIM from the
joint ANPA-IPTC committee.

The header is parsed and the contents of tags are put in the FIP header fields
according to that described in the parameter file.

Normally the data file is left in the queue named in the parameter file and a
stub file containing just the FIP Header is slotted into the spool/2brouted
queue for IPROUTE to process and route.

The parameter file in tables/wire is normally the name of the service. It
contains one or more of the following :
    ; comment lines preceeded by a semicolon
    datapath: (full path name for the data)
        This is the name of the queue for data files.
    dump-data:
        exactly that !
    fiphdr:(2 letter FipHdr Code)   tag:(record,tag number)
    fiphdr:(2 letter FipHdr Code)   tag:(record,tag number)
binary:(size,format,swapped)
    fiphdr:(2 letter FipHdr Code)   tag:(record,tag number) bits:(size)
    fiphdr:(2 letter FipHdr Code)   tag:(record,tag number) type: (a|n|u|l|p|t)
    fiphdr:(2 letter FipHdr Code)   fixed:(fixed data)

There are a couple of variations on the fiphdr parameter. Normally just a tag
will do.
    eg Put contents of record 2, dataset 100 in JH
        fiphdr:JH   tag:2,100
Note there MUST be no spaces in the 'tag' part.
If the data is in binary format, it can be made visible using the 'binary'
subparameter which takes parameters a size - 1,2,4 bytes, an output format -
o,d,h for octal, decimal (default) or hex and, if from an Intel or Dec box, 's'
to flag the bytes are swapped.
        fiphdr:JK   tag:3,33    binary:4,d,s
If the field is a bit sequence, this can be converted to visable '0' and '1'
using bits:. An optional size is the number of bytes to convert - default is
the size of the incoming data.
TYPE will force the contents of the field :
    a - alphabetic only
    u - force all alphabetic uppercase
    l - force all alphabetic lowercase
    n - numbers only
    p - printable only
    s - space chrs only (TAB, VT, SPC, CR or NL)
    t - punctuation only
    b - allow all chrs
    x - alphanumeric only
    c - control chrs only
    z - anpa (alphanumeric and dash)  only
FIXED allows extra Fip Hdr fields to be added with no corresponding tag.

Input Parameters :
    Mandatory :
    -n : name of this wire (usually the agency)     default: none
either  -s : 'px25', 'sx25', Spider name or TTY device name default: none
    -p : Terminal Server port number (Not for TTY)      default: none
or  -P : Port on UnixBox to use for outbound        default: none
        This is only used where Terminal Servers canNOT run reverse telnet
        correctly and need to set a Permanent Virtual Connection across
        the ethernet to a fixed port number on the UnixBox

    Optional :
    -A : name of the archive file if not the -n name field  default: 'name'
    -d : the name of a DUPLICATE wire where 2 copies of the same
        file is required (SD header field).     default: none
    -f : Extra FIP header information           default: none
        For fixed header info in FIP. eg -f #QA:AA#QB:BASIC
        As this flag is normally the last specified, its contents
        can be used to overwrite any unique fields such as DU, DP, SN etc.
    -L : For Passive (-P) type connections, reestablish the
        link after disconnection            default: no
    -o : Name of output format (DF field)           default: IIMWIRE
    -O : Name of the output folder if not default      default: spool/2brouted
        This folder will be under /fip/spool
    -r : the name of a DIFFERENT routing table to 'name'
        (SR field : used by iproute)            default: name
    -t : timeout period in seconds              default: none
        If there is no data received within this time, the connect is cut and
restarted.
    -T : display timing stats               default: no
    -x : Wakeup string for Pad/modem etc            default: none
    -y : Banner string to strip from terminal server.default: SpiderBanner
    -Y : There is no banner to strip        default: as above
    -z : name of the parameter file in tables/wire      default: same as -n
    -Z : do NOT archive any incoming files          default: archive
    -v : Print the version number and exit

Version Control
;003j3  22may97 Binary properly added
    ;a minor - small mod for name
    ;b error - bad sock
    ;c 14nov97 WINNT - first version
    ;d 16dec97 minor - reset everything after loss of line
    ;e 20apr98 minor - added 'd' and 'e' as FipSeq data types
    ;f 23apr98 woops - altzone for HG
    ;g 24sep04 speedy
    ;h 30nov05 added -O for output queue
    ;i 08feb06 added -T
    ;j3 08nov06 woops - Reuters start to use Extended size tag and it disneywark

(copyright) 2017 and previous years FingerPost Ltd.