DDM commands and objects

 

These topics describe the DDM command parameters that an iSeries™ server supports for each DDM architecture command.

For more detailed information about these parameters, see the DDM Architecture: Reference, SC21-9526.

The description of the commands might include:

• Limitations for the use of each command

• Objects that the source server might send to the target server

• Objects that the target server might return to the source server

• DDM parameters that the iSeries server supports for the command and how the iSeries server responds to each parameter

The commands listed here are supported. Level 1.0, Level 2.0 and Level 3.0 indicate which level of the DDM architecture is supported by the commands.

• CHGCD (Change Current Directory) Level 2.0
  This command changes the current path. The path is a string of folders. The current path is added to the front of a file or directory name if it does not start with a slash.

• CHGEOF (Change End of File) Level 2.0 and Level 3.0
  This command changes the end-of-file mark of a document. The end may be truncated or expanded.

• CHGFAT (Change File Attribute) Level 2.0
  This command changes the attributes of a file, document, or folder.

• CLOSE (Close File) Level 1.0 and Level 2.0
  This command ends the logical connection between the source server and the data set accessed on the target server. Once the target DDM begins running this command, it must close the data set regardless of the reply message returned.

• CLRFIL (Clear File) Level 1.0 and Level 2.0
  This command clears an existing file and re-initializes it as if it had just been created.

• CLSDRC (Close Directory) Level 2.0
  This command closes a folder. This command is not sent by a source iSeries server.

• CPYFIL (Copy File) Level 2.0
  This command copies one document to another document. If the new document does not exist, it might be created. This command is not sent by a source iSeries server.

• CRTAIF (Create Alternate Index File) Level 1.0 and Level 2.0
  This command creates an alternate index file on the target server.

• CRTDIRF (Create Direct File) Level 1.0 and Level 2.0
  This command creates a direct file on the target server.

• CRTDRC (Create Directory) Level 2.0
  This command creates folders or libraries on the target server, based on the name received. This command is not sent by a source iSeries server.

• CRTKEYF (Create Keyed File) Level 1.0 and Level 2.0
  This command creates a keyed file on the target server.

• CRTSEQF (Create Sequential File) Level 1.0 and Level 2.0
  This command creates a sequential file on the target server.

• CRTSTRF (Create Stream File) Level 2.0
  This command creates a stream file on the target server. This command is not sent by a source iSeries server.

• DCLFIL (Declare File) Level 1.0 and Level 2.0
  This command associates a declared name (DCLNAM) with a collection of object-oriented parameters in the target agent. This collection is stored by the receiving agent for later use. At the time it is received, the command does not affect objects currently opened by the agent. The primary access to the DCLFIL collection is the DCLNAM parameter.

• DELDCL (Delete Declared Name) Level 1.0
  This command deletes a declared agent name.

• DELDRC (Delete Directory) Level 2.0
  This command deletes a folder or a library. This command is not sent by a source iSeries server.

• DELFIL (Delete File) Level 1.0 and Level 2.0
  This command deletes a file or document.

• DELREC (Delete Record) Level 1.0
  This command deletes the record that currently has an update intent placed on it. It does this without affecting the current cursor position.

• EXCSAT (Exchange Server Attributes) Level 1.0 and Level 2.0
  This command exchanges information between servers, such as the server's class name, architectural level of each class of managers it supports, server's product release level, server's external name, and server's name.

• FILAL and FILATTRL (File Attribute List) Level 1.0, Level 2.0, and Level 3.0
  This is a list of file attributes that DDM might request on an LSTFAT, OPEN, or GETDRCEN. Some parameters are only valid for specific file types.

• FRCBFF (Force Buffer) Level 2.0
  This command forces the data of the referred object to nonvolatile storage.

• GETDRCEN (Get Directory Entries) Level 2.0
  This command gets a list of folders, documents or both. This command is not sent by a source iSeries server.

• GETREC (Get Record at Cursor) Level 1.0
  This command gets and returns the record indicated by the current cursor position.

• GETSTR (Get Substream) Level 2.0 and Level 3.0
  This command gets stream data from a document. This command is not sent by a source iSeries server.

• INSRECEF (Insert at EOF) Level 1.0
  This command inserts a record at the end of the file.

• INSRECKY (Insert Record by Key Value) Level 1.0
  This command inserts one or more records according to their key values wherever there is space available in the file.

• INSRECNB (Insert Record at Number) Level 1.0
  This command inserts one or more records at the position specified by the record number parameter.

• LCKFIL (Lock File) Level 1.0 and Level 2.0
  This command locks the file for subsequent use by the requester.

• LCKSTR (Lock Substream) Level 2.0 and Level 3.0
  This command locks a stream file substream. This command is not sent by a source iSeries server.

• LODRECF (Load Record File) Level 1.0 and Level 2.0
  This command puts a whole record file on the target server.

• LODSTRF (Load Stream File) Level 2.0
  This command sends a whole stream file from the source server to the target server. This command is sent by a source iSeries server when using the copy stream file HPS API.

