Configuration object types
Due to space restrictions in the following tables, some
of the names for the CTs and their values were split onto two lines,
even though each is one word.
| Attribute | Description | Possible values |
|---|---|---|
| FMTDISABLE | Allow use of the FMT FIN disable command. | (none) |
| FMTENABLE | Allow use of the FMT FIN enable command. | (none) |
| FMTRESET | Allow use of the FMT FIN reset command. | (none) |
| FMTSTART | Allow use of the FMT FIN start command. | (none) |
| FMTSTOP | Allow use of the FMT FIN stop command. | (none) |
| RECOVER | Allow use of the FMT FIN recover command. | (none) |
| QUERY | Allow use of the FMT FIN query command. | (none) |
| SEND | Allow use of access control for sending FIN messages via FMT FIN. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| atdn | Distinguished name of the authoriser. | SWIFTNet user |
| encr | Distinguished name used for encrypting requests. | SWIFTNet user |
| mdt | Timestamp used by the SAG Add-on to determine whether an object needs to be updated. This is updated by the service. | Timestamp |
| nrep | Non-repudiation. |
|
| owner | Name of the message partner who owns the basic profile. | Character string |
| pltp | Type of payload. |
|
| prfn | Name of the basic profile. | Character string |
| prty | SWIFTNet priority. |
|
| rqdn | Distinguished name of the requestor. | SWIFTNet user |
| rqtp | Type of request. | Character string |
| rsdn | Distinguished name of the responder. | SWIFTNet user |
| sign | Distinguished name that is used for signing requests. | SWIFTNet user |
| svc | Name of the service. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| BOU | Business OU of the destination. | Eight-character string |
| Attribute | Description | Possible values |
|---|---|---|
| deployed | Indicates that the service bundle is deployed in the OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cln | Certificate list name. | |
| target | (for future use) | (none) |
| numberOfElements | Number of cert attributes for which a certificate is specified. This is updated by the DNFSAGCFG service. | 1 - 20 |
| lastElement | Serial number of the last cert attribute for which a certificate is specified. This is updated by the DNFSAGCFG service. | 1 - 20 |
| mdt | Date and time the CO was last modified. This is updated by the DNFSAGCFG service. | Timestamp |
| cert1
: cert20 |
Certificate contents (one certificate per cert attribute). |
| Attribute | Description | Possible values |
|---|---|---|
| sln | Service list name. | |
| target | (for future use) | (none) |
| numberOfElements | Number of serv attributes for which a service is specified. This is updated by the DNFSAGCFG service. | 1 - 10 |
| lastElement | Serial number of the last serv attribute for which a certificate is specified. This is updated by the DNFSAGCFG service. | 1 - 10 |
| mdt | Date and time the CO was last modified. This is updated by the service. | Timestamp |
| serv1
: serv10 |
Service name (one service per serv attribute). |
| Attribute | Description | Possible values |
|---|---|---|
| DoCmdAudit | Specifies whether audit data is to be recorded for commands. |
|
| InErrorAction | Specifies the action that DNF_O_FT takes when the transfer condition of a SendFile scenario is changed to inError. |
|
| TrackProcessing | Specifies the circumstances under which the MSIF transfer service (DNF_O_FT) is to issue events to document its processing. |
|
| SagSwitchMode | Specifies whether SAG switching is enabled. |
|
| SnFSessionCloseMode | Specifies whether an output channel session or an SnF queue session is closed automatically after a transfer failed. |
|
| Attribute | Description | Possible values |
|---|---|---|
| acquire | Pseudo attribute to allow use of the MSIF acquire command. | (none) |
| cancel | Pseudo attribute to allow use of the MSIF cancel command. | (none) |
| cleanup.aux | Pseudo attribute to allow use of the MSIF cleanup command to delete the entries for all auxiliary functions of a specific scenario that has the condition finished. | (none) |
| cleanup.aux.force | Pseudo attribute to allow use of the MSIF cleanup command delete the entries for all auxiliary functions of a specific scenario regardless of its current condition. | (none) |
| cleanup.ic | Pseudo attribute to allow use of the MSIF cleanup command to delete entries for SnF input channels from the database, but only for input channels that are in the state Closed. | (none) |
| cleanup.ic.force | Pseudo attribute to allow use of the MSIF cleanup command to delete entries for SnF input channels from the database regardless of their current state. | (none) |
| cleanup.oc | Pseudo attribute to allow use of the MSIF cleanup command to delete entries for SnF output channels from the database, but only for output channels that are in the state Closed. | (none) |
| cleanup.oc.force | Pseudo attribute to allow use of the MSIF cleanup command to delete entries for SnF output channels from the database regardless of their current state. | (none) |
| cleanup.me | Pseudo attribute to allow use of the MSIF cleanup command to delete the maximum number of entries for file or message scenarios from the database. | (none) |
| cleanup.q | Pseudo attribute to allow use of the MSIF cleanup command to delete entries for SnF queues from the database, but only for queues that are in the state Closed. | (none) |
| cleanup.q.force | Pseudo attribute to allow use of the MSIF cleanup command to delete entries for SnF queues from the database regardless of their current state. | (none) |
| cleanup.ref | Pseudo attribute to allow use of the MSIF cleanup command to delete entries for file or message transfer scenarios from the database. | (none) |
| cleanup.sub | Pseudo attribute to allow use of the MSIF cleanup command to delete an entry for a specific subscription that has a state other than subscribed. | (none) |
| cleanup.sub.force | Pseudo attribute to allow use of the MSIF cleanup command to delete an entry for a specific subscription regardless of its current state. | (none) |
| close.ic | Pseudo attribute to allow use of the MSIF close command to close an input channel. | (none) |
| close.oc | Pseudo attribute to allow use of the MSIF close command to close an output channel. | (none) |
| create.oc | Pseudo attribute to allow use of the MSIF create command to create an output channel. | (none) |
| create.ic | Pseudo attribute to allow use of the MSIF create command to create an input channel. | (none) |
| delete.oc | Pseudo attribute to allow use of the MSIF delete command to delete an output channel. | (none) |
| delete.ic | Pseudo attribute to allow use of the MSIF delete command to delete an input channel. | (none) |
| list | Pseudo attribute to allow use of the MSIF list command. | (none) |
| open.ic | Pseudo attribute to allow use of the MSIF open command to open an input channel. | (none) |
| open.oc | Pseudo attribute to allow use of the MSIF open command to open an output channel. | (none) |
| query.mposgrp | Pseudo attribute to allow use of the MSIF query command for SAG MP option-set group. | (none) |
| query.service | Pseudo attribute to allow use of the MSIF query command for service name. | (none) |
| query.snlid | Pseudo attribute to allow use of the MSIF query command for SNL ID. | (none) |
| recover | Pseudo attribute to allow use of the MSIF recover command. | (none) |
| release | Pseudo attribute to allow use of the MSIF release command. | (none) |
| restart | Pseudo attribute to allow use of the MSIF restart command. | (none) |
| set | Pseudo attribute to allow use of the MSIF set command. | (none) |
| start | Pseudo attribute to allow use of the MSIF start command. | (none) |
| status | Pseudo attribute to allow use of the MSIF status command. | (none) |
| stop | Pseudo attribute to allow use of the MSIF stop command. | (none) |
| subscribe | Pseudo attribute to allow use of the MSIF subscribe command. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in Download options: DownloadOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| hlq | Qualifiers of the data sets to be transferred. These qualifiers must begin with a high-level qualifier (HLQ), and cannot contain wildcard characters. | a series of qualifiers, separated by a period |
| read | Pseudo attribute that allows data sets with the specified qualifiers to be sent or provided for download. | (none) |
| write | Pseudo attribute that allows data sets with the specified qualifiers to be downloaded. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in Delivery notification options: DelNotifOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| dir | The directory in which the files to be transferred are located. This directory must begin with a top-level directory, and cannot contain wildcard characters. | Character string (1...254) |
| read | Pseudo attribute that allows files in the specified directory, or in a subdirectory of that directory, to be sent or provided for download. | (none) |
| write | Pseudo attribute that allows files in the specified directory, or in a subdirectory of that directory, to be downloaded. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in File options: FileOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in File receive options: FileReceiveOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in File send options: FileSendOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| snd | Pseudo attribute to allow a user to initiate an MSIF SendMsg or SendFile scenario. | (none) |
| rcv | Pseudo attribute to allow a user to respond to a MsgReceived request by creating and submitting a MsgReceived response. | (none) |
| prvdl | Pseudo attribute to allow a user to initiate an MSIF ProvideFileForDownload scenario. | (none) |
| dl | Pseudo attribute to allow a user to initiate an MSIF Download scenario. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| SagMPOptionSet | Name of the SAG MP option set that is to be used by the SnF input channel. | The name of a DnfEfaSagMPOptionSet configuration object. |
| SagMPOptionSetGroup | Name of the SAG MP option-set group that is to be used by the SnF input channel. If both, the SagMPOptionSet and the SagMPOptionSetGroup are defined, the group takes precedence and the SagMPOptionSet is ignored. | The name of SAG MP option-set group. These groups are defined by the Group attribute in the DnfEfaSagMPOptionSet. |
| WindowSize | The proposed window size for the input channel. The SIPN determines the size that is actually used based on this proposal. | Integer from 1 to 100 Default: 12 |
| Attribute | Description | Possible values |
|---|---|---|
| BOU | Name of the business OU that handles requests received on the message partner with the same name as the CO of this type. | Character string (1...8) |
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in Message receive options: MsgReceiveOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in Message send options: MsgSendOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| DnfContentMwh | Indicates what is to be stored in the MWH_XML_MSG field of the message warehouse. |
|
| DnfFlagMwh | Indicator if message warehouse function is enabled. |
|
| Attribute | Description | Possible values |
|---|---|---|
| SagMPOptionSet | Name of the SAG MP option set that is to be used by the SnF output channel. | The name of a DnfEfaSagMPOptionSet configuration object. |
| WindowSize | The proposed window size for the output channel. The SIPN determines the size that is actually used based on this proposal. | Integer from 1 to 100 Default: 10 |
| DefaultDeliverySubsetList | A list of one or more delivery subsets, separated from each other by a comma (,). The listed delivery subsets determine which of the primitives on the SnF queue to which the output channel is connected are to be received via the output channel, and in what order. The default is that all types of primitives are received in "first in, first out" order, that is, in the same order in which they were added to the queue. |
|
| SnFQueueName | The name of the SnF queue to which this output channel connects (only if more than one output channel is to connect to a particular SnF queue) | Character string of 10 - 30 characters |
| Attribute | Description | Possible values |
|---|---|---|
| SNLRequestExpiration | The number of seconds by which a response from an SAG must be received. | Integer Default: 90 |
| CleanupPeriod | The amount of time that information about an MSIF scenario is kept in the database before it is removed during cleanup. | Character string of the form PdDThHmM,
where:
|
| NULLValue | The value that, when specified for an option, causes the option to be treated as if no value was specified for it, and causes the MSIF transfer service not to use a substitute value based on the settings of option sets, as it would if the option were not specified or its value left blank. | Character string (1...254) Default: NULL |
| BatchSize | The maximum number of scenarios that the broker can process within a single transaction. | Positive integer Default: 100 |
| ReplBatchSize | The maximum number of scenarios that the broker can process within a single transaction when determining SnF outbound transfers with an SnFInputTime that is earlier than the last replication time for the database in SIPN. | Positive integer Default: 100 |
| AutoCleanup | Pseudo attribute that determines whether the MSIF transfer service automatically is to delete information for which the cleanup period expired. | (none) |
| EfaDataDirectory | The root directory in which files required by the MSIF transfer service are stored. | Character string (1...721) |
| EfaWorkDirectory | The subdirectory of the EfaDataDirectory in which the MSIF transfer service stores temporary files. | Character string (1...1023) |
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in Provide options: ProvideOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in SAG communication options: SagCommOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in SAG message partner options: SagMPOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| SagMPOptionSet | Name of the SAG MP option set that is to be used by the SnF queue, or the prefix to which a number is to be appended to create the option set name. | |
| SagMPOptionSetNum | The default of the -num parameter of the acquire command. Specify this attribute only if you need to be able to dynamically specify different SAG MP option sets for the queue sessions of single SnF queue. | 2-digit number from 01 to 99 |
| OrderBy | Specifies the order in which the messages are to be retrieved from the queue. | Possible values:
|
| RecoveryMode | The default of the -rm parameter of the acquire command. |
|
| Attribute | Description | Possible values |
|---|---|---|
| dn | The distinguished name (DN) to be used by the MSIF transfer service. | A valid DN |
| local | Pseudo attribute to specify that the DN can be used as a local DN. | (none) |
| auth | Pseudo attribute to specify that the DN can be used as an authoriser DN. | (none) |
| encr | Pseudo attribute to specify that the DN can be used as an encrypter DN. | (none) |
| sign | Pseudo attribute to specify that the DN can be used as a signer DN. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in SWIFT service options: SwiftServiceOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in Third-party options: ThirdPartyOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| These options are described in Transfer options: TransferOptions. | ||
| Attribute | Description | Possible values |
|---|---|---|
| MsgValExceptionQueue | Name and queue manager of the queue into which messages with message validation errors are to be put. | Character string |
| MsgValExceptionQMgr | Character string | |
| MsgValRcvExceptionQueue | Name and queue manager of the queue into which received messages with message validation errors are to be put. | Character string |
| MsgValRcvExceptionQMgr | Character string | |
| AspSndExceptionQueue | Name and queue manager of the queue into which messages with Application Service Profile (ASP) errors are to be put. | Character string |
| AspSndExceptionQMgr | Character string | |
| NakSndExceptionQueue | Name and queue manager of the queue into which messages that resulted in a NAK from the SIPN are to be put. | Character string |
| NakSndExceptionQMgr | Character string | |
| NakRcvExceptionQueue | Name and queue manager of the queue into which messages that resulted in a NAK being sent to the SIPN are to be put. | Character string |
| NakRcvExceptionQMgr | Character string | |
| RMSndExceptionQueue | Name and queue manager of the queue into which messages that were to be sent but that failed relationship management authorization are to be put. | Character string |
| RMSndExceptionQMgr | Character string | |
| RMRcvExceptionQueue | Name and queue manager of the queue into which messages that were received and that failed RMA authorization are to be put. | Character string |
| RMRcvExceptionQMgr | Character string | |
| SignatureExceptionQueue | Name and queue manager of the queue into which messages that failed signature verification are to be put. | Character string |
| SignatureExceptionQMgr | Character string | |
| DigestCreateExceptionQueue | Name and queue manager of the queue into which messages that failed digest creation are to be put. | Character string |
| DigestCreateExceptionQMgr | Character string | |
| DigestVerifyExceptionQueue | Name and queue manager of the queue into which messages that failed digest verification are to be put. | Character string |
| DigestVerifyExceptionQMgr | Character string | |
| ProcessSndExceptionQueue | Name and queue manager of the queue into which messages that encountered an exception that does not fall into any of the other exception categories are to be put. | Character string |
| ProcessSndExceptionQueue | Character string | |
| FmtAccDndRcvExceptionQueue | Name and queue manager of the queue into which FMT FIN messages that the receiving LT is unable to access are to be put. | Character string |
| FmtAccDndRcvExceptionQMgr | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| TolerateSingleAuthentication | Pseudo attribute that indicates that the FINCopy service is to accept messages that are to be authenticated using single authentication, even if the value of the Authentication attribute is set to 2 (for double authentication). | (none) |
| CentralInstitution | BIC8 of the central institution. | Valid BIC8 |
| TransferDirection | Indicates whether the FINCopy service can be used to send messages, receive messages, or both: |
|
| Attribute | Description | Possible values |
|---|---|---|
| SignerDN | Signer DN that the LT is to use to sign MT097 messages. | cn=ci1,o=xxxxusny,o=swift |
| Attribute | Description | Possible values |
|---|---|---|
| Audit | Specifies for which FIN session operation commands audit data is to be recorded for a specific OU. |
|
| AuthorizeTT | Messages associated with a test and training (T&T) LT are authorized to be processed. | (none) |
| DnfAccessControlSnfil | Specifies whether access control is performed for all LTs of an OU. |
|
| FmtFinSendingEnabled | If this pseudo attribute is specified, FIN messages are sent internally via FMT FIN; otherwise, they are sent via the SIPN. | (none) |
| SigVerifError | Specifies whether a MT398 message or a message
that failed verification is to be:
|
|
| FinCopyConfigError | Specifies whether a received FIN message that
used an unconfigured FINCopy service is to be:
|
|
| FinUtilizeBrokerUserId | Indicates that the user ID of each OSN message and ISN acknowlegement that is processed by the SIPN FIN services to be the user ID of the message broker in which those services run. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| enabled | If this pseudo attribute is specified, this destination can receive FIN messages that were transferred via the FMT FIN service. | (none) |
| FmtAssignedMessageTypes | FIN message types of the FIN messages that this destination can receive via the FMT FIN service. The specified message types can contain an underscore character (_) as a wildcard to indicate any single character. | A single value or a comma-separated list, for example, 1__,202,3_9 |
| FmtAssignedServices | FIN services for which this destination can receive messages via the FMT FIN service. | CPY |
| FmtReceivableMessageTypes | FIN message types of the FIN messages that this destination can receive via the FMT FIN service. The specified message types can contain an underscore character (_) as a wildcard to indicate any single character. | A single value or a comma-separated list, for example, 1__,202,3_9 |
| RequestDelayedNak | Indicates that the sending application is to be sent a negative acknowledgement (NAK) if this destination is unable to receive the message via the FMT FIN service. | (none) |
| AllowDelayedNak | Indicates that this destination is to send a negative acknowledgement (NAK) to the sending application if it is unable to receive a message via the FMT FIN service. | (none) |
| Instance | Name of the FTM SWIFT instance of the receiving FMT FIN service. Specify this attribute only if the receiving destination belongs to an instance other than that of the sending destination. | Character string |
| OU | Name of the OU of the receiving FMT FIN service. Specify this attribute only if the receiving destination belongs to an instance other than that of the sending destination. | Character string |
| QueueManager | Name of the queue manager of the receiving FMT FIN service. Specify this attribute only if the receiving destination belongs to an instance other than that of the sending destination. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| Audit | Whether and for which FMT FIN commands audit data is recorded. |
|
| FmtUtilizeBrokerUserId | Indicates that the user ID of each OSN message and final ISN acknowlegement that is processed by the FMT FIN services to be the user ID of the message broker in which those services run. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| Destination | The BIC 8 of the destination LT. | |
| enabled | Pseudo attribute that enabled the CO for routing FMT messages. | |
| LtAssignedMessageTypes | Specify the FIN message types that the destination LT can receive. Values must be separated by a comma. Use the underscore (_) as a wildcard for a single character; for example, 100, 10_, __9. | |
| LtAssignedServices | Specify the kind of FIN services which destination LT can receive. | Comma-separated list with no wildcards |
| TargetLtId | The 1 char LtId to complete the whole BIC 9 of the destination LT. |
| Attribute | Description | Possible values |
|---|---|---|
| crq | Client response queue. | Character string |
| mdt | Date and time the CO was last modified. This is updated by the service. | Timestamp |
| ret | Retention period. | Integer from 1 to 10 |
| sag | SAG name. | Character string |
| gfq | Name of the get file queue. | Character string |
| fdir | Directory that contains the files to which LFT commands apply. | Character string |
| fexp | Number of seconds after which the MQHA places a file into the get file queue that the file is deleted from that queue or is moved to the dead letter queue. | Integer |
| maxlftms | The maximum chunk size in MB. | A whole number from 1 to 100 |
| Attribute | Description | Possible values |
|---|---|---|
| validityPeriod | Number of days after the LAU key was last changed that the LAU key expires. | Integer |
| notificationPeriod | Number of days before the expiration date that a warning event is to be issued for a LAU key. | Integer |
| Attribute | Description | Possible values |
|---|---|---|
| hk1 | First part of the LAU key. | Each half key must follow these
rules:
|
| hk2 | Second part of the LAU key. | |
| lkn | Name of the LAU key. | Character string |
| mdt | Date and time the CO was last modified. | Timestamp of the form yyyy-mm-dd hh:mm:ss.sssss |
| Attribute | Description | Possible values |
|---|---|---|
| hk1 | First part of the LAU key. | Each half key used to secure RM data must have a length of 16 characters and must contain only characters that correspond to hex digits (0123456789ABCDEF). |
| hk2 | Second part of the LAU key. | |
| LastChanged | Date when the LAU key was last changed. | yyyy-mm-dd, for example 2025-08-30. |
| Attribute | Description | Possible values |
|---|---|---|
| BatchingTimeout | USER batching timeout, in seconds. | Integer from 1 to 99 |
| CiFinCopyService | The name and type of the SWIFTNet FINCopy service to be used with the LT. This attribute is only for central institutions that use FIN Y-Copy. | Character string of 8 characters. |
| DefaultDeliverySubsets | The delivery subsets that are to be used when the -delivery parameter is not specified for the LT Select command. Each delivery subset is exactly six characters long, and you can specify up to 30 delivery subset. | Character string of up to 180 characters and whose length is a multiple of six. |
| DefaultFINState | The default of the -state parameter of the select command. | Composed of three characters, each of which is an N or a Y, that specify the default select states and the LT-directed queue value for the GPA session for an LT. |
| DefaultProtocolVersion | The default protocol version of the login command. | 3 |
| DefaultFINWindowSize | The FIN window size that must be used when the -window parameter is omitted for the LT Select command. | Integer from 10 - 100 |
| DefaultLTConn | Number of the initial LT connection for this LT. | Integer from 1 - 99 |
| DefaultQMgr | Queue manager on which the SFD is started. | Character string |
| FSMInstanceDir | FSM instance directory. | An existing directory |
| InitialService | The service invoked from SIPN FIN. | swift.fin |
| LTGroup | Name of the LT group. | Character string (maximum 12) |
| MaxBatchCount | USER maximum batch count. | Integer in the range 1 - 99 |
| MaxBatchSize | USER maximum batch size (in KB). | Integer in the range 30 - 99 |
| ResyncMaxNumber | Maximum number of resync attempts. | Integer in the range 0 - 40 |
| ResyncMaxTime | Maximum resync time. | Integer in the range 1 - 60 |
| ResyncStartDelay | Delay time before starting an initial resync. | Integer in the range 20 - 300 |
| ResyncWaitTime | Wait time before attempting another resync. | Integer in the range 20 - 300 |
| SLRetry | Pseudo attribute that, if present, specifies that the client send process is to immediately retry sending a message if an exception occurs on the session layer. | (none) |
| SwitchOpenConfTO | Pseudo-attribute to switch the LT connection if there is a request or confirmation timeout (open session confirmation message not received from FIN system within sequence gap timeout value). | (none) |
| SwitchSeqGapTO | Pseudo-attribute to switch the LT connection if there is a sequence gap timeout. | (none) |
| SwitchSignalTO | Pseudo-attribute to switch the LT connection if there is a sequence signal timeout (no Life Signal message received from FIN system within Life Signal frequency of 300 seconds + the sequence gap timeout value). | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| ExceptionOptionSet | Name of the exception option set that the LT is to use to determine which error queues it is to use. | Character string |
| Queue | Queue of the receiving application. | Character string |
| QueueManager | Queue manager of the receiving application. | Character string |
| send | A pseudo attribute that, if present, specifies that access control is to be carried out in the DNF_ILC_FIN message flow. | (none) |
| CT description | ||
|---|---|---|
| Attribute | Description | Possible values |
| AuthoriserDN | Distinguished name of the security endpoint (authoriser DN). | SWIFTNet user |
| enabled | Pseudo-attribute placeholder for enabling the LT connection. | (none) |
| RequestorDN | Distinguished name of the requestor. | SWIFTNet user |
| SAGName | Name of the SAG on which MQHA runs. | Character string |
| SAGQMgr | Used in combination with attribute SAGRequestQueue to specify a specific SAG to be used for the LT. | Character string |
| SAGRequestQueue | SAG-specific client request queue that is to be used for the FIN traffic for an LT. This queue can be used for static workload balancing among LTs, or in setups with more than one SAG to route traffic away from a non-operable SAG. | Character string |
| SNLEndpoint | SNL endpoint used for SIPN FIN. | ltname_FIN |
| Attribute | Description | Possible values |
|---|---|---|
| OU | OU of the destination LT. | Character string (maximum 8) |
| Attribute | Description | Possible values |
|---|---|---|
| ch | Channel definition. This parameter is mandatory when you initially set up an SAG. This parameter contains the channel name, the protocol, such as TCP, and the host name. | Character string |
| cid | Message coding definition (CCSID). | 1208 |
| cn | Name of QM host, that is, the host name or IP address of the host where the queue manager resides. | Character string |
| crq | Client request queue | Character string |
| mdt | Date and time the CO was last modified. This is updated by the service. | Timestamp |
| mqcn | IBM MQ connection name. | DnfMqConnection |
| pfq | Putfile queue. | Character String |
| qm | Queue manager. | Character string |
| srq | Server request queue. | Character string |
| tt | Name of the transport type, such as TCP. | TCP |
| Attribute | Description | Possible values |
|---|---|---|
| cid | Definition of the message coding. | 1208 |
| con | Indicator if conversion is enabled. |
|
| env | Whether messages are received in an envelope. |
|
| mdt | Date and time the CO was last modified. This is updated by the service. | Timestamp |
| mex | Message expiration. | Integer |
| mqcn | IBM MQ connection name. | Updated by the service |
| qm | Queue manager. | Character string |
| owner | Name of the message partner who owns the basic profile. | Character string |
| prfn | Name of the MQHA profile. | Character string |
| rqq | IBM MQ queue name. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| cln | Name of the certificate list CO. | Character string |
| dfm | Default message for emission. |
|
| envm | Envelope mode. |
|
| lkn | Name of LAU key CO. | Character string |
| mdt | Date and time the CO was last modified. This is updated by the service. | Timestamp |
| mfm1 | Supported message string. |
|
| mfm2 | Supported message string. | |
| mfm3 | Supported message string. | |
| mfm4 | Supported message string. | |
| mfm5 | Supported message string. | |
| mpn | Name of the message partner. | Character string |
| mqm | Queue manager. Name of the server request queue. | Character string |
| ou | OU name. | Character string (max. length 8) |
| req | Name of the server request queue. | Character string |
| type | Type of message partner. |
|
| sln | Name of the service list CO. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| envm | Envelope mode. |
|
| mpn | Name of the message partner. | Character string |
| mqm | Queue manager name of the server request queue. | Character string |
| ou | OU name. | Character string (8 maximum) |
| req | Name of the server request queue. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| DnfFlagMwh | Indicates whether the message warehouse function is enabled. |
|
| DnfContentMwh | Indicates what is to be stored in the MWH_XML_MSG field of the message warehouse. |
|
| Attribute | Description | Possible values |
|---|---|---|
| DnfCollectionSnfdb | The Db2 binding information. |
|
| DnfSchemaSnfdb | Name of the Db2 schema. | Character string (this is the value specified for the DNIvSN placeholder) |
| Attribute | Description | Possible values |
|---|---|---|
| Send | Whether RM filtering is done for messages or files sent to a counterpart. |
|
| Receive | Whether RM filtering is done for messages or files received from a counterpart. |
|
| Attribute | Description | Possible values |
|---|---|---|
| RequestDeliveryNotif | Whether the SIPN is to send a delivery notification when correspondent received and acknowledged an RMA message. |
|
| TransferOptionSet | Name of the transfer option set that the MSIF Transfer service is to use when sending an RMA message. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| Instance | The FTM SWIFT instance on that the MSIF Transfer service is running. | Character string |
| OU | Organizational unit to which the MSIF Transfer service belongs. | Character string (8 maximum) |
| QueueManager | Queue manager of the MSIF Transfer service. | Character string (8 maximum) |
| Attribute | Description | Possible values |
|---|---|---|
| ACCEPT | Allow use of accept action (accept, reject) | (none) |
| APPROVE | Allow use of approve action (approve, refuse) | (none) |
| BREAKLOCK | Allow use of break lock action | (none) |
| CHANGE | Allow use of change action (revoke, delete, enable, edit, discard changes) | (none) |
| CREATE | Allow use of create action | (none) |
| DELETEQUERY | Allow use of delete query action | (none) |
| DELETESTALE | Allow use of delete stale action | (none) |
| EXPORT | Allow use of the export RM command. | (none) |
| IMPORT | Allow use of the import RM command. | (none) |
| PROCESSQUERY | Allow use of process query action (create, respond, mark as read) | (none) |
| VIEW | Allows viewing an authorisation, if no other action is permitted | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| Audit | Specifies for which RM administration commands audit data is to be recorded. Can be set separately for each OU. |
|
| DefaultExportDir | Name of the directory used by the export RM command if the -dir parameter is not specified. | Character string |
| DefaultImportDir | Name of the directory used by the import RM command if the -dir parameter is not specified. | Character string |
| DefaultLogDir | Name of the directory where log files (for example, import log files) are stored by default. | Character string |
| ApprovalSteps | Specifies the required number of approval steps
for following actions:
|
|
| ApprovalUserRestriction | Specifies the user restrictions for the approval process if single or double authorization is configured for the approval steps. |
|
| Attribute | Description | Possible values |
|---|---|---|
| DefaultImportDir | Name of the directory used by the importasp command if the -dir parameter is not specified. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| bou | Name of the business OU. | Character string (8 maximum) |
| cos | Configuration object set. | Character string |
| parm1 | Internal parameter. | Character string |
| parm2 | Internal parameter. | Character string |
| parm3 | Internal parameter. | Character string |
| sag | Name of the SAG. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| accessLauKey1 | Pseudo attribute placeholder. | (none) |
| accessLauKey2 | Pseudo attribute placeholder. | (none) |
| acquireCertificate | Configuration command. | Yes |
| addCert | Configuration command. | Yes |
| addLauKey | Configuration command. | Yes |
| addMessagePartner | Configuration command. | Yes |
| addMQConnection | Configuration command. | Yes |
| addService | Configuration command. | Yes |
| addSiEndpoint | Configuration command. | Yes |
| approve | Operation command. | Yes |
| backup | Operation command. | Yes |
| changeCertificatePassword | Configuration command. | Yes |
| createCertificate | Configuration command. | Yes |
| defineSagUser | Configuration command. | Yes |
| deleteCert | Configuration command. | Yes |
| deleteMessagePartner | Configuration command. | Yes |
| deleteLauKey | Configuration command. | Yes |
| deleteSagUser | Configuration command. | Yes |
| deleteService | Configuration command. | Yes |
| deleteSiEndpoint | Configuration command. | Yes |
| deploy | Configuration command. | Yes |
| disable | Operation command. | Yes |
| disableSwiftNetUser | Configuration command. | Yes |
| enable | Operation command. | Yes |
| getstate | Operation command. | Yes |
| getRoutingRules | Operation command. | Yes |
| grantRole | Configuration command. | Yes |
| list | Operation command. | Yes |
| listCertLists | Configuration command. | Yes |
| listCfgObjectSet | Configuration command. | Yes |
| listMessagePartner | Configuration command. | Yes |
| listMQConnection | Configuration command. | Yes |
| listLauKeys | Configuration command. | Yes |
| listRoles | Configuration command. | Yes |
| listSagEventTemplates | Configuration command. | Yes |
| listSagInstances | Configuration command. | Yes |
| ListSagUser | Configuration command. | Yes |
| ListServiceLists | Configuration command. | Yes |
| listSiEndpoints | Configuration command. | Yes |
| listSwiftNetUser | Configuration command. | Yes |
| pluginProcent | Pseudo attribute placeholder. | (none) |
| pluginSagLog | ||
| pluginSagAPL_MQHA | ||
| pluginSagFT_I | ||
| pluginSagAPL_BIMFC | ||
| pluginSagAPL_I | ||
| pluginSagCM | ||
| pluginSagMD | ||
| pluginSagSN_NA | ||
| pluginSagSN_I | ||
| pluginSagSystem | ||
| queue | Name of input queue of the SAG Add-On. | Character string |
| readCertLists | Configuration command. | Yes |
| readGlobalParameters | Configuration command. | Yes |
| readMessagePartner | Configuration command. | Yes |
| readMQConnection | Configuration command. | Yes |
| readServiceLists | Configuration command. | Yes |
| readSiEndpoint | Configuration command. | Yes |
| recoverCertificate | Configuration command. | Yes |
| registerSwiftNetUser | Configuration command. | Yes |
| removeCertFromSag | Configuration command. | Yes |
| renew | Operation command. | Yes |
| reroute | Operation command. | Yes |
| revokeSwiftNetUser | Configuration command. | Yes |
| setCertProtocol | Configuration command. | Yes |
| setupUserForCert | Configuration command. | Yes |
| setupUserForRecovery | Configuration command. | Yes |
| start | Operation command. | Yes |
| stop | Operation command. | Yes |
| ungrantRole | Configuration command. | Yes |
| updateCert | Configuration command. | Yes |
| updateGlobalParameters | Configuration command. | Yes |
| updateMessagePartner | Configuration command. | Yes |
| updateMQConnection | Configuration command. | Yes |
| updateLauKey | Configuration command. | Yes |
| updateSagEventTemplates | Configuration command. | Yes |
| updateService | Configuration command. | Yes |
| updateSiEndpoint | Configuration command. | Yes |
| version | For future use. |
| Attribute | Description | Possible values |
|---|---|---|
| epn | Name of the endpoint. | Character string (20 maximum) |
| mdt | Date and time the CO was last modified. This is updated by the service. | Timestamp |
| mpn | Message partner. | Character string |
| sep | SNL endpoint. | Character string |
| spro | SNL protocol. |
|
| cpro | Cryptographic protocol. |
|
| Attribute | Description | Possible values |
|---|---|---|
| auth | Pseudo attribute that indicates that the DN is an authoriser DN. | (none) |
| dn | Distinguished name. | SWIFTNet user |
| encr | Pseudo attribute that indicates that the DN is an encrypter DN. | (none) |
| req | Pseudo attribute that indicates that the DN is a requestor DN. | (none) |
| rsp | Pseudo attribute that indicates that the DN is a responder DN. | (none) |
| sign | Pseudo attribute that indicates that the DN is a signer DN. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| Master | Name of the corresponding master LT. | An LT name (BIC9) |
| Attribute | Description | Possible values |
|---|---|---|
| SignerDN | Distinguished name used to sign FIN traffic of a synonym LT. | SWIFTNet user |
| Attribute | Description | Possible values |
|---|---|---|
| Level | Trace level. |
|
| Size | Whether the file size is to be limited and, if so, the size limit | A value from 1 to 100 specifies the limit in MB. A value of 0 specifies that the PDU trace file is not controlled and therefore its size is unlimited. |
| Attribute | Description | Possible values |
|---|---|---|
| sign | Pseudo attribute for access control. Controls the right to use the signature processing service DNF_V_API to sign signatures. | |
| verifycmd | Pseudo attribute for access control. Controls the right to use the signature administration service DNF_V_ADM to verify messages by issuing the verify command. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| enabled | Pseudo attribute indicates that the CO is active. | (none) |
| SAGRequestQueue | The queue to which SignEncrypt and VerifyDecrypt requests are to be sent. | |
| SAGQMgr | The queue manager of the queue to which SignEncrypt and VerifyDecrypt requests are to be sent. | |
| AuthoriserDN | Authoriser DN that is used to authorize SignEncrypt and VerifyDecrypt requests. | |
| MessagePartner | The message partner of the LAU key that is to be used. | |
| SAGName | The name of the SAG server of the LAU key that is to be used. |
| Attribute | Description | Possible values |
|---|---|---|
| Audit | Level of audit data recorded for signature verification commands. |
|
| Attribute | Description | Possible values |
|---|---|---|
| AutoInterval | The number of minutes that the signature service is to wait between automatic processing attempts. If automatic processing is not to be performed, specify 0. The default is 5. | Any non-negative integer |
| MaxInterval | When automatic signature processing is to be performed (that is, when AutoInterval > 0), this attribute specifies the number of minutes by which the signature processing service must have processed the signature of a message that it received. If no limit is to be placed on the time available to automatically process signatures, specify 0. The default is 0. | Any non-negative integer |
| MaxTransactionSize | A number from 1 to 70 that indicates the maximum number of messages that the signature processing service is to include in each signature processing transaction. The default is 20. | Any non-negative integer from 1 to 70 |
| DefaultSignatureConn | A two-digit number that indicates which CO of type DnfSignatureConn the signature service is to use as a source of SAG data if none is specified. | Any two-digit number (01 - 99) |
| SNLRequestExpiration | The maximum amount of time, in seconds, after the signature service puts a SignEncrypt or VerifyDecrypt request into the input queue of an SAG, by which the SAG must begin to process the request. The default is 90 seconds. | Any non-negative integer |
| Attribute | Description | Possible values |
|---|---|---|
| ABORT | Allow use of the abort command. | (none) |
| LOGIN | Allow use of the login command. | (none) |
| LOGOUT | Allow use of the logout command. | (none) |
| QUERY | Allow use of the query command. | (none) |
| QUIT | Allow use of the quit command. | (none) |
| RECOVER | Allow use of the recover command. | (none) |
| RESET | Allow use of the reset command. | (none) |
| SELECT | Allow use of the select command. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| IMPORTASP | Allow the user to import application service profiles. | (none) |
| QUERY | Allow a user to obtain a summary of relationship management data. | (none) |
| QUERYASP | Allow the user to query application service profiles. | (none) |
| QUERYRELATIONSHIP | Allow a user to obtain detailed information about relationships. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| DniFlagAccAudit | Auditing flag. |
|
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| DniPollIntAcp | Polling interval in seconds for the Access Control node. | Integer from 0 - 84600 (default is 300) |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| DnfLAUKeyRM.hk1 | Pseudo attribute that allows a user to enter the first (hk1) or second (hk2) half of a key used to secure relationship management data while it is being imported or exported. | (none) |
| DnfLAUKeyRM.hk2 | (none) | |
| DnfLAUKeyRM.LastChanged | Pseudo attribute that allows a user to enter the date when an a LAU key was last changed. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| DniPollIntCpn | Polling interval in seconds for the Configuration Data Provider node. | integer from 0 - 84600 (default is 300) |
| Attribute | Description | Possible values |
|---|---|---|
| CommandQueue | The command queue of the message flow that uses a CIN as its input node. | Character string |
| EnhancedErrorHandlingEnabled | Indicates that the service uses the enhanced error handling mode. This means that its CIN routes to an error queue messages that, if processed, would cause the CIN to stop. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cosfile | Configuration object set file name. | Character string |
| ctfile | Configuration object type file name. | Character string |
| hisfile | Historic installation information file name. | Character string |
| migfile | Migration file name. | Character string |
| rolefile | Role file. | Character string |
| name | Dummy attribute. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| Path | Absolute path in the file system. | Character string |
| read | Pseudo attribute that allows a user to retrieve files from the directory represented by the Path attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| Level | Level for the FTM SWIFT Trace service. |
|
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| DnfLAUKeyRM.hk1 | Pseudo attribute that allows a user to display the first (hk1) or second (hk2) half of a key used to secure relationship management data while it is being imported or exported | (none) |
| DnfLAUKeyRM.hk2 | (none) | |
| DnfLAUKeyRM.LastChanged | Pseudo attribute that allows a user to display the date when an a LAU key was last changed. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| DniSchemaMwh | Schema name. | Character string |
| DniTableMwh | Table or view name. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| DniTableMwh | Table or view name. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| DniSchemaAudit | Schema name. | The value specified for the DNIvSN placeholder |
| DniTableMsgAudit | Table name. | A name of the form DNI_A_MSG_ou |
| DniPartIndTypePartMsgAudit | A value specified for this attribute indicates that a partitioned message audit log is to be used, and the type of partition indicator that is to be recorded for each entry in the message audit log. |
|
| DniTimeAdjustPartMsgAudit | The number of hours added to the GMT time stamp before the partition indicator is derived by FTM SWIFT. | integer |
| DniUserDaysPerPartPartMsgAudit | If the partition indicator type user is specified, this attribute specifies the number of days in succession during which the same partition indicator value is generated. | integer |
| DniUserPartsPerCycPartMsgAudit | If the partition indicator type user is specified, this attribute specifies the number of distinct values that make up the domain of the partition indicator. | integer |
| Attribute | Description | Possible values |
|---|---|---|
| DniFlagMsgAudit | Whether message audit data is to be recorded. |
|
| DniFlagSaveMQRFH2 | Whether MQRFH2 is to be written to the audit table. |
|
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| QueueManager | Queue manager of the remote instance. | Character string (48 maximum) |
| RmaSyncEnabled | Pseudo attribute that indicates, that relationship management synchronization is enabled for the remote instance, if configured. | (none) |
| RmaSyncTimeout | The number of seconds after which a relationship management synchronization request indicates a timeout, if no response has been received. To disable the timeout detection for sent synchronization requests, set the value to 0 or do not configure any value for that attribute. | Any non-negative integer |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| DnfLAUKeyRM.hk1 | Pseudo attribute that allows a user to remove the first (hk1) or second (hk2) half of a key used to secure relationship management data while it is being imported or exported. | (none) |
| DnfLAUKeyRM.hk2 | (none) | |
| DnfLAUKeyRM.LastChanged | Pseudo attribute that allows a user to remove the date when an a LAU key was last changed. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| DniFlagDoubleAuthSecAdm | Dual authorization flag. |
|
| Attribute | Description | Possible values |
|---|---|---|
| user | Pseudo attribute that indicates that this command can be issued for a user. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| rg | Pseudo attribute that indicates that this command can be issued for a role group. | (none) |
| ro | Pseudo attribute that indicates that this command can be issued for a role. | (none) |
| user | Pseudo attribute that indicates that this command can be issued for a user. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| rg | Pseudo attribute that indicates that this command can be issued for a role group. | (none) |
| ro | Pseudo attribute that indicates that this command can be issued for a role. | (none) |
| user | Pseudo attribute that indicates that this command can be issued for a user. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| user | Pseudo attribute that indicates that this command can be issued for a user. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| rg | Pseudo attribute that indicates that this command can be issued for a role group. | (none) |
| ro | Pseudo attribute that indicates that this command can be issued for a role. | (none) |
| user | Pseudo attribute that indicates that this command can be issued for a user. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| rg | Pseudo attribute that indicates that this command can be issued for a role group. | (none) |
| ro | Pseudo attribute that indicates that this command can be issued for a role. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| rg | Pseudo attribute that indicates that this command can be issued for a role group. | (none) |
| ro | Pseudo attribute that indicates that this command can be issued for a role. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| rg | Pseudo attribute that indicates that this command can be issued for a role group. | (none) |
| ro | Pseudo attribute that indicates that this command can be issued for a role. | (none) |
| user | Pseudo attribute that indicates that this command can be issued for a user. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| rg | Pseudo attribute that indicates that this command can be issued for a role group. | (none) |
| ro | Pseudo attribute that indicates that this command can be issued for a role. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| user | Pseudo attribute that indicates that this command can be issued for a user. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| rg | Pseudo attribute that indicates that this command can be issued for a role group. | (none) |
| ro | Pseudo attribute that indicates that this command can be issued for a role. | (none) |
| user | Pseudo attribute that indicates that this command can be issued for a user. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| rg | Pseudo attribute that indicates that this command can be issued for a role group. | (none) |
| ro | Pseudo attribute that indicates that this command can be issued for a role. | (none) |
| user | Pseudo attribute that indicates that this command can be issued for a user. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| user | Pseudo attribute that indicates that this command can be issued for a user. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| na | Dummy attribute. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| DniFlagDoubleAuthCfg | Dual authorization flag. |
|
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| ct | Pseudo attribute that indicates that this command can be issued for a CT. | (none) |
| ou | Pseudo attribute that indicates that this command can be issued for an OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| ct | Pseudo attribute that indicates that this command can be issued for a CT. | (none) |
| ou | Pseudo attribute that indicates that this command can be issued for an OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| ct | Pseudo attribute that indicates that this command can be issued for a CT. | (none) |
| ou | Pseudo attribute that indicates that this command can be issued for an OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| ct | Pseudo attribute that indicates that this command can be issued for a CT. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| ct | Pseudo attribute that indicates that this command can be issued for a CT. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| ct | Pseudo attribute that indicates that this command can be issued for a CT. | (none) |
| ou | Pseudo attribute that indicates that this command can be issued for an OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| ct | Pseudo attribute that indicates that this command can be issued for a CT. | (none) |
| ou | Pseudo attribute that indicates that this command can be issued for an OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| ct | Pseudo attribute that indicates that this command can be issued for a CT. | (none) |
| ou | Pseudo attribute that indicates that this command can be issued for an OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| ct | Pseudo attribute that indicates that this command can be issued for a CT. | (none) |
| ou | Pseudo attribute that indicates that this command can be issued for an OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| ct | Pseudo attribute that indicates that this command can be issued for a CT. | (none) |
| ou | Pseudo attribute that indicates that this command can be issued for an OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Pseudo attribute that indicates that this command can be issued for a COS. | (none) |
| ct | Pseudo attribute that indicates that this command can be issued for a CT. | (none) |
| ou | Pseudo attribute that indicates that this command can be issued for an OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| cos | Configuration object set pseudo attribute placeholder. | (none) |
| ct | CT pseudo attribute placeholder. | (none) |
| ou | Pseudo attribute that indicates that this command can be issued for an OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| CLEANUP | Allows a user to move or delete messages from a CIN error queue. | (none) |
| QUERY | Allows a user to query the status (started or stopped) of a CIN. | (none) |
| RETRY | Allows a user to route messages from a CIN error queue back to the MSIF transfer service for processing. | (none) |
| START | Allows a user to restart the CIN and resume processing. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| Audit | Level of audit data recorded for system operation commands. |
|
| Attribute | Description | Possible values |
|---|---|---|
| DniPollingIntervalTimer | Polling interval. | Any integer |
| DniSchemaTimer | Schema name. | Character string |
| DniTableTimer | Table name. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| DISPLAYUSER | Allows the user to display user specific information. | (none) |
| ASSIGNUSER | Allow a user to manage user assignments. | (none) |
| APPROVEUSER | Allows the user to approve or reject pending changes of a user assignment. | (none) |
| DISPLAYROLE | Allows the user to display role and role group specific information. | (none) |
| MODIFYROLE | Allows a user to create, edit and delete roles and role groups. | (none) |
| APPROVEROLE | Allows the user to approve or reject pending changes of role and role group definitions. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| DISPLAY | Allows the user to display reference data. | (none) |
| MODIFY | Allows a user to create, update or delete reference data. | (none) |
| APPROVE | Allows the user to approve or reject pending changes to reference data. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| ApprovalRequired | Whether an approval is required for changes to the reference data. |
|
| Attribute | Description | Possible values |
|---|---|---|
| DniSchemaAudit | Schema name. | Character string |
| DniTableUserAudit | Table name. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| maxAmount | The amount which defines the threshold for a routing condition |
| Attribute | Description | Possible values |
|---|---|---|
| Label | The label or display name of this action in the MER user interface. | |
| UserAction | The name of this action for routing flows and the message history. | |
| RoutingType | The type of routing flow that will handle this action. |
|
| Validate | Whether to validate a message before executing the action. This attribute is only valid for custom actions on queues of purpose Create or Edit. On queues with other purposes, the messages will not be validated. |
|
| UserConfirmation | Whether the user has to confirm the action before it is executed. This is a protection against accidental selection of the action, similar to the behavior of the standard Delete action. |
|
| Attribute | Description | Possible values |
|---|---|---|
| AddressType | Specifies whether the address is an LT name (for FIN messages) or a distinguished name (for InterAct messages). |
|
| Address | When processing FIN messages (AddressType LT),
this is the BIC12 specified in the FIN basic header. When processing
InterAct messages (AddressType DN), this is one of the following:
|
|
| DisplayName | A descriptive name that is displayed in the user interface of the MER Facility instead of the value of the Address attribute. |
| Attribute | Description | Possible values |
|---|---|---|
| DNIEMPTY | The user can access messages that do not have a payload. | (none) |
| DNIUNPARSABLE | The user can access messages that are not parsable. | (none) |
| One attribute for every message type of the domain, for example, pain.001.001 for CT DnqERMessageRightsDNIMX, or FIN103 for CT DnqERMessageRightsDNIFIN. | A user can access messages that have the corresponding type. | (none) |
|
Note: CTs DnqERMessageRights<Domain> allow creation of access control roles
used by MER for message types of domain <Domain>. For example, CT
DnqERMessageRightsDNIFIN allows creation of access control roles for message types of domain
DNIFIN. The following CTs are provided by FTM SWIFT:
|
||
| Attribute | Description | Possible values |
|---|---|---|
| RMABypassTT | Whether RMA checks are bypassed for test and training (T&T) messages. This attribute is optional, the default is to not bypass these RMA checks. |
|
| FINReferenceExtraction | How to extract, from a FIN message, the value that is displayed in the "Reference" column of an MER Facility message list. Only the indicated possible values are allowed, this is not a comma-separated list. |
|
| MonitorThresholdRouting | The default queue-depth threshold for messages in an MER queue that are waiting to be routed. This attribute is optional. | Any positive integer. |
| MonitorThresholdUser | The default queue-depth threshold for messages in an MER queue that are awaiting user action. This attribute is optional. | Any positive integer. |
| RetypeFieldDefinitionsFile | The path and name of a file resource with custom definitions for retype fields. The file resource will be searched in the classpath of the MER enterprise application. | A resource path and file name starting with dnq/mer/.
By default, built-in retype field definitions are used. |
| EditorWrapLines | Indicates whether the line wrapping mode for input fields with multiple lines is enabled. If enabled, a line break is added automatically to the last line, when the user continues to write at the end of that line. The input field stops to accept characters typed by the user, if the cursor is located at the end of the maximum line. |
|
| EditorAllFieldsUppercase |
Indicates whether the conversion to uppercase characters is enabled for the input fields of FIN messages. If enabled, all characters in the input fields of the Formatted view or Unformatted view are displayed as uppercase characters. If the message is submitted, characters are saved as uppercase characters. |
|
| Attribute | Description | Possible values |
|---|---|---|
| VIEWHISTORY | Users can view the message history of messages they have access to in context of this OU. | (none) |
| VIEW | The user can view all messages available on any queue of this OU. | (none) |
| DELETE | The user can delete all messages available on any queue of this OU. | (none) |
| MOVE | The user can move all messages available on any queue of this OU. | (none) |
| COPY | The user can copy all messages available on any queue of this OU. | (none) |
| RETRYROUTING | The user can retry the routing of all messages available on any queue of this OU. | (none) |
| UNLOCK | The user can unlock all messages available on any queue of this OU. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| ActionList | Specifies the standard business actions and custom actions that are to be available on this queue. This attribute is optional. The default is to provide the standard business actions as specified for the queue purpose. If the value is specified but empty (at least one blank), no business actions are available for the queue. | A comma-separated list of:
|
| ActionListRequireOpen | Specifies the standard business actions and custom actions that are to be excluded from the context menu available on messages in the message list of this queue. This attribute is optional. The default is to provide the actions specific to the queue purpose, respectively to provide the actions as specified by the attribute ActionList. | A comma-separated list of:
|
| AllowComments | Specifies whether the editing of comments is allowed for queues with purpose Display. This attribute is optional. |
|
| AllowDrafts | Specifies whether the saving of draft messages is allowed for queues with purpose Create or Edit. This attribute is optional and can be specified only for queues with purpose Create or Edit. |
|
| BrowserPrintActionList | Specifies a list of actions that invoke browser-based printing of a message. This attribute is optional. | A comma-separated list of:
|
| CHANGELOCALADDR | Gives a user permission to change the local address of messages on an Edit queue. | (none) |
| MonitorThresholdRouting | The queue-depth threshold for messages in an MER queue that are waiting to be routed. If this number is reached or exceeded, an event is issued. | 0 (if the default threshold is to be ignored) or a positive integer (to override the default threshold). If not specified, the default threshold is applied. |
| MonitorThresholdUser | The queue-depth threshold for messages in an MER queue that are awaiting user action. If this number is reached or exceeded, an event is issued. | 0 (if the default threshold is to be ignored) or a positive integer (to override the default threshold). If not specified, the default threshold is applied. |
| Purpose | Defines the purpose of the queue. Note: For some
purposes, the value to configure differs from the name of the purpose.
See Creating new queues for
details.
|
|
| TEMPLATEADMIN | Gives a user permission to create, edit, and delete templates stored in a Template queue. | (none) |
| USE | Gives a user permission to:
|
(none) |
| ValidateRM | Defines for Create or Edit queues whether the RMA authorisation is validated. | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| DnqFlagMwh | Indicates whether the message warehouse function is enabled. |
|
| DnqContentMwh | Indicates what is to be stored in the message warehouse record. |
|
| Attribute | Description | Possible values |
|---|---|---|
| status | Displays print queue status | (none) |
| start | Starts print queues | (none) |
| stop | Stops print queues | (none) |
| reprint | Reprints messages or orders | (none) |
| confirm | Confirms an order | (none) |
| release | Releases an order | (none) |
| delete | Deletes messages or orders | (none) |
| restart | Restarts the ControlledInput node of the print service | (none) |
| Attribute | Description | Possible values |
|---|---|---|
| ParamString | String with parameters for the z/OS TSO OUTDES command. For a list of possible parameters, refer to the description of the OUTDES command in z/OS TSO/E Command Reference. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| InputEnabled | If this pseudo attribute is configured, the Message Print Service can import messages for this queue. | (none) |
| PrintDeviceType | The type of print device. This attribute is mandatory. |
|
| PrintDevice | The print device. Whether
this attribute is mandatory depends on the value of the PrintDeviceType
attribute:
|
|
| PrintOptions | For details, refer to Configuring a print queue - PrintOptions. |
Character string |
| PrintLineLength | Number of characters the printer can print per line. | Integer (the default is 80) |
| PrintPageLength | Number of lines the printer can print per page. | Integer (the default is 60) |
| PrintFormatHeader | Print format for the header. This attribute is optional. | Refer to PrintFormatHeader <FormatHeader> for possible values. |
| PrintFormatMessage | Print format for the message. This attribute is optional. | Refer to PrintFormatMessage <FormatMessage> for possible values. |
| OrderSize | How many messages are to be combined into a single print job. This attribute is optional. | Integer > 0 (the default value is 1) |
| OrderTimeout | Number of minutes after which an order is processed, even if its order size was not reached. A value of 0 means that no timeout is to be set. | Integer (the default is 0) |
| Confirmation | If configured, an operator must manually confirm each order. | (none) |
| BICExpansion | If configured, extra information about the BIC from the reference data database is added to the printout of each message. | (none) |
| Priority | The priority of the print queue. Higher values means higher priority. | Integer from 0 - 9 (default is 5) |
| TargetQueue | The name of the MQ queue for the generated output messages. If it is not configured, no output messages are generated. | Character string |
| TargetQMgr | The name of the MQ queue manager for the generated output messages. The default is the queue manager used by the message printing service. | Character string |
| Attribute | Description | Possible values |
|---|---|---|
| DoCmdAudit | Specifies the commands for which a command audit entry are to be written. |
|
| WorkingDirectory | Directory in which the print processing service
stores the print output files. For PrintToFile, the print output files
in this directory are moved to the user-defined directory specified
by the PrintDevice and PrintOptions attributes of a CO of type DnqPrintQueue. Optional when printing to a printer. Mandatory when printing to a file. |
Directory path |
| Attribute | Description | Possible values |
|---|---|---|
| Queue | Target queue into which messages are to be put | |
| QueueManager | Queue manager of the target queue |