HP 3000 Manuals HP 3000 Manuals
Examples of Transaction Files
This section contains some examples of what Transaction Files to or from
particular Intrinsics may contain.
Examples are given for:
Submitting messages to HPDUserSend
Extracting messages with HPDUserReceive
Creating an appointment using HPDDiary
Submitting messages to HPDGateSend
An acknowledgment received with HPDGateReceive
Name validation using HPDNameProbe
Documentation conversion with HPDUtility
Sending and receiving forms messages
Sending and receiving forms packages
Replying to a forms package
Distribution Lists as content files within a message
HPDUserSend
There are a variety of messages which may be submitted to HPDUserSend by
a calling application. The simplest message has just 4 records (3 if the
subject is left blank). All but key information in the records can be
zero filled.
Transaction Type Content
1000 tt_body_type Body type = 0 (message)
Body class = 0 (standard
deliverable item)
11100 tt_subject Subject of message
21100 tt_to Recipients HP Desk name/node
30500 Filecode and name of file
tt_content_file containing text of message
NOTE tt_creator and tt_created_date_time records are not needed.
HPDUserReceive
This allows messages to be extracted serially from either the In Tray or
the Pending Tray. The use of a selector record allows the extraction of
specific messages.
The format of messages returned by HPDUserReceive is fixed, that is
whatever the message contains, the transactions appearing in the file are
the same. The following items are always returned and items in square
brackets appear if relevant.
Transaction Type Content
1000 tt_body_type Body type = 0 (message)
Body class
0 (standard deliverable item)
10000 tt_creator Message creator name/node
11000 tt_created_date_time Date and time message was mailed
11100 tt_subject Subject of message
11200 tt_msg_priority "Urgent" indicator
11300 tt_security "Private" indicator
11400 tt_ack_level Request reply acknowledgment
11700 [tt_app_date_time Date/time/duration of appointment
on message] BOX NORULE NONUMBER
INDENT COLSPEC="L7.5CM,L7.4CM">
12000 [tt_disallow_autof Disallow autoforwarding of this
message]
21100 [tt_to Recipients HP Desk name/node]
21200 [tt_cc Recipients HP Desk name/node]
21300 [tt_bcc Recipients HP Desk name/node]
21000 [tt_from Recipients HP Desk name/node]
30100 [tt_start_package Package creator name and subject]
30500 tt_content_file Filecode and file name
30500 [tt_content_file Filecode and file name]
39000 [tt_end_package ]
200000 tt_referenced_file Name of referenced file
200000 [tt_referenced_file Name of referenced file]
NOTE Distribution Lists appearing as part of the content of the message
are contained in referenced files containing Distribution Lists in
Transaction File format - see a further example later on in this
chapter for details.
HPDDiary
A basic appointment item can be created using HPDDiary by supplying a
Transaction File with the following transaction types. Items in square
brackets are optional.
Transaction Type Content
1000 tt_body_type Body type = 0 (message)
Body class
0 (standard
deliverable item)
11100 [tt_subject Subject of appointment]
11300 [tt_security "Private" indicator]
11700 Appointment date plus time and
tt_app_date_time duration
13000 Label to identify item]
[tt_diary_label
30500 Filecode and file name
tt_content_file
HPDGateSend
As for HPDUserSend, a variety of different messages may be submitted and
within these, various combinations of transaction records may be used.
Transaction Type Content
1000 tt_body_type Body type = 0 (message)
Body class
0 (standard deliverable item)
10000 tt_creator Message creator name/node (+
foreign address)
11000 tt_created_date_time Date and time message was
generated/submitted
11100 tt_subject Subject of message
11200 tt_msg_priority "Urgent" indicator
11300 tt_security "Private" indicator
11400 tt_ack_level Request reply acknowledgment
11750 tt_todo_date Date of todo placed on message
12100 tt_non_delivery Action if cannot deliver message
12000 tt_disallow_autof Disallow autoforwarding indicator
21100 tt_to Recipients HP Desk name/node
21100 [tt_to Recipients HP Desk name/node]
21200 [tt_cc Recipients HP Desk name/node]
21300 [tt_bcc Recipients HP Desk name/node]
21400 tt_use_distlist Recipients Distribution List
30500 tt_content_file Filecode and file name
30100 tt_start_package Package and subject
30500 tt_content_file Filecode and file name of content
file
30500 tt_content_file Filecode and name of additional
content file
39000 tt_end-package
HPDGateReceive
An acknowledgment returned by HPDGateReceive has the following fixed
format:
Transaction Type Content
1000 tt_body_type Body type = 0 (message)
Body class
0 (standard
deliverable item)
10000 tt_creator Name/address of the recipient of
the original message being
acknowledged
11510 tt_ack_id A copy of the tt_message_id record
supplied in the original message
21100 tt_to Name/address of the creator/sender
of the original message being
acknowledged. Note that only the
address is generated by HP Desk,
and only the address is used if
supplied by HP Desk.
Other transaction types will appear in the file, such as tt_security.
However, the transactions above contain the fields essential for an
application to implement an acknowledge feature.
HPDNameProbe
If a match is found, the validation of supplied names and addresses
results in the updating of a supplied name/address transaction record
with the full name and address details as held in the HP Desk
database.[REV BEG] (This is only true if op_type is 1, otherwise if it is
0, it only performs checking.)[REV END] If a match cannot be found, this
is indicated in the supplied name/address transaction record. More than
one name and address record can be validated in this way with each
Intrinsic call and can appear within a Transaction File that contains a
complete message, reply or Distribution List item. Note that the
tt_body_type is not checked, and any transaction may be supplied in the
file, although only recipient transactions are processed. The input:
Transaction Type Content
1000 tt_body_type Body type = 2000 (Intrinsic
selection/list)
Body class = 99 (selection
operation)
Any value is permitted
21100 tt_to Recipient HP Desk name
or recipient HP Desk name/node
will, if a match is found, be updated by the Intrinsic as follows:
1000 tt_body_type Body type = 2000
Body class = 99
Values unchanged
21100 tt_to Full HP Desk name and node
The result field of the transaction record is updated with a code to
identify that the record has been successfully probed so that this is not
unecessarily repeated when the file is subsequently submitted to
HPDUserSend or HPDGateSend. If no match is found, or duplicates appear
to exist, the result field indicates this.
HPDUtility
One of the things HPDUtility allows you to do is convert documents. The
identity of document files to be converted to different formats (subject
to the availability of suitable converters in the system) is defined in a
single transaction record. One or more of these can appear in the
Transaction File, so allowing several conversions to be performed at
once.
Input:
Transaction Type Content
1000 tt_body_type Body type = 0 (message)
Body class
0 (standard
deliverable item)
30600 Filecode to which file is to be
tt_convert_file converted, with name of file to be
converted
Returns:
1000 tt_body_type Body type = 0
Body class = 0
30600 Same as output but with name of
tt_convert_file converted file
The result field for this record indicates if the specified conversion
path does not exist.
Forms Messages
Applications can submit a forms message to HPDUserSend and HPDGateSend.
HPDUserReceive and HPDGateReceive can return a forms message to your
application.
The forms message format follows. Note that various Group 2 and Group 3
transactions may occur, depending on the instrinsic, as in earlier
examples.
Transaction Type Content
1000 tt_body_type Body type = 1 (forms message)
Body class = 0 (deliverable item)
11100 tt_subject Subject of message
[........ Other Group 2 transactions if
required]
21100 tt_to Recepient's HPDesk name and node
[........ Other Group 3 transactions if
required]
30100 Package, subject
tt_start_package type = forms package
30500 Name of forms file
tt_content_file filecode = 0
MPE filecode of file = 1035 (VFORM)
30500 Name of forms data file
tt_content_file filecode = 1447
MPE filecode of file = 0
[30500 Name of additional forms data
tt_content_file files]
39000
tt_end_package
The package in a forms message is taken as being a forms package,
irrespective of whether or not the package is given a type of forms
package.
Forms Package
Your application can submit a message containing a forms package to
HPDUserSend or HPDGateSend. Similarly, HPDUserReceive and HPDGateReceive
can return a message containing a forms package to your application. An
example is:
Transaction Type Content
1000 tt_body_type Body type = 0 (message)
Body class = 0 (deliverable item)
11100 tt_subject Subject of message
[........ Other Group 2 transactions if
required]
21100 tt_to Recepient's HPDesk name and node
[........ Other Group 3 transactions if
required]
30100 Package, subject
tt_start_package type = forms package
30500 Name of forms file
tt_content_file filecode = 0
MPE filecode of file = 1035 (VFORM)
30500 Name of forms data file
tt_content_file filecode = 1447
MPE filecode of file = 0
[30500 Name of additional forms data
tt_content_file files]
39000
tt_end_package
[........ Other Group 4 transactions if
required]
A message may contain any combination of forms packages, standard
packages and content references outside packages. However, a forms
package cannot contain any content items (or packages) other than those
described above.
Forms Reply
Applications can use HPDUserSend to reply to a forms message in your In
Tray. HPDUserSend takes much of the information it requires to construct
the reply from the original message, including the subject, Distribution
List and forms filename. Consequently, the Transaction File suplied
should only contain the following:
Transaction Type Content
1000 tt_body_type Body type = 101 (forms reply)
Body class = 0 (deliverable item)
30500 Name of forms data file
tt_content_file filecode = 1447
MPE filecode of file = 0
[30500 Name of additional forms data
tt_content_file files]
Forms replies submitted to HPDGateSend must contain full information,
similar to a forms message (the only difference is the body type in the
tt_body_type transaction):
Transaction Type Content
1000 tt_body_type Body type = 101 (forms reply)
Body class = 0 (deliverable item)
11100 tt_subject Subject of message
[........ Other Group 2 transactions if
required]
21100 tt_to Recepient's HPDesk name and node
[........ Other Group 3 transactions if
required]
30100 Package, subject
tt_start_package type = forms package
30500 Name of forms file
tt_content_file filecode = 0
MPE filecode of file = 1035 (VFORM)
30500 Name of forms data file
tt_content_file filecode = 1447
MPE filecode of file = 0
[30500 Name of additional forms data
tt_content_file files]
39000
tt_end_package
Distribution Lists as Content Files
Transaction Files submitted to, or received from, the Intrinsics may
contain Distribution Lists in addition to the main active Distribution
List of the message. In this case, the Distribution List is held in a
second Transaction File, and is accessed by a 30500 tt_content_file
transaction in the main Transaction File. Such a Distribution List is
included for information only--it is not intended to be acted on.
For example, suppose User One sends a HPDesk message to User Two, and
User Two forwards it to User Three. An application program signs on to
User Three and calls HPDUserReceive to get the forwarded message. The
format would be:
Transaction Type Content
1000 tt_body_type Body type = 0 (message)
Body class = 0 (deliverable item)
11100 tt_subject Subject of original and forwarded
message
10000 tt_creator User Two (sender of the forwarded
message)
........ Other Group 2 transactions
21100 tt_to User Three (receiver of the
forwarded message)
........ Other Group 3 transactions show
other recipients of the forwarded
message
30500 Comments/text added by User Two
tt_content_file
30400 User One (creator of next content
tt_item_creator item--that is, the sender of the
original message)
30500 Name of the file containing the
tt_content_file Distribution List of the original
message sent by User One. For
example, P1234567
30500 Name of file containing text of the
tt_content_file original message sent by User One
The referenced Distribution List file, P1234567, has an MPE filecode of
1521. Its format is:
1000 tt_body_type Body type = 1000 (Distribution
List)
Body class = 10 (basic item)
21100 tt_to User Two (recipient of the original
message)
........ Other Group 3 transactions showing
other recipients of the original
message
This file cannot contain transactions apart from Group 3 recipent
transactions, and the bodytype transaction.