SWIFT Alliance Gateway Adapter Connectivity Map Properties
The SWIFT AG Adapter Connectivity Map Properties include the following parameter sections:
Envelope
The Envelope section of the SWIFT AG Adapter Connectivity Map properties contains the
top-level parameters displayed in the table.
Connectivity Map - Envelope
|
|
|
|
Specifies the name of the Application
Interface Message Partner. The Message Partner basically identifies an application that sends and
receives messages on behalf of a user. |
The name of the Application Interface Message
Partner. This property is mandatory. |
|
Specifies the cryptographic mode for Relaxed SNL Protocol:
Empty (blank) indicates automatic mode.
Advanced: indicates advanced mode. Relaxed SNL Protocol does not support manual cryptographic mode.
|
Advanced or
blank indicating the selected Context ID. The configured default is Advanced. |
|
Specifies the format
of the current message. Each of the names of the required values denotes
a SWIFT Alliance Gateway message format. |
The default value is Sag:RelaxedSNL.
Note - This property is
grayed out to indicate that the property is not configurable. |
|
Specifies the name of the
SWIFT Alliance Gateway Sender. This is an SAG operator. |
The name of the sender. |
|
Specifies
the password of the SAG operator. |
The SAG operator password. |
|
Primitive Control
The Primitive Control section of the SWIFT AG Adapter Connectivity Map properties contains
the top-level parameters displayed in the table.
Connectivity Map - Primitive Control
|
|
|
Include XML Attributes in SNL Primitive |
Specifies the construction/marshalling of SNL
primitives. When the SWIFT AG Adapter constructs/marshals the SNL primitives, this flag indicates whether
the adapter includes the XML attributes in the primitives. For example:
For element SwInt:Requestor, including XML attributes, is as follows: <SwInt:Requestor type="Sw.Gbl.DN"
version="4.0.0">o=swift,o=swift</
SwInt:Requestor>
If you do not include XML attributes, as follows: <SwInt:Requestor>o=swift,o=swift
</SwInt:Requestor> If not include XML attributes.
Note - All XML attributes in SNL Primitives are defined in SNL Specification.
|
True or False. True
indicates that the adapter includes the XML attributes in the primitives. The configured default
is False. |
|
RemoteApi Base settings
The RemoteApi Base settings section of the SWIFT AG Adapter Connectivity Map properties
contains the top-level parameters displayed in the table.
Connectivity Map - RemoteApi Base settings
|
|
|
|
Specifies the maximum time
(in milliseconds) allowed between a request message and its corresponding response message. |
An integer
indicating the maximum time allowed between a request message and its corresponding response
message in milliseconds (for example, 300000 equals 5 minutes). The configured default is 300000. |
|
Specifies
the maximum time (in milliseconds) to block a read operation. |
An integer indicating
the maximum time in milliseconds to block a read operation (for example, 60000
equals 1 minute). The configured default is 60000. |
|
InterAct Client
This section maps to Primitive SwInt:ExchangeRequest. For parameters Sw<parameter name> found within this
section, refer to the SNL specification for more detailed descriptions. The InterAct Client section
of the SWIFT AG Adapter Connectivity Map properties contains the top-level parameters displayed
in the table.
Connectivity Map - InterAct Client
|
|
|
|
Specifies the SwSec_UserDN, full distinguished name used to identify and
authenticate the principal. Size is limited to 100 bytes. |
The User DN (distinguished name)
ending with o=<BIC8>,o=swift For example, cn=dandrews,o=bankn14b,o=swift |
|
Specifies the SwInt_Requestor, used to identify the Application entity
name. Size is limited to 100 bytes. |
The Requestor DN (distinguished name) ending with
o=<SWIFTNet institution BIC-8>,o=swift For example, ou=management,o=bankn14b,o=swift |
|
Specifies the SwInt_Responder, used to identify the intended responder. Size is
limited to 100 bytes. |
The Responder DN (distinguished name) ending with o=<SWIFTNet institution BIC-8>,o=swift For
example, cn=management,o=swift,o=swift |
|
Specifies the SwInt_Service, the Service Name containing the SWIFTNet service used. Size is
limited to 30 bytes. |
The Service Name. For example, swift.cte, swift.generic.ia!x, swift.generic.iast!x, and so forth. |
|
Specifies
the SwInt_RequestType, used to identify the message type of the XML message using
the standard message code. Size is limited to 30 bytes. |
The Request Type. For example, camt.005.001.02
(GetTransaction) |
|
Specifies the SwInt_RequestRef. This is used to associate a request message with subsequent
response or error messages. Size is limited to 30 bytes. |
A user reference of
30 bytes or less. |
|
Specifies whether the request contains Crypto operations to be
performed. Only the last Crypto block is analyzed. SwInt_RequestCrypto (digital signature). |
True or False. True
indicates that the request contains Crypto operations to be performed. The configured default is
False. |
|
Specifies the SwInt_Priority. The priority of delivery. In the future, SWIFTNet may implement
this priority through schemes such as top-queuing, dedicated server processes, network transport priority. In
the current implementation, differentiation on priority may be used for store-and-forward delivery. |
Normal or
Urgent. The configured default is Normal. |
|
Specifies whether SwInt_NRIndicator, non-repudiation support is being requested. |
True or
False. True indicates that non-repudiation is requested. The configured default is False. |
Delivery Notification Queue Name |
Specifies the SwInt_NotifQueue,
store-and-forward delivery mode. When a value is present, it indicates SnF delivery mode
and the queue where SnF delivery notifications are received. In the case of non-delivery
(Rejected or Failed message), an SnF failed notification is always generated in this
notification queue. In the case of delivery (Accepted or Duplicated message) an SnF
delivery notification is optionally generated in this queue. |
For store-and-forward delivery mode, enter the
name of the delivery notification queue. Size is limited to 30 bytes. For example, ptsauszz_generic!x.
(see Sw:DeliveryNotif) |
Ask Positive Delivery Notification |
Specifies Sw_DeliveryNotif, delivery notification. This is for store-and-forward delivery mode only. Indicates whether
a delivery notification is required in case of successful delivery (Accepted or Duplicated). |
True
or False. True indicates that a delivery notification is required. The configured default is False. |
|
InterAct Client with Store and Forward
This section maps to the parameter Sw:AcquireSnFRequest of the Primitive Sw:ExchangeSnFRequest. For parameters
Sw<parameter name> found within this section, refer to the SNL specification for more detailed
descriptions. The InterAct Client with Store and Forward section of the SWIFT AG
Adapter Connectivity Map properties contains the top-level parameters displayed in the table.
Note - For more information on SWIFT Alliance Gateway configuration properties in the context of
SWIFT Alliance Gateway, refer to the SWIFT Alliance Gateway and SNL user documentation
provided by SWIFT.
Connectivity Map - InterAct Client with Store and Forward
|
|
|
|
Specifies the name of the queue (SwInt_Queue). |
The User SwInt_Queue. For
example, ptsauszz_generic!x Size is limited to 30 bytes. |
|
Specifies the Sw_ForceAcquire. Indicates whether an acquisition
request must be accepted in case the queue is already acquired. |
True or False.
True indicates that an acquisition request must be accepted. The configured default is True. |
|
Specifies
the usage mode of the queue. This property is purposely disabled. |
The default setting
is Pull. Pull is the correct setting for client mode.
Note - This property is purposely
disabled. |
|
Specifies the Sw_OrderBy. Indicates the order priority in which the messages are retrieved
on the queue. The options are:
|
InterAct, blank, FileAct, or Urgent. The configured default is
InterAct. |
|
Specifies the Sw_RecoveryMode. Indicates whether the session must be opened in recovery mode.
Messages that already have an output sequence number are sent first, before considering
the selected order. |
True or False. True indicates that the session must be opened in recovery
mode. The configured default is False. |
|
FileAct Client
This section maps to the Primitive Sw:ExchangeFileRequest. For parameters Sw<parameter name> found within this
section, refer to the SNL specification for more detailed descriptions. The FileAct Client
section of the SWIFT AG Adapter Connectivity Map properties contains the top-level parameters
displayed in the table.
Connectivity Map - FileAct Client
|
|
|
|
Specifies the SwSec_UserDN. Used to identify and authenticate the
principal. Size is limited to 100 bytes. |
The User DN (distinguished name) ending
with o=<BIC8>,o=swift For example, cn=dandrews,o=bankn14b,o=swift |
|
Specifies the SwInt_Requestor, the Application entity name. Size is limited
to 100 bytes. |
The Requestor DN (distinguished name) ending with o=<SWIFTNet institution BIC-8>,o=swift For example,
ou=management,o=bankn14b,o=swift |
|
Specifies the SwInt_Responder, the name of the intended responder. Size is limited to
100 bytes. |
The Responder DN (distinguished name) ending with o=<SWIFTNet institution BIC-8>,o=swift For example, cn=management,o=swift,o=swift |
|
Specifies
the SwInt_Service, the Service Name containing the SWIFTNet service used. Size is limited
to 30 bytes. |
The Service Name. For example, swift.cte, swift.generic.fa!x, swift.generic.fast!x, and so forth. |
|
Specifies the
SwInt_RequestType, used to identify the message type of the XML message using the
standard message code. Size is limited to 30 bytes. |
The Request Type. For example, camt.005.001.02
(GetTransaction) |
|
Specifies the SwInt_RequestRef. This is used to associate a request message with subsequent
response or error messages. Size is limited to 30 bytes. |
A user reference of
30 bytes or less. |
|
Specifies whether the request contains Crypto operations to be
performed. Only the last Crypto block is analyzed. SwInt_RequestCrypto (digital signature). |
True or False. True
indicates that the request contains Crypto operations to be performed. The configured default is
False. |
|
Specifies the SwInt_Priority. The priority of delivery. In the future, SWIFTNet may implement
this priority through schemes such as top-queuing, dedicated server processes, network transport priority. In
the current implementation, differentiation on priority may be used for store-and-forward delivery. |
Normal or
Urgent. The configured default is Normal. |
|
Specifies whether SwInt_NRIndicator, non-repudiation support is being requested. |
True or
False. True indicates that non-repudiation is requested. The configured default is False. |
Delivery Notification Queue Name |
Specifies the SwInt_NotifQueue, store-and-forward delivery
mode. When a value is present, it indicates SnF delivery mode and the
queue where SnF delivery notifications are received. In the case of non-delivery (Rejected
or Failed message), an SnF failed notification is always generated in this notification
queue. In the case of delivery (Accepted or Duplicated message) an SnF delivery notification
is optionally generated in this queue. |
For store-and-forward delivery mode, enter the name
of the delivery notification queue. Size is limited to 30 bytes. For example, ptsauszz_generic!x. (see
Sw:DeliveryNotif). |
Ask Positive Delivery Notification |
Specifies Sw_DeliveryNotif, delivery notification. This is for store-and-forward delivery mode only. Indicates whether a
delivery notification is required in case of successful delivery (Accepted or Duplicated). |
True or
False. True indicates that a delivery notification is required. The configured default is False. |
Remote File Handler TransferEP |
Specifies
the Sw_TransferEP, the Transfer EndPoint name used for the remote file handler. Value
options:
Blank value: indicates that the file transfer does not use the remote file handler.
Transfer EndPoint name: When this value is present, the file transfer uses the remote file handler. Before the file transfer starts you need to start the remote file handler process with the specified Transfer EndPoint name on your system. The command to start the remote file handler (swfa_handler) requires the command-line arguments: swfa_handler <HostName>:<PortNumber>[:ssl] <TransferEndpoint> [<Process ID>] Here are some examples:
swfa_handler snlhost:48003:ssl MyUniqueEndpoint 23450
swfa_handler snlhost:48003 MyUniqueEndpoint 23450
swfa_handler snlhost:48003 MyUniqueEndpoint
As for the syntax details and operational guidelines of remote file handler, refer to the SWIFTNet Service Design Guide or contact the system administrator.
|
The Transfer EndPoint name used for the remote file handler. Size is limited
to 30 bytes. |
|
Specifies BlockFileTransfer. This indicates whether the function call will finish when
a final file status is returned. This may be useful for the large file
transfers. The final status values for file transfer are,
Completed
Duplicated
Aborted
Failed
Rejected
Unknown
|
True or False. True indicates
that the function call will finish when a final file status is returned. The
configured default is True. |
|
FileAct Client with Store and Forward
This section maps to parameter Sw:AcquireSnFRequest of Primitive Sw:ExchangeSnFRequest. For parameters Sw<parameter name> found within
this section, refer to the SNL specification for more detailed descriptions. The InterAct
Client with Store and Forward section of the SWIFT AG Adapter Connectivity Map
properties contains the top-level parameters displayed in the table.
Connectivity Map - FileAct Client with Store and Forward
|
|
|
|
Specifies the SwInt_Queue. For example,
ptsauszz_generic!x. Size is limited to 30 bytes. |
The User SwInt_Queue. For example, ptsauszz_generic!x |
|
Specifies the
Sw_ForceAcquire. Indicates whether an acquisition request must be accepted if a queue is already
acquired. |
True or False. True indicates that an acquisition request must be accepted. The configured default
is True. |
|
Specifies the usage mode of the queue. This property is purposely disabled. |
The
default setting is Pull. Pull is the correct setting for client mode.
Note - This property
is purposely disabled. |
|
Specifies the Sw_OrderBy. Indicates the order priority in which the messages
are retrieved on the queue. The options are:
|
InterAct, blank, FileAct, or Urgent. The configured
default is FileAct. |
|
Specifies the Sw_RecoveryMode. Indicates whether the session must be opened in
recovery mode. Messages that already have an output sequence number are sent first,
before considering the selected order. |
True or False. True indicates that the session must be
opened in recovery mode. The configured default is False. |
|
FileAct Client with Get File
This section maps to the parameter Sw:GetFileRequest of the Primitive Sw:ExchangeFileRequest. For parameters
Sw<parameter name> found within this section, refer to the SNL Specification for more detailed
descriptions. The FileAct Client with Get File section of the SWIFT AG Adapter
Connectivity Map properties contains the top-level parameters displayed in the table.
Connectivity Map - FileAct Client with Get File
|
|
|
|
Specifies the
Sw_TransferDescription, user information about the file transfer. Free text. Size is limited to 256
bytes. |
The transfer description. |
|
Specifies the Sw_TransferInfo, user information about the file transfer. Structured data
that can be analyzed by the server. Size is limited to 256 bytes. |
The transfer
information. |
|
Specifies the Sw_LogicalName, the logical name of the file to get. This name
is communicated to the server application. By default, this name is the physical
name without path. Size is limited to 254 bytes. |
The logical file name. |
|
Specifies the
Sw_PhysicalName, the full physical name where the file to get must be stored.
If the file already exists it is overwritten. Size is limited to 254 bytes. |
The
physical file name. |
|
Specifies the Sw_MaxSize, the maximum accepted file size. When a value
is present, the maximum size is a field that is communicated from the
client application to the server application. This property is optional. Size range is
0 to 250 Megabytes. |
The maximum file size. |
|
FileAct Client with Put File
This section maps to parameter Sw:PutFileRequest of the Primitive Sw:ExchangeFileRequest. For parameters Sw<parameter name> found within
this section, refer to the SNL Specification for more detailed descriptions. The FileAct
Client with Put File section of the SWIFT AG Adapter Connectivity Map properties
contains the top-level parameters displayed in the table.
Connectivity Map - FileAct Client with Put File
|
|
|
|
Specifies the Sw_TransferDescription, This is
information about the file transfer. Free text. Size is limited to 256 bytes. |
The
transfer description. |
|
Specifies the Sw_TransferInfo, information about the file transfer. This is structured data
that can be analyzed by the server. Size is limited to 256 bytes. |
The transfer
information. |
|
Specifies the Sw_LogicalName, the logical name of the file to put. This name
is communicated to the server application. By default, this name is the physical
name without path. Size is limited to 254 bytes. |
The logical file name. |
|
Specifies the
Sw_PhysicalName, the full physical name of the file to put. Size is limited
to 254 bytes. |
The physical file name. |
|
Specifies the Sw_FileDescription. This is user information about
the file. Free text. Size is limited to 256 bytes. |
The file description. |
|
Specifies the
Sw_FileInfo, user information about the file. This is structured data that can be
analyzed by the server. Size is limited to 256 bytes. |
The file information. |
|
FileAct Client with SnF Fetch File
This section maps to Primitive Sw:FetchFileRequest. For parameters Sw<parameter name> found within this section, refer
to the SNL Specification for more detailed descriptions. The FileAct Client with SnF
Fetch File section of the SWIFT AG Adapter Connectivity Map properties contains the
top-level parameters displayed in the table.
Connectivity Map - FileAct Client with SnF Fetch File
|
|
|
|
Specifies the Sw_PhysicalName, the full physical name
where the file is stored locally. Size is limited to 254 bytes. |
The physical
file name. |
|
Connection Establishment
The Connection Establishment section of the SWIFT AG Adapter Connectivity Map properties
defines configuration parameters used to control the connection establishment. It contains the top-level parameters
displayed in the table.
Connectivity Map - Connection Establishment
|
|
|
Always Create New Connection |
Specifies whether to ALWAYS try to create a
new connection for a connection establishment request. The options are:
|
True or False. The configured
default is False. |
Auto Disconnect Connection |
Specifies whether the adapter closes the connection automatically after the work
is finished on the connection.
|
True or False. The configured default is False. |
|