HP 3000 Manuals HP 3000 Manuals
Group 1 : Item Identifiers
1000 - Transaction File Body Type Identifier (tt_body_type)
This must always be the first record in a Transaction File.
Bytes Data Type Contents
17 - Byte Fixed identification string which must
20 array have the value "HPDI". (This is
defined as a constant in the Include
descriptions and Copy Library.)
21 - Integer Version number of the software that
24 produced this file. On input, this
should be supplied from the version
number field as defined (as a
constant) in INCLUDE files supplied
with the HP Desk Intrinsics product.
It corresponds to the value the
Intrinsic Driver program will output.
For the first version of the product
this will be 1, for subsequent
versions it will increase by a factor
of 2. A version 2 file supplied to a
version 1 Driver process will result
in a warning condition being
generated.
25 - Integer Body Type, defines precisely what is
28 contained in the file. Permitted
values are as follows:
0 Message
1 Forms message
100 Reply
101 Forms reply
102 Search reply
212 Received Ack
213 Delivered Ack
214 Read Ack
300 Non Delivery Item
400 Schedule message (freetime
request)
1000 Distribution List item
1100 Diary appointment item
1101 Diary todo item
2000 Intrinsic selection /list
3000 Intrinsics Session Profile
Bytes Data Type Contents
29 - Integer Body class, defines in more general
32 terms than body type what is contained
in the Transaction File. It is always
set on messages received from HP Desk
and must be supplied correctly on
messages sent into HP Desk. Values of
0 to 9 define items which can be
transmitted, higher values define
non-transmittable items.
0 Standard deliverable item
(message, ack, reply etc.)
1 Non-delivery notification
2 Service request (freetime
request etc.)[REV BEG]
3 Routed message or process
control item[REV END]
4-9 Unused
10 "Basic" item (Distribution
List, diary item etc. - input
and output).
99 An Intrinsics selection
operation (input only -
selector record is the second
record in the file) or the
result of an Intrinsics "list"
operation (output only - for
example a list of the In Tray,
diary directories etc., where
the output of the operation
can be used as selectors).
100 The file is an Intrinsics
Session Profile file, the
records following it are those
described in Chapter 8
(Session Profile File).
33 - Integer Reserved
36
37 - Integer Marker that identifies the first
40 trailer transaction record position at
the end of the file (output only,
ignored on input). The value of this
field is the MPE record number of the
record. For instance, a value of 10
means the the first trailer record is
in the 11th record of the file. A
value of 0 means there are no trailer
records in the file.
41 - Message size. Gives a general
44 indication of the message size in
Kilobytes, and is rounded up to the
next Kilobyte. It is actually the
size of the message in the HP Desk
database. (For output from HP Desk
only).[REV BEG]
45 - Integer Routed message state (only for when
48 Body class= 3)
0 Ordinary message
1 Approved message
2 Rejected message
48 on Reserved for future use.[REV END]
For example, a tt_body_type transaction record requesting an Intrinsic
selection and used as input to HPDUtility, could look like this:
Click here to view figure.
2000 - Format of Extra User Information (tt_eu_info_format)
This transaction record is intended for use primarily with the Gateway
Intrinsics.
When addresses and, therefore, the format of transactions like tt_to,
tt_cc etc. are tailored to an applications needs, tt_eu_info_format
specifies the format of these fields.
If you create a Transaction File for a gateway application using the
Transaction File Editor, it always creates one of these transaction
records.
If the Transaction File is created by HPDGateReceive, HPDGateReceive
creates this transaction record based on the sp_extra_user_info record in
the Session Profile file. If no sp_extra_user_info record exists, the
tt_eu_info_format record specifies that no extra user information is
defined.
If you are creating a Transaction File for input to HPDGateSend, the
tt_eu_info_format record is optional, but you are advised to supply it.
If it is missing, the values normally supplied by this record will be
taken from the Session Profile sp_extra_user_info record. If this is
also missing, it is assumed that there is no extra user information. If
both a tt_eu_info_format record and an sp_extra_user_info record
are supplied but contain different information, the values in
tt_eu_info_format are used.
Although this transaction is mainly for Gateway Intrinsic applications,
it can also be used with the User Intrinsics. It can be supplied to
HPDUserSend, and HPDUserReceive will always generate it although normally
it would simply indicate that there is no extra information. If used
with the User Intrinsics, only the Explicit Foreign Address type is
meaningful--foreign aliases are only seen when messages pass through
gateways.
Bytes Data Type Contents
17-20 Integer Option 1 type
21-24 Integer Option 1 length (in bytes)
25-28 Integer Option 2 type
29-32 Integer Option 2 length (in bytes)
etc..... .
Values for Option type are:
"Search" items
1 - Foreign address aliases
"Supplementary" items
10 - Explicit foreign addresses
For example, if an sp_extra_user_info record has the following values:
Click here to view figure.
All name/address fields in tt_to and similar records would be formatted
like this:
Bytes Data Type Contents
37 Byte Name
-144 array
145- Byte Mailnode
152 array
153- Byte Foreign address alias
192 array
193- Byte Explicit foreign address
232 array
5000 - Message List Selector (tt_list_messages)
If you want to selectively list messages in either the In Tray or Pending
Tray, this is required as the second record in an otherwise empty
Transaction File. This record is overwritten with the results.
Selection may either be by creator name and node (using standard HP Desk
name comparison rules), by subject (using standard HP Desk subject
matching rules), by creation date range, by urgency or by a combination
of these (where all the selection criteria must apply). A "null" record,
or the absence of a record, results in the entire tray being listed.
Bytes Data Type Contents
17 Byte Sender/Creator name
-124 Array
125- Byte Sender/Creator's mailnode
132 Array
133- Byte Message subject
192 Array
193- Integer Year (e.g. 1987))
196
197- Integer Month (1 to 12) ) FROM date
200
201- Integer Day (1 to 31) )
204
205- Integer Year (e.g. 1987))
208
209- Integer Month (1 to 12) ) TO date
212
213- Integer Day (1 to 31) )
216
217- Integer Priority indicator with the following
220 values:
0 Priority insignificant
1 Select if message urgent
221 on Reserved for future use
For example, a tt_list_messages transaction record to list all messages
with a subject of Actlist, could look like this:
Click here to view figure.
5100 - In-tray Item (tt_intray_item)
This record describes an In Tray item as returned by the "list In Tray"
function of the HPDUtility Intrinsic. It can be submitted to the
HPDUserReceive Intrinsic as an item selector in order to read a specific
message. You can only have one item selector in a Transaction File, as
HPDUserReceive can only return one item at a time. You can also submit a
tt_intray_item to HPDDeleteMsg to delete a message from the In Tray. You
can delete more than one item in a call to HPDDeleteMsg by supplying
multiple item selectors in the Transaction File.
Bytes Data Type Contents
17 - Reserved.
24
25 - Integer Message type. Its value can be:
28
0 Message
1 Forms Message
100 Reply
101 Forms Reply
102 Search Reply
300 Non Delivery Item
400 Schedule message (freetime
request)
29 - Integer Message class. Its value can be :
32
0 Standard
1 Non-delivery notification
2 Service request
33 - Integer Reserved
36
37 - Integer Message reference/tracking number
40
41 Byte Sender/Creator name
-148 Array
149- Byte Sender/Creator's mailnode
156 Array
157- Byte Message subject
216 Array
Bytes Data Type Contents
217- Integer Category of recipient. Its value can
220 be:
1 FROM
2 TO
3 CC
4 BCC
221- Integer Year (e.g. 1987))
224
225- Integer Month (1 to 12) ) Date message was
228 sent
229- Integer Day (1 to 31) )
232
233- Integer Hour (0 to 23) )
236
237- Integer Minute (0 to 59) ) Time message was
240 sent
241- Integer Second (0 to 59) )
244
245- Integer New message indicator. Its value can
248 be:
0 Old message (i.e. already
read)
1 New message (i.e. not yet
read)
249- Integer Priority indicator. Its values can
252 be:
0 Normal
1 Non-urgent
2 Urgent
253- Integer Appointment indicator. Its values can
256 be:
0 No appointment set on message
1 Appointment set
257- Integer Security indicator. Its values can
260 be:
0 Normal
1 Not used
2 Private
3 Not used
Bytes Data Type Contents
261- Integer Requested level of acknowledgment set
264 (by creator of message):
0 No acknowledgment set
1 Transmitted Ack set
2 Received Ack set
3 Delivered Ack set
4 Read Ack set
5 Reply Ack set
6 Forms reply Ack set
265 on Reserved for future use.
For example, a tt_intray_item transaction record returned by the
HPDUtility Intrinsic and which could be used as input to HPDUserReceive
might look like this:
Click here to view figure.
5200 - Pending Tray Item (tt_pendingtray_item)
This record describes a Pending Tray item as returned by the "list
Pending Tray" function of the HPDUtility Intrinsic. It can be submitted
to the HPDUserReceive Intrinsic an an item selector in order to read a
specific message. You can only have one item selector in a Transaction
File as HPDUserReceive can only return one item at a time. You can also
submit a tt_pendingtray_item to HPDDeleteMsg to delete a message from the
Pending Tray. You can delete more than one item in a call to
HPDDeleteMsg by supplying multiple item selectors in the Transaction
File.
Bytes Data Type Contents
17 - Reserved.
24
25 - Integer Message type. Its value can be:
28
0 Message
1 Forms Message
100 Reply
101 Forms Reply
102 Search Reply
300 Non Delivery Item
400 Schedule message (freetime
request)
29 - Integer Message class. Its value can be:
32
0 Standard
1 Non-delivery notification
2 Service request
33 - Integer Reserved
36
37 - Integer Message reference/Tracking number
40
41 Byte Sender/Creator's name
-148 Array
149- Byte Sender/Creator's mailnode
156 Array
157- Byte Message subject
216 Array
217- Integer Not used
220
Bytes Data Type Contents
221- Integer Year (e.g. 1987))
224
225- Integer Month (1 to 12) ) Date message was
228 sent
229- Integer Day (1 to 31) )
232
233- Integer Hour (0 to 23) )
236
237- Integer Minute (0 to 59) ) Time message was
240 sent
241- Integer Second (0 to 59) )
244
245- Integer Not used
248
249- Integer Priority indicator. Its value can be:
252
0 Normal
1 Non-urgent
2 Urgent
253- Integer Appointment indicator. Its value can
256 be:
0 No appointment set on message
1 Appointment set
257- Integer Security indicator. Its value can be:
260
0 Normal
1 Not used
2 Private
3 Not used
261- Integer Requested level of acknowledgment set
264 (by creator of message):
0 No acknowledgment set
1 Transmitted Ack set
2 Received Ack set
3 Delivered Ack set
4 Read Ack set
5 Reply Ack set
6 Forms reply Ack set
265 on Reserved for future use.
For example, a tt_pendingtray_item transaction record could look like
this:
Click here to view figure.
5300 - Diary List Selector (tt_list_diary)
If you want to list items or free time (using the HPDUtility Intrinsic)
in the currently signed on user's diary, this must be the second record
in an otherwise empty Transaction File. It will be overwritten with the
results. The selection of appointments and ToDo items may be by a number
of criteria, individually or in combination. Selection of a free time
list may be done by date range only.
Bytes Data Type Contents
17 - Integer Year (e.g. 1987))
20
21 - Integer Month (1 to 12) ) FROM date
24
25 - Integer Day (1 to 31) )
28
29 - Integer Year (e.g. 1987))
32
33 - Integer Month (1 to 12) ) TO date
36
37 - Integer Day (1 to 31) )
40
41 - Integer Item type selector. Values as
44 follows:
0 List appointments only
1 List ToDo items only
2 List both appointments and
ToDos
3 List freetime
45 Byte Item subject
-104 Array
105- Byte Item label (only 1st 30 bytes are
136 Array significant)
137 on Reserved for future use.
For example, a tt_list_diary transaction record could look like this:
Click here to view figure.
5400 - Diary Appointment/ToDo Item (tt_app_todo_item)
This transaction record describes a diary appointment or ToDo item as
returned by the "list diary" function of the HPDUtility Intrinsic.
Several of these records may be returned in the Transaction File. This
record can be submitted to the HPDUtility Intrinsic as an item selector
in order to read or delete a specific item from the diary.
Bytes Data Type Contents
17 - Integer Diary item type. Its value is as
20 follows:
1100 Appointment
1101 ToDo item
21 - Integer Diary item reference number (entry
24 number)
25 - Integer Year (e.g. 1987))
28
29 - Integer Month (1 to 12) ) Insertion date
32
33 - Integer Day (1 to 31) )
36
37 - Integer Hour (0 to 23) )
40
41 - Integer Minute (0 to 59) ) Insertion time
44 (appts only)
45 - Integer Second (0 to 59) )
48
49 - Integer Hour (0 to 23) )
52
53 - Integer Minute (0 to 59) ) Duration (appts
56 only)
57 - Integer Second (0 to 59) )
60
61 Byte Item subject
-120 Array
121- Byte Item label (only 1st 30 bytes
152 Array significant)
153- Integer Priority indicator (ToDo items only):
156
1 (high priority)
to
9 (low priority)
10 partially completed
11 completed
Bytes Data Type Contents
157- Integer Security indicator. Its value can be:
160
0 normal
1 not used
2 private
3 not used
161- Integer Importance indicator. Its value can
164 be:
0 normal entry type
1 minor entry
165 on Reserved for future use
For example, a tt_app_todo_item transaction record could look like this:
Click here to view figure.
5500 - Diary List Free Item (tt_listfree_item)
This record describes a free time map as returned by the "list free time"
function of the HPDDiary Intrinsic. Several of these transaction records
may be returned in the Transaction File, one for each day for which the
list is requested.
Bytes Data Type Contents
17 - Integer Year (e.g. 1987))
20
21 - Integer Month (1 to 12) ) Date for which
24 this
25 - Integer Day (1 to 31) ) record applies
28
29 Byte Free time map for above date. Free
-124 Array time is given for each 15 minute time
slice, starting at 00:00 and ending at
23:45 (96 time slices in all). An
ASCII 0 represents a free time slice,
an ASCII 1 represents booked time.
125 on Reserved for future use.
For example, a tt_listfree_item transaction record could look like this:
Click here to view figure.