ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/movdoc.htm

238 lines
8.6 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Move Document (MOVDOC)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="MOVDOC.Top_Of_Page"></a>
<h2>Move Document (MOVDOC)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#MOVDOC.PARAMETERS.TABLE">Parameters</a><br>
<a href="#MOVDOC.COMMAND.EXAMPLES">Examples</a><br>
<a href="#MOVDOC.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="MOVDOC"></a>
<p>The Move Document (MOVDOC) command changes the path the system uses to search for a document. The document is <b>not</b> physically moved to another location of auxiliary storage, and a new object is <b>not</b> created.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>You must be enrolled in the System Directory and have all (*ALL) authority to the document being moved and have change (*CHANGE) authority to both the FROM and TO folders (if applicable).
</li>
<li>To move a document to or from a folder, the user must have *CHANGE authority to the folder.
</li>
<li>Documents cannot be moved between folders that reside in different auxiliary storage pools (ASPs).
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#MOVDOC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="MOVDOC.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#MOVDOC.FROMDOC"><b>FROMDOC</b></a></td>
<td valign="top">From document</td>
<td valign="top"><i>Character value</i>, *SYSOBJNAM</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#MOVDOC.FROMFLR"><b>FROMFLR</b></a></td>
<td valign="top">From folder</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#MOVDOC.TOFLR"><b>TOFLR</b></a></td>
<td valign="top">To folder</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#MOVDOC.RENAME"><b>RENAME</b></a></td>
<td valign="top">Rename</td>
<td valign="top"><i>Character value</i>, <b><u>*SAME</u></b></td>
<td valign="top">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#MOVDOC.SYSOBJNAM"><b>SYSOBJNAM</b></a></td>
<td valign="top">System object name</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#MOVDOC.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="MOVDOC.FROMDOC"></a>
<h3>From document (FROMDOC)</h3>
<p>Specifies the document to be moved. If a document name is specified on the FROMDOC parameter, then a folder name must be specified on the <b>From folder (FROMFLR)</b> parameter. If *SYSOBJNAM is specified on the FROMDOC parameter, then a system object name must be specified on the <b>System object name (SYSOBJNAM)</b> parameter.
</p>
<p>
<b>Note: </b>If FROMDOC(name) is specified, then FROMFLR(name) is required. If FROMDOC(*SYSOBJNAM) is specified, then SYSOBJNAM(name) and RENAME(name) are required.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b>*SYSOBJNAM</b></dt>
<dd>A system object name is used to identify the document to be moved. This parameter must be used to move a folderless document and may be used instead of a folder/document name any time the system object name is known.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the document to be moved.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#MOVDOC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="MOVDOC.FROMFLR"></a>
<h3>From folder (FROMFLR)</h3>
<p>Specifies the name of the folder from which the document is being moved. A folder name must be entered on this parameter if a document name is entered on the <b>From document (FROMDOC)</b> parameter. FROMFLR(*NONE) cannot be specified if FROMDOC(name) is specified.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The document to be moved is specified by its system object name.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the folder containing the document to be moved.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#MOVDOC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="MOVDOC.TOFLR"></a>
<h3>To folder (TOFLR)</h3>
<p>Specifies the name of the folder into which the document is being moved. A folder name must be entered in this parameter if a document name is entered in the <b>Rename (RENAME)</b> parameter.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The document is to become a folderless object. If you specify TOFLR(*NONE), the document becomes folderless and can only be referred to by its system object name.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the folder that is to contain the document.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#MOVDOC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="MOVDOC.RENAME"></a>
<h3>Rename (RENAME)</h3>
<p>Specifies the name by which the moved document is to be known in the TOFLR folder. This parameter allows the user to name a document when moving a folderless document to a folder. It also allows the user to rename the document when moving it from one folder to another.
</p>
<p>If the user wants to move a document into a folder, the name of the document in the TOFLR folder must be unique.
</p>
<p>If the new name is already assigned to a folder or a document in a folder specified on the TOFLR parameter, the user must either choose a new name for the target document or rename the folder or document that has the same name.
</p>
<p>
<b>Note: </b>If FROMDOC(*SYSOBJNAM) is specified, then RENAME(name) must be specified.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The document name does not change when moving it from one folder to another, or the document will no longer have a name when making it folderless.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the moved document in the TOFLR folder.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#MOVDOC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="MOVDOC.SYSOBJNAM"></a>
<h3>System object name (SYSOBJNAM)</h3>
<p>Specifies the system object name of the document to be moved. This parameter can only be specified if FROMDOC(*SYSOBJNAM) is specified.
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the system object name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#MOVDOC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="MOVDOC.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Adding a Folderless Document</b>
</p>
<p>
<pre>
MOVDOC FROMDOC(*SYSOBJNAM) FROMFLR(*NONE) TOFLR(FLR1)
RENAME(DOC1) SYSOBJNAM(CNTR192366)
</pre>
</p>
<p>This command, whose system object name is CNTR192366, adds a folderless document to FLR1 and names it DOC1.
</p>
<p><b>Example 2: Moving a Document and Keeping its Name</b>
</p>
<p>
<pre>
MOVDOC FROMDOC(DOC1) FROMFLR(FLR1) TOFLR(FLR2)
RENAME(*SAME)
</pre>
</p>
<p>This command moves DOC1 from FLR1 to FLR2 and keeps the name DOC1.
</p>
<p><b>Example 3: Moving and Renaming a Document</b>
</p>
<p>
<pre>
MOVDOC FROMDOC(DOC1) FROMFLR(FLR1) TOFLR(FLR2)
RENAME(DOC2)
</pre>
</p>
<p>This command moves DOC1 from FLR1 to FLR2 and renames it DOC2.
</p>
<p><b>Example 4: Moving a Document and Making It Folderless</b>
</p>
<p>
<pre>
MOVDOC FROMDOC(DOC1) FROMFLR(FLR1) TOFLR(*NONE)
</pre>
</p>
<p>This command moves DOC1 from FLR1 and changes it to a folderless document.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#MOVDOC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="MOVDOC.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF8A13</b></dt>
<dd>Document &amp;2 in folder &amp;1 not moved.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#MOVDOC.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>