HP 3000 Manuals

Group 4 - Content Related Items [ HP DeskManager Intrinsics ] MPE/iX 5.0 Documentation


HP DeskManager Intrinsics

Group 4 - Content Related Items 

The transaction records in this group range in value from 30000 to 39999
and must appear after Group 3 transaction records in the Transaction
File.  Not all the records have to appear, though if they do, they may
appear several times.  If a Transaction File describes an acknowledgment
or is forwarding a previously read message, none of the records in this
group need be used.

Note that for Transaction Files output by the Intrinsics, each content
file referenced in this group of transactions will have a corresponding
number of "referenced file" transactions (from Group T) appended to the
Transaction File.  This provides a means to identify all the files which
are associated with the current Transaction File without the application
having to be aware of the format of the Transaction File.

30100 - Start Package Definition (tt_start_package) 

This provides the means to describe a composite package structure within
the content of a message.

On input it causes a new "part" to be inserted in a message (for example,
Part 3) and until the next matching "end package" definition is
encountered, subsequent content items are considered to form part of this
package (for example, Part 3.1, Part 3.2).  Package structures may be
nested to multiple levels (except for forms packages which may not be
nested).

If a package is a forms package, the forms file specified becomes the
first part of the package, for example Part 3.1.  Subsequent content
items, which if included must be "forms data" items, will make up the
rest of the package, for example, Parts 3.2, 3.3 etc., until a matching
"end package" record is reached.

On output, a message containing a package, a forms package, or another
message, is reproduced according to the same conventions.

Bytes  Data Type Contents 

17 -   Integer   Package type.  Its values can be:
20

                 0       embedded message, output only
                         (will be interpreted as a
                         standard package on input)

                 1       standard package

                 2       forms package

21 -   Integer   Security indicator.  Its values can
24               be:

                 0       normal

                 1       not used

                 2       private

                 3       not used

25 -   Byte      Subject of package (first 60 bytes are
84     Array     significant)

For example, a tt_start_package transaction record could look like this:

	       Click here to view figure.
            

30200 - Package Creator (tt_package_creator) 

This identifies the name of the creator of a package and is used in
conjunction with the previous transaction record.  On input, this
transaction must be used in a package context and, if no "start package"
transaction has so far been specified in the file, then this record is
ignored.  This record is always returned on output if the message being
read contains a structured content.

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.  Other products may
                 define additional address formats.

21 -             Not used, should be set to zeros.
36

The remainder of the record is dependent on the name/address format
selected above, although only one format applies for the HP Desk
Intrinsics:

37     Byte      Creator name, mandatory on input,
-144   Array     except if Session Profile option
                 100110 (use foreign address aliases is
                 selected).  It is always returned on
                 output.

145-   Byte      Creator mailnode, optional on input,
152    Array     always returned on output.

153-   Byte      Additional user information, optional
on     Array     on input, returned on output if
                 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).

For example, a tt_package_creator transaction record could look like
this:

	       Click here to view figure.
            

30400 - Item Creator (tt_item_creator) 

This identifies the name of the creator of an item and is used in
conjunction with the tt_content_file transaction record.

It does not appear within "start package", "end package" pairs, only
outside them.  It identifies the name of the creator of the following
content item, whether this is a Distribution List or a text item.  If it
is not present, the message creator is taken to be the item creator.

This record is valuable for messages that have been forwarded by HP Desk
users and then taken out of the database by HPDGateReceive.  It allows
the recipient in the external mail system to see who sent the forwarded
message as well as the sender of the resulting message.

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.  Other products may
                 define additional address formats.

21 -             Not used, should be set to zeros.
36

The remainder of the record is dependent on the name/address format
selected above, although only one format applies for the HP Desk
Intrinsics:

37     Byte      Creator name, mandatory on input,
-144   Array     except if Session Profile option
                 100110 (use foreign address aliases)
                 is selected.  It is always returned on
                 output.

145-   Byte      Creator mailnode, optional on input,
152    Array     always returned on output.

153-   Byte      Additional user information, optional
on     Array     on input, returned on output if
                 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).

For example, a tt_item_creator transaction record could look like this:

	       Click here to view figure.
            

30500 - Included Content File (tt_content_file) 

This transaction record references a file that forms part of the content
of a message or a diary item.  Such files may be ASCII text, HP Word
documents, program files, a V/3000 forms data file etc.  Included
Distribution Lists (Distribution Lists other than the main one) must be
supplied, and will be returned, in a file in Transaction File format
(using the relevant transaction records from groups 1 and 3).  For
example, if a message has been forwarded, the original Distribution List
must be described in this way.

