GXS ICS FTP Adapter

The GXS ICS FTP adapter sends and collects documents from the GXS Interchange Services (ICS) mailbox via the TCP/IP FTP Gateway.

The following table provides an overview of the GXS (Global Exchange Services) ICS (Interchange Services) FTP adapter:

System name GXS ICS FTP Adapter
Graphical Process Modeler (GPM) category None
Description The GXS ICS FTP Adapter is used to send and collect documents from the GXS Interchange Services (ICS) mailbox via the TCP/IP FTP Gateway.
Business usage This adapter can be used to exchange documents with the Trading Partner that uses the GXS Interchange Services mailbox.
Usage example Service initializes only the parameters required to invoke the business process explicitly. If you need to invoke the bootstrap business process GxsIcsFtp_Processing_Service of GXS system, you must add a separate invoke call after the service call in the business process configuration.
Preconfigured? No
Requires third-party files? No
Platform availability All supported Sterling B2B Integrator platforms
Related services FTP Client Adapter
Application requirements None
Initiates business processes? Yes, this adapter initiates business processes when it is in the Collect mode.
Invocation This adapter is invoked by an internal service.
Business process context considerations The configuration parameters and the outgoing document are picked up by the GXS ICS FTP adapter in the workflow context.
Workflow Context Considerations You must be familiar with the internal service (workflow context/business process parameters) that invoked this adapter. Workflow parameters are passed into the internal service and business process parameters are the values specified in the business process code.
Returned status values Returned status values:
  • 0 – Success
  • 1 – Error
Restrictions None
Persistence level System default
Testing considerations To test an instance of the GXS ICS FTP adapter, create a GXS_ICS_Adapter by clicking Deployment->Services->Configuration and choosing GXS ICS FTP Adapter. The most frequent problems encountered are:
  • Incorrect parameters are set up.
  • The adapter is not active.
If you get an error with any of these conditions, check with your System Administrator.

Implementing the GXS ICS FTP Adapter

To implement the GXS ICS FTP adapter, complete the following tasks:
  1. Activate your license for the GXS ICS FTP adapter. See An Overview of Implementing Services.
  2. Create a GXS ICS FTP adapter configuration. See Creating a Service Configuration.
  3. Configure the adapter. See Configuring the GXS ICS FTP Adapter.
  4. Create and enable a business process that includes the GXS ICS FTP adapter.
  5. Test the business process and the adapter.
  6. Run the business process.

Configuring the GXS ICS FTP Adapter

To configure the GXS ICS FTP adapter, you must specify field settings in Sterling B2B Integrator. See Creating a Service Configuration.

The following table describes the fields used to configure the GXS ICS FTP adapter in Sterling B2B Integrator:

Field Description
Name Unique and meaningful name for the adapter configuration. Required.
Description Meaningful description for the adapter configuration, for reference purposes. Required.
Select a Group Select one of the options:
  • None – You do not want to include this configuration in a group at this time.
  • Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
  • Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.
Note: See Using Service Groups.
Default GXS ICS FTP Server DNS name or IP address of the GXS ICS FTP server that Sterling B2B Integrator is to connect to. This is any valid DNS name or a dotted decimal address. The default value (myhost) is shown as an example. Required
Default GXS ICS FTP Server Port Port number of the GXS ICS FTP server. This is typically port number 21, but it can be another number depending on the FTP server settings. Default is 21. Required.
User Name User login name to connect to the GXS ICS FTP server. Alphanumeric and case-sensitive. Required.
Password Password used for authentication when connecting to the GXS ICS FTP server. Case-sensitive. Required. The password will be obscured (encrypted) and will appear as all asterisks.
SMIME Encryption User Certificate Not used
SMIME Decryption Certificate Not used
SSL Flag that determines Secure Socket Layering (SSL) socket negotiation. Required. Valid values:
  • SSL_IMPLICIT – Indicates that the GXS ICS FTP server expects and requires SSL to happen automatically at the time of connection.
  • SSL_EXPLICIT – Indicates that the GXS ICS FTP client requests SSL and a secure connection is negotiated.
  • None – Indicates that the connection will not use SSL.
Clear Control Channel Indicates if information that travels across the control channel should be clear. Required. Valid values:
  • Yes – Information will be clear
  • No – Information does not need to be clear
Key Certificate Passphrase Not used
Cipher Strength Level of encryption to be applied to the data that flows through the socket connection. Optional. Valid values:
  • ALL – All cipher strengths are supported.
  • WEAK – Often required for international trade, because government regulations prohibit STRONG encryption from being exported.
  • STRONG – Highest level of encryption.
Default is STRONG.
Key Certificate (System Store) PrivateKeys / Public Certificates that are signed by the Trading Partner Trusted Certificate Authority. In process data, this parameter is displayed as an object ID. Select a valid key certificate from the list of those already stored inside Sterling B2B Integrator. Required if the GXS ICS FTP server requires client authentication using SSL.
CA Certificates

Trusted Certificate Authority public certificate. In process data, this parameter is displayed as an object ID. Select a valid CA certificate from the list of those already stored inside the application. Required for server authentication using SSL.
Type of operation Type of operation to performValid values:
  • Collect – Collect messages from the GXS ICS mailbox
  • Submit – Submit mailbox messages to the GXS ICS mailbox
