OS4X Core event scripts

The scripting interface gives you the possibility to start processes during an OFTP connection like managing an EDM system, sending confirmation eMails, deleting files, etc. The scripts have all information available as parameters at this point of time the script will be started.

The scripts are defined via web interface. This configuration is stored in the database, which will be read by every binary on startup and on every configuration reload. If a script is unavailable or not runnable (i.e. execute permissions are missing, user has no read permissions etc.), the script will not be started.

start session script

Will be started at the beginning of an OFTP session after handshaking SSIDs and passwords.

Parameters:

• 1. partner shortname
• 2. partner index value

end session script

Will be started at the end of an OFTP session after receiving an ESID („end session ID“).

Parameters:

• 1. partner shortname
• 2. partner index value

start receive script

Will be started at the beginning of an OFTP file transfer from partner to local site after handshaking SFIDs.

Parameters:

• 1. partner shortname
• 2. virtual filename
• 3. absolute filename of received file AFTER successful transfer
• 4. absolute filename of receiving file DURING transfer (temporary)
• 5. filesize in kilobytes (kB) given by partner (may not be true size)
• 6. partner index value
• 7. SFID destination
• 8. SFID originator
• 9. [optional: OFTPv2 file description]

end receive script

Will be started after an OFTP file transfer from partner to local site after handshaking EFIDs („end file ID“)

Parameters:

• 1. partner shortname
• 2. virtual filename
• 3. absolute filename of received file AFTER successful transfer
• 4. error indicator: 0 means no error, any other displays an error
• 5. partner index
• 6. SFID destination
• 7. SFID originator
• 8. [optional: OFTPv2 file description]

start send script

Will be started at the beginning of an OFTP file transfer from local site to partner after handshaking SFIDs.

Parameters:

• 1. partner shortname
• 2. virtual filename
• 3. real filename with absolute path
• 4. send queue entry comment
• 5. partner index

end send script

Will be started at the end of an OFTP file transfer from local site to partner after handshaking SFIDs.

Parameters:

• 1. partner shortname
• 2. virtual filename
• 3. real filename with absolute path
• 4. send queue entry comment
• 5. error indicator: 0 means no error, any other displays an error
• 6. partner index

blocked script

Will be started if a send queue entry will be blocked. If more than one entry will be blocked (i.e. if a connection problem occurs), the script will be executed for every send queue entry seperately.

Parameters:

• 1. partner shortname
• 2. virtual filename
• 3. real filename with absolute path
• 4. send queue entry comment
• 5. partner index

debug daemon log script

Every time a debug log will be dumped, this script will be started.

Parameters:

• 1: absolute path to the logfile