list

Purpose

Use this command to list information about one or more MSIF scenarios. Use parameters of this command to specify filter criteria. Only those scenarios that match all the specified filter criteria are listed. The output is sorted by the date and time that the state of the scenario was last updated.

Required access rights:	CT: DnfEfaCmdAccessControl CO: DnfEfaAdmAccessControl attr: list
Predefined roles that provide required access rights:	DnfEfaAdministrator
Issue for OU:	Business OU
Issue to service:	DNF_O_CMD

Format

timestamp parameters

Parameters

-ref

The MSIF reference of the scenarios to be listed. You can use the following wildcard characters:

%: Use a percent character as a wildcard that represents any number of characters.
_: Use an underscore character as a wildcard that represents a single character.

-tref

The transfer reference (for a file transfer) or SWIFT reference (for a message transfer) of the scenarios that are to be listed. These references are assigned by SWIFT.

-lfn

The external reference of the scenarios that are to be listed:

For a SendFile, FileReceived, ProvideFileForDownload, DownloadFile, or RespondDownload scenario: The external reference is the logical name of the file being transferred. This name is specified by the sender and is used to identify the file.
For a NotifReceived scenario: The external reference is the MSIF reference of the SendFile, SendMsg, or RespondDownload scenario to which the NotifReceived scenario applies. A NotifReceived scenario corresponds to a SWIFTNet notification for a SendMsg, SendFile, or RespondDownload scenario.

You can use the percent character (%) as a wildcard to represent any number of characters, or the underscore character (_) as a wildcard to represent a single character. If an external reference contains an underscore character, precede the underscore character by two backslash characters, for example, input\\_file42.

-st

The transfer state of the scenarios that are to be listed. Which values you can specify depends on the type of scenario. These values are described in States of an MSIF scenario.

-sn

The notification state of the scenarios that are to be listed. Which values you can specify depends on the type of the scenario. These values are described in States of an MSIF scenario.

-co

The transfer condition of the scenario:

running

The MSIF transfer service is processing a message or file transfer.

finished

The MSIF transfer service finished processing a message or file transfer.

inError

The MSIF transfer service encountered an error. For most scenarios that have this condition, after the error is corrected, the MSIF administrator can recover the scenario by issuing the recover command (see recover). However, if the error was caused by a misconfigured CO for a scenario other than a FileReceived scenario, cancel the scenario, correct the error, and resubmit the corresponding request.

stopped

The MSIF transfer service stopped processing a scenario for one of the following reasons:

The MSIF operator stopped the MSIF transfer service for the OU of the scenario.
The MSIF transfer service is not subscribed to receive events from the SAG.

lockedByExpiry

The relative expiration time specified for the RelativeExpiration option has elapsed. The MSIF transfer service enters this condition until the state of the scenario changes to Expired, at which time the condition of the MSIF transfer service changes to Running.

lockedByCancel

An MSIF administrator issued a cancel command to cancel a running scenario (see cancel). The scenario enters this condition until the state of the scenario changes to Canceled, at which time the condition of the scenario changes to Running.

waitForSAG

An SAG is currently conducting its maximum number of simultaneous file transfers. This number is determined by:

The message transfer window: This window limits the maximum number of requests or delivery notifications that are associated with file transfers and for which a response can be outstanding at any one time. It is set by the SAG communication option FileWindowSize.
The SAG (If you use SAG 7.0): The SAG allows at most 30 concurrent file transfers.

The MSIF transfer service waits until the number of active file transfers falls below both of these limits before initiating the next file transfer.

unrecoverableError

The MSIF transfer service encountered an error from which it cannot recover.

-cn

The notification condition of the message or file transfer:

running: The MSIF transfer service is processing a system message for a message or file transfer.
inError: The MSIF transfer service encountered an error while processing a system message for a message or file transfer. After the error is corrected, the MSIF administrator can recover the file transfer by issuing the recover command (see recover).
waitForSAG: An SAG is currently conducting its maximum number of simultaneous file transfers.

-s

The type of scenario to be listed:

SND: Send a message or file to a counterpart (SendMsg or SendFile).
RCV: A counterpart sent a message or file, or the network sent a SWIFTNet notification (MsgReceived, FileReceived, or NotifReceived).
PRVDL: Provide a file for downloading by counterparts (ProvideFileForDownload).
RSPDL: Respond to a request to download the file, and notify a local application each time a file is downloaded (RespondDownload).
DL: Download a file from a counterpart (DownloadFile).
FS: An FS auxiliary-function scenario. This can be specified only if -qo a is also specified. For more information about auxiliary functions, see Auxiliary functions.
SAGSD: An SAGSD auxiliary-function scenario. This can be specified only if -qo a is also specified. For more information about auxiliary functions, see Auxiliary functions.
SAGRC: An SAGRC auxiliary-function scenario. This can be specified only if -qo a is also specified. For more information about auxiliary functions, see Auxiliary functions.

-obj

The type of object of the scenarios that are to be listed:

