addMessagePartner

Purpose

Use this command to add a message partner for the specified SAG. The message partner is not deployed to the SAG until someone issues the dep (deploy) command. After the message partner was deployed to the SAG it must be enabled before it can be used.

Required access rights:	See Table 4
Predefined roles that provide required access rights:	See Table 2
Issue for OU:	DNFSYSOU
Issue to service:	DNFSAGCFG

Format

The syntax of the command depends on the value specified for the parameter -type:

Client
Server
ClientServer

-type Client: syntax for addMessagePartner command

-type Client: BIMFC parameters

-type Server: syntax for addMessagePartner command

-type Server: MQHA parameters

-type Server: BIMFC parameters

-type ClientServer: syntax for addMessagePartner command

-type ClientServer: MQHA parameters

Parameters

-type type

The application type:

Client: The message partner corresponds to a client application
Server: The message partner corresponds to a server application
ClientServer: The message partner corresponds to a client or server application

-mpn msg_partner

Name of the message partner to be added. A message partner name cannot exceed 30 characters and contain only the following characters:

Uppercase letters (A - Z)
Lowercase letter (a - z)
Numerals (0 - 9)
Underscore (_)

-sag sag

Name of the SAG.

-ou ou

Name of the business OU associated with the message partner. The user must have the role DnfDNSec for this OU; only then is the user allowed to use the distinguished names (DNs) specified in the command. This parameter is mandatory if a DN is specified in this command, that is, if the -rsdn or -rqdn parameters are specified.

-mfmx msgformat

The x represents a number from 1 to 4. You can specify up to four message formats that the message partner is support:

Sag:SNL: SNL messages are supported.
Sag:Primitive: SAG primitives are supported.
Sag:BasicInterAct: Basic mode messages are supported.
Sag:RelaxedSNL: SNL messages are supported in relaxed mode.
Note: If you use SAG Add-On for SAG 7.3 or a later version, and if you specify value Sag:RelaxedSNL, then parameter -lkn is mandatory.

-cln certlistname

Name of the list of certificates that the message partner is allowed to use (see Creating and managing lists of certificates and SWIFTNet services).

-sln servicelistname

Name of the list of services that the message partner is allowed to use (see Creating and managing lists of certificates and SWIFTNet services). Do not specify a service list if the message partner is of type server.

-dfm msgformat

Default message format for emission. This parameter applies only to message partners of type Client or ClientServer. The message format must be one of the message formats specified for at least one of the -mfmx parameters.

-lkn lau_key

Name of the local authentication (LAU) that is to be used to secure the message traffic between the SFD and an SAG or between the MSIF transfer services and an SAG. This key is a CO of type DnfLAUKeyMP, as described in Configuring a LAU key to be used by a message partner.

Notes:

When using dynamic workload balancing for FIN messages, the LAU key of a message partner must be the same on each of the SAGs in the SAG cluster. For more information about dynamic workload balancing and SAG clusters, see SAG clusters.
If you use SAG Add-On for SAG 7.3 or a later version, and if you specify value Sag:RelaxedSNL for parameter -mfmx, then parameter -lkn is mandatory.

-mqha

This parameter is used to group the parameters that apply to the MQ Host Adapter (MQHA):

-name name

A name used by internal processes to identify this group of MQHA parameters. This name must be different from the name you specify for the name of the group of BIMFC parameters for this message partner. The length of this name cannot exceed 28 characters minus the lengths of the names of the message partner and SAG. For example, if the name of the message partner is 12 characters and the length of the sag name is seven characters, the length of this name cannot exceed nine characters.

-qm qm

This parameter applies only to message partners of type Server or ClientServer. It specifies the name of the queue manager of the server request queue for this message partner (that is, the queue to which server requests for this message partner are to be routed). If this parameter is not specified, the queue manager specified for the MQ connection must be able to route all server request messages to the server request queue.

-rqq rqq

This parameter applies only to message partners of type Server or ClientServer. It specifies the name of the server request queue.

-cid cid

Message coding. Normally, this should be set to 1208, which corresponds to UTF-8. For more information about character conversion, see SWIFT Alliance Gateway: MQ Host Adapter Configuration Guide.

-mex mex

Number of seconds after which messages in the following queues expire:

ClientRequestQueue (see Configuring the MQ connection)
DefaultClientResponseQueue (see Setting global parameters)
Client response queue as specified by FTM SWIFT services
ServerResponseQueue (see Configuring the MQ connection)

