FTP Client SITE Service
The FTP Client SITE service sends site-specific control commands to an FTP server.
The following table provides an overview of the FTP Client SITE service:
System name | FTP Client SITE Service |
---|---|
Graphical Process Modeler (GPM) categories | All Services, B2B Protocols > FTP Client |
Description | This service is used to send site-specific control commands to an FTP server. |
Business usage | You would use this service to send site-specific control commands to a trading partner FTP server. |
Usage example | A Sterling B2B Integrator business process is executed that must send a site-specific control command to a trading partner. Sterling B2B Integrator uses the FTP Client SITE service to send a site-specific control command to the trading partner's FTP server. |
Preconfigured? | No |
Requires third-party files? | No |
Platform availability | All supported Sterling B2B Integrator platforms |
Related services | Related services:
|
Application requirements | An FTP server at the external trading partner location. Information about this server must be configured in the trading profile. |
Initiates business processes? | This service does not initiate business processes. |
Invocation | This service is invoked from a business process. |
Business process context considerations | None |
Returned status values | Returned status values:
|
Restrictions | None |
Persistence level | Default |
Testing considerations | Test this service by running the FTPClientDemoAllServices
business process provided with Sterling B2B Integrator. This
business process tests the FTP Client adapter and all its related
services. The FTPClientDemoAllServices business process uses the preconfigured
instance of the FTP Server adapter, which is disabled by default,
and must be enabled before running this test. To verify that the
preconfigured FTP Server adapter is enabled, perform the following
steps from the Sterling B2B Integrator Admin
Console:
To test this service, perform the following steps from
the Sterling B2B Integrator Admin
Console:
|
Notes | Every FTP Client service returns a response code
from the server. If this code is an error code as defined by the FTP
specification (that is, 4xx or 5xx) then the business process will
produce a fault. If the error code is expected, use an OnFault service
to continue interacting with the trading partner. There are two exceptions
to this rule:
|
Implementing the FTP Client SITE Service
To implement the FTP Client
SITE service, complete the following tasks:
- Create an FTP Client SITE service configuration (or enable the configuration installed with Sterling B2B Integrator and edit parameters as needed). For information, see Managing Services and Adapters.
- Configure the FTP Client SITE service. For information, see Configuring the FTP Client SITE Service.
- Use the FTP Client SITE service in a business process.
Configuring the FTP Client SITE Service
To configure the FTP Client SITE service, you must specify settings for the following fields in the GPM:
Field | Description |
---|---|
Config | Name of the service configuration. |
ResponseTimeout | Maximum number of seconds the FTP client waits for the server to respond before the session times out and terminates. Optional. Valid value is any numeric value. The default is the value from the FTP Client Begin Session service ResponseTimeout parameter. Minimum value you can specify is 1 second. If the value you specify is less than 1 second, the FTP Client SITE service resets the value to 1 second. |
SessionToken | Specifies the identifier for the session established
between the FTP Client adapter and an FTP server. Required. Note: The
session token is returned from the FTP Client Begin Session service.
|
SiteCommand | A site-specific control command. Required. Valid value is any site-specific command that does not require the use of a data connection. |
SaveTranscript | Indicates how to handle the transcript. Valid values
are:
|
Output from Service to Business Process
The following table contains the parameters passed from the FTP Client SITE service to the business process:
Parameter | Description |
---|---|
ServerResponse | Indicates the FTP server response, which may include a reply code and any text associated with the reply code. Required. |
TranscriptDocumentId | Identifies the document that contains a transcript of the exact exchange with the FTP server. Required. |
Output from Business Process to Service
The following table contains the parameters passed from the business process to the FTP Client SITE service:
Parameter | Description |
---|---|
ResponseTimeout | Maximum number of seconds the FTP client waits for the server to respond before the session times out and terminates. Optional. Valid value is any numeric value. The default is the value from the FTP Client Begin Session service ResponseTimeout parameter. Minimum value you can specify is 1 second. If the value you specify is less than 1 second, the FTP Client SITE service resets the value to 1 second. |
SessionToken | Specifies the identifier for the session established
between the FTP Client adapter and an FTP server. Required. Note: The
session token is returned from the FTP Client Begin Session service.
|
SiteCommand | A site-specific control command. Required. Valid value is any site-specific command that does not require the use of a data connection. |
SaveTranscript | Indicates how to handle the transcript. Valid values
are:
|
Business Process Example
The following example business process illustrates using the FTP Client SITE service:
<sequence>
[[ Insert FTP Client Begin Session ]]
<operation name="FTP SITE SERVICE">
<participant name="FTPClientSite"/>
<output message="SiteRequest">
<assign to="SessionToken"
from="/ProcessData/FtpBeginSessionServiceResults/SessionToken/text()">
</assign>
<assign to="SiteCommand">Help</assign>
</output>
<input message="inmsg">
<assign to="FTPClientSiteResults" from="*"></assign>
</input>
</operation>
[[ Insert FTP Client End Session ]]
</sequence>