MSG: List only message-transfer scenarios (SendMsg, MsgReceived, or NotifReceived).
FILE: List only file-transfer scenarios (SendFile, FileReceived, ProvideFile, DownloadFile, RespondDownload, or DeleteFile).
NOTIF: List only NotifReceived scenarios.

If no object is specified, all types of scenarios are listed.

-mode

The delivery mode of the scenarios that are to be listed:

RT: List real-time scenarios.
SNF: List store-and-forward scenarios.

If no mode is specified, real-time and store-and-forward scenarios are listed.

-chl

The name of the input or output channel used for the message or file transfer. A name can contain a percent character (%) as a wildcard to represent any number of characters, or an underscore character (_) as a wildcard to represent a single character. If a channel name contains an actual underscore character, precede that character by two backslash characters, for example:

xxxxdeff\\_generic!x

To list only the scenarios that use a specific type (input or output) of channel, specify the -s parameter in addition to the -chl parameter:

-s SND: To list only those scenarios that use an input channel.
-s RCV: To list only those scenarios that use an output channel.

-fa

The minimum number of failed attempts that a scenario must have in order to be listed. The default is 0, that is, all scenarios are listed regardless of how many times their corresponding transfers failed.

-ra

Whether a scenario is listed depends on whether it has automatic recover attempts remaining:

Yes

Only those scenarios are listed that encountered a recoverable error and for which at least one automatic recovery attempt is remaining; that is, the number of attempts has not reached the maximum specified by the MaxAutoRecoverCount attribute, which is described in SAG message partner options: SagMPOptions.

No

Only those scenarios are listed that either did not encounter a recoverable error, or that did, but that do not have any automatic recovery attempts remaining, because either:

Automatic recovery is not used for the scenario (that is, the value of the MaxAutoRecoverCount attribute is set to 0 for the SAG message partner used in the scenario)
All automatic recover attempts were exhausted for the scenario

If a scenario that encountered a recoverable error is to be recovered, and if no automatic recover attempts are remaining for that scenario, the recovery must be done manually as described in recover. To list the scenarios that encountered recoverable errors and that will not be recovered automatically (that is, that require manual intervention), specify the parameters -co inError and -ra No.

If a scenario for which no automatic recover attempts are remaining is to be recovered, this must be done manually as described in recover.

-me

The maximum number of entries that are to be listed. The default is 50. Do not specify a number above 5000. To improve performance, specify a value under 1000.

-lo

The value of this parameter is a string of letters, each of which indicates what output information is to be displayed, and the order in which it is to be displayed. The default is rtosckjdnvqmufzpe.

r: MSIF reference.
l: MSIF reference tail, that is, the final 8 hex characters of the MSIF reference.
t: The SWIFT reference (for a message-transfer scenario) or transfer reference (for a file-transfer scenario).
o: Scenario type.
s: Transfer state.
c: Transfer condition.
k: Notification state.
j: Notification condition.
d: Local DN.
n: Remote DN.
v: Service name.
q: Request type.
m: Start date and time.
u: Date and time of last update.
i: SnF input time
f: External reference. This reference is described in the explanation of the -lfn parameter.
z: Size, in bytes, of the application file. The application file is the file that is received from or passed to the application, whereas the network file is the file that is received from or passed to the network. Compared to the application file, the network file might be compressed and might use a different code page.
p: Expire time.
x: Expire state.
e: Cancel state.
b: Object type (FILE, MSG, or NOTIF).
a: Delivery mode (RT or SnF).
h: Channel name.
w: Number of failed recovery attempts, including both manual and automatic attempts.
y: Number of remaining automatic recovery attempts for a scenario that encountered a recoverable error.

-lf

The format of the list output:

single: All output fields for a scenario are displayed in a single message.
multi: Each output field for a scenario is displayed in a separate message on a new line.

timestamp parameters

Use these parameters to include only those scenarios that were started or that experienced a state change before or after specific times:

-stf: The name of this parameter is an abbreviation of start time from. Only scenarios that started after this time are listed. If -sdf is also specified, the default is 0 a.m. (midnight); otherwise, there is no default. The time zone is Coordinated Universal Time (UTC).
-sdf: The name of this parameter is an abbreviation of start date from. Only scenarios that started after this date are listed. If -stf is also specified, the default is the current date; otherwise, there is no default.
-stt: The name of this parameter is an abbreviation of start time to. Only scenarios that started before this time are listed. If -sdt is also specified, the default is 0 a.m. (midnight); otherwise, there is no default. The time zone is Coordinated Universal Time (UTC).
-sdt: The name of this parameter is an abbreviation of start date to. Only scenarios that started before this date are listed. If -stt is also specified, the default is the current date; otherwise, there is no default.
-lutf: The name of this parameter is an abbreviation of last update time from. Only scenarios that changed their state after this time are listed. If -ludf is specified, the default is 0 a.m. (midnight); otherwise, there is no default. The time zone is Coordinated Universal Time (UTC).
-ludf: The name of this parameter is an abbreviation of last update date from. Only scenarios that changed their state after this date are listed. If -lutf is specified, the default is the current date; otherwise, there is no default.
-lutt: The name of this parameter is an abbreviation of last update time to. Only scenarios that changed their state before this time are listed. If -ludt is specified, the default is 0 a.m. (midnight); otherwise, there is no default. The time zone is Coordinated Universal Time (UTC).
-ludt: The name of this parameter is an abbreviation of last update date to. Only scenarios that changed their state before this date are listed. If -lutt is specified, the default is the current date; otherwise, there is no default.