• LSTFAT (List File Attributes) Level 1.0, Level 2.0, and Level 3.0
  This command retrieves selected attributes of a file, document, or folder.

• MODREC (Modify Record with Update Intent) Level 1.0
  This command changes the record that currently has update intent placed on it without affecting the current cursor position.

• OPEN (Open File) Level 1.0 and Level 2.0
  This command establishes a logical connection between the using program on the source server and the object on the target server.

• OPNDRC (Open Directory) Level 2.0
  This command opens a folder on the target server. This command is not sent by a source iSeries server.

• PUTSTR (Put Substream) Level 2.0 and Level 3.0
  This command puts stream data into a document. This command is not sent by a source iSeries server.

• QRYCD (Query Current Directory) Level 2.0
  This command returns the current directory. This command is not sent by a source iSeries server.

• QRYSPC (Query Space) Level 2.0
  This command returns the amount of space available to a user. This command is not sent by a source iSeries server.

• RNMDRC (Rename Directory) Level 2.0
  This command renames a folder or database library. The command does not support moving folders, and is not sent by a source iSeries server.

• RNMFIL (Rename File) Level 1.0 and Level 2.0
  This command changes the name of an existing database file or document and can also be used for moving documents.

• SBMSYSCMD (Submit server Command) Level 4.0
  This command submits a server command, in the target control language syntax, to the target server.

• SETBOF (Set Cursor to Beginning of File) Level 1.0
  This command sets the cursor to the beginning-of-file position of the file.

• SETEOF (Set Cursor to End of File) Level 1.0
  This command sets the cursor to the end-of-file position of the file.

• SETFRS (Set Cursor to First Record) Level 1.0
  This command sets the cursor to the first record of the file.

• SETKEY (Set Cursor by Key) Level 1.0
  This command positions the cursor based on the key value supplied and the relational operator specified for RELOPR.

• SETKEYFR (Set Cursor to First Record in Key Sequence) Level 1.0
  This command sets the cursor to the first record in the key sequence.

• SETKEYLM (Set Key Limits) Level 1.0
  This command sets the limits of the key values for subsequent SETKEYNX and SETNXTKE commands. This command is not sent by a source iSeries server.

• SETKEYLS (Set Cursor to Last Record in Key Sequence) Level 1.0
  This command sets the cursor to the last record of the file in key sequence order.

• SETKEYNX (Set Cursor to Next Record in Key Sequence) Level 1.0
  This command sets the cursor to the next record of the file in the key sequence order following the record currently indicated by the cursor.

• SETKEYPR (Set Cursor to Previous Record in Key Sequence) Level 1.0
  This command sets the cursor to the previous record of the file in the key sequence order preceding the record currently indicated by the cursor.

• SETLST (Set Cursor to Last Record) Level 1.0
  This command sets the cursor to the last record of the file.

• SETMNS (Set Cursor Minus) Level 1.0
  This command sets the cursor to the record number of the file indicated by the cursor minus the number of record positions specified by CSRDSP.

• SETNBR (Set Cursor to Record Number) Level 1.0
  This command sets the cursor to the record of the file indicated by the record number specified by RECNBR.

• SETNXT (Set Cursor to Next Number) Level 1.0
  This command sets the cursor to the next record of the file with a record number one greater than the current cursor position.

• SETNXTKE (Set Cursor to Next Record in Key Sequence with a Key Equal to Value Specified) Level 1.0
  This command positions the cursor to the next record in the key sequence if the key field of that record has a value equal to the value specified in the KEYVAL parameter. This command is not sent by a source iSeries server.

• SETPLS (Set Cursor Plus) Level 1.0
  This command sets the cursor to the record number of the file indicated by the cursor plus the integer number of records specified by CSRDSP.

• SETPRV (Set Cursor to Previous Record) Level 1.0
  This command sets the cursor to the record of the file with a record number one less than the current cursor position.

• SETUPDKY (Set Update Intent by Key Value) Level 1.0
  This command places an update intent on the record that has a key value equal to the key value specified by KEYVAL.

• SETUPDNB (Set Update Intent by Record Number) Level 1.0
  This command places an update intent on the record of the file indicated by the record number specified by RECNBR.

• ULDRECF (Unload Record File) Level 1.0
  This command sends records from a target record file to the source.

• ULDSTRF (Unload Stream File) Level 2.0
  This command sends a document from the target to the source. This command is sent by a source iSeries server when using the Copy Stream File (QHFCPYSF) HFS API.

• UNLFIL (Unlock File) Level 1.0 and Level 2.0
  This command releases explicit file locks held by the requester on the file.

• UNLIMPLK (Unlock Implicit Record Lock) Level 1.0
  This command releases all implicit record locks currently held by the cursor.

• UNLSTR (Unlock Substreams) Level 2.0 and Level 3.0
  This command unlocks a stream file substream. This command is not sent by a source iSeries server.

 

Parent topic:

DDM commands and parameters