HP 3000 Manuals HP 3000 Manuals
HPDUtility
____________________________________________________________
| |
| S BA I I |
| HPDUtility (status, [trans-file], op_type, [param4]);|
____________________________________________________________
HPDUtility is a general purpose Supporting Intrinsic that allows you to
list the In Tray or Pending Tray either in full or selectively and to
convert documents from one format to another, given the converters
available in the system. It also allows you to switch the current
Session Profile file to another containing different options.
status
Required, by Reference; type = STATUS_TYPE.
Used to return information from the Intrinsic.
This gives the overall result of the operation. It does not matter what
it contains when the Intrinsic is called.
trans_file
Optional, by Reference; type = BYTE ARRAY, length = 36 bytes.
Used to supply information to and return information from the Intrinsics.
This contains the name of the Transaction File holding the information
necessary to perform the action, or the results of the action, or both.
The filename should be terminated by a non-alphanumeric character other
than "/" or ".". If the first character of this parameter is an asterisk
(*), the default Transaction File, as defined in the Session Profile
file, is used. The name of the default Transaction File will be returned
in the trans_file field.
The Transaction File might only be used for returning results from the
Intrinsic. In this case if the first character of this parameter is a
non-alphabetic character but not an asterisk or space, the Intrinsic
creates a randomly named Transaction File to hold the results. This
randomly created name will be returned in trans_file.
op_type
Required, by Reference; type = INTEGER.
Used to supply information to the Intrinsic.
This defines the operation that is to be performed by this call of
HPDUtility. Valid values are:
1 List user's In Tray, either its entire contents or according to
selection criteria specified in the Transaction File. The
number of items listed is returned in param4. If you don't
supply a Transaction File, and one was created for you, the
entire contents of the user's In Tray will be listed. In this
case, you do not have the option to display only a section of
the In Tray.[REV BEG]
2 List user's Pending Tray, either its entire contents or
according to selection criteria specified in the Transaction
File. The number of items listed is returned in param4. If you
don't supply a Transaction File, and one was created for you,
the entire contents of the user's Pending Tray will be listed.
In this case, you do not have the option to display only a
section of the Pending Tray.[REV END]
10 Convert one or more documents from one format to another, as
specified in the Transaction File.
20 Switch the current Session Profile, as defined in the last sign
on or last call to HPDUtility, to another Session Profile using
the Session Profile options specified in the Transaction File.
21 Switch the current Session Profile back to that defined in the
last sign on. No Transaction File is required.
22 Switch the current Session Profile to the standard default
Session Profile. No Transaction File is required.
param4
Optional, by Reference; type = INTEGER.
Used to return information from the Intrinsics.
This is used to pass or return information. Its use is dependent on the
value of op_type.
General Information about HPDUtility
HPDUtility is designed to cover a variety of functions. The mode of
operation of the Intrinsic is governed by an operation type indicator
provided as a parameter to the call.
Operations involving the In Tray and Pending Tray may only be done after
a successful call to HPDUserSignon. The conversion and Session Profile
switch options may be performed while the application is signed on as a
user or as a gateway.
For the In Tray and Pending Tray lists, the Transaction File, if
supplied, must contain a selector record (type 5000) as the second record
in the file. It will be overwritten with the results of the list.
For the conversion option, the Transaction File should contain one or
more type 30600 selector records, starting from record 2. Each of these
records will be updated with the result of the conversion. The file can
contain other transaction records which will be ignored. No checks will
be made on the type field of the tt_body_type transaction.
For the Session Profile switch option, the Transaction File should
contain Session Profile records as described in Chapter 8 . The file
is validated in exactly the same way as in the sign on.
Session Profile options not supplied will be given default values. That
is, no values are carried over from earlier Session Profiles.
Transaction Records Permitted with HPDUtility
Refer to Chapter 6 for more information on the Transaction File. The
following transaction records may be used in the Transaction File
submitted to HPDUtility:
1000 tt_body_type Transaction File body type Identifier. This
record must always be supplied, and will
always be generated.
5000 tt_list_messages List messages selector. If you provide a
Transaction File when requesting a list, this
record must be supplied.
5100 tt_intray_item In Tray item. Generated by list option.
5200 tt_pendingtray_item Pending Tray item. Generated by list option.
30600 tt_convert_file Convert file selector. At least one of these
records must be supplied if you are going to
do a conversion.
Session Profile Options Relevant to HPDUtility
Refer to Chapter 8 for more information on the Session Profile file.
These Session Profile options can be used to change the operation of
HPDUtility:
100800 sp_def_transfile Use default Transaction File
101100 sp_destination Destination Group
group
NOTE If you are using HPDUtility to switch to a new Session Profile file
you can supply any Session Profile records you wish, but at least
one must be provided.
Status Returns Specific to HPDUtility
-400 Cannot access first parameter
-401 Cannot access second parameter
-402 Cannot access third parameter
-403 Cannot access fourth parameter
-500 Application does not have PH capability
-501 Application does not have DS capability
-502 User does not have SF capability
-1002 Application is not signed on as a user or gateway
-1003 HP Desk is not available
-1004 The HP Desk Intrinsics product is not installed
-1005 HP Desk Intrinsics software and message catalogue
are incompatible
-1007 HP Desk User Intrinsics are disabled
-1008 HP Desk Gateway Intrinsics sessions are disabled
-1009 No MPE system resource (CreateProcess Error 4)
-1010 Cannot load Intrinsics Driver program
(CreateProcess Error 16)
-1011 HP Desk and HP Desk Intrinsics software versions
are incompatible
-1100 Cannot access Transaction File (see STATUS[6] for
FS error)
-1101 Cannot create Transaction File
-1110 One or more transaction records has an invalid
field
-1111 Transaction records are out of sequence, or a
transaction has an invalid type
-1112 The Transaction File is empty
-1114 The Transaction File is too small (end of file
encountered)
-1115 The record size of the Transaction File is too
small
-1116 A Transaction Filename must be supplied
-1200 Invalid operation type
-1202 No matching items
-1900 Unexpected error
-8100 No items In Tray