Skip to main content
Previous sectionNext section

Using the FTP Inbound Adapter

This chapter describes how to use the FTP inbound adapter (EnsLib.FTP.InboundAdapter). It contains the following sections:


Ensemble also provides specialized business service classes that use this adapter, and one of those might be suitable for your needs. If so, no programming would be needed. See “Connectivity Options” in Introducing Ensemble.

Overall Behavior

The EnsLib.FTP.InboundAdapter enables Ensemble to receive files via the FTP protocol. The adapter receives FTP input from the configured location, reads the input, and sends the input as a stream to the associated business service. The business service, which you create and configure, uses this stream and communicates with the rest of the production.

If the FTP server expects an acknowledgment or response to its input, the business service is also responsible for formulating this response and relaying it back to the data source, via the EnsLib.FTP.InboundAdapter. The adapter does not evaluate or supplement the response, but relays it, if it is provided.

The following figure shows the overall flow of inbound messages (but not the responses):


In more detail:

  1. Each time the adapter encounters input from its configured data source, it calls the internal ProcessInput() method of the business service class, passing the stream as an input argument.

  2. The internal ProcessInput() method of the business service class executes. This method performs basic Ensemble tasks such as maintaining internal information as needed by all business services. You do not customize or override this method, which your business service class inherits.

  3. The ProcessInput() method then calls your custom OnProcessInput() method, passing the stream object as input. The requirements for this method are described later in “Implementing the OnProcessInput() Method.”

    If the data source expects an acknowledgment or response of some kind, the OnProcessInput() method of the business service creates it. The inbound adapter simply relays this response back to the external data source.

The response message follows the same path, in reverse.

Creating a Business Service to Use the Inbound Adapter

To use this adapter in your production, create a new business service class as described here. Later, add it to your production and configure it. You must also create appropriate message classes, if none yet exist. See “Defining Ensemble Messages” in Developing Ensemble Productions.

The following list describes the basic requirements of the business service class:

Implementing the OnProcessInput() Method

Within your custom business service class, your OnProcessInput() method should have the following signature:

Method OnProcessInput(pInput As %CharacterStream,pOutput As %RegisteredObject) As %Status
Copy code to clipboard


Method OnProcessInput(pInput As %BinaryStream,pOutput As %RegisteredObject) As %Status
Copy code to clipboard


  • pInput is the message object that the adapter will send to this business service. This can be of type %CharacterStream or %BinaryStream, depending on the contents of the expected stream. You use an adapter setting (Charset) to indicate whether the input stream is character or binary; see “Reference for Settings.”

  • pOutput is the generic output argument required in the method signature.

The OnProcessInput() method should do some or all of the following:

  1. Examine the input stream (pInput) and decide how to use it.

    This input type depends on the value of the Charset adapter setting:

  2. Create an instance of the request message, which will be the message that your business service sends.

    For information on creating message classes, see “Defining Ensemble Messages” in Developing Ensemble Productions.

  3. For the request message, set its properties as appropriate, using values in the input.

  4. Call a suitable method of the business service to send the request to some destination within the production. Specifically, call SendRequestSync(), SendRequestAsync(), or (less common) SendDeferredResponse(). For details, see “Sending Request Messages” in Developing Ensemble Productions.

    Each of these methods returns a status (specifically, an instance of %Status).

  5. Make sure that you set the output argument (pOutput). Typically you set this equal to the response message that you have received. This step is required.

  6. Return an appropriate status. This step is required.

Invoking Adapter Methods

Within your business service, you might want to invoke the following instance methods of the adapter:

Method Connect(pTimeout As %Numeric = 30,
                pInbound As %Boolean = 0) As %Status
Copy code to clipboard

Connect to the FTP server and log in, setting the directory and transfer mode.

Method Disconnect(pInbound As %Boolean = 0) As %Status
Copy code to clipboard

Disconnect from the FTP server.

