HP 3000 Manuals HP 3000 Manuals
HPDUserSignon
_______________________________________________________________________________
| |
| S R R BA |
| HPDUserSignon (status, user_name, [user_mailnode,] [user_password] |
| |
| BA R R |
| [, session_profile] [, principal_name, princ_mailnode]);|
_______________________________________________________________________________
HPDUserSignon allows an application to sign on to HP Desk like a normal
HP Desk user. A user name and password must normally be provided.
Optionally, the application can sign on as one user, acting as the
Designate of another user.
status
Required, by Reference; type = STATUS_TYPE
Used to return information from the Intrinsic.
This is a status parameter and must be provided. It gives the result of
the attempted sign on. It does not matter what it contains when the
Intrinsic is called.
user_name
Required, by Reference; type = RECORD, length = 108 bytes
Used to supply information to the Intrinsic.
When using COBOL, the parameter should be defined like HPD-NAME, in the
COBOL copy libraries. The FORTRAN parameter has to be defined as
HPD_NAME with the corresponding equivalence statements given in the
FORTRAN include files. The Pascal parameter should be of type
HPD_NAME_TYPE, as defined in the Pascal include files.
user_name contains the local HP Desk user name to be used when signing
on. The parameter should contain the user's family name from byte
position 1 to 36 (space filled as necessary), the first forename (if
relevant) in positions 37 to 72 (space filled) and the second forename
(if relevant) in positions 73 to 108 (space filled). The combined length
of the different name elements must not exceed 36 characters. Separators
between the different parts of user_name are not necessary in this
parameter. However, remember that at other times, separators will be
inserted between the family name, first forename and second forename.
This means that if only one name element is provided it cannot be more
than 36 characters long, if two name elements are provided they cannot be
more than a combined length of 35 characters to allow for a separator,
and if three name elements are provided they cannot be more than a
combined length of 34 characters to allow for two separators.
user_mailnode
Optional, by Reference; type = RECORD, length = 8 bytes.
[REV BEG]
Used to supply information to the Intrinsic. Note that this parameter is
required if the user_name is not unique.[REV END]
When using COBOL, the parameter should be defined like HPD-NODE, in the
COBOL copy libraries. The FORTRAN parameter has to be defined as
HPD_NODE with the corresponding equivalence statements given in the
FORTRAN include files. The Pascal parameter should be of type
HPD_NODE_TYPE as defined in the Pascal include files.
This contains the mailnode on which the user is resident. It must be at
least 8 bytes long, the first 6 bytes must contain the HP Desk Location
(space filled as necessary), the last 2 must contain the Sublocation
(space filled). This parameter will be needed if the specified user name
is insufficient to identify a local user uniquely.
user_password
Optional, by Reference; type = BYTE ARRAY, length = 8 bytes
[REV BEG]
Used to supply information to the Intrinsic. Note that this is required
if there is an HP Desk user password set up.[REV END]
This parameter need not be supplied if the HP Desk user does not have a
password. It contains the password of the user signing on. It must be
at least 8 bytes long, space filled.
session_profile
Optional, by Reference; type = BYTE ARRAY, length = 36 bytes.
Used to supply information to the Intrinsic.
It contains the name of the Session Profile file to be used. The file
name should be left justified in the field and terminated by a
non-alphanumeric character other than a "/" or ".". If you do not
provide a Session Profile file, the default Session Profile options are
used.
principal_name
Optional, by Reference; type = RECORD, length = 108 bytes.
Used to supply information to the Intrinsic.
This contains the name of the Principal user if the user defined in
user_name is a Designate and the application program is to work on behalf
of the Principal. The field should be at least 108 bytes long and should
be formatted in the same way as the user_name.
princ_mailnode
Optional, by Reference; type = RECORD, length = 8 bytes.
Used to supply information to the Intrinsic.
[REV BEG]
This contains the mailnode on which the Principal is resident. The
parameter must be 8 bytes long and formatted in the same way as the
user_mailnode. It is a required parameter if the principal_name is not
unique.[REV END]
General Information about HPDUserSignon
An application must call HPDUserSignon before it can execute most User
and Supporting Intrinsics.
Once a call to HPDUserSignon is made, a subsequent call results in the
first user being signed off automatically.
An application can work as a user who is a Designate of other users. It
can operate on behalf of users for whom it is a Designate providing both
the Designate and Principal user names and nodes are specified.
NOTE For the current release of the Intrinsics, a Principal and a
Designate (working on behalf of that Principal) MUST NOT sign on
and work at the same time. This applies when one or both sign-ons
are done with HPDUserSignon.
If a user password is specified in the Intrinsic call, the applications
programmer must be careful that security is not compromised. If the
application stores passwords, it should ensure that they are safeguarded
in some way.
The usual HP Desk reporting of a successful sign on is done to the system
operator's terminal and to the HP Desk Statistics file.
Session Profile Options Relevant to HPDUserSignon
Refer to Chapter 8 for more information on the Session Profile file.
These Session Profile options can be used to change the operation of
subsequent Intrinsic calls:
100010 sp_accept_fail Acceptable Failure Indicator
100100 sp_extra_user_info Define foreign address format
100200 sp_convert Convert specific document type
100210 sp_convert_target Convert all documents to a specified filecode
type
100300 sp_max_size Maximum size of message to be extracted
100500 sp_time Time processing option
100700 sp_pendtray_content Contents extraction from Pending Tray
100800 sp_def_transfile Default Transaction File
101100 Destination group for received files
sp_destination_group
100900 sp_name_addr_checks Alter name/address checking
Status Returns Specific to HPDUserSignon
-400 Cannot access first parameter
-401 Cannot access second parameter
-402 Cannot access third parameter
-403 Cannot access fourth parameter
-404 Cannot access fifth parameter
-405 Cannot access sixth parameter
-406 Cannot access seventh parameter
-500 Application does not have PH capability
-501 Application does not have DS capability
-502 User does not have SF capability
-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
-1006 A dataset is full
-1007 HP Desk User Intrinsics sessions not enabled
-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
-1111 Transaction records are out of sequence, or a
transaction has an invalid type
-1900 Unexpected error
-2000 User Name not valid or badly formed
-2001 User Name longer than 36 characters
-2002 User name missing
-2003 User node invalid or badly formed
-2004 User is not configured/not a local user
-2005 User node must be supplied as the user is configured
on more than one node
-2006 Principal name is invalid or badly formed
-2007 Principal name longer than 36 characters
-2008 Principal node is invalid or badly formed
-2009 User is not configured as a Designate of the Principal
-2010 Principal node must be supplied as the Principal is
configured on more than one node
-2011 User is already signed on in another HP Desk or
Intrinsics session
-2400 Password is incorrect