SWIFTNet7 Client Service
The SWIFTNet7 Client service handles any outbound request (for SWIFTNet7). The following table provides an overview of the SWIFTNet7 Client service:
- System Name
- SWIFTNet7ClientService
- Graphical Process Modeler (GPM) categories)
- All services
- Description
- This service handles any outbound request for SWIFTNet7. Using this service you are able to accept parameters from business processes or the SWIFTNet Client Profile (profileID), and parameters can be passed from business processes or when using SWIFTNet Client Profile (you need to specify the profileName). Additionally, this service uses the HTTP Client Group, so it does not have to be linked to a specific HTTP Client Adapter instance.
- Business usage
- The SWIFTNet7 Adapter uses this service to exchange SWIFTNet InterAct and FileAct messages with its trading partners over the SWIFTNet system.
- Usage example
- You want to send an InterAct or FileAct request using SWIFTNet. You pass the parameters to the SWIFTNet7 Client service using a business process. The SWIFTNet7 Client service crafts the SWIFT request and passes it to the MEFG Server to be sent to the SWIFT network, and waits for the response. When the response is received, this service parses it and updates necessary information based on the response (for example, status or reference number).
- Preconfigured?
- Yes, preconfigured as part of the Sterling B2B Integrator installation.
- Requires third party files?
- No third party files are required.
- Platform availability
- All supported Sterling B2B Integrator platforms.
- Related services
- This is designed to work in conjunction with the SWIFTNet MEFG Server and the Command Line Adapter 2. This service works with the SWIFTNet HTTP7 Server adapter to provide SSL support, and works with the SWIFTNet7 HTTP Client adapter, SWIFTNet7 HTTP File System adapter, SWIFTNet7 Adapter, SWIFTNet7 Adapter Scheduler, SWIFTNet7 Client Service, SWIFTNet7 Server Service, SwiftNet Import ASP Service, and SwiftNet Import RMA Service.
- Application requirements
- None.
- Initiates business processes?
- No.
- Invocation
- You call this service from a business process.
- Business process context considerations
- None.
- Returned status values
- Fatal—non-recoverable error
- Transient—recoverable error
- Logic—recoverable error
- Success—Success
- Warning—Success with warning
- Restrictions
- None.
- Persistence level
- N/A
- Testing considerations
- N/A
Implementing the SWIFTNet7 Client Service
You do not need to do anything to implement the SWIFTNet7 Client service.
Configuring the SWIFTNet7 Client Service
You can pass parameters to the SWIFTNet7 Client service from a business process. The following table contains the parameters passed from the business process to the SWIFTNet7 Client service:
- Parameter
- Description
- profileName
- The name of the SWIFTNet Client Profile, if specified. If you specify this parameter, the service looks for the associated SWIFTNet Client Profile and uses all the parameters defined there. However, you may override some parameters from the business process. Those parameters that can be overridden should not be related to Application Service Profile (ASP). If there is no profileName parameter is specified, all the parameters are taken only from the business process. These parameters cannot be overridden:
- serverAdapterName
- The name of SWIFTNet7 Adapter instance or group. The service uses this instance/group name to look up its configuration for the MEFG host and port, security context and also input channel, and so forth. If this parameter is not specified, the service will look for the default instance (SWIFTNet7Adapter).
- numOfRetries
- The total number of times to resend this message in case of any transient failure. If not specified, the default is three times.
- switchToSnF
- Whether to switch to store-and-forward mode when real-time transmission fails. Select True if you want to switch to Store and Forward mode when the real-time transmission (InterAct and FileAct Put) has failed. Valid values are True and False.
- SnFServiceName
- The name of the store-and-forward service. Required when Switch to SnF mode when real-time transmission failed is set to True.
- SnF
- Indicates if the file transfer is done using the store-and-forward method. Valid values are True (use Store-and-Forward) and False (default—do not use Store-and-Forward). Required.
- swiftOp
- The SWIFTNet operation to send an InterAct or FileAct message
Possible values are:
- sync (default)—InterAct
- async—InterAct
- put—FileAct
- get—FileAct
- nonRepudiation
- Indicates whether non-repudiation is required. Possible values are TRUE (when enabled, trading partners cannot deny that they sent a request) or FALSE (default, indicating that non-repudiation is not required). Optional.
- requestType
- SWIFT request type, For example, pain.001.02.01 or xsys.018.001.01.
- serviceName
- Name of the service to which both SWIFT correspondents have subscribed. Required.
- requestReference
- User reference of the request. This parameter is alphanumeric. Optional.
- requestorDN
- Distinguished name of the requestor. Required. Note: This DN must be registered with the SAG instance using SWIFTNet Alliance Webstation.
- responderDN
- Distinguished name of the responder. Required.
- authoriserDN
- Distinguished name for the authoriser. This is used for a non-input channel to look for context.
- messagePriority
- Indicates priority handling in the queue for store-and-forward only. Optional.
- messageID
- Message identifier for resending a message if Possible Duplicate
is set to TRUE. Optional. Note: Normally, you only need to specify this if possibleDuplicate = TRUE.
- possibleDuplicate
- Indicates whether to include a trailer specifying that this message may be a duplicate.
- HeaderInfo
- The Enhanced Header information. Since Enhanced Header Info is usually an XML structure, you should specify it as CDATA.
- AppHeader
- An XML structure that is only used in InterAct case (either real-time or SnF). If this parameter is not specified, the default AppHeader structure is used (as in version 6.x).
- sign
- Whether an end-to-end signature is required. Valid values are Crypto, SignatureList, or do not specify this tag if you do not want to use signing.
- returnSignatureList
- Whether to return a signature list.
- useRND
- Whether to use RND (digest reference values that terminate on “and RND”). Valid values are False (default) and True.
- deliveryNotification
- Indicates that the sender asked the receiver to send a delivery
notification. Possible values are TRUE or FALSE. Optional. Note: This parameter is only displayed when you select True for SnF or are performing a FileAct Put. If you are performing a Put operation, you can request the responder to send you a delivery notification and specify a different Delivery Notification DN and Request Type of Delivery Notification, if desired. If you are performing a Get operation, the responder can request Delivery Notification from the requestor after receiving the file. That setting for delivery notification is configured through the SWIFTNet Server adapter. For System Message or InterAct Real-Time, this parameter will be overwritten to FALSE. Otherwise, you can choose whether you want to receive delivery notification.
- notificationQueue
- Whether a notification queue will be used. If you selected SnF = TRUE, this parameter is required.
- overdueDelay
- Specify the overdue delay. For SnF = TRUE, you must specify an integer value between 5 - 20160 (minutes). If the value between 5 - 1440, the tag <Sw:OverdueWarningDelay> will be output. Otherwise the tag <Sw:OverdueTime> will be output.
- notificationAsSystemMsg
- For SnF = TRUE, deliver the notification as system message TRUE/FALSE. If using overdueDelay, this will be set to TRUE.
- deliveryNotificationDN
- For FileAct Real-Time, this is the delivery notification distinguished name (valid DN).
- deliveryNotificationRT
- For FileAct Real-Time, this is the delivery notification Request Type.
- useInputChannel
- For InterAct SnF, whether to use the input channel.
- copyIndicator
- When using Copy Service this is an indicator that you want the Copy to occur. When ASP is used, this parameter is validated against ASP. Otherwise, when this parameter is specified, the system assumes you are using CopyService.
- authNotifIndicator
- When using Copy Service this is an indicator that you want to receive authorisation notification from third party (for Y-Copy ). If ASP is used, this parameter is validated. Otherwise, it is assumed that if this parameter is specified by the user, that this service is a Y-Copy service.
- thirdPartyDN[1..N]
- Copy destination(s). For T-Copy service, you can specify up to ten. For Y-Copy, you can only specify one. This is only validated if ASP is used.
- recipientDN[1..N]
- Allows you to specify multiple destination if it is not a copy service.
- isRecipientListPublic
- Whether the recipient list if public. Used only if recipient List is used.
- physicalFilename
- Optional. Only for FileAct. For a FileAct Put, this is the full path and the physical name of the file to send. For a FileAct Get, this is the full path and the physical name of the file to save after the Get is completed.
- logicalFilename
- This name is communicated to the server application. By default, this name is the physical name without the file path. Optional. Only for FileAct.
- transferDesc
- The transfer description. Only for FileAct. Optional.
- transferInfo
- User information about the transfer. Only for FileAct. Optional. Note: This must follow the BNF format (see Appendix C of SNL Interface Specifications).
- fileDesc
- User information about the file transfer. Only for FileAct. Optional.
- fileInfo
- User description about the file transfer. Only for FileAct. Optional. Note: This must follow the BNF format (see Appendix C of SNL Interface Specifications).
- AuthDecision
- The third party decision. Valid values are Authorised or Refused. Use this parameter with the thirdPartyAuth parameter.
- ToRcvrInfo
- If you are the third party and decide to authorize a request or file notification, this parameter enables you to specify Third Party to Receiver Information. The information can be any format (plain text or XML). If you use XML format, this parameter should be CDATA.
- ToSndrInfo
- If you are the third party and decide to authorize a request or file notification, this parameter enables you to specify Third Party to Sender Information. The information can be in any format (plain text or XML). If you use XML format, this parameter should be CDATA.
- RefuseReason
- If you are the third party and you refuse a request or file notification, you can specify a Refusal Reason in this parameter. The information can be any format (plain text or XML). If you use XML format, this parameter should be CDATA.
- MessageName
- The name of the HeaderInfo message, as inserted into the mailbox. The format is ThirdParty_[CopySnFRef]. When you use Mailbox Extract service to extract the HeaderInfo message from mailbox, by default the name is available in Process Data.
- queueName
- The queue name.
- queueSharingMode
- The queue sharing mode. Valid values are Shared or Exclusive.
- reportOption
- The report option. Depending on the system message sent, there may be different validations. For example, the xsys.004.001.01 format is RT or HHHMM. For xsys.008.001.*, the format is Full. For the xsys.018.001.01, the format is Input or Output.
- requestorPatternCriteria
- This is a request for pattern criteria. You can only use a wildcard at the last level distinguished name; the organization DN cannot use a wildcard.
- inputChannelCriteria
- This is the input channel criteria. Valid values are BIC_a or BIC_* (wild card behind, BIC must match requestorDN).
- messagingServiceCriteria
- This is the messaging service criteria. Valid values are InterAct or FileAct.
- locationCriteria
- This is the location criteria.
- serviceNameCriteria
- This is the service name criteria (specify any valid service).
- messagePriorityCriteria
- This is the message priority criteria. The valid values are Urgent or Normal.
- channelPatternCriteria
- This is the channel pattern criteria. Valid values areBIC_a or BIC_* (wild card behind, BIC must match requestorDN).
- queuePatternCriteria
- This is the queue pattern criteria. Valid values are BIC_a or BIC_* (wild card behind, BIC must match requestorDN).
- queueFirstCriteria
- This is the queue first criteria. Valid values are TRUE or FALSE.
- reportVersion
- This is the report version. Valid values are 1 or 2.
- reportStartTime
- This is the start time of the report in zulu time format (for example, 2010-05-30T15:34:21Z).
- reportEndTime
- This is the end time of the report in zulu time format (for example, 2010-05-30T15:34:21Z).