IPC Files [ HP DeskManager Customization ] MPE/iX 5.0 Documentation
HP DeskManager Customization
IPC Files
Outgoing FSC Messages
The IPC file whose format is detailed below is used to describe the
identity and destination of one or more MPE files containing messages to
be transmitted by an external transport system.
There is one IPC file for each external transport system, that is one for
each gateway known to the local computer. The IPC file for the gateway
must be built before the external transport system can be used. The
characteristics of the IPC file must be the same as if it were to be
built by the following MPE command:
BUILD filename;REC=-80,,F,ASCII;MSG
The length of each record in the IPC file is 80 bytes. The fields in
each record are:
Entry type:.
COBOL pic S9(4)
PASCAL smallint
1 describes HP Desk internal format file (EFT).
2 describes ARPA Standard format file.
3 describes ARPA Reference format file.
4 describes ARPA Compressed format file.
NOTE smallint is defined in a PASCAL program as: TYPE smallint=
-32768...32767;
Filename:.
COBOL pic X(36)
PASCAL 36 chars packed
Name of the MPE file containing messages.
NOTE "36 chars packed" is defined in a PASCAL program as:
VAR filename:PACKED ARRAY [1..36] OF char;
Filler:.
COBOL PIC S9(4)
PASCAL smallint
Reserved for future use.
Target mailnode:.
COBOL PIC X(8)
PASCAL 8 chars packed
This is the HP Desk location and sublocation of the target mailnode as
configured.
NOTE 8 chars packed is defined in a PASCAL program as:
VAR target_node:PACKED ARRAY [1..8] OF char;
Gateway name:.
COBOL PIC X(8)
PASCAL 8 chars packed
This is the computer or gateway name as entered on the EFT/FSC menu in
Mailconfig. Its only function is to provide a check that the entries in
the IPC file are intended for the external transport system doing the
reading. The gateway name should be agreed by the HP Desk system
Administrator and the designer of the external transport application
program.
For example, agateway is configured to a foreign system known to HP Desk
as COMGRM (the HP Desk node). The gateway is named COMSYS and it is
configured to handle ARPA format messages. The connecting IPC file for
the gateway is COMIPC.HPMAIL.HPOFFICE.
Every time the external application program reads a record from the file
COMIPC, it checks for the gateway name COMSYS. If it finds any other
name, there is an error in the system. The gateway has probably been
given a different name during configuration.
Time:.
COBOL PIC S9(8)
PASCAL integer
The time that the entry was written to the IPC file in CLOCK format.
Date:.
COBOL PIC S9(4)
PASCAL smallint
The date that this entry was written to the IPC file in CALENDAR format.
Software level number:.
COBOL PIC S9(4)
PASCAL smallint
The version number of the FSC software that produced the file. The
number will increase with each release of the software; the increment may
be greater than one.
Filler:.
COBOL PIC S9(8)
PASCAL integer
Reserved for future use.
Privileged file indicator:.
COBOL PIC S9(4)
PASCAL smallint
Shows whether the file is privileged or not:
0 means the file is a normal file
1 means the file is a privileged file
Filler:.
Remaining bytes
These are reserved for future use.
Sample Outgoing IPC File Format.
GATE2IPC.EFILES.HPOFFICE RECORD 0 (%0, #0)
00000: 0002 4532 3139 3135 3332 2E45 4649 4C45 ..E2191532.EFILE
00010: 532E 4850 4F46 4649 4345 3B20 2020 2020 S.HPOFFICE;
00020: 2020 2020 2020 0000 4942 4D47 4154 2020 ..IBMGAT
00030: 5245 4D47 4154 4532 0B11 2007 ACC5 0FAC REMGATE2.. .....
00040: 2020 2020 0000 2020 2020 2020 2020 2020 ..
GATE2IPC.EFILES.HPOFFICE RECORD 1 (%1, #1)
00000: 0002 4532 3139 3135 3333 2E45 4649 4C45 ..E2191533.EFILE
00010: 532E 4850 4F46 4649 4345 3B20 2020 2020 S.HPOFFICE;
00020: 2020 2020 2020 0000 5445 5354 5553 2020 ..TESTUS
00030: 5245 4D47 4154 4532 1210 0001 ACD5 0FAC REMGATE2........
00040: 2020 2020 0000 2020 2020 2020 2020 2020 ..
GATE2IPC.EFILES.HPOFFICE RECORD 2 (%2, #2)
00000: 0002 4532 3139 3135 3431 2E45 4649 4C45 ..E2191541.EFILE
00010: 532E 4850 4F46 4649 4345 3B20 2020 2020 S.HPOFFICE;
00020: 2020 2020 2020 0000 4942 4D47 4154 2020 ..IBMGAT
00030: 5245 4D47 4154 4532 1210 1B08 ACD5 0FAC REMGATE2........
00040: 2020 2020 0000 2020 2020 2020 2020 2020 ..
GATE2IPC.EFILES.HPOFFICE RECORD 3 (%3, #3)
00000: 0002 4532 3139 3135 3537 2E45 4649 4C45 ..E2191557.EFILE
00010: 532E 4850 4F46 4649 4345 3B20 2020 2020 S.HPOFFICE;
00020: 2020 2020 2020 0000 4850 3136 3030 5858 ..HP1600XX
00030: 5245 4D47 4154 4532 1210 2700 ACD5 0FAC REMGATE2..'.....
00040: 2020 2020 0000 2020 2020 2020 2020 2020 ..
GATE2IPC.EFILES.HPOFFICE RECORD 4 (%4, #4)
00000: 0002 4532 3139 3136 3036 2E45 4649 4C45 ..E2191606.EFILE
00010: 532E 4850 4F46 4649 4345 3B20 2020 2020 S.HPOFFICE;
00020: 2020 2020 2020 0000 4942 4D47 4154 2020 ..IBMGAT
00030: 5245 4D47 4154 4532 1006 0902 ACDA 0FAD REMGATE2........
00040: 2020 2020 0000 2020 2020 2020 2020 2020 ..
GATE2IPC.EFILES.HPOFFICE RECORD 5 (%5, #5)
00000: 0002 4532 3139 3136 3230 2E45 4649 4C45 ..E2191620.EFILE
00010: 532E 4850 4F46 4649 4345 3B20 2020 2020 S.HPOFFICE;
00020: 2020 2020 2020 0000 4653 4320 2020 3032 ..FSC 02
00030: 5245 4D47 4154 4532 1014 1303 ACDB 0FAD REMGATE2........
00040: 2020 2020 0000 2020 2020 2020 2020 2020 ..
The hex code on the left is shown printed out on the right.
Non-printable hex codes are represented by periods (.). In this example
each record identifies an MPE file to be transported via an FSC gateway
called REMGATE2 (as the first item in each record, the record type is 1).
The MPE filename is shown as an E file resident in the group
EFILES.HPOFFICE, and the HP Desk defined destination mailnodes as IBMGAT,
TESTUS and so on. The entry type and time/date are non-printable.
Incoming FSC Messages
This IPC file is used to describe the identity of an MPE file delivered
by an external transport system and containing the ARPA format messages
or ARPA/Reference format messages which need to be brought into HP Desk.
On any system there is only one incoming IPC file for each format and
this is pre-built by an MPE command in one of the following forms which
correspond to the format used by the gateway:
BUILD ARPAIPC.MAILDB.HPOFFICE;REC=-80,,F,ASCII;MSG
for incoming FSC ARPA Standard and Compressed (formats 2 and 4) and:
BUILD AREFIPC.MAILDB.HPOFFICE;REC=-80,,F,ASCII;MSG
for incoming FSC ARPA Reference (format 3).
The length of each record in the IPC file is 80 bytes.
The fields in each record are:
Entry type:.
COBOL PIC S9(4)
PASCAL smallint
2 describes an ARPA Standard format file
3 describes an ARPA Reference format file
4 describes an ARPA Compressed format file
Filename:.
COBOL PIC X(36)
PASCAL 36 chars packed
Name of the MPE file containing the incoming messages.
Filler:.
COBOL PIC S9(4) OCCURS 5
PASCAL smallint times 5
Gateway name:.
COBOL PIC X(8)
PASCAL 8 chars packed
Name of the gateway from which messages are being received which, if not
blank, is for use when resolving foreign alias addresses.
Filler:.
COBOL PIC S9(4) OCCURS 4
PASCAL smallint times 4
Start message number:.
COBOL PIC S9(4)
PASCAL smallint
This identifies the sequence number of the message within the incoming
data file at which processing is to start. Set to 0 or 1 if processing
is to start at the beginning of the file. Same as failed message number
in the FSC Error file explained in "Errors While Processing Incoming
Messages" .
FSC Error Code:.
COBOL PIC S9(4)
PASCAL smallint
This details the reason for failure.
Filler:.
COBOL PIC S9(4)
PASCAL smallint
Suppress message header indicator:.
COBOL PIC S9(4)
PASCAL smallint
This indicates whether, when a message from a foreign system is brought
into HP Desk, the generation of the "Part 2 MESSAGE HEADER" should be
suppressed.
1 means suppression
Any other value means message header generation.
Filler:.
Remaining bytes
These are reserved for future use.
Sample ARPAIPC File Format.
ARPAIPC.MAILDB.HPOFFICE RECORD 0 (%0, #0)
00000: 0002 5730 3334 3734 352E 5052 4F46 534D ..W034745.PROFSM
00010: 5347 2E48 504F 4646 4943 453B 2020 2020 SG.HPOFFICE;
00020: SAME: TO 000030-1
00030: 5245 4D47 4154 4532 2020 2020 2020 2020 REMGATE2
00040: SAME: TO 000050-1
ARPAIPC.MAILDB.HPOFFICE RECORD 1 (%1, #1)
00000: 0002 5730 3334 3932 342E 5052 4F46 534D ..W034924.PROFSM
00010: 5347 2E48 504F 4646 4943 453B 2020 2020 SG.HPOFFICE;
00020: SAME: TO 000030-1
00030: 5245 4D47 4154 4532 2020 2020 2020 2020 REMGATE2
00040: SAME: TO 000050-1
ARPAIPC.MAILDB.HPOFFICE RECORD 2 (%2, #2)
00000: 0002 5730 3334 3935 372E 5052 4F46 534D ..W034957.PROFSM
00010: 5347 2E48 504F 4646 4943 453B 2020 2020 SG.HPOFFICE;
00020: SAME: TO 000030-1
00030: 5245 4D47 4154 4532 2020 2020 2020 2020 REMGATE2
00040: SAME: TO 000050-1
MPE/iX 5.0 Documentation