Method ParseFilename(pFilenameLine As %String,
                     Output pTimestamp As %String,
                     Output pSize As %String) As %Boolean
Copy code to clipboard
Method TestConnection()
Copy code to clipboard

Correct the properties reflecting the connection state, in case the adapter thinks it is connected but has lost the socket.

The following methods are also available. Each method corresponds to an adapter setting that the user can adjust using the Management Portal. Each time the user clicks Apply to accept changes to the value of a Setting, the corresponding SettingSet method executes. These methods provide the opportunity to make adjustments following a change in any setting. For detailed descriptions of each setting, see “Reference for Settings.”

Method ArchivePathSet(pInVal As %String) As %Status
Copy code to clipboard

ArchivePath is the directory where the adapter should place a copy of each file after processing.

Method CharsetSet(cset As %String) As %Status
Copy code to clipboard

Charset is the character set of the input file.

Method ConnectedSet(pValue As %Boolean) As %Status
Copy code to clipboard

Connected is an internal property that tracks the adapter’s connection to the FTP server.

Method CredentialsSet(pInVal As %String) As %Status
Copy code to clipboard

Credentials is an Ensemble credentials entry that can authorize a connection to the FTP server. For information on creating Ensemble credentials, see Configuring Ensemble Productions.

Method FilePathSet(path As %String) As %Status
Copy code to clipboard

FilePath is the directory on the FTP server in which to look for files.

Method FTPPortSet(port As %String) As %Status
Copy code to clipboard

FTPPort is the TCP Port on the FTP Server to connect to.

Method FTPServerSet(server As %String) As %Status
Copy code to clipboard

FTPServer is the FTP Server to connect to. This can be the IP address or server name, as long as the domain host controller can resolve the name.

Method SSLConfigSet(sslcfg As %String) As %Status
Copy code to clipboard

SSLConfig is the SSL/TLS configuration entry to use to authenticate this connection.

Business Service Class

The following code example shows a business service class that references the EnsLib.FTP.InboundAdapter.

Class EnsLib.FTP.PassthroughService Extends Ens.BusinessService

Parameter ADAPTER = "EnsLib.FTP.InboundAdapter";

/// Configuration item(s) to which to send file stream messages
Property TargetConfigNames As %String(MAXLEN = 1000);

Parameter SETTINGS = "TargetConfigNames";

/// Wrap the input stream object in a StreamContainer message object and send
/// it. If the adapter has a value for ArchivePath, send async; otherwise send
/// synchronously to ensure that we don't return to the Adapter and let it
/// delete the file before the target Config Item is finished processing it.

Method OnProcessInput(pInput As %Stream.Object,
                      pOutput As %RegisteredObject) As %Status
  Set tSC=$$$OK, tSource=pInput.Attributes("Filename"),
  Set tWorkArchive=(""'=..Adapter.ArchivePath)

  For iTarget=1:1:$L(..TargetConfigNames, ",") {
    Set tOneTarget=$ZStrip($P(..TargetConfigNames,",",iTarget),"<>W")
    $$$sysTRACE("Sending input Stream ...")

    If tWorkArchive {
      Set tSC1=..SendRequestAsync(tOneTarget,pInput)
      Set:$$$ISERR(tSC1) tSC=$$$ADDSC(tSC,tSC1)
    } Else {
      #; If not archiving send Sync to avoid Adapter deleting file before
      #; Operation gets it
      Set tSC1=..SendRequestSync(tOneTarget,pInput)
      Set:$$$ISERR(tSC1) tSC=$$$ADDSC(tSC,tSC1)
    Quit tSC
Copy code to clipboard

This example sets the tSource variable to the original file name which is stored in the Filename subscript of the Attributes property of the incoming stream (pInput).

Adding and Configuring the Business Service

To add your business service to an Ensemble production, use the Management Portal to do the following:

  1. Add an instance of your business service class to the Ensemble production.

  2. Configure the business service. For information on the settings, see “Reference for Settings.”

  3. Enable the business service.

  4. Run the production.