This value is used in the following fields:

MQMD.Expiry: The lifespan of a message in MQPUT calls
MQMD.WaitInterval: The time period that the MQGET call waits for a message to arrive

The specified value must be an integer and must be enclosed in single quotation marks. If the messages are not to expire, specify '-1'.

-con

Indicates whether conversion is enabled:

MQFMT_STRING: Conversion is to be done.
MQFMT_NONE: Conversion is not to be done. If the message partner is for FTM SWIFT, this must be set.

-env

Indicates whether the MQHA is to pass inbound messages to a server application with or without an envelope:

With: With an envelope.
Without: Without an envelope.

-bimfc

This parameter is used to group the parameters that apply to the BasicInterActMessageFormatConverter (BIMFC) plug-in. These parameters are used by the SAG to enrich basic-mode messages in order to create InterAct messages. You must specify BIMFC parameters for a client or server application that uses basic-mode messages.

-name name

A name used by internal processes to identify this group of BIMFC parameters. This name must be different from the name you specify for the name of the group of MQHA parameters for this message partner. The length of this name cannot exceed 28 characters minus the lengths of the names of the message partner and SAG. For example, if the name of the message partner is 12 characters and the length of the sag name is seven characters, the length of this name cannot exceed nine characters.

-rqdn rqdn

Distinguished name of the requestor.

-rsdn rsdn

Distinguished name of the responder.

-atdn atdn

Distinguished name of the authoriser.

-svc svc

Name of the SWIFT service to be used.

-rqtp rqtp

Type of request.

-sign sign

Distinguished name that is used for signing requests.

-encr encr

Distinguished name that is used for encrypting requests.

-nrep

Indicates whether the SIPNis to perform non-repudiation processing:

TRUE: Non-repudiation processing is performed.
FALSE: Non-repudiation processing is not performed.

-pltp

Type of payload:

Char: Character data
XML: XML format

-prty

The SWIFTNet priority:

Normal
Urgent

Examples

The following command, entered on a single line, adds the message partner MP1 to the SAG SAG1. This message partner is used for client applications. It can process only messages with the message format Sag:RelaxedSNL. This message format is also set as the default. This command specifies that the message partner is to use only those certificates listed in the certificate list with the name certlist1, and only those services listed in the service list with the name svclist1. The message partner uses the MQHA with the following configuration:

MQHA server request queue is SERVER.REQUEST.QUEUE
Coded character set ID (CCSID) is 1208
Conversion is set to MQFMT_NONE
Envelopes are enabled

INST1.DNFSYSOU.DNFSAGCFG>addMessagePartner -sag  SAG1
                                            -mpn  MP1
                                            -mfm1 Sag:RelaxedSNL
                                            -cln  certlist1
                                            -dfm  Sag:RelaxedSNL
                                            -sln  svclist1
                                            -type Client
                                            -mqha
                                            (
                                             -name MP2P
                                             -rqq SERVER.REQUEST.QUEUE
                                             -cid 1208
                                             -con MQFMT_NONE
                                             -env With
                                            )

The following command adds the message partner MP2 to the SAG SAG1. The message partner is used for client-server applications. It can process only messages with the message formats Sag:Primitive and Sag:RelaxedSNL. It sets the default message format to Sag:RelaxedSNL. This command specifies that the message partner is to use only those certificates listed in the certificate list with the name certlist1. The message partner uses the MQHA with the following configuration:

MQHA server request queue is SERVER.REQUEST.QUEUE.
Coded character set ID (CCSID) is 1208.
Conversion is set to MQFMT_NONE.
Envelopes are enabled.

Additional plug-ins are not specified for this message partner. The configuration of the MQHA in the -mqha parameter implicitly sets the active host adapter parameter to MQHostAdapter. FTM SWIFT supports only this host adapter as the active host adapter.

addMessagePartner -sag SAG1
                  -mpn  MP2
                  -type ClientServer
                  -mfm1 Sag:Primitive
                  -mfm2 Sag:RelaxedSNL
                  -cln certlist1
                  -dfm  Sag:RelaxedSNL
                  -mqha
                  (
                        -name MP2P
                        -rqq SERVER.REQUEST.QUEUE
                        -cid 1208
                        -con MQFMT_NONE
                        -env With
                  )