Configure the SWIFTNet7 Adapter for SWIFTNet 7

About this task

To configure the SWIFTNet7 Adapter:

Procedure

  1. Select Deployment > Services > Configuration.
  2. Search for SWIFTNet7 Adapter or select it from the list and click Go!.
  3. Click Edit.
  4. Specify field settings in the Admin Console.
    Note: Specify failover processing to ensure that failover is supported if a SAG connection fails by configuring failover-SAG.

    Use the field definitions in the following table to create a new configuration of the SWIFTNet7 adapter, or to set up the configuration provided with the application.

    Note:

    The business entities (accessible through the Business Entities wizard as part of the SWIFTNet7 adapter configuration) are shared by both RA1 and RA2. The Business Entities wizard enables you to add multiple entities.

    Field
    Description
    Name
    Unique and meaningful name for the adapter configuration. Required.
    Description
    Meaningful description for the adapter configuration, for reference purposes. Required.
    Environment
    Select the environment in which the adapter will run. Required.
    Note: The adapter is not eligible to run in the adapter container.
    Select a Group
    Select one of the options:
    • None – Do not include the configuration in a service group at this time.
    • Create New Group – Enter a unique name for a new group, which will be created with this configuration. (You can then add other services to the group as well.)
    • Select Group – If service groups already exist for this service type, they are displayed in the list. Select a group from the list.
    SI Server Address
    The callback IP of Sterling B2B Integrator for the SWIFTNet Servers. Required.
    Note: The default value is the IP address of the machine where the Sterling B2B Integrator is installed.
    SI HTTP Server Adapter Port
    This is the listening port for the SWIFTNet7 HTTP Server Adapter. Required. The default populated value is the instance port number of the Sterling B2B Integrator instance plus 53. For example, if the Sterling B2B Integrator instance port is 34600, the listening port populated by default is 34653.
    Note: The HTTP Server adapter functions between the SWIFTNet7 adapter and the SWIFTNet Servers. For an SSL connection, this value should be server name because the certificate is made with the server name.
    Note: If you are using the SWIFTNet7 adapter in your current installation, prior to installing a new version of the Standards Library, you need to note the value you have configured for this parameter. This parameter may be overwritten during the upgrade process (replaced with the default value). If this parameter is overwritten, you need to restore it to the original value after the upgrade process is complete.
    MEFG SWIFTNet Address
    The IP address of the SWIFTNet Servers. Required.
    MEFG SWIFTNet Port
    The port of the SWIFTNet Servers. Required.
    CLA2Client Listening Port
    The listening port used by the client command adapter (CLA2Client) running along the SWIFTNet Servers. Required.
    Note: This port listens for requests to start and stop the SWIFTNet Servers.
    MEFG SWIFTNet Home
    The home directory of the SWIFTNet Servers. Required.
    Start MEFG SWIFTNet despite errors
    Whether to start the SWIFTNet Servers if errors occur. The default is unchecked (do not start the SWIFTNet Servers if errors occur). Optional.
    Use SSL
    Whether to enable Secure Socket Layer (SSL) over HTTP communication between the Sterling B2B Integrator and the SWIFTNet Servers. Valid values are False (default) and True. Select True to use SSL with an Input Channel.
    Event Status Tracking
    The event status tracking for the adapter. Required. Valid selections are Minimal (Only Completed, Rejected, Duplicated status) - this is the default, and Full.
    Cipher Strength
    Specifies the strength of the algorithms (cipher suites) used to encrypt data. Valid values are:
    • STRONG - Required if Use SSL is Must
    • ALL - All cipher strengths are supported
    • WEAK - Often required for international trade, because government regulations prohibit STRONG encryption from being exported

    Default is ALL. Required if Use SSL is checked.

    CA Certificate
    Move one or more CA Certificates to the use column. These are the digital security certificates that the SSL server will use to authenticate the client. Required if SSL is selected.
    Message Partner Client Name
    The client message partner name that the SNL server application recognizes for the SWIFTNet Servers client application.
    Note: The Message Partner Client Name must correspond to the Application Interface Message Partner that is defined on the SAG as the client interface for the SWIFTNet Servers.
    Message Partner Server Name
    The server message partner name that the SNL server application recognizes for the SWIFTNet Servers server application.
    Note: The Message Partner Server Name must correspond to the Application Interface Message Partner that is defined on the SAG as the client interface for the SWIFTNet Servers.
    Delivery Notification
    Determines whether the server requests a delivery notification when a business partner is downloading. Possible values are True and False (default). Required.
    Delivery Notification Request Type
    The request type of the delivery notification is the value SI SWIFTNet Server uses in the response after getting a request from a remote client. Required.
    Configure for failover SAG?
    Enables you to set up Failover SAG Configuration using two separate instances of the Remote API (RA), RA1 and RA2. Each RA should be configured to point to a different SAG to support failover processing. Possible values are True and False (default). Required.
    Note: This parameter specifies whether to support failover if one SAG fails. When this parameter is set to True, you are presented with parameters for both an RA1 Profile and an RA2 Profile.

    When you are operating in an environment with multiple SAGs configured in failover SAG mode, setting this parameter enables you to define an alternate RA connection to a secondary SAG for failover support.
    Delivery Notification
    Determines whether the RA1 server is handling a delivery notification. Possible values are True and False (default). Optional. This is used for a FileAct Get.
    Delivery Notification DN
    Distinguished name of the responder of the delivery notification. This is used for a FileAct Get. Optional.
    Request Type of Del. Notifn
    Request type of the delivery notification. This is used for a FileAct Get. Optional.
    Return Signature List
    Whether you want to receive your own signature to safe store it in case of any dispute in the future. Valid values are False or True. Applicable only if Signature List is used. Optional for T-Copy and Y-Copy implementation.
    SWIFTNet RA
    The absolute path of the RA1 installation directory for RA1 SWIFTNet. Required. For example, /SWIFTAlliance/RA.
    Note: This parameter specifies where to pick up the remote API and execute to SAG.
    Config
    The relative path of the RA1 instance configuration directory (relative to the RA installation directory). Required. For example, RA1/cfg.
    Note: If you are using the SWIFTNet7 Adapter in your current installation, prior to installing a new version of the Standards Library, you need to note the value you have configured for this parameter. This parameter may be overwritten during the upgrade process (replaced with the default value). If this parameter is overwritten, you need to restore it to the original value after the upgrade process is complete.
    Bin
    This is added to the PATH environment variable to contain the SWIFTNet Server binaries. Possible value is bin. Required.
    Note: If you are using the SWIFTNet7 Adapter in your current installation, prior to installing a new version of the Standards Library, you need to note the value you have configured for this parameter. This parameter may be overwritten during the upgrade process (replaced with the default value). If this parameter is overwritten, you need to restore it to the original value after the upgrade process is complete.
    Lib
    This is added to the library path environment variable. Possible value is lib. Required.
    Note: If you are using the SWIFTNet7 Adapter in your current installation, prior to installing a new version of the Standards Library, you need to note the value you have configured for this parameter. This parameter may be overwritten during the upgrade process (replaced with the default value). If this parameter is overwritten, you need to restore it to the original value after the upgrade process is complete.
    Category
    This is the category of RA. Possible values are:
    • RA (SNL facade library to access an SAG)
    • SNL (a native SNL interface)
    • DEFAULT (default set for the RA1 instance)

    Required.

    Note: If you are using the SWIFTNet7 Adapter in your current installation, prior to installing a new version of the Standards Library, you need to note the value you have configured for this parameter. This parameter may be overwritten during the upgrade process (replaced with the default value). If this parameter is overwritten, you need to restore it to the original value after the upgrade process is complete.
    Delivery Responder DN
    The distinguished name of the responder to which delivery notifications requested by the sender are sent. Optional.
    Note: If left blank, Delivery Notifications requested by the server are sent to the responder indicated in the message; otherwise, it is sent to this responder
    SWIFTNet RA
    The absolute path of the RA2 installation directory for RA2 SWIFTNet. Required (based on Failover SAG Configuration). For example, /SWIFTAlliance/RA.
    Note: This parameter is only displayed if Failover SAG Configuration is set to True.
    Config
    The relative path of the RA2 instance configuration directory (relative to the RA2 installation directory). Required (based on Failover SAG Configuration). For example, /RA2/cfg.
    Note: This parameter is only displayed if Failover SAG Configuration is set to True.
    Note: If you are using the SWIFTNet7 Adapter in your current installation, prior to installing a new version of the Standards Library, you need to note the value you have configured for this parameter. This parameter may be overwritten during the upgrade process (replaced with the default value). If this parameter is overwritten, you need to restore it to the original value after the upgrade process is complete.
    Bin
    This is added to the PATH environment variable to contain the SWIFTNet Server binaries. Required (based on Failover SAG Configuration).
    Note: This parameter is only displayed if Failover SAG Configuration is set to True.
    Note: If you are using the SWIFTNet7 Adapter in your current installation, prior to installing a new version of the Standards Library, you need to note the value you have configured for this parameter. This parameter may be overwritten during the upgrade process (replaced with the default value). If this parameter is overwritten, you need to restore it to the original value after the upgrade process is complete.
    Lib
    This is added to the library path environment variable. Required (based on Failover SAG Configuration).
    Note: This parameter is only displayed if Failover SAG Configuration is set to True.
    Note: If you are using the SWIFTNet7 Adapter in your current installation, prior to installing a new version of the Standards Library, you need to note the value you have configured for this parameter. This parameter may be overwritten during the upgrade process (replaced with the default value). If this parameter is overwritten, you need to restore it to the original value after the upgrade process is complete.
    Category
    This is the category of RA2. Possible values are:
    • RA (SNL facade library to access an SAG)
    • SNL (a native SNL interface)
    • DEFAULT (default set for the RA1 instance)

    Required (based on Failover SAG Configuration).

    Note: This parameter is only displayed if Failover SAG Configuration is set to True.
    Note: If you are using the SWIFTNet7 Adapter in your current installation, prior to installing a new version of the Standards Library, you need to note the value you have configured for this parameter. This parameter may be overwritten during the upgrade process (replaced with the default value). If this parameter is overwritten, you need to restore it to the original value after the upgrade process is complete.
    Delivery Responder DN
    The responder to which delivery notifications requested by the sender are sent. Required (based on the failover SAG configuration).
    Note: If left blank, Delivery Notifications requested by the server are sent to the responder indicated in the message; otherwise, it is sent to this responder This parameter is only displayed if failover SAG Configuration is set to True.
    New Security Context
    Click add to create a new security context for the Output Channel Configuration or click edit to modify an existing entry.
    Note: You must have at least one security context created to proceed. This is the authorization context to open the output channel.
    UserId
    The user identifier for this business entity (to log in to SWIFTNet). Required for each configured entity.
    Password (RA1)
    The user password for this security context for RA1. Required for each configured entity.
    Note: This password is automatically encrypted. This parameter is only displayed if you edit an existing Security Context or add a new Security Context.
    Password (RA2)
    The user password for this security context for RA2. If not specified, the RA2 password is considered to be equal to the RA1 password. Optional.
    Note: This password is automatically encrypted. This parameter is only displayed if you edit an existing Security Context or add a new Security Context.
    New Business Entity
    Click add to create a new business entity or click edit to modify an existing entity.
    Note: You must have at least one business entity created to proceed.
    Entity
    Identifies the security context to be used. For the client, the business entity is the requester. For the server, the business entity is the responder.
    The SWIFTNet7 Adapter enhances business entities. You are not required to define an exact match for every distinguished name used for requestor or responder. The SWIFTNet Client Adapter uses the best matching algorithm to find the business entity and associated context. Therefore, if all the distinguished names used belong to the same organization (for example: o=abcdefgh,o=swift), it is sufficient for you to define one and only one business entity: o=abcdefgh,o=swift. However, if necessary, (for example if you want to ensure that cn=xyz,o=abcdefgh,o=swift will use different context), you may define another business entity for this particular distinguished name.
    Note: This is the distinguished name created by SWIFT. This parameter is only displayed if you edit an existing Business Entity or add a new Business Entity. The business entities are shared by both the RA1 and RA2 profiles.
    UserId
    The user identifier for this business entity (to log in to SWIFTNet). Required for each configured entity.
    Note: The UserName is created in SAG (in the Users Module) and must also have a certificate created for it in the SAG. This parameter is only displayed if you edit an existing Business Entity or add a new Business Entity. The SWIFTNet Client Adapter allows you to use a different security context for RA1 and RA2.
    UserId for RA2 (if different)
    The user identifier for the RA2 business entity (to log in to SWIFTNet). Required for each configured entity.
    Note: The UserName is created in SAG (in the Users Module) and must also have a certificate created for it in the SAG. This parameter is only displayed if you edit an existing Business Entity or add a new Business Entity and only displayed if Failover SAG Configuration is enabled.
    Use Default Delivery Notification
    Indicates whether to use the default delivery notification configuration. Required.
    Delivery Notification (Del. Notifn)
    Indicates whether the sender asked the receiver to send a delivery notification. Optional. Valid values are True (default) or False.
    Note: This parameter is only available when Use Default Delivery Notification is not selected.
    Request Type of Del. Notifn
    If Delivery Notification (Del. Notifn) is set to True, the value of this parameter is used to request a specific delivery notification message from the remote receiving server application when it returns the delivery notification. Optional.
    Note: This parameter is only available when Use Default Delivery Notification is not selected.
    Use Input Channel (for InterAct Store and Forward only)
    Whether to use the input channel with this adapter. Valid values are False (default) and True. You must select True if you are using an input channel. Required.
    Note: Used for InterAct store-and-forward only. If you configure this parameter, the SWIFTNet Servers opens the Input Channel automatically during the startup (when the SWIFTNet7 Adapter is enabled). This Input Channel remains open until the SWIFTNet Servers is shut down (or the SWIFTNet7 Adapter is disabled). During this time, you still have an option to send message using the input channel or without the input channel. All you need to do is to indicate this by using this parameter in SWIFTNet Client profile.
    Use Output Channel (for Store and Forward only)
    Whether to use the output channel with this adapter. Valid values are False (default) and True. You must select True if you are using an output channel. Required.
    Note: Used for store-and-forward only.
    Input Channel Name
    The name of the input channel. Required only if you specified True for Use Input Channel.
    Authoriser DN
    The authorized distinguished name that will be used to open the input channel. Required only if you specified True for Use Input Channel.
    Force Open the Input Channel
    Whether to force open the input channel or use normal mode. Valid values are False (use normal mode, which is the default) and True (force the input channel). Required only if you specified True for Use Input Channel.
    Max. Resend Attempts
    The maximum number of retries that should be attempted before sending the Resolve Gap request. Required. The default is three.
    New Queue
    Click add to create a new queue or click edit to modify an existing entry.
    Note: If you are using an Output Channel, you must have at least one queue created to proceed.
    Queue Name
    The name of the queue you are creating. Optional.
    Output Channel Name
    The name of the output channel. Required if you are using an Output Channel.
    Note: This name must be unique and can only be associated with one SWIFTNet7 Adapter instance. By default there is an output channel with the same name as the queue name. Alternatively, you may create the output channel first using the utility provided.
    Operating DN
    The distinguished name of the operator. Optional.
    SNL Endpoint
    The endpoint for SNL. Optional.
    Traffic Filter #1
    Traffic filter to be applied first. Optional. Valid values are System, InterAct, FileAct, Urgent, Normal, System_Urgent, System_Normal, InterAct_Urgent, InterAct_Normal, FileAct_Normal, FileAct_Urgent, Not Applicable.
    Traffic Filter #2
    Traffic filter to be applied second. Optional. Valid values are System, InterAct, FileAct, Urgent, Normal, System_Urgent, System_Normal, InterAct_Urgent, InterAct_Normal, FileAct_Normal, FileAct_Urgent, Not Applicable.
    Traffic Filter #3
    Traffic filter to be applied third. Optional. Valid values are System, InterAct, FileAct, Urgent, Normal, System_Urgent, System_Normal, InterAct_Urgent, InterAct_Normal, FileAct_Normal, FileAct_Urgent, Not Applicable.
    Traffic Filter #4
    Traffic filter to be applied fourth. Optional. Valid values are System, InterAct, FileAct, Urgent, Normal, System_Urgent, System_Normal, InterAct_Urgent, InterAct_Normal, FileAct_Normal, FileAct_Urgent, Not Applicable.
    Traffic Filter #5
    Traffic filter to be applied fifth. Optional. Valid values are System, InterAct, FileAct, Urgent, Normal, System_Urgent, System_Normal, InterAct_Urgent, InterAct_Normal, FileAct_Normal, FileAct_Urgent, Not Applicable.
    Traffic Filter #6
    Traffic filter to be applied sixth. Optional. Valid values are System, InterAct, FileAct, Urgent, Normal, System_Urgent, System_Normal, InterAct_Urgent, InterAct_Normal, FileAct_Normal, FileAct_Urgent, Not Applicable.
    Reception Directory
    The full directory path where the file is received and stored during FileAct Put mode. Required for FileAct. Optional.
    Download Directory
    The full directory path where the file is picked up and sent to the requestor during FileAct Get mode. Required for FileAct. Optional.
    Enable Service for Business Process
    Whether the adapter is enabled to be used with business processes. Optional.
  5. After configuring the SWIFTNet7 Adapter in the Admin Console, click the Enable Service for Business Process check box on the Confirm page to enable the instance.
  6. Once the SWIFTNet7 Adapter is configured and saved, click the Enabled check box on the Services Configuration page. This starts the SWIFTNet Servers. You should wait to ensure that the SWIFTNet Servers starts.
  7. On the Confirm page, verify that the Enable Service for Business Processes check box is selected to enable the adapter instance.