dispose

Purpose

The dispose command deletes an FTM SWIFT database entry of the SIPN FIN services that is suspected of being manipulated. To get detailed information about manipulated database entries, run the check command with the -report option first.
Required access rights: User requires the rights according to data integrity disposing. Refer to Table 1 for further information.
Predefined roles that provide required access rights: None

Format

Read syntax diagramSkip visual syntax diagram  dnpdic  -dispose  -ref disposeReference -Djava.security.policy=<policy_file> -passphrase phrase -dsn data_source_name -schema schema -instanceinstance -qmgrqmgr -uid user_id -pw password -dbhost host -dbport portMQ options
MQ options
Read syntax diagramSkip visual syntax diagram  -host host  -channel channel  -port 1414 -portnumber -ciphersuitename -truststorefilename -fips
To display command help:
Read syntax diagramSkip visual syntax diagramdnpdic -help -h -dispose
Notes:
  • Deleting a row in a database may cause the deletion of other rows in linked tables which are referentially constrained.
  • The deletion of a row causes a message audit log entry. For a description see Audit log for Data Integrity Checker command dispose.
  • If a message warehouse entry exists for the disposed message, the message warehouse status is changed to DI_DISPOSED.
  • FTM SWIFT events are not processed unless the instance's remote event service DNI_R_EVENT is running.
  • You must specify parameters -host, -channel and -port only if you want the data integrity checker to connect to the queue manager specified by parameter -qmgr in client mode. If you omit these parameters, the data integrity checker connects in bindings mode.
  • You must specify parameters -ciphersuite, -truststore and -fips only if you want to use SSL/TLS.

Parameters

-ref disposeReference
The reference to the entry which is to be disposed. A DisposeReference will be printed alongside the data which is suspected to be manipulated when running the -check command. The reference has to be specified in the following format:
name#xxx         (Example: FINSEND#1021)
where name can be either FINDSEND or FINRECEIVE and xxx represents a numerical value.
-Djava.security.policy=policy_file
policy_file is the policy file that was provided for the runtime system. You can omit this parameter if your system administrator has added the required policies to the JVM default security properties file. For more information, see Java Policy files.
-passphrase phrase
The passphrase that the data integrity administrator specified when issuing the vault utility command create as described in activation of the data integrity framework, step 2.a.
Notes:
  • If you omit this parameter, the data integrity checker utility prompts for the passphrase.
  • Instead of specifying the phrase itself, you can also provide a stash file as described in Stash File Utility, for example:
    -passphrase @/var/ftmswift_v300/run/passphrase.stash
-dsn data_source_name
The data source name of the FTM SWIFT runtime database. The value of environment variable DNI_DSN is used as default.
-schema schema
The schema name of the tables in the FTM SWIFT runtime database. The value of environment variable DNI_SN is used as default.
-instance (or -in or -i) instance
The name of the FTM SWIFT instance used to write events. If not specified, the environment variable DNI_I is used.
-qmgr qmgr
The name of the queue manager that is associated with the specified FTM SWIFT instance. If not specified, the environment variable DNI_QM_instance is used.
-uid user_id
The user ID to be used when connecting to the FTM SWIFT runtime database. Specify your own user ID as user_id. If not specified, the user ID of the user running the data integrity checker is taken.
-pw password
The password of the user ID specified in the -uid parameter.
Notes:
  • If you omit this parameter, the data integrity checker prompts for the password.
  • Instead of specifying the password itself, you can also provide a stash file as described in Stash File Utility, for example:
    -pw @/var/ftmswift_v300/run/db2.stash
-dbhost hostname
The hostname of the database server which contains the datasource. If specified, the parameter dbport is also required.
-dbport port
The port number of the database server which contains the datasource. If specified, the parameter dbhost is also required.
-host host
The host name of the IBM® MQ server on which the queue manager runs. Specify this parameter if you want the data integrity checker to connect to the queue manager in client mode instead of bindings mode.
-channel channel
The channel to be used to connect to the queue manager. Specify this parameter if you want the data integrity checker to connect in client mode instead of bindings mode.
-port number
The port number of the IBM MQ server on which the queue manager runs. Specify this parameter if you want the data integrity checker to connect in client mode instead of bindings mode. The default is 1414.
-ciphersuite name
The name of the SSL cipher suite to be used in client connections to the IBM MQ server on which the queue manager runs. Use the name of the SSL cipher suite that matches the SSL definition for the channel name used. Refer to the IBM MQ documentation, SSL CipherSpecs and CipherSuites in MQ classes for Java, for more information on cipher suite naming.
-truststore filename
The file name of a trust store which contains the certificate information of the IBM MQ queue manager. Refer to the IBM MQ documentation, Configuring SSL security, for details on how to set up SSL/TLS connections and certificate information.
-fips
Use this parameter to enable Federal Information Processing Standards (FIPS) conforming SSL/TLS operations.
-help or -h
Show the help text that describes the parameters.

Return codes

The dispose command terminates with one of the following return codes:
Code
Description
0
Successful processing. This implies that the specified row has been disposed and an audit entry was written. If there is a message warehouse entry for the data entry, the message warehouse status was set to DI_DISPOSED.
4
No row was disposed because an invalid parameter was specified, the data entry is not detected as suspicious by the check command or FTM SWIFT is not in a state to dispose the data entry.
8
The check command terminated because the vault file could not be read.
12
The check command terminated due to a fatal error. For more information, see the command output in the shell.

Example

The following command (issued on a single line) disposes the potentially manipulated entry with reference FINSEND#2 of the FTM SWIFT database identified by environment variables DNI_DSN (data source name) and DNI_SN (schema name):
dnpdic -dispose -ref FINSEND#2 -Djava.security.policy=/var/ftmswift_v300/run/ftmswift.policy 
        -uid john -pw johns_password -i INST1 -qmgr QM3
       -host localhost -channel SYSTEM.DEF.SVRCONN -port 1421