The format in which you specify a date or time is locale-dependent. For a list of time and date formats, see Languages and regions.

-qo a

A query option that specifies that information about auxiliary-function scenarios is to be displayed in addition to information about file-transfer scenarios. The MSIF transfer service uses auxiliary functions to create and delete working copies of the files that it transfers. During a file-transfer scenario, for each auxiliary function that the MSIF transfer service employs, it creates a separate auxiliary-function scenario. An auxiliary-function scenario and its corresponding file-transfer scenario both have the same MSIF reference, and so can be correlated. For more information about auxiliary functions, see Auxiliary functions.

Examples

The following command lists the first 50 scenarios in multiple line format, that is, each output field for a scenario is displayed in a separate message on a new line:

INST1.BANKA.DNF_O_CMD>list -lo rtosckjdnvqmufzxebaywh -lf multi -me 50
DNFO0330I The list command completed successfully.
DNFO0334I Information displayed for '27' scenarios that meet filter criteria.
DNFO0299I ---------------------------------------------
DNFO0202I MSIF reference : 'c3e2d840d8f4f9f64040404040404040c205ca72ea353c12'
DNFO0204I Transfer reference: 'SNL00601XX1204293155000485S'
DNFO0205I Scenario          : 'SAGRC'
DNFO0206I Transfer state    : 'Requested'
DNFO0207I Transfer condition: 'running'
DNFO0221I Notif. state      : 'Refusal'
DNFO0222I Notif. condition  : 'running'
DNFO0208I Local DN          : '.'
DNFO0209I Remote DN         : '.'
DNFO0210I Service           : '.'
DNFO0211I Request type      : '.'
DNFO0212I Start time        : 'Feb 28, 2009 2:53:01 PM'
DNFO0213I Last update time  : 'Feb 28, 2009 3:13:01 PM'
DNFO0214I Ext. reference : '.'
DNFO0215I App. File size    : '.'
DNFO0217I Expire state      : '.'
DNFO0218I Cancel state      : '.'
DNFO0219I Object type       : 'FILE'
DNFO0220I Delivery mode     : 'RT'
DNFO0223I Failed attempts   : '11'
DNFO0224I Remaining attempts: '2'
DNFO0225I Channel name      : '.'
DNFO0299I ---------------------------------------------
DNFO0202I MSIF reference : 'c3e2d840d8f4f9f64040404040404040c0c01a51d971b897'
⋮

The following command lists all scenarios in single-line format, that is, the output fields for each scenario are displayed in a single message:

INST1.BANKA.DNF_O_CMD>list -lo ltcuy -lf single
DNFO0330I The list command completed successfully.
DNFO0334I Information displayed for '44' scenarios that meet filter criteria.
DNFO0200I req_ref_tail transfer_ref transfer_condition last_update failed_attempts
DNFO0201I a7527c58 SNL00601XX1203415892000764S finished Dec 19, 2015 11:14:03 AM 11
DNFO0201I a7527c58 . finished Dec 19, 2015 11:16:01 AM 0
⋮

The following command lists all NotifReceived scenarios, that is, scenarios for the SWIFTNet notifications that apply to a SendMsg, SendFile, or RespondDownload scenario:

INST1.BANKA.DNF_O_CMD>list -obj NOTIF -lo rtbkf
DNFO0330I The list command completed successfully.
DNFO0334I Information displayed for '2' scenarios that meet filter criteria.
DNFO0299I ---------------------------------------------
DNFO0202I MSIF reference : 'f4e2d840d8f4f9f64040404040404040c205ca72ea353a11'
DNFO0204I Transfer reference: 'SNL00601XX1204293155000485S'
DNFO0219I Object type       : 'NOTIF'
DNFO0221I Notif. state      : 'Correlated'
DNFO0214I Ext. reference : 'b4e5684cd8f4f9f6338844338844890c205ca72ea353c12'
DNFO0299I ---------------------------------------------
DNFO0202I MSIF reference : 'e7e2d840d8f4f9f64040404040404040c0c01a51d971b010'
⋮

The following command lists all NotifReceived scenarios that correspond to a SendMsg, SendFile, or RespondDownload scenario that has the MSIF reference 'f4e2d840d8f4f9f64040404040404040c205ca72ea353a11':

INST1.BANKA.DNF_O_CMD>list -obj NOTIF -lfn f4e2d840d8f4f9f64040404040404040c205ca72ea353a11 -lo rtbkf⋮