Home

openFT-Script

1. Internal code Error code Description ft code2083 ft error Request request ID Error during preprocessing postprocessing ft code2084 ft error Request request ID Exit code 2 during preprocessing postpro cessing ft code2085 ft auth Request request ID File password no longer valid ft code2086 ft auth Request request ID local file gt is now write protected ft code2087 ft localFile Request request ID Structure File structure error ft code2088 ft error Request request ID NDMS error 2 ft code2089 ft recoveryFailed Request request ID Recovery failed ft code2090 ft error Request request ID Error in completing file transfer ft code2092 ft auth Request request ID Access to local file is no longer permitted ft code2093 ft error Request request ID FTAM error 2 ft code2094 ft cantDelete Request request ID The file s retention period has not yet expired ft code2095 ft notSupported Request request ID Not possible to extend the file during trans parent transfer ft code2096 ft notSupported Request request ID File structure not supported ft code2109 ft connection Request request ID Connection request rejected by local transport system ft code2110 ft connection Request request ID Data integrity checking has detected an error ft code2111 ft connection Encr
2. ft noUtf8Support ft resource UTF 8 is not supported 132 openFT V12 0 openFT Script Interface Error messages Internal code Error code Description ft openParamError ft error Error generating the openFT session ft openParamError2 ft error ft open was not successful parameter error ft OrderQueueNotFound ft resource Order queue could not be found ft parseByteArray ft error Parse or IO error ft parseError ft error Parse or IO error ft portFileCantClose ft resource PortFile could not be closed correctly ft portNotFound ft resource No port found Execution later ft readStatus ft error Parameter error while determining status ft recordSize ft error Incorrect specification for maxRecSize Defective schema ft recoveryCreateDirectory ft recoveryFailed Recovery failed See manual ft recoveryFailed ft recoveryFailed Recovery failed See manual ft replaylllegalEntry ft error Neither an error code or request ID found on replay ft reglistOutOfRange ft error Error querying the openFT request list ft regstatParamError ft error Incorrect parameter for reqstat Internal error ft requestidFormat ft error Error in the format of the request ID ft requestldillegalFormat ft error Error in the format for the request ID ft requestinvalid ft error Invalid request ft resumeForbidden
3. for Unix systems and Windows systems openFT Script Interface This manual is intended for XML programmers and describes the openFT Script commands the XML statements for the openFT Script interface Li Many of the functions described in the manuals are also available in the openFT graphical interface open FT Explorer A detailed online help system that describes the operation of all the dialogs is supplied together with the openFT Explorer The online help system also contains a complete description of the openFT commands openFT V12 0 openFT Script Interface 9 Changes compared to the predecessor version Preface 1 3 1 4 Changes compared to the predecessor version The openFT Script interface to openFT V12 provides the following new commands for the variable issue of openFT Script requests e jftmodsuo for modifying openFT Script user options e ftshwsuo for displaying openFT Script user options The commands ficans ftdels and ftshws have been modified e ftscriptid You can use the wildcard characters and in the fiscriptid in order to identify the openFT Script request The amount of memory that can be allocated in the Java Virtual Machine in order to execute Ftscripts has been increased in openFT V10 0B20 with the result that even extensive open FT Script requests with high memory requirements can be run At the same time resource consumption has been regulated through the use of parallel thr
4. ft code2125 ft connection Request request ID Transport connection lost ft code2126 ft connection Request request ID Transport system error Error code 2 ft code2127 ft connection Request request ID No data traffic within 2 seconds ft code2140 ft admin Request request ID Remote system openFT is not authorized to process requests for this user ft code2141 ft notEmpty Request request ID Remote system The directory remote file gt is not empty ft code2142 ft remoteFile Structure Request request ID Remote system The file attributes do not correspond to the request parameters openFT V12 0 openFT Script Interface 119 Error messages Internal code Error code Description ft code2143 ft access Request request ID Remote system Attributes could not be modified ft code2144 ft cantCreate Request request ID Remote system File directory remote file gt could not be created ft code2145 ft notExist Request request ID Remote system CCS name unknown or not supported ft code2146 ft notExist Request request ID Remote system Higher level directory not found ft code2147 ft exist Request request ID Remote system File directory lt remote file gt already exists ft code2148 ft notSupported Request
5. ft notEmpty A directory for deletion is not empty ft notExist A file directory CCS file owner does not exist ft remoteFileStructure Error in the remote file openFT V12 0 openFT Script Interface 23 Error handling Structure of an Ftscript 2 3 2 Severe Ftscript error codes The severe errors are primarily caused by internal problems e g insufficient storage space on the hard disk for administrative information or script errors e g unresolved references If a severe error occurs than a restart is only possible under certain conditions see section Restart on page 25 Severe errors cannot be intercepted by the faulthandler default In this case it is necessary to write an explicit faulthandler case see section case on page 70 Error codes Description ft abort Termination by the user ft error A general error has occurred ft notSupported The functionality is not supported ft panic A serious error has occurred ft paramError A parameter error has occurred ft paramTooLong A parameter lies outside the value range ft recoveryFailed Error during restart see section Restart on page 25 It is not possible to intercept the error ft reference A reference is invalid not present or circular ft resource A resource error has occurred e g not enough storage space ft syntax A syntax error has o
6. UnixP 1 ission gt sion ftacAdmission FTACADM1 gt mission gt lt directory na lt toRemoteFile gt lt transferFile gt lt transferFile gt lt fromLocalFile n W openFT fts toRemoteFile na partner name transferAd ftacAdmis transferAd lt partner gt e frg_eis_14 gt ame cript Test data large bin mp3 data bin gt me bin mp3 gt WindowsP_1 gt ission gt sion ftacAdmission FTACADM2 gt mission gt lt directory na toRemoteFile lt transferFile gt lt sequence gt lt ftscript gt e frg_eis_14 gt The files text txt and bin mp3 are delivered one after the other First of all the first request in the request queue is submitted Once this has been completed and if no error message is triggered the second request in the request queue is submitted openFT V12 0 openFT Script Interface 91 transferFile openFT Script statements 4 22 transferFile You use transferFile to perform a file transfer transferFile starts the file transfer and waits inside ftscript for the end of the file transfer The file transfer itself can be restarted If you specify remoteSuccessScript see section remoteSuccessScript on page 109 or remoteFailureScript see section remoteFailureScript on page 108 then the corresponding script is subsequently run on the remote computer For local scripts you should use faulthandlers s
7. If the status F and the v option are specified then the cause of the error is output in clear text in another column openFT V12 0 openFT Script Interface 49 ftshws openFT Script Commands Output in CSV format User Ftscriptid State CreationTime FtscriptFileName Error The output contains the following information User User ID under which the request was started Ftscriptid Unique identification of the request The identification is returned by the ftscript command State See table format Sta CreationTime Time at which the openFT Script request was created in the format yyyy mm dd hh mm ss FtscriptFileName Path name of the script file Error Cause of error in clear text in the case of openFT Script requests with status F otherwise empty User Ftscriptid FtscriptFileName and if applicable Error are output enclosed in double quotes 50 openFT V12 0 openFT Script Interface 4 openFT Script statements This section describes the individual openFT Script statements in alphabetical order The use of the statement The existing restrictions The format describes the syntax of the statement For an explanation of the syntax see the following section Syntax of the openFT Script statements The statements available attributes their values and the meaning of these values Optional attributes are indicated by a The examples illustrate th
8. ft panic The specified name workdir does not designate a directory ft err PAR NOTERM ft panic The request is not yet active ft err PAR OPEN ft panic In a program the same directory workdir has already been assigned to a session ft err PAR REMOTE _ ft access No authorization to delete in the remote NOACCESS system No authorization to read attributes in the remote system ft err PAR REMOTE _ ft notEmpty The directory in the remote system is not NOTEMPTY empty ft err PAR REMOTE ft notExist File directory does not exist in the remote NOTEXIST system ft err PAR TERM ft ignore The request has already terminated ft err PAR VALUE ft panic Unknown parameters parameters are incompatible The name of the working directory workdir is invalid ft err PAR VALUE ACCESS ft panic Invalid parameter ftamext gt accessmode ft err PAR VALUE AVAIL ft panic Invalid parameter ftamext gt available ft err PAR VALUE CANTIME ft panic Invalid parameter cantime ft err PAR VALUE COMPR ft panic Invalid parameter compress ft err PAR VALUE DIR ft panic Invalid parameter direction ft err PAR VALUE ENCRYPT resource Invalid parameter encryption ft err PAR VALUE FPWD ft panic Invalid parameter mgmtpasswd ft err PAR VALUE FTYPE ft panic Invalid parameter filetype ft err PAR VALUE LOCCCSN ft paramError Invalid parameter locccsn ft err P
9. and in der ftscriptid This outputs all openFT Script requests that match the wildcard pattern is interpreted as any single character is interpreted as any number of characters If you use wildcards enclose the ftscriptid specification in single quotes so that the wildcard symbols are not interpreted by the shell By default if you do not specify ftscriptid all the user s openFT Script requests are displayed Return code 0 OK 4 Syntax error 51 Error while outputting an Ftscript user 54 Ftscript ID not found 250 Internal error 48 openFT V12 0 openFT Script Interface openFT Script Commands ftshws Output in table format The processing level of the openFT Script requests is displayed in four columns User User ID under which the request was started Ftscriptid Unique identification of the request The identification is returned by the ftscript command Sta Indicates the processing status where W waiting request has not yet been started R running request has been started but has not yet been terminated T terminated The request has been terminated without errors F failure The request has been terminated with errors interrupted The request was interrupted e g due to a system crash C cancelled The request was cancelled with an ftcans command X cancelling The request is currently being cancelled due to an ftcans command FtscriptFileName Path name of the script file
10. openFT Script Interface Error messages Internal code Error code Description ft exit 255 ft execute Error executing executeScript ft featuresNotSupported ft error The parser does not support necessary features ft ftsadmFailed ft error IO exception on start of ftsadm ft housekeepingError ft error Housekeeper terminated with unknown error Is repeated ft illegalJobState ft error Invalid status found on end of request ft illegalMode ft error Invalid mode ft infoFileCantWrite ft resource Info file cannot be written ft InterpreterNotAlive ft resource Interpreter could not be started Execution later ft invalidStartState ft error Invalid status on start ft jobCantCreate ft resource The request could not be generated ft jobCloseError ft resource Error terminating request ft jobExists ft error This request already exists ft jobFailed ft error An unknown error has occurred ft listDirectoryError ft resource Directory cannot be read ft listDirectoryFileInfo ft resource Error writing persistent data ft listDirectoryNoDirectory ft notExist No directory ft listDirectoryOutOfRangeError error Area error on ListDirectory ft listDirectoryParamError ft error Parameter error on ListDirectory ft listDirectorySecurity ft access Access error on ListDirectory for a local directory ft listDirWriterCantCreate ft resource Cannot wr
11. zosScript lt remoteFailureScript gt Attributes Name Value Meaning ref string Reference to a script context object Any partner described there is not evaluated The partner in the associated transferFile activity is used The specification of repeatable in referenced script objects is ignored Example See example on page 94 108 openFT V12 0 openFT Script Interface openFT Script statements transferFile remoteSuccessScript You use remoteSuccessScript to execute a script on the remote system if data transfer succeeds see section script on page 88 The functionality rs of the openFT request is used see ft command in the openFT user manual See also section executeScript on page 63 Format remoteSuccessScript re comment script bs2000Script unixScript windowsScript zosScript lt remoteSuccessScript gt f2 ID gt Attributes Name Value Meaning ref string Reference to a script context object Any partner described there is not evaluated The partner in the associated transferFile activity is used The specification of repeatable in referenced script objects is ignored Example See example on page 94 openFT V12 0 openFT Script Interface 109 transferFile openFT Script statements toLocalFile You use toLocalFile to specify the local target file for file transfer See also section file on
12. Any errors which occur are ignored Using this script either both files or neither of the files reach their destination i If a remoteFailureScript is defined for the file transfer which is cancelled by means of cancel then this may continue to run even when the faulthandler is already active openFT V12 0 openFT Script Interface 67 faulthandler openFT Script statements 4 12 faulthandler The faulthandler is analyzed if an error occurred in the activity in which it is present or if the activity is switched to the error state due to a child activity see section Running an Ftscript on page 26 The faulthandler is used if a case activity with the corresponding error code is defined in it or in the absence of any severe error a default activity is defined see section Severe Ftscript error codes on page 24 This case or default activity then replaces the activity in which the faulthandler is located takes over its context objects and is then executed If an error occurs during the execution of the case or default activity then the original faulthandler is ignored and a suitable faulthandler in the activity s own context or that of its parent activities is used Format lt faulthandler gt comment case default case default lt faulthandler gt Attributes See section case on page 70 68 openFT V12 0 openFT Script Interface openFT Script stateme
13. aborted with the error f recoveryFailed This response may occur if the openFT instance has been switched If the openFT instance is deleted then all running openFT Script requests are interrupted They restart when the instance is switched In the above cases processing waits for approximately 2 seconds for the end of the activity after interruption of the request In the case of lengthy executeScript activities this may not be enough with the result that this openFT Script request is aborted with an error when a restart attempt is made openFT V12 0 openFT Script Interface 25 Running Ftscript Structure of an Ftscript 2 4 Running an Ftscript When an Ftscript is run each activity passes through the following states initialization execution end error Initialization The context is provided Execution In the case of external activities the openFT functionality is executed In the case of internal activities the corresponding statement is executed If an error occurs during the execution of an activity than an error or fault is output together with an error code The activity switches to the error state End The end of the activity is reached if execution is terminated without an error Data may be displayed in the higher level context The activity is terminated Processing continues with the next activity If there are no further activities then the Ftscript is terminated
14. co _ FUJITSU openFT V12 0 for Unix Systems and Windows Systems openFT Script Interface User Guide Edition September 2012 Comments Suggestions Corrections The User Documentation Department would like to know your opinion on this manual Your feedback helps us to optimize our documentation to suit your individual needs Feel free to send us your comments by e mail to manuals ts fujitsu com Certified documentation according to DIN EN ISO 9001 2008 To ensure a consistently high quality standard and user friendliness this documentation was created to meet the regulations of a quality management system which complies with the requirements of the standard DIN EN ISO 9001 2008 cognitas Gesellschaft f r Technik Dokumentation mbH www cognitas de Copyright and Trademarks Copyright Fujitsu Technology Solutions GmbH 2012 All rights reserved Delivery subject to availability right of technical modifications reserved All hardware and software names used are trademarks of their respective manufacturers Contents 1 1 1 2 1 3 1 4 1 5 1 6 2 1 2 1 1 2 1 2 2 1 3 2 2 22 1 22 2 2 3 2 3 1 d dm 2 3 3 2 4 dip doe de a we we 7 ING OUD Bek ee hee ee ee SS ee eee ow 7 Concept of openFT manuals for Unix and Windows systems 8 Changes compared to the predecessor version 10 Notational conventi
15. h csv t v st W ITRTILT ILE ILE C TX 1 u lt user ID 1 36 gt lt ftscriptid gt Description h Outputs the command syntax on screen Any specifications after h are ignored csv The information is output in CSV format If you do not specify csv then the infor mation is output in table format t The openFT Script requests are displayed sorted on generation time beginning with the last request By default the requests are displayed in alphabetical order V Diagnostic information is also output verbose If v is specified then in the case of openFT Script requests which terminate with an error the cause of the error is output in a second line after the tabular information In CSV format the v option is ignored openFT V12 0 openFT Script Interface 47 ftshws openFT Script Commands st W R TI FIUICIIX displays openFT Script requests with the specified status see Sta field in Output in table format on page 49 You can specify multiple statuses one after the other e g st WRT u user ID User ID for which openFT Script requests are output or under which the specified request is searched for Only administrators may specify or a all user IDs The default value is the calling party s user ID ftscriptid Identification of the openFT Script request This is output if the openFT Script request is started via an ftscript command You can use the wildcard symbols
16. 0 openFT Script Interface 2 Structure of Ftscript 2 1 Components of an Ftscript An Ftscript consists of activities Each activity has a context The context may also describe error handling mechanisms faulthandler e Activities may take the form of instructions issued to openFT e g transferFile deleteFile or instructions which control the workflow e g parallel foreach The instruc tions are described in chapter openFT Script statements on page 51 e Files directories scripts and partners can be stored as context objects in the context By means of referencing it is possible to re use this type of context object in the activity and the underlying activities provided that these do not possess a context object with the same name Re use is not possible outside of the activity in which the context object is defined e Ifa fault occurs within an activity then error handling can be used to supply an appro priate response If error handling terminates correctly i e without errors then the associated activity is considered to have been completed successfully Similarly if error handling is terminated with an error then the activity is considered to be defective The general structure of an Ftscript is as follows ftscript version 1 gt context ContextObjects faulthandler lt context gt Activities lt ftscript gt Every Ftscript has the statement lt ftscript versionz 1 as its roo
17. 2 gt ft code756 ft syntax Introductory operand value required for d ft code757 ft syntax Value of operand lt 1 gt not compatible with data type lt 2 gt ft code758 ft syntax Keyword value of operand lt 1 gt ambiguous with regard to lt 2 gt ft code759 ft syntax Too many closing brackets ft code760 ft syntax Required operand lt 1 gt not present ft code762 ft syntax Operand name lt 1 gt ambiguous with regard to lt 2 gt ft code763 ft syntax Operand lt 1 gt not known ft code764 ft syntax Operand lt 1 gt specified more than once ft code765 ft syntax Too many list elements for operand lt 1 gt ft_code766 ft_syntax Too many positional operands ft_code767 ft_syntax Too many positional operands for lt 1 gt ft_code780 ft_syntax Internal error Insufficient operand memory ft_code781 ft_syntax Internal error Structure nesting too deep ft_code790 ft_syntax Available commands 15 ft_code791 ft_syntax Available list values 1 ft_code792 ft_syntax Available operands lt 1 gt ft_code793 ft_syntax Available values lt 1 gt ft_code800 ft_error Request lt request ID gt Internal error Monitor file not accessible ft_code801 ft_error Request lt request ID gt Internal error 124 openFT V12 0 openFT Script Interface Error messages Internal code Error code Descripti
18. 65535 Specifies the record size By default the openFT value applies see e openFT lt openFT user manual V11 If data char then maxRecSize specifies the length of a line to the 1 32756 or CR LF Files with a line length greater than 65535 bytes must be trans 1 32767 ferred with data bin For example an Ftscript with a maxRecSize value that is not permitted in openFT V11 0 will not run in openFT V11 0 ccsname string max Specifies the Coded Character Set 8 characters see openFT user manual filenames See section File name attributes on page 20 Example lt xml version 1 0 encoding UTF 8 gt lt ftscript version 1 gt transferFile fromLocalFile name bin mp3 gt directory name W openFT ftscript Test data smal1 gt autoDataSpec charPattern txt userPattern tab dat default bin gt fromLocalFile toRemoteFile name bin mp3 gt partner name UnixP_1 gt lt transferAdmission gt lt ftacAdmission ftacAdmission FTACADM1 gt lt transferAdmission gt lt partner gt lt directory name frg_eis_18 gt lt toRemoteFile gt lt transferFile gt lt ftscript gt In the example the local file bin mp3 is transferred to the remote system UnixP 1 under the name bin mp3 No transfer mode or autoDataSpec is specified The transfer mode is bin default value of autoDataSpec 102 openFT V12 0 openFT Script Interface o
19. State See table format on page 42 Activity See table format on page 43 ActivityObject See table format enclosed in double quotes otherwise the path name is output without partner specifications only the faultcodes are output for the faulthandler activity Partner In the case of path related activities the partner or partner specification that would be present in front of the path name in table format enclosed in double quotes Otherwise empty AddInfo For sendFile and rcvFile TID enclosed in double quotes if the activity has already started Otherwise empty For faulthdl the triggering activity Id enclosed in double quotes Otherwise empty nrElements In the case of a started foreach number of loop passes In the case of a started parallel or sequence number of sub activities StartTime Start time in the format yyyy mm dd hh mm ss Error In the case of requests with the status F case of error in clear text enclosed by double quotes Otherwise empty 46 openFT V12 0 openFT Script Interface openFT Script Commands ftshws 3 8 ftshws Displaying openFT Script requests Outputs information about the status of a user s openFT Script requests You can also specify a ftscriptid in order to select a specific openFT Script request Format for Unix systems ftshws h csv t v St W l R I T I ETHH CTI X 1 u lt user ID 1 32 gt lt ftscriptid gt Format for Windows systems ftshws
20. are permitted for the faulthandler see section faulthandler on page 68 Error codes Description ft abort Command aborted ft access Access error ft admin Administration error ft auth Authentication error ft cantCreate File directory could not be generated ft cantDelete File directory could not be deleted ft configuration Configuration defective ft connection Connection error ft corrupt File data directory cannot be used ft error General error ft exist File directory already exists ft execute Error executing executeScript ft localFileStructure Error in the local file ft notEmpty Directory is not empty ft notExist File directory does not exist ft notSupported The functionality is not supported ft panic Severe internal error ft paramError Parameter error ft paramTooLong Parameter too long ft recoveryFailed Restart failed ft reference An Ftscript object which is not present is referenced ft remoteFileStructure Remote file structure defective ft resource Resource error e g not enough storage space no RAM ft script A script executed with executeScript has terminated with an error code ft syntax Syntax error openFT V12 0 openFT Script Interface Glossary Cross references are written in italics Activity An openFT script consi
21. code ft notExists if the directory does not exist On a restart see section Restart on page 25 deleteDirectory is terminated with the error code ft recoveryFailed This may also occur if the instance is switched dirnames See section Directory name attributes on page 21 openFT V12 0 openFT Script Interface 57 deleteDirectory openFT Script statements Example lt xml version 1 0 encoding UTF 8 gt lt ftscript version 1 gt lt context gt lt directory id myDir name myTmp gt lt context gt lt deleteDirectory ref myDir gt partner name UnixP 1 systemType unix lt transferAdmission gt ftacAdmission ftacAdmission FTACADM1 gt lt transferAdmission gt lt partner gt lt baseDir name frg_eis_04 gt lt deleteDirectory gt lt ftscript gt Deletes the directory myTmp for the FTAC transfer admission FTACADMI on the computer UnixP 1 deleteDirectory is terminated without error if the directory does not exist or has already been deleted frg eis 04 is specified as baseDir The directory that is to be deleted is referenced The entire directory path baseDir name is frg eis 04 myTmp and consists of 16 characters 58 openFT V12 0 openFT Script Interface openFT Script statements deleteFile 4 7 deleteFile You use deleteFile to delete a file If you do not specify a partner then the file is deleted under the local
22. code2228 ft error Monitor file not present ft code236 ft admin Set instance lt 1 gt no longer found ft code35 ft access File locked against concurrent access ft code41 ft resource Request queue full ft code700 ft syntax The parameters lt 1 gt and lt 2 gt may not both be specified at once ft code701 ft syntax Input error ft code702 ft syntax Parameter value lt 1 gt too long ft code703 ft syntax Mandatory parameter missing ft code704 ft syntax Mandatory parameter 1 missing ft code705 ft syntax Parameter lt 1 gt specified more than once ft_code706 ft_syntax Parameter 1 can only be specified together with lt 2 gt ft_code707 ft_syntax Invalid parameter lt 1 gt openFT V12 0 openFT Script Interface 123 Error messages Internal code Error code Description ft code708 ft syntax Range of values for parameter lt 1 gt not respected ft code709 ft syntax Too many positional parameters ft code710 ft syntax Incorrect parameter value lt 1 gt ft code750 ft syntax Command not known ft code751 ft syntax Command name ambiguous with regard to d ft code752 ft syntax Closing bracket missing for operand lt 1 gt ft code753 ft syntax Incorrect separator 1 after operand lt 2 gt ft code755 ft syntax List value of operand 1 not compatible with data type lt
23. current context The context object is referenced under this ID ref string References a context object of type partner After de referencing the partner must possess a transfer admission see section transferAdmission on page 86 name string Name of the partner system TNS and DNS names are permitted IPv4 and IPv6 addresses start with see openFT user manual systemType The default value is any windows Specifies the partner s system type zos bs2000 The system type is not determined automatically If no system type is specified then the general data e g name is used instead of the system specific data e g unixname 84 openFT V12 0 openFT Script Interface openFT Script statements partner 4 19 1 processingAdmission You use processingAdmission to assign the processing admission for scripts processingAdmission is not currently supported The attribute can be specified but has no effect Format processingAdmission userId user userAccount account userPassword password gt comment lt processingAdmission gt Attributes Name Value Meaning userId string User ID Does not have to be specified if the transferAdmission is used section transferAdmission on page 86 userAccount string Account information userPassword string Password for the user ID openFT V12 0 openFT Script Interface
24. exist there The file is given an internal name The suffix of the file is determined from the suffix of the associated fromRemoteFile f this does not have a suffix then the generated temporary file also has no suffix This file is stored in user memory If the memory space for the user is restricted Disk Quota then the limit may be exceeded when temporary files are created The transferFile activity is cancelled with the error code ft err LOCERR MEM The file object inherits the data MaxRecSize recordFormat ccsname and autoDataSpec speci fications in the associated fromRemoteFile activity These are then re used when the fromLocalTmpFile activity is called see section fromLocalTmpFile on page 103 The temporary file is deleted automatically as soon as the context in which the file object was defined is exited See also section file on page 72 Restrictions 1 You can only access the generated temporary file with use tmpID from a fromLocalTmpFile 2 The transferFile fromRemoteFile activity must be concluded before you use transferFile toRemoteFile to access the temporary file You should therefore perform these activities sequentially or if appropriate embed them in a lt sequence gt openFT V12 0 openFT Script Interface 111 transferFile openFT Script statements Format lt toLocalTmpFile id tmpID gt Attributes Name Value Meaning id string ID of the temporary file
25. file too long ft code2027 ft paramError No file or directory name specified ft code2028 ft auth Invalid management password ft code2029 ft access local file gt not available ft code2030 ft notExist Home directory not found ft code2031 ft access Not possible to rename ft code2032 ft resource Not enough storage space for local file gt ft code2033 ft notExist File owner unknown ft code2034 ft auth Invalid file password ft code2036 ft cantDelete The file s retention period has not yet expired ft code2037 ft auth local file is write protected ft code2038 ft localFile File structure not supported Structure ft code2039 ft syntax Syntax error in resulting file name local file gt ft_code2040 ft_notSupported Transparent file transfer not supported 116 openFT V12 0 openFT Script Interface Error messages Internal code Error code Description ft code2042 ft notSupported Not possible to extend the file during trans parent transfer ft code2043 ft auth Access to local file prohibited ft code2044 ft paramTooLong Follow up processing too long ft code2045 ft auth Authorization for follow up processing invalid ft code2046 ft auth Local transfer admission invalid ft code2047 ft auth Request rejected by local FTAC ft code20
26. ft statusCantWrite ft resource Cannot write status ft termSocketClose ft resource Socket cannot be closed ft timestampCantCreate ft resource Timestamp could not be created ft tmpFileDelete ft resource Timestamp could not be deleted ft tmpFileNotFound ft resource Expected TmpFile was not found ft traceCantCreate ft resource Trace file could not be generated No trace deactivate trace ft traceFileCreateError ft resource Trace file could not be generated Deactivate trace ft traceFileNotFound ft resource Trace file could not be found ft traceSerialization ft error Trace file corrupt ft traceSyncFailed ft resource Trace data could not be written to disk Trace may not be complete ft traceWrapperCantCreate ft resource Trace file wrapper could not be generated ft traceWrapperCreateError ft resource Trace file wrapper could not be generated ft traceWrapperNotFound ft resource Trace file wrapper could not be found ft transferFilelllegalSyntax ft error remote remote or local local not permitted Schema defective ft transferMandatoryParam ft error Parameter error on ft transfer ft transparentModelllegal ft error Incorrect specification in transparent mode Defective schema ft transparentModeOutOfRange ft error Incorrect specification in transparent mode version correct ft unex
27. in transferFile elements associated with the parent context You can only access this ID with use tmpID from a fromLocalTmpFile Example See example in section fromLocalTmpFile on page 104 112 openFT V12 0 openFT Script Interface openFT Script statements transferFile toRemoteFile You use toRemoteFile to specify the remote target file for file transfer See also section file on page 72 File names may be a maximum of 512 characters in length This is checked before the Ftscript is run The length of the resulting file name directory and filenames is limited by the operating system in question and the openFT version The length is the number of characters plus 1 character if directory does not end with a The check is performed while the Ftscript is being run For further information see section File name attributes on page 20 Restrictions toRemoteFile must contain a partner specification after de referencing Format toRemoteFile ref ID ccsname string filenames gt comment partner directory lt toRemoteFile gt Attributes Name Value Meaning ref string Reference to another file object ccsname string Specifies the Coded Character Set max 8 characters see openFT user manual filenames See section File name attributes on page 20 Example See example on page 94 openFT V12 0 openFT Script Interface 113 transfer
28. listed The base directory itself is not listed see section listDirectory on page 79 You can only use baseDir with the openFT Script statements which are listed above Format See the corresponding openFT Script statement Attributes Name Value Meaning dirnames See section Directory name attributes on page 21 Examples See section createDirectory on page 55 section deleteDirectory on page 57 section listDirectory on page 79 52 openFT V12 0 openFT Script Interface openFT Script statements comment 4 3 comment You use comment to enter a comment text for the element in question You can use comments to describe the scripts You use XML comments lt gt to make internal comments regarding the scripts Format comment text lt comment gt openFT V12 0 openFT Script Interface 53 context openFT Script statements 4 4 context You use context to define a context and faulthandlers for an activity Context objects are objects which can be used in the same or in lower level activities when referenced using the attribute ref or listRef They may be of type autoDataSpec directory file list partner script A context exists for every activity If no context element is specified the an empty context is explicitly created All the context objects and faulthandlers of the higher level contexts are visible provided that they are
29. not hidden by context objects or faulthandlers with the same name Format context ContextObject faulthandler lt context gt 54 openFT V12 0 openFT Script Interface openFT Script statements createDirectory 4 5 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 on page 52 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 i You should note the response on a restart see section Restart on page 25 Restrictions If you specify a directory path in the name attribute then all the directories down to the lo west level must already exist Format createDirectory ref ID faultIfExists yes no dirnames gt comment context partner baseDir createDirectory gt Attributes Name Value Meaning ref string Reference to a directory context object faultIfExists 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 exi
30. not started and the errors are output at stderr If the script file starts correctly then the following message is output at stderr ftscript started successfully Id ftscript id Information about the openFT Script request is stored in the internal openFT user memory during execution and through to expiry of the retention period As a consequence users can view the output ftscript id in order to obtain information about the status and success of the operation ftscript is restartable i e the processing of the openFT Script request is ensured even after a system failure Format ftscript h t Ftscript file name gt Description h Outputs the command syntax on screen Any specifications after are ignored t Diagnostic information a trace is created Ftscript file name Name of the script file which contains the XML statements for the openFT Script request that is to be run 38 openFT V12 0 openFT Script Interface openFT Script Commands ftscript Return code 0 OK 4 Syntax error 50 Ftscript process could not be started 52 Maximum number of Ftscript users 1024 exceeded 55 Ftscript ID not found 250 Internal error openFT V12 0 openFT Script Interface 39 ftshwact openFT Script Commands 3 7 ftshwact Displaying the activity associated with an openFT Script request Outputs information about the individual openFT Script requests Format for Unix systems ftshwact h csv a
31. openFT instance during script execution in the case of scripts with short runtimes see section Example lt xml version 1 0 encoding UTF 8 gt lt ftscript version 1 gt lt context gt list id partnerList gt partner name WindowsP 1 systemType windows gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADMI lt transferAdmission gt lt partner gt partner name UnixP 1 systemType unix gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADM2 lt transferAdmission gt lt partner gt lt list gt lt context gt lt foreach listRef partnerList selectType partner contextObject partner lt executeScript gt lt unixScript gt frg eis 07Ndemo txt 1 lt windowsScript gt partner ref partner gt lt executeScript gt lt foreach gt lt ftscript gt unixScript LCDATALecho hello unix frg eis 07 demo txt 1 windowsScript LCDATALcmd c echo hello windows An executeScript is run on the computers in the list partnerList Corresponding operating specific scripts are executed depending on the operating system in question It is important to specify the operating system in the partner definition 64 openFT V12 0 openFT Script Interface openFT Script statements fault 4 11 fault You use fault to cancel the parent activity and all its running child activities with a user define
32. page 72 File names may be a maximum of 512 characters in length This is checked before the Ftscript is run The length of the resulting file name directory and filenames is limited by the operating system in question and the openFT version The length is the number of characters plus 1 character if directory does not end with a The check is performed while the Ftscript is being run For further information see section File name attributes on page 20 Restrictions toLocalFile must not contain any partner specification after de referencing Format lt toLocalFile ref ID ccsname string filenames gt comment partner directory lt toLocalFile gt Attributes Name Value Meaning ref string Reference to another file object ccsname string Specifies the Coded Character Set max 8 characters see openFT user manual filenames See section File name attributes on page 20 Example See example on page 94 110 openFT V12 0 openFT Script Interface openFT Script statements transferFile toLocalTmpFile You use toLocalTmpFile to specify a temporary target file for file transfer from remote to remote see Types of file transfer on page 92 The temporary file is simply a buffer under the local ID The file is assigned to a file object with the specified ID This file object is displayed in the parent context of the current rrans ferFile element and must not already
33. parallel to frg eis 2 local bin on all the computers in the RemoteHostList The context object FileList from the listDirectory activity is displayed in the context of the parent element in the example ftscript openFT V12 0 openFT Script Interface 81 parallel openFT Script statements 4 18 parallel You can specify parallel to run all the activities simultaneously and independently of one another However truly simultaneous execution for example as in the case of time slicing is not implemented The parallel activity is terminated when all the child activities have terminated If one child activity outputs an error then child activities that are still running are cancelled The results of any given child activity are not visible in the other child activities The transfer of context objects to the parent context is not planned at present Conse quently context objects which arise during the parallel activity are discarded A listDirectory as a direct child element of a parallel activity therefore does not return 1 a usable event list see section listDirectory on page 79 parallel refers to the parallel processing of activities by openFT Script The maximum num ber of file transfers that actually run in parallel is determined by the openFT connection limit and process limit see the openFT manual Installation and Administration To save re Sources openFT Script restricts the number of re
34. request ID Remote system Transfer of file generation groups not supported ft code2149 ft access Request request ID Remote system Error accessing remote file gt ft_code2150 ft_syntax Request lt request ID gt Remote system Resulting file name too long ft_code2151 ft_access Request lt request ID gt Remote system File locked against concurrent access ft_code2152 ft_paramError Request lt request ID gt Remote system No file or directory name specified ft_code2153 ft_auth Request lt request ID gt Remote system Invalid management password ft_code2154 ft_access Request lt request ID gt Remote system File directory remote file gt not available ft_code2155 ft_notExist Request lt request ID gt Remote system File directory lt remote file gt not found ft_code2156 ft_notExist Request lt request ID gt Remote system Home directory not found 120 openFT V12 0 openFT Script Interface Error messages Internal code Error code Description ft code2157 ft access Request request ID Remote system Not possible to rename ft code2158 ft resource Request request ID Remote system Not enough storage space for remote file gt ft code2159 ft notExist Request request ID Remote system File owner unknown ft code2160 ft auth Request requ
35. request queue 139 restart 25 root element 13 14 running an Ftscript 26 running an openFT script 26 S script 88 script statements see openFT Script statements sequence 90 severe error codes 22 24 specifying directory names 21 specifying the file name 20 statements see openFT Script statements structure of an Ftscript 13 T target group 7 TCP IP 139 toLocalFile 110 toLocalTmpFile 111 toRemoteFile 113 transferAdmission 86 142 openFT V12 0 openFT Script Interface Index transferFile 92 autoDataSpec 98 fromLocalFile 101 fromLocalTmpFile 103 fromRemoteFile 106 remoteFailureScript 108 remoteSuccessScript 109 toLocalFile 110 toLocalTmpFile 111 toRemoteFile 113 U userAdmission 86 2 2 05 63 openFT V12 0 openFT Script Interface 143 Index 144 openFT V12 0 openFT Script Interface
36. statements are described beginning on page 51 3 1 Overview of the openFT Script commands Starting and ending openFT Script requests ftscript Starts an openFT Script request ftcans Cancels an openFT Script request ftdels Deletes an openFT Script request Displaying openFT Script requests and openFT Script activities ftshws Displays openFT Script requests ftshwact Displays the activities of an openFT Script request FT administrators can also use the ftsetjava command to administer the link to the Java executable see openFT System Administrator Manual and the online help system As FT administrator you can view cancel and delete all the openFT Script requests in the system and view the activities associated with all the openFT Script requests Users without administrator rights can only administer their own openFT Script requests Variable storage of openFT Script requests ftmodsuo Modify openFT Script user options ftshwsuo Display openFT Script user options openFT V12 0 openFT Script Interface 29 ftcans openFT Script Commands 3 2 ftcans Cancelling an openFT Script request tcans allows you to cancel openFT Script requests that have not yet been concluded You can cancel either a specific openFT Script request or all the openFT Script requests for a user This also cancels any file transfer requests started by the specified openFT Script requests which are currently running This may take a little time The statu
37. the computers and the inner sequence works through all the files The connection to the computers takes place in parallel and the files are also worked through in parallel at each computer 74 openFT V12 0 openFT Script Interface openFT Script statements foreach autoDataSpec differentiates between text and binary files see section autoDataSpec on page 98 When the script is run the files are distributed to all the computers Since no faulthandler was used in the example the script is terminated with an error 2 Copying the file tree lt xml version 1 0 encoding UTF 8 ftscript version 1 gt lt context gt partner id remote name UnixP 1 lt transferAdmission gt ftacAdmission ftacAdmission FTACADMI lt transferAdmission gt lt partner gt lt context gt lt listDirectory name listObject Flist gt lt partner ref remote gt baseDir name frg_eis_11 gt lt listDirectory gt foreach listRef Flist selectType directory contextObject creDir execute sequential gt lt createDirectory ref creDir gt lt baseDir name frg_eis_11 gt lt createDirectory gt lt foreach gt lt foreach listRef Flist selectType file contextObject file execute parallel gt lt transferFile gt fromRemoteFile ref file gt partner ref remote gt directory name 2 frg eis 11 fromRemoteFile lt toLocalFile ref file gt directory name frg e
38. too long mgmtpasswd or filepasswd ft err PAR LEN LEGALQ ft paramTooLong Parameter too long ftamext gt legalq ft err PAR LEN LOCFN ft paramTooLong Parameter too long locfn ft err PAR LEN LOCPR ft paramTooLong Parameter too long Total of the lengths of locsuccproc and locfailproc ft err PAR LEN REMACC ft paramTooLong Parameter too long remaccount ft err PAR LEN REMADM ft paramTooLong Parameter too long remadmis ft err PAR LEN REMFN ft paramTooLong Parameter too long fn or remfn ft err PAR LEN REMPR ft paramTooLong Parameter too long Total of the lengths of remsuccproc and remfailproc ft err PAR LEN REMPWD ft paramTooLong Parameter too long rempasswd ft err PAR LEN REMSYS ft paramTooLong Parameter too long remsys ft err PAR MAND ft panic The parameter list par was not specified The name of the working directory workdir was not specified The output area stat was not specified The parameter list par was not specified The output area info was not specified only in the case of ft show ft err PAR MAND LOCFN ft paramError locfn was not specified 128 openFT V12 0 openFT Script Interface Error messages Internal code Error code Description ft err PAR MAND REMSYS ft error The remote system was not specified ft err PAR
39. 48 ft notSupported Function for protocol partner protocol type not supported ft code2049 ft notSupported Remote follow up processing not supported ft code2070 ft admin Request request ID openFT is no longer authorized to process requests for this user ft code2071 ft notSupported Request request ID User data encryption not installed ft code2072 ft abort Request request ID has been deleted ft code2073 ft corrupt Request request ID Error during encryption ft code2074 ft cantCreate Request request ID local file gt could not be created ft code2075 ft notExist Request request ID Higher level directory no longer found ft code2076 ft access Request request ID Error on local file input output ft code2077 ft access Request request ID File now locked against concurrent access ft code2078 ft access Request request ID local file gt no longer available ft code2079 ft notExist Request request ID local file no longer found ft code2080 ft notExist Request request ID Home directory no longer found ft code2081 ft resource Request request ID local file can no longer be assigned any space ft code2082 ft notExist Request request ID File owner no longer known openFT V12 0 openFT Script Interface 117 Error messages
40. 85 openFT Script statements 4 19 2 transferAdmission You use rransferAdmission to assign the admission for transfer files Format lt transferAdmission gt comment lt transferAdmission gt ftacAdmission userAdmission ftacAdmission You use ftacAdmission to assign the admission in the form of an FTAC transfer admission Format ftacAdmission ftacAdmission ftac gt Attributes Name Value Meaning ftacAdmission string FTAC transfer admission See openFT user guide userAdmission You use userAdmission to specify the admission in the form of the login LOGON access data user ID password and account i Avoid using userAdmission in this version openFT Script requires the password to be specified in plain text If possible use the more reliable ftacAdmission instead 86 openFT V12 0 openFT Script Interface openFT Script statements partner Format userAdmission userId userId userAccount account userPassword password gt comment lt userAdmission gt Attributes Name Value Meaning userId string User ID userAccount string Account information userPassword string Password for the user ID openFT V12 0 openFT Script Interface 87 script openFT Script statements 4 20 script You use script to specify a text string which is to be executed as an ope
41. AR VALUE MAXREC ft paramError Invalid parameter maxrecsize ft err PAR VALUE PRIO ft panic Invalid parameter priority ft err PAR VALUE REMACC ft paramError Invalid parameter remaccount ft err PAR VALUE REMADM ft auth Invalid parameter remadmis or invalid parameter remadm The user ID transfer admission in the remote system is invalid ft err PAR VALUE REMCCSN ft paramError Invalid parameter remccsn openFT V12 0 openFT Script Interface 129 Error messages Internal code Error code Description ft err PAR VALUE REMFN ft paramError Invalid parameter remfn The specified file does not exist access is not permitted ft err PAR VALUE REMPWD ft paramError Invalid parameter rempasswd ft err PAR VALUE REMSYS ft paramError Invalid parameter rem The specified remote system is unknown ft err PAR VALUE RFORM ft paramError Invalid parameter record format ft err PAR VALUE RID ft panic The request ID rid is invalid ft err PAR VALUE STARTTIME ft panic Invalid parameter starttime ft err PAR VALUE SYNC ft panic Invalid parameter synchron ft err PAR VALUE TRANSP ft panic Invalid parameter transparent ft err PAR VALUE WMODE ft panic Invalid parameter writemode ft err PAR VERS ft panic The version of the data structure parameter list or output area is invalid ft er
42. Error The error state may be caused by error occurring during the execution of the activity itself anerror in a child activity which is not intercepted by a faulthandler A suitable faulthandler is searched for in the current context see section faulthandler on page 68 The activity is replaced by the content of the faulthandler In this case the context objects of the activity are displayed in the faulthandler All the activity s child activities are aborted and their contexts are lost If these child activities have started file transfer requests then these are also aborted If no suitable faulthandler is found then the error is passed to the parent activity The parent activity switches to the error state If no suitable faulthandler is found in any of the higher level activities then the entire Ftscript is terminated 26 openFT V12 0 openFT Script Interface Diagnostic information You can activate a trace in order to conduct a precise analysis of the Ftscript run including restart see section Restart on page 25 ftscript t Ftscript file name gt The trace logs every action in the request openFT V12 0 openFT Script Interface 27 28 openFT V12 0 openFT Script Interface 3 openFT Script Commands The openFT Script commands are used to start and administer openFT Script requests The requests themselves are stored in a text file in the form of XML statements These XML
43. FT FTAC and ADM administrators It describes the installation of openFT and its optional components the operation control and monitoring of the FT system and the FTAC environment the administration commands for FT and FTAC administrators the configuration and operation of a remote administration server and a ADM trap server e openFT for Unix systems Managed File Transfer in the Open World The user manual is intended for the openFT user and describes the basic functions of the openFT product family the conventions for file transfers to computers running different operating systems details on implementing FTAM the openFT user commands the openFT Script commands the BSFT interface the messages of the different components openFT V12 0 openFT Script Interface Concept of manuals e openFT Windows systems Managed File Transfer in the Open World The user manual is intended for the openFT user and describes the basic functions of the openFT product family the conventions for file transfers to computers running different operating systems details on implementing FTAM the openFT user commands the openFT Script commands the messages of the different components e for Unix systems and Windows systems Program Interface This manual is intended for C programmers and describes the C program interface on Unix and Windows systems e
44. File openFT Script statements 114 openFT V12 0 openFT Script Interface 5 Error messages For a list and description of the severe Ftscript error codes please refer to section Se vere Ftscript error codes on page 24 You can use the error codes listed here in the case statement of the faulthandler activity If required you can find the internal code in the ActivityObject output parameter of the output from ftshwact The internal code has the structure ft codexxxx where xxxx is the openFT error number The Ftscript error code is assigned to the openFT error numbers see also the openFT User Manual fthelp command Internal code Error code Description ft activeDirNotExists ft resource Script request directory does not exist Restart not possible ft alarmException ft error Error during alarm handling Is ignored ft alarmFailed ft error Slow poll An unhandled error has occurred ft callFtRuntime ft error Runtime error on FT call ft callSecurity ft access Access error during file deletion ft cancelCmdError ft error Abort terminated with unknown error ft cancelError ft error Error during abort ft cancelUnexpectedState ft error Request terminated but status incorrect Abort expected ft cantCreateJobListener ft resource Interruption during communication with openFT ft cantlnitializeJob ft error Request cannot be initialized ft can
45. IG uu uu e ia e ee RE SRE cm aa 106 uui oo Eke RSME SA EGS Geb ee 108 FEMOIESLRCESSSONDE uu ud eG Ru See SSE Ee SRE RE OR ER Be 109 anb ehe ces cae roii eio ees bci sb doe e ie aes 5 110 teLocelTImpElle uu uus s som RR HH RS RE Rem moe 111 Asl ico ps iim MIR TRE RO ROTE RS Co 2129 27 7 2772 27 4794 113 5 Error message 64 xoxo E RR ee ex 115 DOSSI uc sos om ROBUR 308 cR OH AS ope eS eS qd RR dm 137 5 ee Se i doce Qo SRL ow x UR A poA So CROCO a Gre 141 openFT V12 0 openFT Script Interface Contents openFT V12 0 openFT Script Interface 1 Preface This document describes Version 1 of openFT Script openFT Script is a language for the description of multiple logically interdependent openFT requests openFT Script makes it possible to combine these requests to form a single request Ftscript openFT Script reduces the customer workload involved in monitoring sequential openFT requests and permits restarts in the event of a downtime openFT Script uses XML notation You can use openFT Script under Windows as well as under Unix systems 1 1 Target group This manual is intended for XML programmers who want to create openFT Script requests openFT Script requests are use
46. RR FTC exit status ft panic exit status indicates the message number of the ftc command see message 94 and message 95 in the openFT message table ft err LOCERR INCONS ft localFile Structure The local file is inconsistent ft err LOCERR MEM ft resource The local file is assigned no space ft err LOCERR NOACCESS ft access It is not possible to access the local file ft err LOCERR NOCREAT ft cantCreate The local file cannot be created openFT V12 0 openFT Script Interface 127 Error messages Internal code Error code Description ft err LOCERR NOTEXIST ft notExist The local file cannot be found ft err PAR errno ft error errno is the value of the errno variable This value is set by the stat call The errno variable has the value 0 if no write authori zation has been assigned for the directory ft err PAR 5 code Error code in accordance with ft code code Message in accordance with ft code code ft err PAR INVSESS ft panic The session number is invalid ft err PAR LEN ft notSupported The name of the working directory workdir is too long ft err PAR LEN ACCOUNT ft paramTooLong Parameter too long ftamext gt account ft err PAR LEN CRPWD ft paramTooLong Parameter too long ftamext gt crpasswd ft err PAR LEN FPWD ft paramTooLong Parameter
47. Value Meaning id string A unique ID in the current context The context object is referenced under this ID ref string ID of another script object repeatable truelfalse The default value is true The script may be repeated on a restart If false is specified then the script may not be repeated If on restart it is not possible to determine whether the Ftscript has run then the entire Ftscript is cancelled Examples See section executeScript on page 63 openFT V12 0 openFT Script Interface 89 sequence openFT Script statements 4 21 sequence You use sequence to execute the activities in a sequence one after the other in the specified order Each child activity can use the results of the preceding child activities If an activity adds new context objects to the sequence context e g transferFile toLocalTmpFile or listDirectory then the following activities can access the new data Format sequence comment context Activity lt sequence gt 90 openFT V12 0 openFT Script Interface openFT Script statements sequence Example lt xml version 1 0 en lt ftscript version 1 gt lt sequence gt lt transferFile gt lt fromLocalFile n W openFT ftsc toRemoteFile na partner name transferAd ftacAdmis transferAd lt partner gt coding UTF 8 gt ame ript Test data small text txt data char gt me text txt
48. a line to 1 32767 the CR LF Files with a line length greater than 65535 bytes must be transferred with data bin For example an Ftscript with a maxRecSize value that is not permitted in openFT V11 0 will not run in openFT V11 0 ccsname string Specifies the Coded Character Set max 8 characters see openFT user manual filenames See section File name attributes on page 20 Example See example on page 94 openFT V12 0 openFT Script Interface 107 transferFile openFT Script statements remoteFailureScript You use remoteFailureScript to execute a script on the remote system if data transfer fails see section script on page 88 The functionality rf of the openFT request is used see ft command in the openFT User Guide You should note that remoteFailureScript and a corresponding faulthandler in the 1 Ftscript see section faulthandler on page 68 may affect one another since their execution is practically simultaneous local and remote See also section executeScript on page 63 Additional notes The script is also executed if a running data transfer is aborted with a fault internally cancel is issued if a fault occurs see section fault on page 65 and the openFT user manual If a fault occurs then remoteFailureScript is only executed for the running transfers Format remoteFailureScript ref ID gt comment script bs2000Script unixScript windowsScript
49. amp RSs Soe ehe GSS que wx qp qoae 68 CASS s dk KR OR wo RRR dXX E NOR SBOE E 5 70 eras ua ce Your EPOR URL Eg re FC ied used 71 4 13 j fT CC ETT Tom 72 4 14 M det a GOGH Bw RO Rl a Re 73 4 15 TISGMPE 2 c sU 77 openFT V12 0 openFT Script Interface Contents 4 16 is fet cate hae ee eee aha ee eee 78 4 17 ek a Gea RE SOS ODE Grea Saw Haw 79 4 18 parallel Be 82 4 19 ccc 0 84 4 19 1 PIOCESSINGACMISSION ow REO kaw Dee De eR XR XR Y XR 85 4 19 2 transeo acp KC COE OE dod 86 dede ok pe UE EUR 86 UBBEAHIIBSIOIT s c sia got beh ee nO p e Bae 86 4 20 SOND cack uos ROBES HO CHS SEAS SSK DOCE 88 4 21 SEQUENCE hed 04S RG EARS ORS E e dep d 90 4 22 WansierFil 1 ou uos ox oa ee oho omo m Roe Re Rode RO EOS 92 c Ip PCT 98 sace REESE REESE Ee 3c 949924342439 ESE 21 101 TCT SIDE ded aedi edes B uii ge abe det ee Behe d 103 iromPlamolsF
50. annot be set Interpreter will be terminated ft mainLocklOerror ft resource Main lock cannot be set Interpreter will be terminated ft mainLockNotSet ft resource Main lock not set Interpreter will be termi nated ft nameGroupElementUnknown ft error The schema and Ftscript do not match There is no such name attribute ft nasty error ft error An unhandled error has occurred ft nolnterpreter ft resource Server process not present at the correct time ft noKeyInLogfile ft error Log file entry invalid key not present Restart no longer possible ft noPartner ft paramError No partner was specified for the remote file ft noRef ft reference Reference cannot be resolved ft noRefForContextObject ft reference Reference cannot be resolved ft noRefinFtscript ft reference Reference cannot be resolved ft noScript ft resource No script was specified ft noSession ft error openFT session could not be generated ft notExist ft notExist File or directory does not exist ft noTransferAdmission ft paramError The transfer admission is missing in the partner specification ft notRepeatable ft error Ftscript request cannot be repeated ft noUserFaultCode ft paramError Error code may not start with ft ft noUserScript ft paramError No script was specified for executeScript
51. atternlist Wildcard pattern If the pattern matches the specified file name then the file is trans ferred in bin format charPattern patternlist Wildcard pattern If the pattern matches the specified file name then the file is trans ferred in char format userPattern patternlist Wildcard pattern If the pattern matches the specified file name then the file is trans ferred in user format default char The default value is char binl Specifies the assumed data type if no pattern is found user 1 patternlist is the list of patterns separated by spaces openFT V12 0 openFT Script Interface 99 transferFile openFT Script statements Example lt xml version 1 0 encoding UTF 8 gt lt ftscript version 1 gt lt context gt list id FileList gt file name bin mp3 gt lt file name text txt gt lt list gt list id HostList gt partner name UnixP_1 gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADM1 gt lt transferAdmission gt lt partner gt partner name WindowsP_1 gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADM2 gt lt transferAdmission gt lt partner gt lt list gt lt context gt foreach listRef HostList selectType partner contextObject host gt lt foreach listRef FileList selectType file contextObject file gt lt transferFile gt fromLocalFile ref file gt dir
52. case is executed if the current error code is found in its list of error codes The case activity replaces the activity in which the faulthandler is located The context objects of the replaced activity are copied to the context of the case activity if still present The contexts of the child activities including those in which the error occurred are no longer accessible For information on execution see section sequence on page 90 Format case code codelist gt comment context Activity lt case gt Attributes Name Value Meaning code codelist A list of error codes for which this case activity is to be executed The individual error codes are separated from one another by spaces Here you can use normal Ftscript error codes See page 23 and severe Ftscript error codes see page 24 or a user defined error code that you create with the fault activity 70 openFT V12 0 openFT Script Interface openFT Script statements faulthandler default If the current error code is not found in any of the case elements then the default activity is executed This applies to all error codes with the exception of the severe Ftscript error codes see section Severe Ftscript error codes on page 24 for which the default branch of the faulthandler is ignored The default activity replaces the activity in which the faulthandler is located The context objects of the
53. ccurred 24 openFT V12 0 openFT Script Interface Structure of an Ftscript Error handling 2 3 3 Restart Ftscripts can generally be restarted if for example they have been aborted due to a system crash Restrictions apply only to the following activities executeScript if repeatable no was specified createDirectory if faultIfExists was specified deleteFile or deleteDirectory if faultIfNotExists was specified If the openFT Script request is aborted during the processing of the statement then it is not possible to determine whether the activity has been completed In the above cases it is not clear when the restart is performed how the Ftscript should continue to run If for example a directory that was to be created already exists then it is not possible to determine whether it was created by the aborted createDirectory activity or whether it already existed before the openFT Script request was run If the restart operation encounters this type of ambiguous situation then it reacts as follows Activity Response on restart executeScript Activity aborted with the error ft resumeForbidden with the attribute repeatable no createDirectory If the directory already exists then activity aborted with the with the attribute faultIfExists error ft recoveryCreateDirectory deleteFileordeleteDirectory Ifthe file does not or no longer exist s then the activity is with the attribute fault I fNotExists
54. ct and the ref lt contextID gt resolution is not yet known because it has not yet been passed through 44 openFT V12 0 openFT Script Interface openFT Script Commands ftshwact Activity ActivityObject Meaning createDir cont lt directory name gt if the directory is local In this case as for sendFile the name for already started requests is determined from the FT request and for requests which have not yet been started from the specifications in the XML file A local file name would be output as an absolute file name in the case of a started request and as a relative path name in the case of an as yet unstarted request deleteDir as createDir listDir as createDir execScript 32 characters Contains the first 32 characters of the command that is to be executed For security reasons the user should make sure that the first 32 characters do not contain any confi dential parameters fault lt faultcode gt Error code specified by the user faulthdl lt triggering activity id gt lt special faultcode gt lt general faultcode gt openFT V12 0 openFT Script Interface 45 ftshwact openFT Script Commands Output in CSV format Id State Activity ActivityObject Partner AddInfo nrElements StartTime Error The output contains the following information Id See table format on page 42
55. d error code and continue execution in the corresponding faulthandler The faulth andler of the parent activity is processed first The error is intercepted with the appropriate faulthandler default or case see section fault handler on page 68 The activity associated with the faulthandler is executed All file transfer requests that were started by the parent activity and are still running are also cancelled ft cancel This may result in the execution of the remoteFailureScript see section remoteFailureScript on page 108 If itis not possible to assign a faulthandler to the error code then the entire script is aborted Restrictions The error code must not start with ft These error codes are reserved for openFT Script Format fault code faultcode gt comment fault Attributes Name Value Meaning code Text The error code which can be intercepted in a faulthandler openFT V12 0 openFT Script Interface 65 fault openFT Script statements Example lt xml version 1 0 encoding UTF 8 gt lt ftscript version 1 gt parallel context partner id remote name UnixP 1 lt transferAdmission gt ftacAdmission ftacAdmission FTACADMI lt transferAdmission gt lt partner gt lt faulthandler gt case code intercept gt lt deleteFile name targetl bin gt partner ref remote gt directory name frg_eis_O8NotAvailable gt
56. d to start openFT requests in Windows or Unix systems and for example transfer files to or from other systems A knowledge of Windows and Unix based operating systems as well as an understanding of XML would be useful when reading this manual The manual applies to Windows systems Solaris systems and to portings to other Unix platforms The operating system dependent differences are described in detail in the Release Notice which is supplied with each product CD openFT V12 0 openFT Script Interface 7 Concept of openFT manuals Preface 1 2 Concept of openFT manuals for Unix and Windows systems The complete description of openFT and its components comprises a number of different manuals Alongside the present manual there are also other openFT manuals for Unix systems and Windows systems This description is distributed across the manuals as follows e for Unix systems Installation and Administration The system administrator manual is intended for FT FTAC and ADM administrators It describes the installation of openFT and its optional components the operation control and monitoring of the FT system and the FTAC environment the administration commands for FT and FTAC administrators the configuration and operation of a remote administration server and a ADM trap server important CMX commands e openFT for Windows systems Installation and Administration The system administrator manual is intended for
57. e ft cantCreate A further example of createDirectory can be found in section foreach on page 73 56 openFT V12 0 openFT Script Interface openFT Script statements deleteDirectory 4 6 deleteDirectory You use deleteDirectory to delete a directory If you do not specify a partner then the directory is deleted under the local user ID You use baseDir to specify a base directory see section directory on page 61 under which the directory that is to be deleted is to be searched for The base directory name and the name specified with the dirnames attribute are combined to form the directory name 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 i You should note the response on a restart see section Restart on page 25 Restrictions The directory that is to be deleted must be empty Format deleteDirectory ref ID faultIfNotExists yes no dirnames gt comment context partner baseDir lt deleteDirectory gt Attributes Name Value Meaning ref string Reference to a directory context object faultIfNotExists yes The default value is If the directory does not exist then deleteDirectory is terminated without error If yes is specified then deleteDirectory is termi nated with the error
58. e use of the statement 4 1 Syntax of the openFT Script statements The openFT Script statements are described in the following sections The syntax of the openFT Script statements is specified in the Format section in the description of each statement The following symbols are used Symbol Meaning a No element or an element a Optional attributes are also indicated by a a No element or any number of elements a One element a or multiple elements a Either Either exactly one element a or one or more elements b The current element with its attributes is presented in angle brackets Elements can be combined to form an activity Such combined elements are printed without the angle brackets openFT V12 0 openFT Script Interface 51 baseDir openFT Script statements 4 2 baseDir You use baseDir to define a base directory for the following openFT Script statements createDirectory The directory which you create with createDirectory is set up under the base directory see section createDirectory on page 55 deleteDirectory The directory which you delete with deleteDirectory is deleted under the base directory see section deleteDirectory on page 57 deleteFile The file which you delete with deleteFile is deleted under the base directory see section deleteFile on page 59 listDirectory The files or directories under the base directory are
59. eads see section parallel on page 82 Notational conventions The following notational conventions are used throughout this manual typewriter font typewriter font is used to identify entries and examples italics In running text commands statements names variables and values are indicated by italic letters e g file names and host names i indicates notes Additional conventions are used for the command descriptions and the program interface 10 openFT V12 0 openFT Script Interface Preface README files 1 5 README files Information on any functional changes and additions to the current product version can be found in product specific README files 1 6 Requirements for openFT Script openFT Script is supplied with openFT and requires an openFT version as of V10 to be installed on the executing host All the addressed partners must use an FTAM openFT compatible product for file transfer If openFT is not used then the restrictions described in the openFT manual apply At least J2SE Runtime Environment 5 0 JRE 5 0 is required for the Java runtime environment On Windows systems the extended language version of Java JRE support of non European languages Extended Encoding Set is also required This does not have to be explicitly installed if Java JDK or Java 1 6 or higher is installed openFT V12 0 openFT Script Interface 11 Requirements for openFT Script Preface 12 openFT V12
60. ectory name W openFT ftscript Test data smal1 gt lt autoDataSpec charPattern txt userPattern tab dat default bin gt lt fromLocalFile gt toRemoteFile ref file gt partner ref host gt directory name frg_eis_17 gt toRemoteFile lt transferFile gt lt foreach gt lt foreach gt lt ftscript gt In the example the file list FileList of local files is transferred to all the computers in the HostList The file transfer modes are activated in accordance with the autoDataSpec specifi cation txt files are converted in accordance with the target system type All unknown file types are transferred in binary form tab and dat are defined for user transfers 100 openFT V12 0 openFT Script Interface openFT Script statements transferFile fromLocalFile You use fromLocalFile to specify the local source file for file transfer The transfer type data type can be derived from the file name by means of autoDataSpec see section autoDataSpec on page 98 File names may be a maximum of 512 characters in length This is checked before the Ftscript is run The length of the resulting file name directory and filenames is limited by the operating system in question and the openFT version The length is the number of characters plus 1 character if directory does not end with a The check is performed while the Ftscript is being run For further informati
61. ed openFT V12 0 openFT Script Interface 93 transferFile openFT Script statements Examples 1 File transfer with remoteSuccessScript remoteFailureScript lt xml version 1 0 encoding UTF 8 gt lt ftscript version 1 gt lt context gt lt script id everything unixScript LCDATALecho everything ok frg eis 15 status txt l lt unixScript gt lt windowsScript gt lt LCDATALcmd c echo everything ok gt frg_eis_15 status txtlJ gt lt windowsScript gt lt script gt lt script id something failed gt lt unixScript gt lt CCDATALecho something failed frg eis 15 status txtll lt unixScript gt lt windowsScript gt ILCDATALcmd c echo something failed frg eis 15WNstatus txt l lt windowsScript gt lt script gt partner id remote name UnixP 1 systemType unix gt lt transferAdmission gt lt ftacAdmission ftacAdmission FTACADM1 gt lt transferAdmission gt lt partner gt lt context gt lt sequence gt lt context gt lt faulthandler gt lt default gt lt executeScript ref something failed gt lt default gt lt faulthandler gt lt context gt lt transferFile gt fromRemoteFile name bin mp3 gt lt partner ref remote gt lt directory name frg_eis_15 gt lt fromRemoteFile gt lt toLocalFile name bin mp3 gt lt directory name frg_eis_15 gt lt toLocalFile gt lt remoteSuccessScript ref everything ok
62. ee section faulthandler on page 68 or executeScript see section executeScript on page 63 For an example see page 97 Types of file transfer You use transferFile to transfer files as follows e File transfers from remote to local fromRemoteFile toLocalFile e File transfers from local to remote fromLocalFile toRemoteFile e File transfers from remote to remote can be accomplished by means of two sequential transferFile activities e g in a sequence activity File transfer from remote to localTmp fromRemoteFile toLocalTmpFile File transfer from localTmp to remote fromLocalTmpFile toRemoteFile Restrictions 1 After de referencing fromRemoteFile and toRemoteFile must possess a partner specifi cation 2 The elements fromLocalFile and toLocalFile must not possess any partner specification after de referencing 3 You cannot use rransferFile to perform any file transfers from local to local To perform file transfers from local to local you must use a corresponding 1 script or specify one of the two files as remote and specify the local computer as the partner specify rransferAdmission 92 openFT V12 0 openFT Script Interface openFT Script statements transferFile Format comment context fromRemoteFile toLocalFile fromLocalFile toRemoteFile fromRemoteFile toLocalTmpFile fromLocalTmpFile toRemoteFile remoteSuccessScr
63. ements of each element in the selected list as a sequence You can specify whether the sequences are executed one after the other in the same order as the list elements or in parallel Format foreach listRef ID contextObject ID execute parallel sequential selectType file partner directory direction forward reverse comment context Activity lt foreach Attributes Name Value Meaning listRef string Name of a valid context object of type list contextObject string Name of the foreach context object which takes on the value of the current list element This must not be defined in the foreach context It is defined implicitly The type of context object corresponds to the type set in the selectType attribute execute parallell The default value is sequential sequential The sequences are executed one after the other If parallel is specified then the sequences are started in parallel selectType partner Filters the elements of the specified type from the list filel Only the filtered elements are iterated directory direction forward The default value is forward reverse The list is worked through forwards If reverse is specified then the list is worked through backwards openFT V12 0 openFT Script Interface 7 foreach openFT Script statements Examples 1 Distributing files lt xml version 1 0 encoding UTF 8 gt lt ftscript vers
64. es These are specified in the attributes name bs2000Name unixName windowsName and zosName lf no special character istics are defined then the following definition applies If a partner is specified then its operating system must also be explicitly specified openFT Script itself determines the operating system of the local computer Rules for file name and directory name attributes e An operating system specific file name or directory name attribute bs2000Name unixName windowsName oder zosName is only evaluated if it does not contain an empty string and if the specified or determined operating system has this type e f no matching operating system specific file name attribute is found or it is specified as an empty string then the non operating system specific file name attribute name applies Please note that the default value for name is the empty string e f you use a profile in which a file name or a directory name is defined as the transfer admission see the openFT User Manual then the easiest way is to omit all file name or directory name attributes This way the empty string is used default value of the non operating system specific attribute see above Alternative Enter an empty string for all relevant operating system specific file name or directory name attributes You can then omit the non operating system specific attribute or specify it as an empty string openFT V12 0 openFT Script Interface 19 Speci
65. est ID Remote system Invalid file password ft code2161 ft cantDelete Request request ID Remote system The file s retention period has not yet expired ft code2162 ft auth Request request ID Remote system File directory remote file gt is write protected ft code2163 ft remoteFile Request request ID Structure Remote system File structure not supported ft code2164 ft syntax Request request ID Remote system Syntax error in resulting file name ft code2165 ft notSupported Request request ID Remote system Transparent file transfer not supported ft code2166 ft notSupported Request request ID Remote system Not possible to extend the file during transparent transfer ft code2167 ft auth Request request ID Remote system Access to remote file gt prohibited ft code2168 ft paramTooLong Request request ID Remote system Follow up processing too long ft code2169 ft auth Request request ID Remote system Transfer admission invalid ft code2170 ft notSupported Request request ID Remote system Function not supported ft code2195 ft admin Request request ID Remote system openFT is no longer authorized to process requests for this user openFT V12 0 openFT Script Interface 121 Error messages Internal code Error code Descri
66. face 59 deleteFile openFT Script statements Example lt xml version 1 0 encoding UTF 8 lt ftscript version 1 gt lt deleteFile name hugo trash gt partner name UnixP 1 systemType unix lt transferAdmission gt ftacAdmission ftacAdmission FTACADM1 gt lt transferAdmission gt lt partner gt lt directory name frg_eis_05 gt lt deleteFile gt lt ftscript gt Deletes the file hugo trash for the FTAC transfer admission FTACADMI in the directory frg eis 05 on the computer UnixP 1 Errors are not handled in this example and result in the Ftscript being deleted 60 openFT V12 0 openFT Script Interface openFT Script statements directory 4 8 directory You use directory to define a directory path directory is always a child element of an Ftscript activity If a remote directory is intended specify the partner as a further subelement of the activity Format directory id ID ref ref dirnames gt comment lt directory gt Attributes Name Value Meaning id string A unique ID in the current context The context object is referenced under this ID ref string Name of the directory context object Data which is not present here is taken over from the directory context object after de referencing dirnames See section Directory name attributes on page 21 openFT V12 0 openFT Script Interface 61 empt
67. ft error Resume not possible ft resumeUnloggedTransfer ft resource More than one file transfer open ft rformillegal ft error Incorrect specification for RecordFormat Defective schema Ft rformOutOfRange ft error Incorrect specification for RecordFormat ftAPI version incorrect ft schemaConflict ft error Unknown activity schema defective ft schemaNotFound ft resource Schema file ftscript xsd not installed ft scriptElementUnknown ft error The schema and Ftscript do not match There is no such script ft scriptldNotGiven ft error Script ID not specified ft scriptinfoFileCantCreate ft resource Script information cannot be generated ft scriptinfoFileCantWrite ft resource Script information cannot be written ft scriptinfoFileCantWrite2 ft resource Script information cannot be generated openFT V12 0 openFT Script Interface 133 Error messages Internal code Error code Description ft serverSignalCommand ft error Error in request acceptance by server process ft sessionNotFound ft resource No valid openFT session found ft signalingFailed ft resource Signalling to port failed Execution later ft socketClose ft resource Socket cannot be closed ft stateUnknown ft resource Unknown status ft statusCantRead ft resource Status cannot be read Request cannot be executed
68. ftacAdmission FTACADM2 gt lt transferAdmission gt lt partner gt lt context gt lt transferFile gt fromRemoteFile name data txt gt partner ref remotel gt directory name frg_eis_16 gt lt autoDataSpec charPattern txt binPattern dat mp3 gt lt fromRemoteFi le gt lt toLocalTmpFile id tmp gt lt transferFile gt lt transferFile gt lt fromLocalTmpFile use tmp gt lt toRemoteFile name data txt gt partner ref remote2 gt directory name frg_eis_16 gt lt toRemoteFile gt lt transferFile gt lt ftscript gt In the example the file data txt is first copied from the partner remote to a temporary file The temporary file is given an internal name The suffix of the temporary file corresponds to the suffix of the associated fromRemoteFile here txt Conversion is performed using autoDataSpec charPattern for character symbols because the filename suffix corresponds to the pattern txt see section autoDataSpec on page 98 If the local system is a Windows system then the line ends are converted accordingly When the temporary file is transferred to the remote system remote2 the autoDataSpec settings made when the temporary file was created are taken over They are inherited as well as maxRecSize and the data properties of the fromRemoteFile element If the local system is a Windows system then the data is not converted on the second t
69. fying file and directory names Structure of an Ftscript 2 2 1 File name attributes If a file name starts with the pipe character I then this has the special meaning of a generating fromLocalFile fromRemoteFile or receiving toLocalFile toRemoteFile program call see the openFT user manual Restriction File names can be a maximum of 512 characters long This restriction is checked at the time the openFT Script request is issued static check Depending on the operating system the number of permitted characters may be less see the openFT User Manual This operating system specific length is not checked until the Ftscript is run dynamic check Please note the section Rules for file name and directory name attributes on page 19 Name Value Meaning name string File name with specification of the subpath see openFT user manual name is used if no operating system is known or no operating system specific name has been specified The default value is an empty string If name is not specified and the profile partner ftac is linked to a fixed file name then this applies Only the character may be used as a separator e g C x y in Unix systems or C x y in Windows systems bs2000Name string File name for BS2000 The name is used if it has been specified and the associated partner is a BS2000 system window sName string File name for Windows The name
70. fying openFT Script user options 34 3 5 ftshwsuo Displaying openFT Script user options 36 3 6 ftscript Starting an openFT Script request 38 3 7 ftshwact Displaying the activity associated with an openFT Script request 40 Description of the output lt a gt s oon oe om oom oko e mo m 9 y mom kom ox 42 3 8 ftshws Displaying openFT Script 51 47 4 openFT Script statements 51 44 Syntax of the openFT Script 51 4 2 A C OEE 52 4 3 nga c Ge GS 53 4 4 COMORE 2 5a 909 ee Wea Scat 54 4 5 c eateDireclory x9 Pe RR X E ROUX RO REE RN 55 4 6 JONED o Rp Rw OE a soe I WEE 57 4 7 del leFil amp REOR RO RO RR 59 4 8 2 5 sos deam gus Sood Sees es RR CN RR ar ce dica Bow 61 4 9 BINDIU do Ee Un Fe i ee ode e ecd 62 4 10 uu oso cae wae Gee RES Se eee Ue X OR UE axe 63 4 11 TOMI Se boas uo X d Udo e 65 4 12 uus
71. gt remoteFailureScript ref something failed gt lt transferFile 94 openFT V12 0 openFT Script Interface openFT Script statements transferFile Example I cont executeScript ref everything ok gt lt sequence gt lt transferFile writeMode extend gt fromRemoteFile name status txt data char partner ref remote directory name frg eis 15 lt fromRemoteFile gt toLocalFile name 2 status txt directory name frg eis 15 lt toLocalFile gt lt transferFile gt lt ftscript gt The file bin mp3 is transferred from the partner remote to the local file bin mp3 The file status txt is then created with the following contents if transfer is OK everything ok everything ok if an error occurs something failed something failed If errors occur during the compilation of the file status txt then the script is aborted openFT V12 0 openFT Script Interface 95 transferFile openFT Script statements 2 File transfer from remote to remote lt xml version 1 0 encoding UTF 8 gt lt ftscript version 1 gt lt context gt partner id remotel name UnixP_1 gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADM1 gt lt transferAdmission gt lt partner gt partner id remote2 name WindowsP_1 gt lt transferAdmission gt ftacAdmission
72. h Request request ID Remote system File password no longer valid ft code2209 ft auth Request request ID Remote system File directory remote file gt is now write protected 122 openFT V12 0 openFT Script Interface Error messages Internal code Error code Description ft code2210 ft remoteFile Structure Request request ID Remote system File structure error ft code2211 ft error Request request ID Remote system error 2 ft code2212 ft recoveryFailed Request request ID Remote system Recovery failed ft code2213 ft resource Request request ID Remote system Resource bottleneck ft code2214 ft auth Request request ID Remote system Access to remote file gt is no longer permitted ft code2215 ft error Request request ID FTAM error 2 ft code2216 ft remoteFile Structure Request request ID Remote system File structure not supported ft code2217 ft cantDelete Request request ID Remote system The file s retention period has not yet expired ft code2218 ft notSupported Request request ID Remote system Not possible to extend the file during transparent transfer ft code2226 ft error Inconsistent monitor file contents ft code2227 ft error Monitor file not used by openFT ft
73. hat are a level below the activity with the activity ID specified as the chapter In the above example these are c 1 1 2 and 1 3 for c 1 2 1 2 1 1 1 2 1 2 1 2 2 1 and 1 2 2 2 st W R T F K D C Display activities with the specified status You can specify multiple statuses one after the other e g st WRT Activity 1 is always output since it displays the execution status of the entire script u user ID User ID under which the specified request is searched for Only FT administrators may input a user ID The default value is the calling party s user ID ftscriptid Identification of the openFT Script request This is output if the openFT Script request is started via an ftscript command You must specify precisely one openFT Script request Wildcard syntax is not sup ported Return code 0 OK 4 Syntax error 51 Error while outputting an Ftscript user 53 Ftscript section not found 54 Ftscript ID not found 250 Internal error openFT V12 0 openFT Script Interface 41 ftshwact openFT Script Commands Description of the output Output is possible in tabular form and in CSV format It should be noted that for activities which have not yet been started the output from the ftshwact command is usually incomplete since the references present in the request have not yet been resolved and it is not therefore possible to enter all the desired output values In particular file and directory names
74. he openFT Script request that is to be deleted is performed Only FT administrators may input a user ID The default value is the calling party s user ID 32 openFT V12 0 openFT Script Interface openFT Script Commands ftdels ftscriptid Identification of the openFT Script request This is output when the openFT Script request is started via an ftscript command You can use the wildcard symbols and in der ftscriptid This deletes all openFT Script requests that match the wildcard pattern is interpreted as any single character is interpreted as any number of characters If you use wildcards enclose the ftscriptid specification in single quotes so that the wildcard symbols are not interpreted by the shell means that all the user s openFT Script completed requests are to be deleted Return code 0 4 51 54 56 250 OK Syntax error Error while outputting an Ftscript user Ftscript ID not found openFT Script has not completed Internal error openFT V12 0 openFT Script Interface 33 ftmodsuo openFT Script Commands 3 4 ftmodsuo Modifying openFT Script user options As of openFT V12 users are able to specify where their openFT Script requests are to be stored openFT Script creates the subdirectory openFT lt instance gt script or openFT lt in stance gt script in the specified working directory and stores openFT Script requests in it The user in question then has write
75. iled ft resource Directory could not be created or not a directory ft createDirectorySecurity ft access Directory could not be created ft createNoFilename ft paramError No name specified on generation of a directory openFT V12 0 openFT Script Interface 125 Error messages Internal code Error code Description ft createParamError ft error Parameter error on creation of a directory ft deleteFailed ft error Local file local directory could not be deleted ft deleteNoFilename ft paramError No directory or file name was specified for deletion ft deleteOrderQueue ft resource Order queue could not be deleted ft deleteParamError ft error Parameter error on deletion ft deleteParents ft error Directory will not be deleted ft deleteSelf ft error Directory will not be deleted ft delparError ft error Error in the internal delete parameters ft directionModeOutOfRange ft error Incorrect specification for direction ftAPI version ft directoryElementUnknown ft error Schema and Ftscript do not match There is no such directory element ft doubleContextObject ft error Context object initialized more than once ft doubleLocalTmpFileRef ft reference ID for local temporary file already assigned in this context ft emptyEventQueue ft error Internal error Empty queue ft emptyParallelQueue ft error Internal error Empty queue f
76. in reference specifications are not fixed until runtime since they may be dependent on the operating system Output in table format The processing level of the activities is displayed in four columns Id Sta Unique identification of the activity within the request This can be converted into an Xpath which mirrors the position of the activity in the tree which is statically predefined by the XML script Dynamic information is simply added for the foreach nodes sequence number in the foreach loop For more detailed information see the description of the XML statements for the openFT Script interface Status of the statement The following status identifiers are possible W waiting activity has not yet been started R running activity has been started but has not yet been terminated T terminated The activity has been terminated without errors F failure The activity has been terminated with an error K killed The activity was cancelled by means of a faulthandler or an ftcans command D dead The activity no longer starts due to a previous error In the case of the ftscript activity first activity in an openFT Script request distinction is made between the following statuses interrupted The request was interrupted e g due to a system crash C cancelled The request was cancelled with ftcans X cancelling The request is currently being cancelled due to an ftcans command F fail
77. in the referenced element are taken over Before being taken over the referenced element is de referenced on the basis of these rules 16 openFT V12 0 openFT Script Interface Structure of an Ftscript Components of an Ftscript Examples 1 Valid referencing lt xml version 1 0 encoding UTF 8 gt ftscript version 1 gt lt context gt partner id remote name WindowsP_1 gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADM gt lt transferAdmission gt lt partner gt file id pack name packl bin gt partner ref remote directory name frg eis 01 lt file gt lt context gt lt transferFile gt lt fromRemoteFile ref pack gt lt toLocalFile name packl bin gt directory name frg eis 01 toLocalFile lt transferFile gt lt transferFile gt lt context gt partner id remote name UnixP_1 gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADM gt lt transferAdmission gt lt partner gt lt context gt lt fromRemoteFile ref pack gt partner ref remote gt lt fromRemoteFile gt lt toLocalFile name pack2 bin gt directory name frg eis 01 toLocalFile lt transferFile gt lt ftscript gt The file object with the ID pack references a partner object with ID remote The partner WindowsP 1 is used in the first transferFile activity The same file object pack i
78. in the target system If you do not specify a partner then the script is executed on the local system under the user ID of the user who called the Ftscript The following command interpreters are used Operating system Command interpreter Windows System call i e an executable file with the specified name is searched for E g to execute a shell command enter cmd c Unix system bin sh c z OS TSO BS2000 SDF Restrictions 1 A script e g bs2000Script unixScript may only occupy one line and is limited to 500 characters in length 2 You must specify a script which is not empty for the addressed operating system Format executeScript ref ID repeatable true false gt comment context script bs2000Script unixScript windowsScript zosScript partner lt executeScript gt openFT V12 0 openFT Script Interface 63 executeScript openFT Script statements Attributes Name Value Meaning ref string Reference to a script context object If false is specified script has been fully processed Restart on page 25 repeatable truel false default value is true The script may be repeated on a restart The script may not be repeated on a restart On a restart the executeScript activity is aborted with the error code ft resumeForbidden if it is not possible to determine whether this It is only possible to switch the
79. ion 1 gt lt context gt list id FileList gt file name bin mp3 gt file name text txt gt lt list gt list id HostList gt partner name UnixP_1 systemType unix gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADMI1 gt lt transferAdmission gt lt partner gt partner name WindowsP 1 systemType windows gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADM2 gt lt transferAdmission gt lt partner gt lt list gt lt context gt lt foreach listRef HostList selectType partner contextObject partner execute parallel gt lt foreach listRef FileList selectType file contextObject file execute parallel gt lt transferFile gt fromLocalFile ref file gt lt fromLocalFile gt toRemoteFile ref file gt partner ref partner gt lt directory name frg_eis_09 gt lt toRemoteFi le gt lt transferFile gt lt foreach gt lt foreach gt lt ftscript gt directory name W openFT ftscript Test data large gt autoDataSpec binPattern mp3 charPattern txt gt The files bin mp3 and text txt are copied to two computers In the example the lists of files and computers are defined as context objects The file list can also be defined for example by means of a listDirectory see section listDirectory on page 79 A double foreach sequence is used The external sequence works through all
80. ipt remoteFailureScript lt transferFile gt lt transferFile compress none byteRep zip writeMode replace new extend transparentMode dataEncryption yes no onlyDataIntegrity true false Attributes Name Value Meaning compress nonelbyteReplzip The default value is none The file is not compressed If byteRep is specified then identical sequences of characters are compressed If zip is specified then zip compression is used writeMode replace The default value is replace If the file exists then it is extend overwritten If the file does not exist it is created If extend is specified then the data is appended to the existing file If the file does not exist it is created If new is specified then a new file is created If a file with this name already exists then the activity is cancelled with the error ft exist transparentMode true false The default value is false The file is transferred as standard If true is specified then a transparent transfer is performed e g in the case of transfers from a BS2000 system to another BS2000 system via a Windows Unix system dataEncryption yes onlyDatalIntegrity The default value is no The user data is not encrypted If yes is specified then the user data is encrypted for settings see the openFT user manual If onlyDatalntegrity is specified then only the data integrity is check
81. ipt version 1 gt lt context gt list id RemoteHostList gt partner name UnixP_1 gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADM1 gt transferAdmission gt lt lt partner gt partner name WindowsP 1 lt transferAdmission gt ftacAdmission ftacAdmission FTACADM2 gt transferAdmission gt lt lt partner gt lt list gt lt context gt lt listDirectory listObject FileList gt lt baseDir name W openFT ftscript Test mul ti gt lt listDirectory gt lt foreach 11 lt foreach lt trans fromLocalFi di stRef RemoteHostList selectType partner contextObject RemoteHost execute parallel gt listRef FileList selectType file contextObject File execute parallel gt erFile gt lt fromLocalFile gt toRemoteFile ref File gt lt partner ref RemoteHost gt lt di rectory name frg_eis_12 local bin gt toRemoteFile lt transferFile gt lt foreach gt lt foreach gt lt ftscript gt e ref File rectory name W openFT ftscript Test multi 80 openFT V12 0 openFT Script Interface openFT Script statements listDirectory In the example all the files from the local directory W openFT ftscript Test multi are written to the context object FileList The list only contains the file names not the baseDir directory The files are distributed in
82. is 11 toLocalFile lt transferFile gt lt foreach gt lt ftscript gt In the directory frg eis 11 on the computer UnixP 1 the file tree is copied to the directory frg eis 11 under the local ID In the first foreach sequence all the necessary directories are copied sequentially using createDirectory listDirectory returns the directories a a b and a b c in sequence for the directory frg eis 11 a b c frg eis 11 is itself defined as the base directory with baseDir A directory cannot be created unless the parent directory exists In the second foreach sequence the files are copied in parallel since all the target directories are now present openFT V12 0 openFT Script Interface 75 foreach openFT Script statements 3 Deleting a file tree lt xml version 1 0 encoding UTF 8 gt lt ftscript version 1 gt lt context gt partner id remote name UnixP_1 gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADM1 gt lt transferAdmission gt lt partner gt lt context gt listDirectory name frg_eis_10 listObject Flist gt partner ref remote gt lt listDirectory gt lt foreach listRef Flist selectType file contextObject delFile execute parallel gt lt deleteFile ref delFile gt partner ref remote gt lt deleteFile gt lt foreach gt lt foreach listRef Flist selectType directory contextObject delDir exec
83. is used if it has been specified and the associated partner or the associated local system is a Windows system You can use the notation or the Windows specific notation unixName string File name for Unix system The name is used if it has been specified and the associated partner or the associated local system is a Unix system You may only use the notation zosName string File name for z OS The name is used if it has been specified and the associated partner is a 2 05 system 20 openFT V12 0 openFT Script Interface Structure of an Ftscript Specifying file and directory names 2 2 2 Directory name attributes Restriction Directory names can be a maximum of 512 characters long This restriction is checked at the time the openFT Script request is issued static check Depending on the operating system the number of permitted characters may be less see the openFT User Manual This operating system specific length is not checked until the Ftscript is run dy namic check Name Value Meaning name string Directory name name is used if no operating system is known or no operating system specific name has been specified The default value is an empty string If name is not specified and the profile partner ftac is linked to a fixed directory name then this applies Only the character may be used as a separator bs2000Name stri
84. ite persistent ListDirectory data ft_listElementUnknown ft_error The schema and Ftscript do not match There is no such element in a list ft listenerCantClose ft resource Listener could not be terminated ft lockNotReadable ft resource Interpreter process not accessible ft logfileCantCreate ft resource Log file could not be created No logfile no replay ft logfileCantRead ft resource Log file cannot be read Replay not possible ft logfileError ft resource Log file could not be created No logfile no replay ft logfilelnvalid ft resource Invalid log file ft logfileloError ft resource IO error for log file openFT V12 0 openFT Script Interface 131 Error messages Internal code Error code Description ft logfileNoSuchFile ft resource Log file could not be found ft logFileNotFound ft resource Log file could not be found ft logfileNotReadable ft resource Log file cannot be read Replay not possible ft logfileWrongVersion ft error Incorrect version of the log file This request cannot be restarted ft loggerCantClose ft resource Logger could not be terminated ft logWrapperCantCreate ft resource Log file wrapper could not be created ft logWrapperCantFind ft resource Log file wrapper could not be found ft logWrapperCantWrite ft resource Log file wrapper could not be written ft mainLockError ft resource Main lock c
85. lt deleteFile gt deleteFile name target2 bin gt partner ref remote gt lt directory name frg_eis_08 gt lt deleteFile gt lt case gt lt faulthandler gt lt context gt lt transferFile gt lt context gt lt faulthandler gt lt default gt lt fault code intercept gt lt default gt lt faulthandler gt lt context gt lt fromLocalFile name W openFT ftscript Test data small bin mp3 toRemoteFile name targetl bin gt partner ref remote directory name frg eis 08NotAvailable lt toRemoteFile gt lt transferFile gt 66 openFT V12 0 openFT Script Interface openFT Script statements fault Example cont transfer contex faul de fau toRemo lt parallel gt lt ftscript gt lt context gt lt fromLocalFile name W openFT ftscript Test data large bin mp3 gt File gt t gt thandler gt fault fault code intercept gt default thandler gt teFile name target2 bin gt partner ref remote gt directory name frg_eis_08 gt lt toRemoteFile gt lt transferFile gt Two file transfers are performed in parallel If an error occurs during one of the transfers then this is indicated by the error code intercept This is intercepted in the faulthandler The other file transfer is cancelled ft_cancel The two target files are deleted in the faulthandler
86. lt ID of the activity d lt Level depth 1 c lt Chapter gt st W ITRTI TTFI KTI D C u lt user ID 1 32 gt lt ftscriptid gt Format for Windows systems ftshwact h csv a lt ID of the activity gt d lt Level depth 1 gt c lt Chapter gt st W I R I TIIEF I K I D I C 1 u lt user ID 1 36 gt lt ftscriptid gt Description h Outputs the command syntax on screen Any specifications after are ignored csv The information is output in CSV format If you do not specify csv then the infor mation is output in table format 10 of the activity Only the specified activity is displayed You may also indicate a specific instruction in a request An activity s ID can be determined using a preceding ftshwact command without the a option This means that you can view the status of the activity later 40 openFT V12 0 openFT Script Interface openFT Script Commands ftshwact d Level depth Depth of the levels to be displayed All activities whose activity ID is not greater than the specified level number are displayed The level number is the number of index numbers separated by dots Examples from a request with activity IDs 1 1 2 1 2 1 1 1 2 1 2 1 2 2 1 1 2 2 2 and1 3 the option d 2 selects the activities with the activity IDs 1 1 2 and 1 3 c Chapter Chapter corresponding to the activities to be displayed Those activities are output t
87. ng BS2000 specific addressing see openFT User Guide window sName string Windows specific path The name is used if it has been specified and the associated partner or the associated local system is a Windows system You can use the notation or the Windows specific notation unixName string Unix system specific path The name is used if it has been specified and the associated partner or the associated local system is a Unix system You may only use the notation zosName string z OS specific addressing see openFT User Guide openFT V12 0 openFT Script Interface 21 Error handling Structure of an Ftscript 2 3 Error handling The Ftscript is checked when it is read If errors are identified then the Ftscript is not run When the Ftscript is started you see a corresponding error message and a return code see section ftscript Starting an openFT Script request on page 38 If the check is completed successfully then the Ftscript is executed asynchronously If an error occurs during execution then the cause of the error is logged Every error message has a unique internal code and is assigned to a specific error code The errors are assigned to one of the following two categories on the basis of the error codes normal Ftscript error codes severe Ftscript error codes The table listing all these error messages can be found in chapter Error mes
88. nts faulthandler Example lt xml version 1 0 encoding UTF 8 lt ftscript version 1 gt lt context gt partner id RemotePartner name D018S011 gt lt transferAdmission gt ftacAdmission ftacAdmission pl1111111 gt lt transferAdmission gt lt partner gt lt context gt lt transferFile gt lt context gt lt file id source name source bin gt lt file id target name target bin gt partner ref RemotePartner gt lt file gt lt faulthandler gt lt default gt lt transferFile gt lt context gt lt partner id RemotePartner name D018S022 gt lt transferAdmission gt lt ftacAdmission ftacAdmission p2222222 gt lt transferAdmission gt lt partner gt lt context gt lt fromLocalFile ref source gt toRemoteFile ref target gt lt transferFile gt lt default gt lt faulthandler gt lt context gt fromLocalFile ref source gt toRemoteFile ref target gt lt transferFile gt lt ftscript gt In this example the local file source bin is to be copied to D018S01 I aget bin If an implicit error occurs in transferFile then the file is copied to D018S022 target bin This overlays the context object with the Id Remote Partner f another error occurs during this activity then the Ftscript is cancelled openFT V12 0 openFT Script Interface faulthandler openFT Script statements case The activity described in
89. on ft code802 ft error Request request ID Warning Inconsistent monitor lt 2 gt contents ft code803 ft error Request request ID Follow up processing could not be started ft code804 ft error Request request ID Inconsistent request data ft code850 ft error Internal error Monitor file not accessible ft code851 ft error Internal error ft code852 ft error Internal error Set instance lt 1 gt incom patible ft code853 ft error Reloading error Error code 1 ft code854 ft error No longer possible to write logging records Process terminated ft code855 ft error No further storage space for internal files ft code856 ft error Error on OPS output ft code857 ft error Error in key file lt 1 gt ft code858 ft error Internal error Not possible to set reset file locks ft code859 ft error Function not supported due to teleservice restrictions ft code860 ft error Teleservice restriction for FTAC due to FT ft code861 ft error Teleservice restriction for 1 ft code862 ft error Protocol stack 1 not installed ft code999 ft error openFT panic 1 Abnormal termination ft compressModelllegal ft error Defective compress mode Defective schema ft compressModeOutOfRange ft error Incorrect specification in compress mode ftAPI version ft contextCantCreate ft error Context file could not be created ft contextCantCreate2 ft error Context file could not be generated ft createDirectoryFa
90. on see section File name attributes on page 20 Restrictions fromLocalFile must not contain any partner specification after de referencing Format fromLocalFile ref ID data auto char bin user recordFormat std undef var fix maxRecSize int ccsname string filenames gt comment directory autoDataSpec lt fromLocalFile Attributes Name Value Meaning ref string Reference to another file object partner and directory are taken over from this if you have not specified the elements here see section Referencing on page 15 data autol char The default value is auto Specifies the data type bin user If char bin or user are specified then the autoDataSpec specification is ignored see section autoDataSpec on page 98 openFT V12 0 openFT Script Interface 101 transferFile openFT Script statements Name Value Meaning record 554 The default value is std Specifies the record format Format var fix The standard openFT assignment applies data bin gt undef otherwise var If undef is specified then the record format is undefined e g in the case of binary formats If var is specified then the record format is variable e g in the case of text formats 1 record 1 line lines can be of different lengths If fix is specified then the record format is fixed e g f80 with recordFormat fix and maxRecSize 80 maxRecSiz 1
91. on 27 directory 61 directory name attributes 21 E empty 62 end of an openFT script 26 error codes 22 115 normal 22 23 permitted for faulthandler 136 severe 22 24 error handling 13 22 error in an openFT script 26 error messages 22 115 executeScript 63 F fault 65 faulthandler 13 15 68 case 70 default 71 permitted errorcodes 136 file 72 file name attributes 20 foreach 73 fromLocalFile 101 fromLocalTmpFile 103 fromRemoteFile 106 ftacAdmission 86 Ftscript components 13 running 26 structure 13 ftscript 77 Ftscript error codes 22 initialization 26 openFT V12 0 openFT Script Interface 141 Index L list 78 listDirectory 79 N normal error codes 22 23 notational conventions 10 script diagnostic information 27 end 26 error 26 execution 26 initialization 26 openFT Script statements 51 attributes 19 baseDir 52 comment 53 context 54 createDirectory 55 deleteDirectory 57 deleteFile 59 directory 61 directory name attributes 21 empty 62 error handling 22 executeScript 63 fault 65 faulthandler 68 file 72 file name attributes 20 foreach 73 ftscript 77 list 78 listDirectory 79 overview 51 parallel 82 partner 84 script 88 sequence 90 transferFile 92 parallel 82 partner 15 84 ftacAdmission 86 processingAdmission 85 transferAdmission 86 userAdmission 86 processingAdmission 85 R referencing 13 15 remoteFailureScript 108 remoteSuccessScript 109
92. ons 10 README HIGS 1222248862884 UE 288 dadne d 11 Requirements for 5 11 Structure of anFtscript 4 a 13 Components of lt 13 t v A ae oy Ss ec ea el 14 COMIN adc oe eR EEE ERR ORC AC RE OU EER EE He em 15 RORO da aide edes a ds qeu dy dy doses ditis di det de fenis d 15 Specifying file and directory names 19 FilesameaudbUlBS amp 1 xke do OOP ECCO Re XO 20 Directory Nanas cua md PEWS REDRESS GA EES SED n 21 Error handling 2222222222 xx kom ook om ox ox 3o hee Ro 7X E RO Ex de 22 Normal Fteerpl error codes 2 23 Severe Ftscript error codes 0 24 Rd eo chy LUI DM T TRE 25 Running an 6 42 3468426 OSs dard RS ERR d 26 openFT V12 0 openFT Script Interface Contents 3 cpenFT Scripl Commands 5 9 5 2 29 3 1 Overview of the openFT Scriptcommands 29 3 2 ftcans Cancelling openFT Scriptrequest 30 3 3 ftdels Deleting an 5 32 3 4 ftmodsuo Modi
93. oreach contextObject and the resolution is not yet known because it has not yet been passed through openFT V12 0 openFT Script Interface 43 ftshwact openFT Script Commands Activity ActivityObject Meaning sendFile file name in the case of requests which have already cont been started this is the name specified in the FT request In the case of requests which have not yet been started this name is derived from the operating system specific name specified in the XML file e g unixName and extended by the directory specifica tions rcvFile as sendFile deleteFile specifies the remote file as in sendFile with partner if the file is local without partner file name gt like sendFile is determined from the FT request in the case of requests that have already been started and from the XML file in the case of requests that have not yet started A local file name would be output as an absolute file name in the case of a started request and as a relative path name in the case of an as yet unstarted request unknown file name if itis not known if the file is local when a file object is referenced createDir lt gt Partner with directory name if both are lt directory name gt known unknown if the partner is not yet known lt directory name gt unknown unknown if both are not yet known lt partner gt if contexId foreach contextObje
94. ory other than the default openFT Script working directory are to be displayed 36 openFT V12 0 openFT Script Interface openFT Script Commands ftshwsuo Output in table format User FtscriptWorkdir user path name user User ID path name Designates the name of the openFT Script working directory that the user has set with ftmodsuo without the subdirectory names created by openFT Script If the user has not set any special working directory then the name of his or her home directory is output since this is the openFT Script directory by default and is used to store the openFT Script requests Output in CSV format Column Type Values User String User ID FtscriptWorkdir String Name of the openFT Script working directory Return code 0 OK 4 Syntax error openFT V12 0 openFT Script Interface 37 ftscript openFT Script Commands 3 6 ftscript Starting an openFT Script request The ftscript command checks the specified script file and executes the statements it includes The script file must contain a valid XML document which corresponds to the schema for the openFT Script interface It must also be possible to read the file using the caller s ID The maximum number of users who may be owner of openFT Script requests is 1024 This includes requests that are terminated but not yet deleted If errors occur during verification then the script file is
95. oteFile ref ID data auto char bin user recordFormat std undef var fix maxRecSize int ccsname string filenames comment partner directory autoDataSpec fromRemoteFile 106 openFT V12 0 openFT Script Interface openFT Script statements transferFile Attributes Name Value Meaning ref string Reference to another file object partner and directory are taken over from this if you have not specified the elements here see section Referencing on page 15 data auto The default value is auto Specifies the data type char Ibin luser If char bin or user are specified then the AutoDataSpec specifi cation is ignored see section autoDataSpec on page 98 record stdl The default value is std Specifies the record format Format undef I fix The standard openFT assignment applies data bin gt undef otherwise var If undef is specified then the record format is undefined e g in the case of binary formats If var is specified then the record format is variable e g in the case of text formats 1 record 1 line lines can be of different lengths If fix is specified then the record format is fixed e g f80 with recordFormat fix and maxRecSize 80 maxRecSize 1 65535 Specifies the record size By default the openFT value applies openFT x V11 see openFT user manual 1 32756 or If data char then maxRecSize specifies the length of
96. parallel transferFile gt listDirectory foreach gt deleteFile gt lt foreach gt lt parallel gt lt ftscript gt fiscript is the root element The root element has a child element parallel parallel has ftscript as parent element or higher level element parallel also has three child elements transferFile listDirectory and foreach The foreach activity also has a deleteFile activity as a child element 14 openFT V12 0 openFT Script Interface Structure of an Ftscript Components of an Ftscript 2 1 2 Context An activity s context describes the context objects and error handling mechanisms faulthandler Using the context object language tool you can specify an element for example a partner once in the Ftscript and then re use it whenever necessary To do this you reference the context object at the point at which it is to be used Using appropriate referencing it is also possible to combine the properties of multiple context objects Each context object has an ID which must be unique within the context This ID is used to address reference the context object If a referenced context object is not found in the current context then a recursive search is performed in the higher level contexts Context objects other context objects with the same ID in higher level contexts A context is always present even if it has not been defined There are certain activitie
97. pectedLogEntry ft error Log file invalid Expected entry not found ft unknownError ft error Unknown error code ft unlockOrderQueue ft resource Order queue could not be released ft unresolvedTmpFile ft reference Local TmpFile was not found Reference cannot be resolved 134 openFT V12 0 openFT Script Interface Error messages Internal code Error code Description ft unwrap ft error Unwrapping failed ft userFault ft userFault Error activity called in the Ftscript ft userStorageCantCreate ft resource Basic data cannot be initialized EXIT NO ERROR LOG ft validatingFeaturesNot ft error Internal errorThe parser does not support Supported necessary features for validation ft validationError ft error Validation parse or IO error ft workDirectoryPiNotFound ft error PI for call directory not found in script ft workDirUnusable ft resource Working directory cannot be generated ft writeModelllegal ft error Incorrect specification in write mode Defective schema ft writeModeOutOfRange ft error Incorrect specification in write mode Defective schema ft writeOrderQueue ft resource Write to order queue failed ft wrongJavaVersion ft resource The current Java version is too old openFT V12 0 openFT Script Interface 135 Error messages The following error codes
98. penFT Script interpreter or other fimodsuo is running Command aborted Current openFT Script requests are present Command aborted Old openFT Script request not accessible Subdirectories cannot be created in the openFT Script working directory Meaning The directory lt wd gt openFT lt instance name gt script wd XopenFTN instance name gt script could not be created for example due to the absence of write access permission or because a physical error occurred Working directory does not exist Command aborted Warning The previous working directory could not be checked openFT V12 0 openFT Script Interface 35 ftshwsuo openFT Script Commands 3 5 ftshwsuo Displaying openFT Script user options You use the ftshwsuo command to display the directory in which the openFT Script requests are to be stored Format for Unix systems ftshwsuo h csv u lt user ID 1 321 Format for Windows systems ftshwsuo h csv u lt user ID 1 36 a Description h Outputs the command syntax on screen Any specifications after h are ignored csv The information is output in CSV format If you do not specify csv then the informa tion is output in table format u user IDI a Only for the FT administrator User ID whose openFT Script options are to be displayed means that the openFT Script options of all active openFT Script users as well as of all openFT Script users who have a working direct
99. penFT Script statements transferFile fromLocalTmpFile You use fromLocalTmpFile to specify a temporary source file for file transfer from remote to remote see Types of file transfer on page 92 The temporary file is simply a buffer under the local ID This temporary file is deleted automatically The data maxRecSize recordFormat ccsname and autoDataSpec specifications in the fromRe moteFile toLocalTmpFile activity apply implicitly When a TmpFile is created from fromRe moteFile then these specifications are inherited Restrictions You may only use fromLocalTmpFile after a fromRemoteFile toLocalTmpFile activity since the file TmpFile already exists and must be accessible in the current context For more infor mation see section fromRemoteFile on page 106 and section toLocalTmpFile on page 111 Format fromLocalTmpFile use tmpID gt Attributes Name Value Meaning use string Reference to a file TmpFile which can be accessed in the current context This file must previously have been created with a transferFile using toLocalTmpFile openFT V12 0 openFT Script Interface 103 transferFile openFT Script statements Example lt xml version 1 0 encoding UTF 8 gt lt ftscript lt contex lt part lt tr lt f t par list pa lt lt lt p version C gt ansferAdmi tacAdmiss ransferAd tner gt id Remot t
100. permissions for the subdirectory and it cannot be accessed by other users You use the ftmodsuo command to specify the directory in which the openFT Script requests are to be stored However you can only do this if no openFT Script is running and there are no current openFT Script requests for the user If necessary you may have to cancel your running openFT Script requests with ftcans and delete terminated openFT Script requests with ftdels The command is also rejected if another ftmodsuo command for the specification of an openFT Script working directory is currently running under the same user ID Format ftmodsuo h wd directory name 1 128 gt Description h Outputs the command syntax on screen Any specifications after h are ignored wd Absolute or relative path name of the working directory in which the subdirectory for the user s openFT Script requests is to be created wd resets the working directory to the default value i e the user s home directory ftmodsuo can also be specified without parameters but does nothing 34 openFT V12 0 openFT Script Interface openFT Script Commands ftmodsuo Return code 0 4 15 69 79 80 81 88 90 91 OK Syntax error e g the name of the working directory is too long openFT is not authorized to process requests for this user e g password not set on access to home directory File access error Prelock Ick UserLock lck in FtscriptWorkdir o
101. ption ft code2196 ft abort Request request ID has been deleted in the remote system ft code2197 ft cantCreate Request request ID Remote system File directory remote file gt could not be created ft code2198 ft notExist Request request ID Remote system Higher level directory no longer found ft code2199 ft access Request request ID Remote system Error on remote file gt input output ft code2200 ft access Request request ID Remote system File now locked against concurrent access ft code2201 ft access Request request ID Remote system File directory remote file gt no longer available ft_code2202 ft_notExist Request lt request ID gt Remote system File directory lt remote file gt no longer found ft_code2203 ft_notExist Request lt request ID gt Remote system Home directory no longer found ft_code2204 ft_resource Request request ID Remote system File directory remote file gt can no longer be assigned any space ft code2205 ft notExist Request request ID Remote system File owner no longer known ft code2206 ft error Request request ID Remote system Error during prepro cessing postprocessing ft code2207 ft error Request request ID Remote system Exit code 2 during preprocessing postpro cessing ft code2208 ft aut
102. quests in the request queue in order to en sure that this connection limit is not exceeded In the case of parallel the requests can be processed in any order Synchronous activities such as deleteScript are also not necessarily all started at the same time within the framework of a parallel activity Instead the maximum number is 200 so that not too many threads have to be established The openFT connection limit and process limit operating parameters control wheth 1 er requests in the request queue are processed simultaneously or sequentially and consequently influence the actual level of parallel execution as well as the perfor mance and resource consumption of your openFT Script request Format parallel comment context Activity lt parallel gt 82 openFT V12 0 openFT Script Interface openFT Script statements parallel Example lt xml version 1 0 encodi ftscript version 1 gt parallel lt transferFile gt lt fromLocalFile name W openFT ftscript data char toRemoteFile name partner name Uni transferAdmissi ftacAdmission transferAdmiss lt partner gt lt directory name lt toRemoteFile gt lt transferFile gt lt transferFile gt lt fromLocalFile name W openFT ftscript data bin gt lt toRemoteFile name lt partner name Win lt transferAdmissi lt ftacAdmission lt transferAdmiss lt partner gt lt directo
103. r REMERR EXIST ft exist The remote file already exists ft err REMERR INCONS ft remoteFile Structure The remote file is inconsistent ft err MEM ft cantCreate The remote file is assigned no space ft err REMERR NOACCESS ft access It is not possible to access the remote file ft err REMERR NOCREAT ft cantCreate The remote file cannot be created ft err REMERR NOTEXIST ft notExist The remote file cannot be found ft err REMADM ft auth The remote transfer admission is invalid ft errorEncoding ft resource Code Cp850 not supported Install extended language support for Java ft_errorOnCancel ft_error Error during abort ft_errorReadingCsv ft_resource User information could not be read ft_errorReadingExec ft_resource Default error output from script execution could not be read ft_errorReadingFtsadmErr ft_resource Default error output from fsadm command could not be read ft_errorWaitingForExec ft_resource Error waiting for the end of script execution ft_errorWaitingForFtsadm ft_resource Error waiting for the end of fsadm command ft_execFailed ft_error Script execution could not be started ft_exist ft_exist Directory already exists ft_exit_ lt exitcode gt ft_script A script executed with executeScript has terminated with an error code 130 openFT V12 0
104. ransfer In the case of a local Unix system the reverse would be true When the transfer to the local system is performed no data is converted Instead the data is converted on the subsequent transfer to the remote system 96 openFT V12 0 openFT Script Interface openFT Script statements transferFile 3 Use of faulthandler and executeScript for local scripts faulthandler see section faulthandler on page 68 corresponds to the JocalFailureScript and the executeScript which directly follows transferFile see section executeScript on page 63 corresponds to the ocalSuccessScript You can activate a rransferFile request with local Script as indicated in the example below sequence context faulthandl defau lt context gt lt transferFil lt executeScri lt sequence gt faulthandl transferFil er gt default lt executeScript gt localFailureScript lt executeScript gt t gt er gt e gt e gt pt gt localSuccessScript lt executeScript gt This sequence can also be located in a parallel or foreach parallel statement openFT V12 0 openFT Script Interface 97 transferFile openFT Script statements autoDataSpec You use autoDataSpec to define the transfer mode for the file in which the element was specified If the file s data type is unknown then it is determined on the basis of the file name using patte
105. ransferAd lt ftacAdm transferA artner gt ner id Fil WS eServer name UnixP_1 gt ssion gt ion ftacAdmission FTACADM1 gt ission gt eHostList gt rtner name UnixP_1 gt ission gt ission ftacAdmission FTACADMI dmission gt partner name WindowsP_1 gt lt lt ftacAdmi transferAdmission gt ssion ftacAdmission FTACADM2 gt lt transferAdmission gt lt partner gt lt lis L lt context gt listDirectory listObject FileList gt partner ref FileServer gt lt base lt listD lt foreac irectory h listRef contextO lt transferFile gt fromRemoteFile ref File gt partner ref FileServer gt lt di lt f lt to Local TmpFi lt transferFile gt lt foreach 1 lt transferFi contex le gt Dir name frg_eis_19 datastore gt FileList selectType file bject File execute parallel gt rectory name frg_eis_19 datastore gt romRemoteFi le e id tmpFile gt istRef RemoteHostList selectType partner tObject RemoteHost execute parallel gt fromLocalTmpFile use tmpFile gt toRemoteFile ref File gt lt partner ref RemoteHost gt directory name frg_eis_19 targetDir gt lt toRemoteFi le gt lt transferFile gt lt foreach gt lt foreach gt lt ftscript gt 104 openFT V12 0 openFT Script Interface openFT Sc
106. rating system command context object of type script can be referenced in the executeScript activity or by remoteSuccessScript Of remoteFailureScript The command must be written in the operating system specific syntax of each operating System You can specify a different text string for each operating system in a script object openFT Script selects the text string that is to be executed on the basis of the operating system specification in the partner definition or on the basis of the local operating system If the operating system is unknown or no script matching the operating system is specified then the text string designated with script is executed The text string script is completely output by the ftshwact command If this string contains passwords or related security relevant information e g for an ncopy command then the ftshwact command outputs this information A return value other than zero is interpreted as an error and results in an ft scriptError Restrictions 1 A script e g bs2000Script unixScript may only occupy one line and its length is limited to 500 characters 2 In this version the script is not configurable Format script id ID ref ID repeatable true false gt comment script bs2000Script unixScript windowsScript zosScript partner lt script gt 88 openFT V12 0 openFT Script Interface openFT Script statements script Attributes Name
107. replaced activity are copied to the context of the default activity if still present The contexts of the child activities including those in which the error occurred are no longer accessible For information on execution see section sequence on page 90 Format default comment context Activity lt default gt openFT V12 0 openFT Script Interface 71 file openFT Script statements 4 13 file You use file to define a file Properties of a file The file has a system specific name file is located on a concrete system partner a concrete directory directory If no partner is specified then the file is located on the local system Restrictions The same restrictions apply as for filenames and directory see sections File name attributes on page 20 and Directory name attributes on page 21 Format file id ID ref ref filenames gt comment partner directory lt file gt Attributes Name Value Meaning id string A unique ID in the current context The context object is referenced under this ID ref string Name of another file context object filenames See section File name attributes on page 20 72 openFT V12 0 openFT Script Interface openFT Script statements foreach 4 14 foreach You use foreach to execute a sequence for each element in a list see section list on page 78 foreach executes the child el
108. ript statements transferFile In the example the files in the directory frg eis 9 datastore are copied to the relevant frg eis I9 targetDir target directory on the various computers listDirectory is used to identify the files on the FileServer The first foreach activity works through all the files identified on the FileServer Each file is copied to a temporary file tmpFile In the second foreach activity each temporary file is copied to the target directory frg eis I9 targetDir on the RemoteHost Finally the associated temporary file tmpFile is deleted openFT V12 0 openFT Script Interface 105 transferFile openFT Script statements fromRemoteFile You use fromRemoteFile to specify the remote source file for file transfer The transfer type data type can be derived from the file name by means of autoDataSpec see section autoDataSpec on page 98 File names may be a maximum of 512 characters in length This is checked before the Ftscript is run The length of the resulting file name directory and filenames is limited by the operating system in question and the openFT version The length is the number of characters plus 1 character if directory does not end with a The check is performed while the Ftscript is being run For further information see section File name attributes on page 20 Restrictions fromRemoteFile must contain a partner specification after de referencing Format fromRem
109. rn recognition The only pattern currently permitted is xxx since only the file name suffix is checked The file name specified for the actual transfer is used If a Unix specific file name and Windows specific file name specified then the 1 appropriate file name is analyzed depending on the partner in question The file types are described in the openFT user manual Data type Format Example char Text format xml bin Binary format doc in a Windows system user User format autoDataSpec describes which pattern is assigned to which data type If multiple patterns for different file formats match a file name then the file type is determined in the sequence bin char user If an explicit data type is specified for the file after de referencing then autoDataSpec is not evaluated Restrictions The only useful pattern is xxx where xxx may be of any length However the overall length of 512 characters for the entire expression may not be exceeded Only the file name suffix is checked Format autoDataSpec ref ID charPattern patternList binPattern patternList userPattern patternList default char bin user gt comment lt autoDataSpec gt 98 openFT V12 0 openFT Script Interface openFT Script statements transferFile Attributes Name Value Meaning ref string Reference to an autoDataSpec context object binPattern p
110. rrno is the value of the errno variable This value is set by the defective system call ft err INT PIPE errno ft error Error on pipe system call errno is the value of the errno variable This value is set by the defective system call ft err INT READ errno ft error Error on read system call errno is the value of the errno variable This value is set by the defective system call ft err INT RMFILE errno ft error Error on rmfile system call errno is the value of the errno variable This value is set by the defective system call ft err INT SIGNAL signal ft error The command was interrupted by signal signal indicates the signal which caused the interruption ft err INT STAT errno ft error Error on stat system call errno is the value of the errno variable This value is set by the defective system call ft err INT SYSTEM errno ft error Error on system system call errno is the value of the errno variable This value is set by the defective system call ft err INT WRITE errno ft error Error on write system call errno is the value of the errno variable This value is set by the defective system call If it was not possible to write all the bytes errno has the value 1 ft err LOCERR EXIST ft exist The local file already exists ft err LOCERR FTAC ft access The request was rejected by the local FTAC ft err LOCE
111. ry name f lt toRemoteFile gt lt transferFile gt lt parallel gt lt ftscript gt ng UTF 8 gt Test data large text txt text txt gt 1 on gt ftacAdmission FTACADM1 gt jon gt frg eis 13 Test data large bin mp3 bin mp3 gt dowsP_1 gt on gt ftacAdmission FTACADM2 gt jon gt rg_eis_13 gt The files text txt and bin mp3 are delivered simultaneously In fact the file transfer requests are sent to openFT simultaneously free then these requests are executed simultaneously If enough capacity is openFT V12 0 openFT Script Interface 83 openFT Script statements 4 19 partner You use partner to specify the partner for which the activity applies or at which the file or directory is located If a partner is specified then this is always considered to be the remote system even if your own computer and own user ID are being addressed If you do not specify a partner the activity refers to the current user ID on the local computer After de referencing the partner must possess a transfer admission see section trans ferAdmission on page 86 Format comment partner id ID ref ref name name systemlype any unix windows zos bs2000 gt transferAdmission processingAdmission lt partner gt Attributes Name Value Meaning id string A unique ID in the
112. s foreach listDirectory which automatically incorporate data in a context The context objects are described in more detail in section context on page 54 2 1 3 Referencing openFT Script also allows you to combine context objects For example a partner see section partner on page 84 does not have to be specified in full at every location You can transfer a partner to a context object and re use it via refer encing openFT V12 0 openFT Script Interface 15 Components of an Ftscript Structure of an Ftscript The following rules apply to de referencing 1 A ref attribute references a context object with the specified ID and the object type of the context object e g file partner The search is continued in the parent context if no suitable object is found in the current object If no suitable context object is found there then the search is continued in its parent context Multi level referencing is permitted If no suitable context object is found then the script is terminated with the error reference see section Error handling on page 22 ref A is permitted in a context object with D A In this case ref always refers to the parent context Circular references are nor permitted objI ID ref B obj2 ID B ref A is not possible one and the same context The error ft reference is output All the attributes and elements of the referenced element which are not present
113. s of the openFT Script request is then set to cancelled to prevent any restart If the openFT Script request that is to be cancelled is currently being processed then the following message is output at stderr ftcans Cancellation request for ftscript id ftscriptid started If the request has been started but not yet processed then the following message is sent to stderr ftcans ftscript id ftscriptid cancelled Format for Unix systems ftcans h u lt user ID 1 32 gt lt ftscriptid gt Format for Windows systems ftcans h u lt user ID 1 36 gt lt ftscriptid gt Description h Outputs the command syntax on screen Any specifications after h are ignored u user ID User ID under which the search for the openFT Script request that is to be cancelled is performed Only FT administrators may input a user ID The default value is the calling party s user ID 30 openFT V12 0 openFT Script Interface openFT Script Commands ftcans ftscriptid Identification of the openFT Script request This is output if the openFT Script request is started via an ftscript command You can use the wildcard symbols and in der ftscriptid This cancels all openFT Script requests that match the wildcard pattern is interpreted as any single character is interpreted as any number of characters If you use wildcards enclose the ftscriptid specification in single quotes so that the
114. s referenced in the second transferFile activity However the partner has been overwritten Consequently the partner UnixP 1 which is defined in the context of the second transferFile is addressed This definition hides the Windows partner with 7d remote If the partner was not overwritten then the Windows partner would be used since this is found in the pack object definition in the ftscript context The partner on the Unix system from the context of the second rransferFile would be ignored since it is no longer accessible from the definition d pack openFT V12 0 openFT Script Interface 17 Components of an Ftscript Structure of an Ftscript 2 Invalid referencing lt xml version 1 0 encoding UTF 8 gt lt ftscript version 1 gt lt transferFile gt fromRemoteFile ref pack gt toLocalFile name packl bin gt lt directory name frg_eis_02 gt lt toLocal File gt lt transferFile gt lt ftscript gt The pack reference is not defined The script outputs an error ft noRef This is not processed no faulthandler defined The script is terminated before execution of the transferFile activity No restart is possible You can use ftshws to display the reason for termination 18 openFT V12 0 openFT Script Interface Structure of an Ftscript Specifying file and directory names 2 2 Specifying file and directory names Many openFT Script statements use file or directory nam
115. sages on page 115 The error codes assigned by openFT Script always start with ft You can also use the fault activity see section fault on page 65 to assign any other error codes However these may not begin with ft These are always considered to be normal error codes The cause of the error can be displayed with ftshwact If no faulthandler exists for an error then ftscript is terminated with an error status F The status and cause of termination can be displayed using ftshws 22 openFT V12 0 openFT Script Interface Structure of an Ftscript Error handling 2 3 1 Normal Ftscript error codes Normal errors relate to the objects which are to be transferred or to the involved computer A normal error can be intercepted by the faulthandler default see section default on page 71 error codes Description ft access It is not possible to access a file directory computer ft admin Administration error ft auth Authentication error incorrect ID password authorizations ft cantCreate It is not possible to create a file directory ft cantDelete It is not possible to delete a file directory ft configuration Configuration error ft connection A connection error has occurred ft corrupt A file does not correspond to the expected format ft exist A file directory already exists ft localFileStructure Error in the local file
116. sion 1 gt comment context Activity lt ftscript gt Attributes Name Value Meaning version 1 Fixed value describing the Ftscript version Example See any example in the current manual openFT V12 0 openFT Script Interface 77 list openFT Script statements 4 16 list A list contains multiple elements of type partner directory or file You can also generate a list using listDirectory see section listDirectory on page 79 foreach permits the iterative processing of the elements in the list see section foreach on page 73 Format list id ID comment partner directory file lt list gt Attributes Name Value Meaning id string A unique ID in the current context The context object is referenced under this ID Example See section foreach on page 73 78 openFT V12 0 openFT Script Interface openFT Script statements listDirectory 4 17 listDirectory You use listDirectory to list the files and directories The located file or directory names are combined in a list The list is displayed in the parent context in a context object with the specified listObject Id The context object is available there after execution of the listDirectory activity If an error occurs during the execution of listDirectory then the object is not available A listDirectory as a direct child element of a parallel activity does not return a usable e
117. sts On a restart see section Restart on page 25 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 on page 21 openFT V12 0 openFT Script Interface 55 createDirectory openFT Script statements Example lt xml version lt context gt lt directory lt context gt lt partner na lt ftacAd lt partner gt lt baseDir na lt ftscript gt 0 encoding UTF 8 gt lt ftscript version 1 gt id2 myDir name myTmp gt createDirectory ref myDir gt e UnixP 1 lt transferAdmission gt ission ftacAdmission FTACADM1 gt lt transferAdmission gt e frg_eis_03 gt lt createDirectory gt Creates the directory myTmp for the FTAC transfer admission FTACADMI 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 cod
118. sts of activities These can be operating instructions to openFT e g transferFile deleteFile or statements which control the processing flow e g parallel foreach Context object Context objects are described in an activity s context Each context object possesses an ID which must be unique in the context The context object is addressed referenced via this ID file transfer request FT request FT request See openFT request FTAC File Transfer Access Controll Part of openFT that offers extended access protection for file transfer and file management FTAM 1 document type for text files FTAM 3 document type for binary files openFT V12 0 openFT Script Interface 137 Glossary FTAM file attributes All systems which permit file transfer via FTAM protocols must make their files available to their partners using a standardized description ISO 8571 To this end the attributes of a file are mapped from the physical filestore to a virtual filestore and vice versa This process distinguishes between three groups of file attributes kernel group describes the most important file attributes storage group contains the file s storage attributes security group defines security attributes for file and system access control FTAM partner Partner system which uses the FTAM protocols for communication ftsc File name suffix for an openFT Script file Ftscript Multiple logically independent openFT reques
119. t element The root element contains the following sub elements optional context with context objects and a maximum of one faulthandler or more activities which are executed in the specified sequence For further information on the syntax see section Syntax of the openFT Script statements on page 51 openFT V12 0 openFT Script Interface 13 Components of an Ftscript Structure of an Ftscript 2 1 1 Activities There are various types of activity Internal activities Internal activities consist of instructions sent to the Ftscript interpreter to control operation These include ftscript sequence parallel foreach empty and fault For a description see chapter openFT Script statements on page 51 External activities The external activities are statements issued to openFT instructing it to run the required functions These include executeScript transferFile deleteFile createDirectory deleteDirectory and listDirectory For a description see chapter openFT Script statements on page 51 If you do not specify a partner in the external statements executeScript deleteFile createDirectory deleteDirectory listDirectory then the statement is executed as a local com mand or local operating system statement Parent and child activities You can nest activities XML syntax As a result activities are subdivided into parent and child activities ftscript version 1 gt
120. t emptyTransferAdmission ft paramError The transfer admission does not contain any user or FTAC admission ft encryptionlllegal ft error Incorrect specification for encryption Defective schema ft encryptionOutOfRange ft error Incorrect specification for encryption ftAPI version ft err CONNERR NOCONN ft connection No free transport connection ft err CONNERR NOTAVAIL ft connection The remote system is not accessible ft err CONNERR UNKNOWN ft configuration The remote system is unknown ft err INT CRFILE ft error Error during file generation ft err INT FORK errno ft error Error on fork system call errno is the value of the errno variable This value is set by the defective system call ft err INIT ft error It is not possible to initialize the server ft err INT INTERNAL FN ft panic Other internal error Function not supported ft err INT INTERNAL VERS ft panic Other internal error Data structure version not supported 126 openFT V12 0 openFT Script Interface Error messages Internal code Error code Description ft err INT MEM ft resource Error on storage request ft err INT OPEN errno ft error Error on open system call errno is the value of the errno variable This value is set by the defective system call ft err INT OPENDIR errno o ft error Error on opendir system call e
121. tWriteLogData ft resource Log data could not be written ft circleRef ft reference Circular reference not permitted ft closeOrderQueue ft resource Order queue could not be closed correctly ft code1038 ft ignore Request request ID is being completed and can no longer be deleted openFT V12 0 openFT Script Interface 115 Error messages Internal code Error code Description ft code108 ft connection Request request ID Remote system not accessible ft code20 ft notExist local file not found ft code2014 ft paramError No modification of file attributes demanded ft code2015 ft admin openFT is not authorized to process requests for this user ft code2016 ft notEmpty The directory local file is not empty ft code2017 ft localFile Structure The file attributes do not correspond to the request parameters ft code2018 ft error Attributes could not be modified ft code2019 ft cantCreate local file could not be created ft code2021 ft notExist CCS name not known ft code2022 ft notExist Higher level directory not found ft code2023 ft exist local file already exists ft code2024 ft notSupported Transfer of file generation groups not supported ft code2025 ft access Error accessing local file ft code2026 ft paramError Resulting file name local
122. ts can be combined into a single request Ftscript using openFT Script Interpreter Here the program which executes an openFT Script request The interpreter controls automatic restarts job Sequence of commands statements and data local system The FT system at which the user is working openFT partners Partner systems which communicate via openFT protocols openFT request Request to an FT system to transfer a file from a send system to a receive system and possible start follow up processing requests openFT script Name of the product and the langage in which openFT requests are formulated openFT script request The processing of an Ftscript 138 openFT V12 0 openFT Script Interface Glossary owner of an FT request Login name in the local system or remote system under which this FT request is executed The owner is always the ID under which the request is submitted not the ID under which it is executed partner system here FT system that executes FT request together with the local system password Sequence of characters that a user must enter in order to access a user ID file job variable network node or application The user ID password serves for user authentication It is used for access control The file password is used to check access rights when users access a file or job variable It is used for file protection purposes remote system see Partner system request here openFT request req
123. uest queue File which contains the asynchronous requests and their processing states The request queue also contains the parameters set with the ftmodo command restart Automatic continuation of an FT request after an interruption system remote See partner system system local See local system TCP IP Transmission Control Protocol Internet Protocol Widespread protocol for file transfer corresponds roughly to Layers 3 and 4 of the OSI Reference Model i e Network and Transport Layer was originally developed for the ARPANET computer network of the US Ministry of Defense now a de facto standard Trace Diagnostic function which logs the course of FT operation openFT V12 0 openFT Script Interface 139 Glossary Transmission Control Protocol Internet Protocol see TCP IP Transport Name Service TNS Service used to administer properties specific to transport systems Entries for partner systems receive the information on the particular transport system employed 140 openFT V12 0 openFT Script Interface Index A activities 13 14 external 14 internal 14 parent and child 14 attributes 19 directory names 21 filename 20 autoDataSpec 98 B baseDir 52 C case 70 changes compared to predecessor version 10 comment 53 components of an Ftscript 13 context 13 15 54 createDirectory 55 D default 71 deleteDirectory 57 deleteFile 59 de referencing 16 example 17 rules 16 diagnostic informati
124. ure Is only displayed for the ftscript activity if the error was not handled by a faulthandler 42 openFT V12 0 openFT Script Interface openFT Script Commands ftshwact In the case of activities with the status F and faulthandler activities the cause of the error is output in clear text in an additional line Activity Activity name The names are based on the openFT Script language but may be truncated in some cases e g faulthdlr instead of faulthandler foreach is designated in accordance with the value of the execute attribute as foreach P parallel or foreach 5 sequential TransferFile is designated as sendFile or rcvFile receive File depending on the direction of transfer ActivityObject The content of this column depends on the activity in question see the table below Activity ActivityObject Meaning ftscript lt scriptPath gt Complete path name of the original file with the XML statements empty foreach P contextObject context object which assumes the value of the current list element foreach 5 asforeach P parallel sequence sendFile Specifies the remote file in the following form lt partner gt lt file name gt Partner with file name if both are known unknown lt file name gt if the partner is not yet known unknown unknown if both are not yet known lt partner gt ref lt contextld gt if contextId f
125. user ID The name of the file that is to be deleted consists of the directory name specified with directory see section directory on page 61 and the name specified with the filenames at tribute If you want to delete the files in a directory you should use listDirectory see section listDirectory on page 79 together with foreach see section foreach on page 73 The length of the file name length of directory plus length of filenames is limited and depends on the openFT version The length is the number of characters plus 1 character if directory does not end with a You should note the response on a restart see section Restart on page 25 i Format deleteFile ref ID faultIfNotExists yes no filenames gt comment context partner directory lt deleteFile gt Attributes Name Value Meaning ref string Reference to a file context object faultIfNotExists yes The default value is If the file does not exist then this is not considered to be an error and Ftscript processing is continued If yes is specified then the Ftscript request is aborted with ft notExists if the file does not exist On a restart see section Restart on page 25 the Ftscript request is aborted with ft recoveryFailed This may also occur if the instance is switched filenames See section File name attributes on page 20 openFT V12 0 openFT Script Inter
126. ute sequential direction reverse gt deleteDirectory ref delDir gt partner ref remote lt deleteDirectory gt lt foreach gt lt ftscript gt In this example everything in the directory frg_eis_10 on the computer UnixP_1 is deleted under the FTAC transfer admission FTACADM listDirectory see section listDirectory on page 79 is used to determine all the files and directories recursively using the search pattern The sequence in which the directories are listed corresponds to the sequence required for their generation i e the opposite sequence is required in order to delete them In the first foreach sequence all the files are deleted in parallel Non existent files are ignored An error during file deletion results in cancellation of the script In the second foreach sequence the empty directories are deleted backwards because the directories to be deleted with deleteDirectory must be empty see section deleteDirectory on page 57 Non existent directories are ignored Other errors result in the cancellation of the script When the script has run the directory frg eis 10 on the computer UnixP_ is empty 76 openFT V12 0 openFT Script Interface openFT Script statements ftscript 4 15 ftscript ftscript is the root element of the script The element always corresponds to a sequence activity see section sequence on page 90 Format ftscript ver
127. vent list see section parallel on page 82 i You can use baseDir see section baseDir on page 52 to define a base directory from which listDirectory is run The base directory itself is not listed in the result File or directory names may be a maximum of 512 characters in length This is checked before the Ftscript is run The length of the resulting file or directory name baseDir and dirnames Or baseDir filenames is limited The length is the number of characters plus 1 character if baseDir does not end with a The check is performed while the Ftscript is being run For further information see section Specifying file and directory names on page 19 Li You can use the wildcard symbol to list a directory tree in full Format listDirectory listObject ID dirnames gt comment context partner baseDir lt listDirectory gt openFT V12 0 openFT Script Interface 79 listDirectory openFT Script statements Attributes Name Value Meaning ref string Reference to a directory context object listObject string Name of the list context object which is displayed in the parent context No context element with this name may exist dirnames See section Directory name attributes on page 21 To list a directory tree in full you can specify the wildcard symbol at the end of the name Example lt xml version 1 0 encoding UTF 8 gt lt ftscr
128. wildcard symbols are not interpreted by the shell a means that all the user s openFT Script requests are to be cancelled Return code 0 4 51 54 250 OK Syntax error Error while outputting an Ftscript user Ftscript ID not found Internal error openFT V12 0 openFT Script Interface 31 ftdels openFT Script Commands 3 3 ftdels Deleting an openFT Script request The specified completed openFT Script request is deleted from the user s directory or all completed openFT Script requests are deleted from the user s directory No more information is subsequently available for deleted requests A ftshws or ftshwact command with the ftscriptid of a deleted request is rejected since it no longer exists Before an openFT Script request can be deleted it must have been completed i e ftshws must indicate the status T F or C Since ftcans is not a synchronous command it may be necessary to wait for the status C cancelled to arise before a subsequent ftdels If no ftdels is issued for an openFT Script request then this is automatically deleted when the retention period expires Format for Unix systems ftdels h u lt user ID 1 32 gt lt ftscriptid gt Format for Windows systems ftdels h u lt user ID 1 36 gt lt ftscriptid gt Description h Outputs the command syntax on screen Any specifications after are ignored u user ID User ID under which the search for t
129. y openFT Script statements 4 9 empty The activity empty does nothing but is required for formal purposes in order to intercept an error or other actions in a faulthandler see section faulthandler on page 68 Format empty comment lt empty gt Example lt xml version 1 0 encoding UTF 8 gt lt ftscript version 1 gt lt transferFile gt lt context gt lt faulthandler gt lt default gt lt empty gt lt default gt lt faulthandler gt lt context gt fromRemoteFile name packl bin gt partner name someHost gt lt transferAdmission gt ftacAdmission ftacAdmission FTACADMI1 gt lt transferAdmission gt lt partner gt lt directory name frg_eis_06 gt lt fromRemoteFi le gt lt toLocalFile name target bin gt lt directory name frg_eis_06 gt lt toLocalFile gt lt transferFile gt lt ftscript gt If errors occur in transferFile then execution of the openFT Script request continues never theless i e the Ftscript request is terminated with status T In the case of severe errors see section Severe Ftscript error codes on page 24 the openFT Script request is terminated with the corresponding error code since the default faulthandler is ineffective 62 openFT V12 0 openFT Script Interface openFT Script statements executeScript 4 10 executeScript You use executeScript to run a script The script is executed
130. yption data integrity check not possible Encryption is disabled ft code2112 ft connection Request request ID Data integrity check is not supported by partner 118 openFT V12 0 openFT Script Interface Error messages Internal code Error code Description ft code2113 ft connection Request request ID User data encryption not possible for this request ft code2114 ft connection Request request ID Local system ID rejected by remote system partner ft code2115 ft connection Request request ID Request interrupted by remote system ft code2116 ft connection Local application lt 1 gt not defined ft code2117 ft connection Local application lt 1 gt not available ft code2118 ft connection Request request ID Authentication of local system failed ft code2119 ft connection Request request ID Local system unknown in remote system ft code2120 ft connection Remote system lt gt unknown ft code2121 ft connection Request request ID Authentication of partner failed ft code2122 ft connection Request request ID Connection rejected or disconnected Cause 2 ft code2123 ft connection Request request ID Error 2 on OSS call ft code2124 ft connection Request request ID No free transport connection

Download Pdf Manuals

Related Search

openFT Script

openFT-Script

Contents

Download Pdf Manuals

Related Search

Related Contents