FTP and File Outbound

Job Variables

A client interface is available for developing the script and the object implementing the terrifies is available in the job slot variable.

• ftpObj The variable to retrieve the client object.

Example: var ftpClient = job.get("ftpObj");

In addition, you can use the following job variables in scripts:

• dataObj An in-memory object containing the data to be transmitted.

Example: var dataObject = job.get("dataObj");

• deleteFileRef Set to false to prevent TIBCO BusinessConnect Container Edition from deleting the outbound file from the local machine at the end of script execution. The default value for this variable is true, and the outbound file gets deleted at the end of script execution.

• fileURL Variable entered in the URL field for File transport. You can use this to dynamically store the file in the file system.

Example: var fileURL = job.get("fileURL");

• hostName The variable containing the trading host name from whom the file came.

Example: var hostName = job.get("hostName");

• logObj The variable to retrieve the UserLogAccess object that does audit logging.

Example: var logClient = job.get("logObj");

• srcFileName The variable for the file name on the local machine that has the outbound file ready to be stored in the FTP server.

Example: var localfile = job.get("srcFileName")

• Skip Content Threshold If BusinessConnect uses the Outbound File poller to get the file from the private process and the file size is smaller than the threshold set as Skip Content Threshold, then the file will be directly read into memory and the value of localFile will be null. In such cases, you should use job.get("dataObject") to access the data to be transmitted;

The default for the property Skip Content Threshold set in the dialog Edit Application Configuration is 10000 KB. This property defines a threshold for large files. Any file with the size that exceeds this threshold will not be fully written into memory, which increases the available memory for the system.

To find out how to define this property, see TIBCO BusinessConnect Container Edition Administration, "Intercomponent Advanced."

• srcFilePath The directory on the local machine that has the outbound files ready to be stored in the FTP server.

Example: var localdir = job.get("srcFilePath");

• tpName The variable containing the trading partner for whom the file is intended to be stored.

Example: var tpName = job.get("tpName");

• obPGPHandler The variable to be used for outbound PGP packaging in an FTP session. Users can use the handler to set the PGP process options.

Example: var obPGPHandler = job.get("obPGPHandler");

var sign = ...

var encryption = ...

var compress = ...

//sign, encryption and compress are boolean values (true or false);

obPGPHandler.setPGPOptions(sign, encryption, compress);

You can also set the format of the payload after PGP processing, and the compression algorithm:

obPGPHandler.setCompressionAlgo("ZLIB"); //"ZLIB" or "ZIP"

obPGPHandler.setFormat("armored"); //"amored" or "binary"

and then you can package the payload with PGP processing:

obPGPHandler.packageMessage();

Copyright © Cloud Software Group, Inc. All rights reserved.