HP 3000 Manuals HP 3000 Manuals
Group 2 - Header Items
Transaction records in this group range in value from 10000 to 19999 and
must appear after Group 1 records in the Transaction File. Not all the
transaction records described below need appear in the Transaction File,
but if they do each will normally only appear once.
10000 - Message Sender/Creator name and address (tt_creator)
This record is returned by both HPDUserReceive and HPDGateReceive and is
required by HPDGateSend. Using standard HP Desk conventions, it
identifies the user who sent the message. This user is not an implicit
recipient of the message unless a FROM transaction type also exists for
the user (see Group 3 transactions).
Bytes Data Type Contents
17 - Integer Name/address format, only one type
20 will be supported with the HP Desk
Intrinsics, value 0, that is one which
conforms to standard HP Desk
conventions for names, mailnodes,
explicit foreign addresses and foreign
address aliases.
21 - Integer This field contains four integers
36 which are not used and should be set
to zeros.
37 Byte Sender name. This field is mandatory
-144 Array on input, unless Session Profile
record 100100 (use foreign address
aliases) is selected. It is always
returned on output.
145- Byte Sender's mailnode. This field is
152 Array mandatory on input. It is always
returned on output.
153 Byte Additional user information. This
etc Array field is optional on input and
returned on output if the relevant
Session Profile options are selected.
The format of this field is defined in
the 100100 Session Profile record or
2000 extra user information format
transaction. These define if explicit
foreign address information or foreign
address information are to be used,
and, if so, where they should appear
in this field and how long they are to
be (subject to a maximum of 512
bytes).
NOTE The width of the Transaction File will probably be governed by
whether the explicit foreign address or foreign address alias
options are selected. If they are not, or if Session Profile
options limit the maximum width of these fields, then the
Transaction File width can be reduced from the maximum possible.
For example, a tt_creator transaction record output by HPDUserReceive
could look like this:
![[]](../../pic3k/M011606/FFN273c50.gif)
10500 - Message Source indicator (tt_msg_source)
This transaction record is reserved for use by Hewlett-Packard,
therefore, user applications should ignore it.
11000 - Message Creation Date and Time (tt_created_date_time)
This transaction record may optionally be supplied to the HPDGateSend
Intrinsic. If it is not supplied, the creation date and time taken will
be that at which the message was processed. It will always be returned
from the HPDUserReceive and HPDGateReceive Intrinsics.
NOTE Unless a Session Profile option is provided requesting GMT format,
time is specified in the local time of the system processing or
returning the message.
Bytes Data Type Contents
17 - Integer Year (e.g. 1987))
20
21 - Integer Month (1 to 12) ) Date message was
24 created
25 - Integer Day (1 to 31) )
28
29 - Integer Hour (0 to 23) )
32
33 - Integer Minute (0 to 59) ) Time message was
36 created
37 - Integer Second (0 to 59) )
40
41 - Integer Local GMT offset in hours (positive or
44 negative - output only)
45 on Reserved for future use.
For example, a tt_created_date_time transaction record could look like
this:
![[]](../../pic3k/M011606/FFN283c50.gif)
11100 - Item Subject (tt_subject)
This transaction record contains the subject of a message or diary item.
This information is optional on input, if not supplied, a blank subject
field is substituted. The subject is always returned on output.
Bytes Data Type Contents[REV BEG]
17 - Byte Subject field (only the first 60 bytes
on Array are significant).[REV END]
For example, a tt_subject transaction record could look like this:
![[]](../../pic3k/M011606/FFN293c50.gif)
11200 - Message Item Priority Indicator (tt_msg_priority)
This transaction record defines the priority of a message. It is
optional on input, if not supplied a default of normal is taken for the
message. It is always returned on output.
Bytes Data Type Contents
17 - Integer Priority indicator with values as
20 follows:
0 normal
1 non-urgent
2 urgent
21 - Reserved for future use.
on
Priority indicators of 0 and 2 correspond to normal and urgent priorities
as used within HP Desk. These values can be set on messages received in
HP Desk or sent from HP Desk.
A priority indicator of 1, non-urgent, is normally only set on messages
sent into HP Desk. They are treated as low priority by HP Desk. This
priority indicator is used for compatibility with other mail systems.
The only occasion when it is set on messages sent from HP Desk is when a
message has been sent into HP Desk through an Intrinsics gateway,
travelled through the HP Desk system and been extracted again through
another Intrinsics gateway.
A tt_msg_priority transaction record could look like this:
![[]](../../pic3k/M011606/FFN303c50.gif)
11210 - Diary ToDo Item Priority Indicator (tt_todo_priority)
This defines the priority of a ToDo item. It is required on input and
always returned on output.
Bytes Data Type Contents
17 - Integer Priority indicator. Its value can be:
20
1 (high priority) to 9 (low
priority)
10 partially completed
11 completed
21 - Reserved for future use.
on
For example, a tt_todo_priority transaction record could look like this:
![[]](../../pic3k/M011606/FFN313c50.gif)
11300 - Item Security Indicator (tt_security)
Defines the security of a message or other item. It is optional on
input, if not supplied, the item is given a security level of NORMAL. It
is always returned on output.
Bytes Data Type Contents
17 - Integer Security indicator. Its values are:
20
0 normal
1 not used
2 private
3 not used
21 on Reserved for future use.
For example, a tt_security transaction record could look like this:
![[]](../../pic3k/M011606/FFN323c50.gif)
11400 - Requested acknowledgment level (tt_ack_level)
This defines the level of acknowledgment required on a message or reply.
As with standard HP Desk conventions, it applies only to the TO
recipients. It is optional on input, if not defined it defaults to no
acknowledgment requested. It is always returned on output.
NOTE Although provision exists within the Transaction File,
acknowledgment setting on an individual user basis is not supported
by the HP Desk Intrinsics.
Bytes Data Type Contents
17 - Integer Requested acknowledgment level. Its
20 values are:
0 no acknowledgment requested
1 Transmitted Ack requested
(HPDUserSend only)
2 Receipt Ack requested
3 Delivered Ack requested
4 Read Ack requested
5 Reply Ack requested
6 Forms Reply Ack requested
(HPDUserSend only)
21 - Integer Keep Pending Tray indicator
24 (HPDUserSend only):
0 delete when all Acks satisfied
1 retain when all Acks satisfied
25 on Reserved for future use
For example, a tt_ack_level transaction record could look like this:
![[]](../../pic3k/M011606/FFN333c50.gif)
11500 - Internal Message ID (tt_message_id)
Can be used to pass information that the originating system stores
internally about a message. This information can be up to 16 bytes long.
It is used in conjunction with HPDGateSend and HPDGateReceive. Its main
use is to handle acknowledgments. It is relevant for messages or replies
for which acknowledgments (or non-delivery notifications) are required.
It is optional on input and always returned on output.
If a calling application supplies this transaction in a message submitted
to HP Desk, the contents will be carried in the HP Desk message. If the
application has requested an acknowledgment to the message, a copy of the
contents is returned by HP Desk in the acknowledgment and appears in a
type 11510 (tt_ack_id) transaction (unless the destination system is
version B.02.00 or earlier, or is an external system linked to HP Desk
using FSC).
If a calling application is generating an acknowledgment (using
HPDGateSend) to a message sent by an HP Desk user, the contents of this
transaction must be copied from the original message and returned in the
acknowledgment as a type 11510 (tt_ack_id) transaction.
Bytes Data Type Contents
17 - Integer Message ID type. Its values can be:
20
0 HP Desk generated
1 non-HP Desk generated
21 - Integer Message ID subtype. If ID type is 0,
24 its values can be:
0 HP Desk
1 Reserved for future use.
25 - Internal message ID, its format is
40 dependent on the calling application.
The format of the record that HP Desk returns to calling applications for
messages originating in HP Desk will be as follows. The caller need not
be aware of the contents.
25 - Integer Message reference number (same as that
28 returned in HPDUserReceive or
HPDGateReceive Intrinsic calls).
29 - Integer User number of originating user
32
33 - Integer Pending Tray number of originating
36 user
37 - Integer Not used
40
For example, a tt_message_id transaction record submitted to HP Desk by a
calling application could look like this:
![[]](../../pic3k/M011606/FFN343c50.gif)
11510 - Internal Message Acknowledgment ID (tt_ack_id)
This is used to build up an acknowledgment or non-delivery message in
response to a previous message. It should be used in replies to previous
messages as HP Desk treats these as a form of acknowledgment. It is only
used in conjunction with HPDGateSend and HPDGateReceive.
On input, this transaction record must contain an exact copy of the 11500
(tt_message_id) transaction record returned in the original message or
reply to which this acknowledgment, reply or non-delivery notification
refers. The record is always returned on output if relevant.
Bytes Data Type Contents
17 - Integer Message ID type. Its value means:
20
0 HP Desk generated
1 non-HP Desk (i.e. customer)
generated
21 - Integer Message ID subtype. If ID type is 0,
24 its values may be:
0 HP Desk
1 Reserved for future use
25 - Internal message ID as contained in
40 the type 11500 transaction from the
original message.
For example, a tt_ack_id transaction record could look like this:
![[]](../../pic3k/M011606/FFN353c50.gif)
11600 - Message Mail Time (tt_mail_time)
Only available for input to HPDUserSend, to define a future date and time
at which a message is to be mailed, that is, when it is released for
processing by the HP Desk transport system. This record is optional, if
not supplied, the message is mailed immediately.
The time is taken as local time unless a Session Profile option to use
GMT format is used.
Bytes Data Type Contents
17 - Integer Year (e.g. 1987))
20
21 - Integer Month (1 to 12) ) Mail date
24
25 - Integer Day (1 to 31) )
28
29 - Integer Hour (0 to 23) )
32
33 - Integer Minute (0 to 59) ) Mail time
36
37 - Integer Second (0 to 59) )
40
41 on Reserved for future use.
For example, a tt_mail_time transaction record could look like this:
![[]](../../pic3k/M011606/FFN363c50.gif)
11700 - Appointment date/time specification (tt_app_date_time)
This transaction defines the date, time and duration of a diary
appointment on a message. This transaction is required when creating
diary items and is always returned when a diary item is read. It is
optional on input to HPDUserSend and HPDGateSend, if not supplied, no
appointment will be set. It is only output by HPDUserReceive and
HPDGateReceive if the originator of the message specified an appointment.
The time is taken as local time unless a Session Profile option to use
GMT format is used.
Bytes Data Type Contents
17 - Integer Year (e.g. 1987))
20
21 - Integer Month (1 to 12) ) Insertion date
24
25 - Integer Day (1 to 31) )
28
29 - Integer Hour (0 to 23) )
32
33 - Integer Minute (0 to 59) ) Insertion time
36
37 - Integer Second (0 to 59) )
40
41 - Integer Hour (0 to 23) )
44
45 - Integer Minute (0 to 59) ) Duration
48
49 - Integer Second (0 to 59) )
52
53 - Integer Clash indicator. Only applicable with
56 HPDDiary Intrinsic. Its value means:
0 allows a clash to occur
1 does not allow a clash to
occur
57 on Reserved for future use.
For example, a tt_app_date_time transaction record could look like this:
![[]](../../pic3k/M011606/FFN373c50.gif)
11750 - ToDo date specification (tt_todo_date)
This record defines the date of a diary ToDo item. It is also used to
mark a message as a ToDo item. It is required when creating diary items
and is always returned when a diary item is read. It is optional on
input to HPDUserSend and, if supplied, puts a todo entry in the diary of
the signed on user. It is never output by HPDUserReceive and
HPDGateReceive.
Bytes Data Type Contents
17 - Integer Year (e.g. 1987))
20
21 - Integer Month (1 to 12) ) Date of ToDo item
24
25 - Integer Day (1 to 31) )
28
29 on Reserved for future use.
For example, a tt_todo_date transaction record could look like this:
![[]](../../pic3k/M011606/FFN383c50.gif)
[REV BEG]
11800 - Hop Count (tt_hop_count)
This record defines the number of machines that the message has passed
through to reach this point. The application may wish to act upon this
field if the hop-count has reached an excessive number. HP Desk will not
transmit messages whose hop-count exceeds 64.
Bytes Data Type Contents
17 - Integer Hop Count (0 to 64 )
20
21 on Reserved for future use
For example, a tt_hop_count transaction record could look like this:
![[]](../../pic3k/M011606/FFN393c50.gif)
[REV END]
12000 - Disallow Autoforwarding indicator (tt_disallow_autof)
This is an indicator to show that a message or reply is not to be
autoforwarded. It is available to prevent the unnecessary movement of
messages and can also be used as a guard against looping. It is optional
on input files and if not supplied, autoforwarding is assumed to be
allowed. It is returned on output if this indicator is set in the HP
Desk message.
Bytes Data Type Contents
17 on Reserved for future use.
12100 - Non-delivery Action indicator (tt_non_delivery)
An indicator for use with the HPDGateSend and HPDGateReceive Intrinsics
to show what action should be taken by the receiving system if a message
cannot be delivered to a recipient on the Distribution List. It is
optional in an input file, if not supplied, the standard HP Desk action
(deliver to General Delivery) is taken. If it is supplied in the input
file and the receiving HP Desk system is version B.03.00 or later, it is
acted upon. The transaction is always returned on output.
NOTE Regardless of this option, messages for recipients on the BCC list
not known at their destination, and private messages for unknown
recipients, are destroyed by HP Desk.
Bytes Data Type Contents
17 - Integer Action indicator. Its values mean:
20
0 forward to central mailbox
(i.e. General Delivery).
This is the default.
1 Destroy and return warning
message
2 Return message
21 on Reserved for future use.
For example, a tt_non_delivery transaction record could look like this:
![[]](../../pic3k/M011606/FFN403c50.gif)
12200 - Non-delivery Reason Indicator (tt_non_del_reason)
An indicator for use with non-delivery notifications to indicate why a
previously sent message could not be delivered. It can only be used with
HPDUserReceive, HPDGateSend and HPDGateReceive. It is optional in input
files and always returned in output files.
Bytes Data Type Contents
17 - Integer Reason code for non-delivery. The
20 values are:
1 recipient not known at
destination system
3 message was too big
4 duplicate name
5 loop detected
6 message not allowed to pass
through gateway/leave local
system
21 - Integer "How the message was actioned"
24 indicator. The values are:
0 forwarded to central mailbox
(i.e. General Delivery).
This is the default.
1 destroyed and a warning
message returned
2 message returned
21 on reserved for future use
For example, a tt_non_delivery transaction record could look like this:
![[]](../../pic3k/M011606/FFN413c50.gif)
13000 - Diary Item Label (tt_diary_label)
A label, usually for a group of diary items. It is optional in input
files, if not supplied, a blank label field is substituted. It is always
returned in output files.
Bytes Data Type Contents
17 - Byte Label field (first 30 bytes are
on Array significant)
For example, a tt_diary_label Transaction File record could look like
this:
![[]](../../pic3k/M011606/FFN423c50.gif)
13100 - Diary Importance Indicator (tt_diary_importance)
Appointment and ToDo diary items can be of normal or minor importance.
Items of minor importance do not show up on weekly lists, only daily
lists.
Bytes Data Type Contents
17 - Integer Importance indicator:
20
0 normal importance (item
appears on all lists)
1 minor importance (item appears
on daily lists)
For example, a tt_diary_importance transaction record could look like
this:
![[]](../../pic3k/M011606/FFN433c50.gif)
13200 - Diary Item Type (tt_diary_item_type)
Used to specify if a diary item is a simple item or composite.
Bytes Data Type Contents
17 - Integer Item type:
20
0 Simple item
1 Mail item (composite item)
For example, a tt_diary_item_type transaction record could look like
this:
![[]](../../pic3k/M011606/FFN443c50.gif)