Downloading, Installing, and configuring the IBM Sterling Intelligent Promising file transfer adapter

Install and configure the file transfer adapter to transfer data to Sterling Intelligent Promising. By using the file transfer adapter, you can transfer various data types from other systems. These data types are important to the process to combine and harmonize data from multiple sources into a unified, coherent format that can be used for various analytical, operation, and decision-making purposes.

Before you begin

  1. Before you use the file transfer adapter, ensure that your system meets the following system requirements:
    • Java™ 11 or newer is installed.
    • Capability is present to run a Linux® shell script.
      • This includes Unix-based systems and any other system with similar capabilities.
    • Executable permissions are available to run the shell script that is provided with the file transfer adapter distribution.
  2. Provision your IBM Cloud® Object Storage bucket. For more information, see Getting started with IBM Cloud Object Storage.
  3. Gather the following provisioning information about your IBM Cloud Object Storage bucket to provide to the file transfer adapter:
    • Endpoint URL for your IBM Cloud Object Storage service instance.
    • Region or geographical location of your service instance.
    • IAM key for IBM Cloud Object Storage. For more information, see IAM overview.
    • Your bucket name.
    • Your provisioned Sterling Intelligent Promising tenant ID.
  4. Review the data model and prepare your files. For more information, see Data feed types.

About this task

The file transfer adapter is used to transfer files between your system and Sterling Intelligent Promising. Install the file transfer adapter on each environment from which you are transferring content to Sterling Intelligent Promising.

Procedure

  1. To download the sip-cos-file-adapter-dist<version>.zip file from Fix Central, complete the following steps:
    1. In your web browser, open Fix Central.
    2. On the Find Product tab, in the Product selector box, type IBM Sterling Order Management System Software.
    3. From the Installed Version drop-down list, select All and click Continue .
    4. In the Individiual fix ID(s) field, type IBM Sterling Intelligent Promising and click Continue.
    5. Enter your IBMid and password and click Sign in.
    6. Select the type of download and click Continue.
    7. To download the IBM Sterling Intelligent Promising file transfer adapter, select the license agreement. Then, click Download now.
  2. Extract the sip-cos-file-adapter-dist-<version>.zip file.
    The sip-cos-file-adapter-dist-<version> directory is created. This directory is referred to as <install-dir>. The extracted package contains the following files:
    readme.txt
    A file that contains information about the file transfer adapter and instructions to follow.
    log4j2.xml
    A sample logging configuration file.
    transfer.options
    A sample configuration options file.
    sip_cos_file_adapter.sh
    A shell script to run the tool.
    lib
    A folder containing the application's executable JAR file.
  3. To verify the installation, run the shell script with the -help command-line option.
  4. For any supported operation, define the following configuration options by using these steps:
    • Use the command-line options to define the values for the configuration options that change for each transfer.
    • Use the transfer.options configuration file to define the values for the general configuration options that do not change often. For example, endpoint URL, apiKey, bucketName, or location.
      • Run the file transfer adapter tool and use the -conf path/to/transfer.options command-line option to reference the configuration file.

        The sample configuration file is provided as part of the sip-cos-file-adapter-dist-<version>.zip that you downloaded.

    General configuration options
    endpoint URL
    The endpoint URL for IBM Cloud Object Storage, for example https://s3.us-south.cloud-object-storage.appdomain.cloud. For more information, see Getting started with IBM Cloud Object Storage.
    location
    Region or geographical location for IBM Cloud Object Storage, for example, us or us-south.
    apiKey
    IAM API key required only for your IBM Cloud Object Storage
    bucketName
    The IBM Cloud Object Storage bucket name.
    tenantId
    The provisioned Sterling Intelligent Promising tenant ID that is used to tag the uploaded files. If the dataType option is provided for the UPLOAD operation, the tenantId is used to construct this <tenantId>/UPLOAD/<dataType> virtual folder path dynamically in the bucket for uploading the files.
    Specific configuration options for each tool run
    op
    The operation to be completed: UPLOAD, DOWNLOAD, and LIST.
    src
    The path to a local source file or directory to upload to the bucket.
    dataType
    The data type of the file to upload or download. If the dataType option is provided for the UPLOAD operation instead of the path option, the dataType is used to construct this <tenantId>/UPLOAD/<dataType> virtual folder path dynamically in the bucket for uploading the files. The following data types are supported by default:
    • OL (Order Line)
    • TLOG (Transaction Log)
    • INV (Inventory)
    • SUPPLY
    • MKC (Markdown)
    For more information, see Data feed types.
    downloadDest
    This is required for the DOWNLOAD operation. The local directory where the files are downloaded from the bucket. If the directory doesn't exist, it is created automatically.
    path
    The path to the root virtual folder in the bucket where files are uploaded, downloaded, or listed that is referenced by providing a blank value. This path is specified for the LIST, DOWNLOAD, and UPLOAD operations.
    If you provide a blank value for the path option, this represents the root virtual folder. As a result, for the LIST and DOWNLOAD operations, the content of the entire bucket is listed and downloaded.
    For the UPLOAD operation only, you can use this as an alternative to the dataType option to instruct the tool to use the value that is provided instead of the <tenantId>/UPLOAD/<dataType> dynamically built virtual folder path.
    listMaxSize
    The maximum number of files that are listed for the LIST operation. The default is 10000.
    deleteFilesAfterUpload
    For the UPLOAD operation, this specifies whether to delete the files permanently that are uploaded successfully from the local source directory. This is a boolean flag. No value is required.
    Configuration options that are not supported by the command-line
    supportedDataTypes
    A comma-delimited list that contains supported data types for the files to be uploaded. When you specify the dataType option, the value is validated against this list and the operation is rejected if the validation fails. The default values are:
    • OL
    • TLOG
    • INV
    • SUPPLY
    • MKC
    supportedContentTypes
    A comma-delimited list that contains upported data types for the files to be uploaded. The content type of each uploaded file is validated against this list and the operation is rejected if the validation fails. The default values are:
    • text/csv
    • text/plain
    • application/gzip
    Performance and error handling configuration options
    Note: You don't need to update the default values for the performance and error handling configuration options unless you experience performance issues or unrecoverable errors.
    maxParallelUploads
    The maximum number of files to upload in parallel. The default value is 10. To upload many small files, you can increase the default value to improve performance. However, to upload large files, where network bandwidth might be an issue, changing the default value might not improve the network performance.
    requestTimeoutMs
    The request timeout in milliseconds. The default value is 60000. Adjust the default value if you frequently encounter request timeouts.
    connectTimeoutMs
    The connect timeout in milliseconds. The default value is 10000. Adjust the default value if you frequently encounter connect timeouts.
    maxErrorRetry
    The maximum number of retry attempts for a failed request. The default value is 10. The IBM Cloud Object Storage SDK default retry policy, exponential backoff strategy, and the retry conditions are applied.
    maxHttpConnections
    The maximum number of open HTTP connections. The default value is 50.
  5. To view the configuration options that are supported, complete one of the following steps:
    • Review the configuration options that are provided in the transfer.options file.
    • Run the shell script that is provided with the -help command-line option to view the supported configuration options.