Note that a null transaction record, that is one referencing a blank file
name and no content, will be returned if an attempt is made to extract an
HP Desk encrypted item using HPDUserReceive or HPDGateReceive.  However,
other encrypted items, that is items encrypted by user written
encryptors, will be output.

One forms file followed by 0, 1 or more forms data files can be specified
with forms package items.  Others are rejected.

Bytes  Data Type Contents [REV BEG] 

17 -   Integer   The original MPE filecode of the file.
20               This field is only relevant to files
                 leaving HP Desk and so is ignored on
                 input to HP Desk.  It is the original
                 filecode of the file (that is the
                 filecode as it was inside HP Desk).
                 This will be different from the
                 current filecode if a conversion has
                 taken place during its extraction from
                 HP Desk.  Its value will be
                 interpreted as described in the next
                 field.

21 -   Integer   The intended MPE filecode.  If you are
24               using HPDUserSend or HPDGateSend (you
                 are moving a message into HP Desk) you
                 can leave the original filecode,
                 described above, blank.  However, you
                 must supply an intended filecode.  Its
                 purpose is to represent the type of
                 the document once it is inside HP
                 Desk.  Its value will be interpreted
                 as follows:[REV END]

                 0       HP Desk will interpret the
                         intended filecode as being the
                         same as the MPE filecode.
                         This is the usual value of the
                         intended filecode.

                         If the MPE filecode is 0, a
                         value of 0 for the intended
                         filecode is still valid, but
                         you may want to specify one of
                         the following numbers instead:

                 1166    the actual filecode of the
                         original file is 0, the file
                         is to be treated as a
                         Transaction File containing a
                         Distribution List in
                         transaction format.

Bytes  Data Type Contents 

                   1167    the actual filecode of the
                         original file is 0, the file
                         is to be treated as HP Desk
                         readable text.

                 1446    the actual filecode of the
                         original file is SD, the file
                         is to be treated as an HP
                         ListKeeper file.

                 1447    the actual filecode of the
                         original file is 0, the file
                         is to be treated as a forms
                         data file.
                 Refer to HP DeskManager Customization 
                 for a full list of filecodes.

                 If you are using HPDUserReceive or
                 HPDGateReceive (you are moving a
                 message from HP Desk) the original
                 filecode, as described above, is the
                 same as it was in HP Desk.  The
                 intended filecode represents the type
                 of file it has been converted to.  It
                 is the same as the MPE filecode.

25 -   Integer   Reserved
28

29 -   Integer   Reserved
32

33 -   Integer   Reserved
36

37 -   Byte      Subject of content file
96     Array

97     Byte      Reserved[REV BEG]
-136   Array

137-   Byte      Name of the MPE content file, only
236    Array     required on input, HPDUserReceive and
                 HPDGateReceive define file names for
                 returned content files.  Content file
                 names must not be more than 36
                 characters long.[REV END]

For example, a tt_content_file transaction record going in to HP Desk
could look like this:

	       Click here to view figure.
            

A tt_content_file transaction record from HP Desk could look like this:

	       Click here to view figure.
            

30600 - Content File Conversion Selector (tt_convert_file) 

This record references a file that is to be converted by HPDUtility into
a different format, depending on the converters installed on the system.
One Transaction File could contain several 30600 records, this would
allow several different files to be converted on one call to the
Intrinsics.  All other transaction records in the Transaction File are
ignored.


NOTE 30500 (tt_content_file) and 30600 transaction records are very similar in format. This similarity means that if you receive a message from HP Desk and want to convert the content, you can easily change the 30500 records to 30600 records to convert the message file. All other records in the Transaction File are ignored in a conversion, so you do not have to amend or delete them.
Bytes Data Type Contents 17 - Integer The original filecode of the file from 20 which the conversion will be done. This may or may not be the same as the filecode in the file label of the file. The same interpretation will be placed on this code as for the original filecode in the type 30500 transaction record. Refer to HP DeskManager Customization for a full list of filecodes. 21 - Integer Intended file code to which the 24 specified file is to be converted. If this code is specified as -1, the file code to which the item is converted will be as defined in the Session Profile file. 25 - Not used. 28 29 - Not used. 32 33 - Not used. 36 37 Byte Name of content file to be converted. -136 Array This name must not be more than 36 characters long. 137- Byte Name of the converted file, returned 236 Array by the Intrinsic. For example, a tt_convert_file transaction record returned by the Intrinsic could look like this: Click here to view figure. 39000 - End Package Definition (tt_end_package) Defines the end of a package or forms package structure in a message. Bytes Data Type Contents 17 on Reserved for future use.


MPE/iX 5.0 Documentation