Select the type of message to collect Type of message to collect from the GXS ICS mailbox. Required if Type of operation is set to Collect. Valid values:
  • Mailbox messages – Collect mailbox messages.
  • Report – Retrieve a report.
Default is Mailbox messages.
Select the report you want to retrieve Type of report to retrieve. Required if Type of operation is set to Collect and Select the type of message to collect is set to Report. Valid values:
  • Sender Status Report
  • Sender Summary
  • Sender Unretrieved
  • Sender Error
  • Receiver Status
  • Receiver Summary
  • Third Party Reject
  • Trading Pair Trxn Detail
Specify the message retrieval criteria Whether to collect all messages or only those meeting the criteria specified in Sender or Receiver address or in Match this ILog number. Required if Type of operation is set to Collect and Select the type of message to collect is set to Mailbox messages. Valid values:
  • Download all interchanges
  • Download interchanges that match the criteria specify below
Default is Download all interchanges.
Sender or Receiver address Address on the GXS ICS FTP server to download messages from. Optional.
Match this ILog number ILog number to download messages from the GXS ICS FTP server under. Optional.
Specify the message download option How to save the downloaded documents. Required if Type of operation is set to Collect and Select the type of message to collect is set to Mailbox messages. Valid values:
  • Download all interchanges into a single document
  • Download each interchange as an individual document
Default value is Download all interchanges into a single document
Business Process Name of the business process you want this adapter to start. Required if Type of operation is set to Collect.
Run As User Applies to the scheduling of the business process. The Run As User field only displays as an option if Type of operation is set to Collect. Type the user ID to associate with the schedule, or click the icon and select a user ID from the list. Valid values:

Any valid Sterling B2B Integrator user ID

Note: This parameter allows someone who doesn't have rights to a specific business process to run it. If you select Admin as the user ID, you will inherit Administrative rights (for this run of the business process only), and enable the scheduled run.
Use 24 Hour Clock Display If selected, the adapter will use the 24-hour clock instead of the default 12-hour clock.
Schedule Information about scheduling the collection action. Required if Type of operation is set to Collect. Valid values:
  • Do not use schedule If this field is selected, the adapter does not start a business process and does not run on a schedule.
  • Run based on timer Valid values are the hour and minutes at which to run the adapter. If you choose to select a time interval, the valid values are the hours and minutes for the intervals. Add or delete selections as necessary. Specify any schedule exclusions or date exclusions. Indicate whether you want the adapter to run at startup.
  • Run daily Valid values are the hour and minutes at which to run the adapter, daily. If you choose to select a time interval, the valid values are the hour and minute for the interval. Add or delete selections as necessary. Specify any date exclusions. Indicate whether you want the adapter to run at startup.
  • Run based on days of the week Valid values are the day of the week, the hour, and the minute that specify when to run the adapter. If you choose to select a time interval, the valid values are the hours and minutes for the intervals. Add or delete selections as necessary. Specify any date exclusions.
  • Run based on days of the month Valid values are the day of the month, hour, and minute that specify when to run the adapter. If you choose to select a time interval, the valid values are the hours and minutes for the intervals. Add or delete selections as necessary. Specify any date exclusions.

Before Using the GXS ICS FTP Adapter in a Business Process

If the GXS ICS FTP server that is communicating with Sterling B2B Integrator uses SSL communication, the CA certificate object ID or system key certificate object ID (CACert or Keycert) files must be saved before the GXS ICS FTP adapter can be used in a business process. The Sterling B2B Integrator system administrator must save these certificates and private key in the Sterling B2B Integrator database.

Business Process Configuration

No GXS ICS FTP adapter parameters are configured with the Graphical Process Modeler (GPM). All parameters must be configured in Sterling B2B Integrator.

ILOG Number

A unique ILOG number is generated per file upload to the GXS ICS FTP server. The adapter captures the ILOG number and stores it in the process data. This enables the downstream workflow to act on to this information. The ILOG number is stored in the following format:

<ProcessData>
  <GXSResponses>
     <IlogNumber>7311258167</IlogNumber>
  </GXSResponses>
</ProcessData>

Certificate Authority (CA) Certificate

Currently, a GXS Server accepts any valid Verisign class 3 CA certificate. You are required to check these certificates in to the application (using Trading Partners > Digital Certificates > CA). One of these certificates must be selected when you configure the GXS ICS FTP adapter instance. Customers are encouraged to check with GXS to ensure that the GXS Server is still using Verisign as its CA prior to using the GXS ICS FTP adapter.

Example Business Process

The following sample BPML invokes an instance of the GXS ICS FTP adapter.

<process name="Test_bpml">
  <sequence name="optional">
    <operation name="Invoke an instance of GXS ICS FTP adapter ">
    <participant name="GXS_ICS_FTP_adapter"/>
      <output message="Xout">
        <assign to="." from="*"></assign>
        <assign to="INVOKE_MODE">INLINE</assign>     
        <assign to="WFD_NAME">GxsIcsFtp_Processing_Service</assign>
        <assign to="NOTIFY_PARENT_ON_ERROR">ALL</assign>
      </output>
      <input message="Xin">
         <assign to="." from="*"></assign>
      </input>
     </operation>
 </sequence>
</process>