ibm-information-center/dist/eclipse/plugins/i5OS.ic.ddm_5.4.0.1/rbae5userparameterl.htm

235 lines
16 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="reference" />
<meta name="DC.Title" content="User exit program parameter list for DDM" />
<meta name="abstract" content="The user exit program on the target server passes two parameter values: a character return code field and a character data structure containing various parameter values." />
<meta name="description" content="The user exit program on the target server passes two parameter values: a character return code field and a character data structure containing various parameter values." />
<meta name="DC.subject" content="parameter list, description, security, target DDM (TDDM), user exit program, TDDM (target DDM), DDM target considerations, target DDM (TDDM), TDDM (target DDM), DDM target considerations, I/O operation, COMMAND function, data authority, data authority" />
<meta name="keywords" content="parameter list, description, security, target DDM (TDDM), user exit program, TDDM (target DDM), DDM target considerations, target DDM (TDDM), TDDM (target DDM), DDM target considerations, I/O operation, COMMAND function, data authority, data authority" />
<meta name="DC.Relation" scheme="URI" content="rbae5exitpgm.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rbae5userparameterl" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>User exit program parameter list for DDM</title>
</head>
<body id="rbae5userparameterl"><a name="rbae5userparameterl"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">User exit program parameter list for DDM</h1>
<div><p>The user exit program on the target server passes two parameter
values: a character return code field and a character data structure containing
various parameter values.</p>
<div class="section"><p>The user exit program on the target server uses the character
data structure parameter values, that are passed by the TDDM, to evaluate
whether to allow the request from the source server. The parameter list is
created each time a file access request or command request is sent to the
TDDM; when any one of the functions shown for the <em>Subapplication</em> field
is requested, the parameter list is created. When file I/O operations are
performed, this parameter list is created only for the file open request,
not for any of the I/O operation requests that follow.</p>
</div>
<div class="section"><p>The program uses the parameter list to determine whether a source
server user's file access or command request should be accepted or rejected.
The list contains the following parameters and values:</p>
<ul><li>The name of the user profile or default user profile under which the source
server user's request is run.</li>
<li>The name of the application program on the source server being used. For
DDM use, the name is *DDM. For DRDA<sup>®</sup> use, the name is *DRDA.</li>
<li>The name of the command or function (subapplication) being requested for
use on the target server or one of its files. <p>Most of the functions listed
in the following table directly affect a file, including the EXTRACT function,
which extracts information from the file when commands such as <span class="cmdname">Display
File Description (DSPFD)</span> or <span class="cmdname">Display File Field Description
(DSPFFD)</span> are specified by the source server user. Some functions
are member-related functions, such as the CHGMBR function, which allows characteristics
of a member to be changed. The COMMAND function indicates that a command string
is submitted by the <span class="cmdname">Submit Remote Command (SBMRMTCMD)</span> command
to run on the target server. The SQLCNN function specifies a DRDA connect
attempt.</p>
</li>
<li>The name of the file (object) to be accessed in the way specified on the
previous parameter. This field does not apply if a command string (COMMAND)
or stream and directory access commands are being submitted or if it is a DRDA command.</li>
<li>If the stream and directory access commands are specified, then the object
and directory fields have a value of *SPC. The user must go to the <em>Other</em> field
to get the alternative object name and alternative path name.</li>
<li>The name of the library containing the file, if a file is being accessed.</li>
<li>The name of the file member, if a file member is being accessed. Stream
and access commands have a value of *N.</li>
<li>The format field does not apply for DDM or DRDA.</li>
<li>Depending on how the next field is used, the length varies.</li>
<li>The <em>Other</em> field is used for as many as three of the following six
values; the first two are always specified (*N might be used for the second
value if the system name cannot be determined), and either of the last four
might be specified, depending on the type of function specified in the <em>Subapplication</em> field.
<ul><li>The location name of the source server. This matches the RMTLOCNAME parameter
value specified in the target server's device description for the source server
if APPC communications is being used.</li>
<li>The system name of the source server.</li>
<li>If a file was specified and it is to be opened, (OPEN) for I/O operations,
this field indicates which type of operation is being requested. For example,
if a file is being opened for read operations only, the input request value
is set to a 1 and the remaining values are set to a 0.</li>
<li>The alternative object name.</li>
<li>The alternative directory name.</li>
<li>The name of the <span class="keyword">iSeries™</span> command,
if a command string is being submitted, followed by all of its submitted parameters
and values.</li>
</ul>
</li>
</ul>
</div>
<div class="tablenoborder"><a name="rbae5userparameterl__rbae5exittbl"><!-- --></a><table cellpadding="4" cellspacing="0" summary="" id="rbae5userparameterl__rbae5exittbl" width="100%" frame="border" border="1" rules="rows"><caption>Table 1. Parameter list for user exit program on target server</caption><thead align="left"><tr><th align="left" valign="bottom" width="14.814814814814813%" id="d0e154"><strong>Field</strong></th>
<th align="left" valign="bottom" width="15.185185185185185%" id="d0e157"><strong>Type</strong></th>
<th align="left" valign="bottom" width="14.629629629629628%" id="d0e160"><strong>Length</strong></th>
<th align="left" valign="bottom" width="55.37037037037037%" id="d0e163"><strong>Description</strong></th>
</tr>
</thead>
<tbody><tr><td align="left" valign="top" width="14.814814814814813%" headers="d0e154 "><strong>User</strong></td>
<td align="left" valign="top" width="15.185185185185185%" headers="d0e157 "><strong>Character</strong></td>
<td align="left" valign="top" width="14.629629629629628%" headers="d0e160 "><strong>10</strong></td>
<td align="left" valign="top" width="55.37037037037037%" headers="d0e163 "><strong>User profile name of target DDM job.</strong></td>
</tr>
<tr><td align="left" valign="top" width="14.814814814814813%" headers="d0e154 "><strong>Application</strong></td>
<td align="left" valign="top" width="15.185185185185185%" headers="d0e157 "><strong>Character</strong></td>
<td align="left" valign="top" width="14.629629629629628%" headers="d0e160 "><strong>10</strong></td>
<td align="left" valign="top" width="55.37037037037037%" headers="d0e163 "><strong>Application name:</strong> <ul><li>'*DDM ' for Distributed Data Management.</li>
</ul>
</td>
</tr>
<tr><td align="left" valign="top" width="14.814814814814813%" headers="d0e154 "><strong>Subapplication</strong></td>
<td align="left" valign="top" width="15.185185185185185%" headers="d0e157 "><strong>Character</strong></td>
<td align="left" valign="top" width="14.629629629629628%" headers="d0e160 "><strong>10</strong></td>
<td align="left" valign="top" width="55.37037037037037%" headers="d0e163 "><strong>Requested function:</strong> <ul><li><samp class="codeph">'ADDMBR ' 'DELETE ' 'RGZMBR '</samp></li>
<li><samp class="codeph">'CHANGE ' 'EXTRACT ' 'RMVMBR '</samp></li>
<li><samp class="codeph">'Change Data Area (CHGDTAARA) ' 'INITIALIZE' 'RNMMBR '</samp></li>
<li><samp class="codeph">'CHGMBR ' 'LOAD ' 'Retrieve Data Area (RTVDTAARA)'</samp></li>
<li><samp class="codeph">'CLEAR ' 'LOCK ' 'SNDDTAQ '</samp></li>
<li><samp class="codeph">'CLRDTAQ ' 'Move (MOVE) '</samp></li>
<li><samp class="codeph">'COMMAND ' 'OPEN '</samp></li>
<li><samp class="codeph">'Copy (COPY) ' 'RCVDTAQ '</samp></li>
<li><samp class="codeph">'CREATE ' 'RENAME '</samp></li>
<li><samp class="codeph">'SQLCNN ' </samp></li>
</ul>
</td>
</tr>
<tr><td align="left" valign="top" width="14.814814814814813%" headers="d0e154 "><strong>Object</strong></td>
<td align="left" valign="top" width="15.185185185185185%" headers="d0e157 "><strong>Character</strong></td>
<td align="left" valign="top" width="14.629629629629628%" headers="d0e160 "><strong>10</strong></td>
<td align="left" valign="top" width="55.37037037037037%" headers="d0e163 "><strong>Specified file name. *N is used when the
subapplication field is 'COMMAND '. *SPC is used when the file is a document
or folder.</strong></td>
</tr>
<tr><td align="left" valign="top" width="14.814814814814813%" headers="d0e154 ">&nbsp;</td>
<td align="left" valign="top" width="15.185185185185185%" headers="d0e157 "><strong>Character</strong></td>
<td align="left" valign="top" width="14.629629629629628%" headers="d0e160 "><strong>10</strong></td>
<td align="left" valign="top" width="55.37037037037037%" headers="d0e163 "><strong>Specified library name. *N is used when
the subapplication field is 'COMMAND '. *SPC is used when the library is
a folder.</strong></td>
</tr>
<tr><td align="left" valign="top" width="14.814814814814813%" headers="d0e154 "><strong>Member</strong></td>
<td align="left" valign="top" width="15.185185185185185%" headers="d0e157 "><strong>Character</strong></td>
<td align="left" valign="top" width="14.629629629629628%" headers="d0e160 "><strong>10</strong></td>
<td align="left" valign="top" width="55.37037037037037%" headers="d0e163 "><strong>Specified member name. *N is used when
the member name is not applicable.</strong></td>
</tr>
<tr><td align="left" valign="top" width="14.814814814814813%" headers="d0e154 "><strong>Format</strong></td>
<td align="left" valign="top" width="15.185185185185185%" headers="d0e157 "><strong>Character</strong></td>
<td align="left" valign="top" width="14.629629629629628%" headers="d0e160 "><strong>10</strong></td>
<td align="left" valign="top" width="55.37037037037037%" headers="d0e163 "><strong>Not applicable for DDM.</strong></td>
</tr>
<tr><td align="left" valign="top" width="14.814814814814813%" headers="d0e154 "><strong>Length</strong></td>
<td align="left" valign="top" width="15.185185185185185%" headers="d0e157 "><strong>Decimal</strong></td>
<td align="left" valign="top" width="14.629629629629628%" headers="d0e160 "><strong>5,0</strong></td>
<td align="left" valign="top" width="55.37037037037037%" headers="d0e163 "><strong>Length of the next field.</strong></td>
</tr>
<tr><td align="left" valign="top" width="14.814814814814813%" headers="d0e154 "><strong>Source Remote Location</strong></td>
<td align="left" valign="top" width="15.185185185185185%" headers="d0e157 "><strong>Character</strong></td>
<td align="left" valign="top" width="14.629629629629628%" headers="d0e160 "><strong>10</strong></td>
<td align="left" valign="top" width="55.37037037037037%" headers="d0e163 "><strong>Remote location unit name of source system
(if SNA).</strong></td>
</tr>
<tr><td align="left" valign="top" width="14.814814814814813%" headers="d0e154 "><strong>Source System Name </strong></td>
<td align="left" valign="top" width="15.185185185185185%" headers="d0e157 "><strong>Character</strong></td>
<td align="left" valign="top" width="14.629629629629628%" headers="d0e160 "><strong>10</strong></td>
<td align="left" valign="top" width="55.37037037037037%" headers="d0e163 "><strong>System name of remote server. If this
value is not available, this field contains '*N '.</strong></td>
</tr>
<tr><td align="left" valign="top" width="14.814814814814813%" headers="d0e154 "><strong>Other</strong></td>
<td align="left" valign="top" width="15.185185185185185%" headers="d0e157 "><strong>Character</strong></td>
<td align="left" valign="top" width="14.629629629629628%" headers="d0e160 "><strong>2000</strong> </td>
<td align="left" valign="top" width="55.37037037037037%" headers="d0e163 ">The use of this 2000 byte area depends on
the request function. If it is SQLCNN, then the DRDA mapping should be used. For other
functions, use the DDM mapping. <dl><dt class="dlterm">To use DDM:</dt>
<dd> <dl><dt class="dlterm"></dt>
<dd>The following varies, depending on the function. If OPEN is specified
to open a file: <dl><dt class="dlterm">1</dt>
<dd>Input request Char(1) 1=yes 0=no</dd>
<dt class="dlterm">1</dt>
<dd>Output request Char(1) 1=yes 0=no</dd>
<dt class="dlterm">1</dt>
<dd>Update request Char(1) 1=yes 0=no</dd>
<dt class="dlterm">1</dt>
<dd>Delete request Char(1) 1=yes 0=no</dd>
</dl>
</dd>
<dt class="dlterm">12</dt>
<dd>Alternative object name.</dd>
<dt class="dlterm">63</dt>
<dd>Alternative directory name.</dd>
<dt class="dlterm">1921</dt>
<dd>The command string if COMMAND is specified to submit a command.</dd>
</dl>
</dd>
<dt class="dlterm">To use DRDA:</dt>
<dd> <dl><dt class="dlterm">9</dt>
<dd>Type definition name of DRDA application requester. Product ID of DRDA application
requester.</dd>
<dt class="dlterm">3</dt>
<dd>Product code.</dd>
<dt class="dlterm">2</dt>
<dd>Version ID.</dd>
<dt class="dlterm">2</dt>
<dd>Release ID.</dd>
<dt class="dlterm">1</dt>
<dd>Modification level.</dd>
<dt class="dlterm">1983</dt>
<dd>Reserved </dd>
</dl>
</dd>
</dl>
</td>
</tr>
<tr><td colspan="4" align="left" valign="top" headers="d0e154 d0e157 d0e160 d0e163 "><div class="note"><span class="notetitle">Note:</span> <dl><dt class="dlterm">*N =</dt>
<dd>Null value indicates a parameter position for which no value is being
specified, allowing other parameters to follow it in positional form.</dd>
</dl>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rbae5exitpgm.htm" title="Customers who use menu-level security, which is accomplished by restricting the user's access to functions on the server, are likely to have a large number of public files. Public files are those files to which the public has some or all authority. A user exit program allows you to restrict each DDM user's access to public files and to private files.">DDM server access control exit program for additional security</a></div>
</div>
</div>
</body>
</html>