createDirectory

You use createDirectory to create a directory. If you do not specify a partner then the directory is created under the local user ID.

You can use baseDir (see section “baseDir”) to define a base directory under which the specified directory is created.

The length of the directory name (length of baseDir plus length of dirnames) is limited and depends on the openFT version. The length is the number of characters plus 1 character if baseDir does not end with a "/".

You should note the response on a restart (see section “Restart”).

Restrictions

If you specify a directory path in the name attribute then all the directories down to the lowest level must already exist.

Format

 <createDirectory ref?="ID" faultIfExists?="yes|no" dirnames >

  comment?
  context?
  partner?
  baseDir?
</createDirectory>

Attributes

Name	Value	Meaning
ref?	string	Reference to a directory context object.
faultIfExists?	yes | no	The default value is no. If the directory exists then createDirectory is terminated without error. If yes is specified then createDirectory is aborted with the error code ft_exists if the directory already exists. On a restart (see section “Restart”), createDirectory is aborted with the error code ft_recoveryCreateDirectory if the directory exists This may also occur if the instance is switched.
dirnames	See section “Directory name attributes”.

Example

 <?xml version="1.0" encoding="UTF-8"?>
 <ftscript version="1">
   <context>
     <directory id="myDir" name="myTmp"/>
   </context>
   <createDirectory ref="myDir">
     <partner name="UnixP_1">
       <transferAdmission>
         <ftacAdmission ftacAdmission="FTACADM1"/>
       </transferAdmission>
     </partner>
     <baseDir name="frg_eis_03"/>
   </createDirectory>
 </ftscript>

Creates the directory myTmp for the FTAC transfer admission FTACADM1 in the directory frg_eis_03 on the computer UnixP_1.

createDirectory is terminated without error if the directory already exists.
Once createDirectory has run, the directory exists.

frg_eis_03 is specified as baseDir. The directory that is to be created is referenced. The entire directory path (baseDir + name) is frg_eis_03/myTmp and consists of 16 characters.

If the desired directory frg_eis_03/myTmp cannot be created, for example because the path frg_eis_03 does not exist then createDirectory is terminated with the error code ft_cantCreate.

A further example of createDirectory can be found in section “foreach”.