Execute Diagnostic Command page

The execute diagnostic command page is used to run a diagnostic command on a selected server. The page is displayed by using the menu actions for a selected server on the platform components page. For more information about using the platform components page to display the execute diagnostic command page, see Platform components page.

Fields

The fields that are available on the page are shown in the following list. Required fields are indicated with an asterisk.

Component name

The name of the component that was selected on the platform components page. This field is read only.

Server name

The name of the server on which the command is run. This field is read only.

Host name

The hostname of the server on which the command is run. This field is shown only if the user has the proper permissions. This field is read only.

Machine address

IP address of the application run time on which the command is run. This field is shown only if the user has the proper permissions. It is read only.

Socket port number

The port number of the socket of the server on which the command is run. This field is shown only if the user has the proper permissions. It is read only.

Diagnostic command *

Select the diagnostic command to run from the list that is displayed for the component selected. Only commands that the user has permission to run are displayed.

Table 1. Diagnostic commands
Application	Commands	Description
Business Rules Manager	buildtables	Builds and distributes the Business Rules XML workflow descriptor files and tables.
	list actualcfg	Displays the configuration parameters and their values for the active Business Rules Manager. Values for encrypted parameters are displayed in plain text.
	list cfg	Displays the configuration parameters and their values for the active Business Rules Manager. Values for encrypted parameters are displayed as asterisks.
	list env	Displays the environment data that is being used for Business Rules Manager.
	rungc	Starts the garbage collector for Business Rules Manager.
	snapshot	Collects problem determination information for Business Rules Manager into a single, compressed file. If an optional PMR number is entered in the edit field, it is included in the name of the file.
	status	Displays the internal status of Business Rules Manager.
	status detail	Displays more details for the Business Rules Manager status.
	trace off	Disables low-level tracing for Business Rules Manager.
	trace on	Enables low-level tracing for Business Rules Manager. Note: Enabling low-level tracing is not recommended during production processing. Use low-level tracing only to help with problem determination.
Gateway Server	clearfs	Deletes file status and duplicate detection information from the database. The data that is deleted is the information that is associated with the files that all instances of Gateway Server processed. Specify a file name to delete only the file status and duplicate detect information that is associated with the specified file from the database. Note: Clearing the Gateway Server file status information from the database affects both file restarts and viewing the Gateway Server files with the Control Center. Also, running clearfs on a single Gateway Server instance deletes the data that is related to all instances of Gateway Server. Use this command with caution.
	genXML	Generates an XML file that contains the file status information for the files that this Gateway Server processed. Specify a file name to generate an XML file that contains only the file status information that is associated with the specified file. The file status information is written to the file specified in the parameter for this command. The XML format of this file is the equivalent of the format that used to be in a Gateway Server WIP file.
	iqa off	Disables calling IQA.
	iqa on	Enables calling IQA.
	its off	Disables writing records to the Transaction Server.
	its on	Enables writing records to the Transaction Server.
	list actualcfg	Displays the configuration parameters and their values for the active Gateway Server. Values for encrypted parameters are displayed in plain text.
	list cfg	Displays the configuration parameters and their values for the active Gateway Server. Values for encrypted parameters are displayed as asterisks.
	list env	Lists the environment parameters and their values.
	onDupBundle off	Disables the duplicate bundle check.
	onDupBundle rejectFile	Gateway Server rejects the input file when a probable duplicate bundle is found.
	onDupBundle warn	Gateway Server issues a warning message when a probable duplicate bundle is found.
	onDupCashLetter off	Disables the duplicate cash letter check.
	onDupCashLetter rejectFile	Gateway Server rejects the input file when a probable duplicate cash letter is found.
	onDupCashLetter warn	Gateway Server issues a warning message when a probable duplicate cash letter is found.
	refresh	Refreshes the local process control file in memory, which allows the file to be changed without having to restart Gateway Server. The copy of the local process control file is removed and then the current version is loaded.
	register	Notifies the Gateway registration services that the Gateway Server is up and running. This command must be used only if the Gateway Server was started before the registration service started. Otherwise, the Gateway Server is registered with the registration service when it starts.
	rejectdups off	Disables the duplicate reject process.
	rejectdups on	Enables the duplicate reject process.
	snapshot	Collects problem determination information for Gateway Server into a single, compressed file. If an optional PMR number is entered in the edit field, it is included in the name of the file.
	status	Displays the internal status of Gateway Server.
	status debug	Displays debug information for Gateway Server components such as the thread monitor and the file-level timer.
	status detail	Displays more details for the Gateway Server status.
	trace off	Disables low-level tracing for Gateway Server.
	trace on	Enables low-level tracing for Gateway Server. Note: Enabling low-level tracing is not recommended during production processing. Use low-level tracing only to help with problem determination.
Transaction Server	clearxs	Deletes the Transaction Server contents from the database. Note: Never use this command in a production environment. Use the sysClrEnabled property to control this action.
	delete	Deletes an entry. Specify the entry by date, category, or entry number. Note: Entries that contain nonpaper capture items cannot be moved or deleted.
	fire task	Starts tasks that are configured within the Transaction Server. To start a task, specify a valid task ID. Use the list schedule command to display the valid tasks and their IDs.
	list actualcfg	Displays the configuration parameters and their values for the active Transaction Server. Values for encrypted parameters are displayed in plain text.
	list agents	Displays the current agents for Transaction Server.
	list cfg	Displays the configuration parameters and their values for the active Transaction Server. Values for encrypted parameters are displayed as asterisks.
	list env	Displays the environment variables and their values for Transaction Server.
	list ifs	Displays the image information for items for a specific date and category, or lists image information for all items in the Transaction Server. The default is to list information for all items.
	list ifs status	Displays the IFS status.
	list listeners	Displays the current listeners for Transaction Server.
	list locks	Displays the active locks.
	list schedule	Displays the current tasks in the Transaction Server scheduler.
	list scheduler	Displays the formatted contents of the Transaction Server scheduler. This command shows only the contents that were loaded. The following scheduler XML tags are not displayed because they control what is loaded but are not used at run time. Comments `<INCLUDE>` `<CONFIG>` `<SECTION>`
	list profile	Displays the current profiles for Transaction Server.
	move	Moves an entry from one business day to another business day within the Transaction Server. The move command options are from date, from category, from entry, to date, to category, and to entry. Note: Entries that contain nonpaper capture items cannot be moved or deleted.
	pause listeners	Pauses any active Transaction Server listeners.
	restart listeners	Restarts all the Transaction Server listeners. The Transaction Server listeners are defined in the listener configuration XML file.
	resume listeners	Restarts the paused Transaction Server listeners.
	snapshot	Collects problem determination information for Transaction Server into a single, compressed file. If an optional PMR number is entered in the edit field, it is included in the name of the file.
	status	Displays the internal status of Transaction Server.
	status detail	Displays more details for the Transaction Server status.
	trace off	Disables low-level tracing for Transaction Server.
	trace on	Enables low-level tracing for Transaction Server. Note: Enabling low-level tracing is not recommended during production processing. Use low-level tracing only to help with problem determination.
Business Rules Server	forcevalidate off	Disables forced validation of all content and MICR fields.
	forcevalidate on	Enables forced validation of all content and MICR fields.
	gc	Starts the garbage collector for Business Rules Server.
	list actualcfg	Displays the configuration parameters and their values for the active Business Rules Server. Values for encrypted parameters are displayed in plain text.
	list agents	Displays the currently connected client applications.
	list cfg	Displays the configuration parameters and their values for the active Business Rules Server. Values for encrypted parameters are displayed as asterisks.
	list env	Displays the environment data that is being used for Business Rules Server.
	refresh	Reloads the workflow XML and .tbl files. The following list shows the optional parameters and their effect. workflows This parameter indicates that the workflows are to be refreshed.
	snapshot	Collects problem determination information for Business Rules Server into a single, compressed file. If an optional PMR number is entered in the edit field, it is included in the name of the file.
	status	Displays the internal status of Business Rules Server.
	status detail	Displays more details for the Business Rules Server status.
	terminate	Stops a client connection. An administrator uses this command to stop a client from further processing.
	trace detail	Displays detailed trace information for Business Rules Server.
	trace off	Disables low-level tracing for Business Rules Server.
	trace on	Enables low-level tracing for Business Rules Server. Note: Enabling low-level tracing is not recommended during production processing. Use low-level tracing only to help with problem determination.
	validate	Searches all tables for validation errors. Normally, tables are validated in the Business Rules Manager when they are distributed. This command does the same function in Business Rules Server.

Parameters

Optional parameters to be passed to the diagnostic command.

Actions

The actions that are available on the page are shown in the following list.

Open documentation link opens the help page.
Execute runs the diagnostic command. This action is available only to users with administrator permissions.
Cancel returns to the platform components page. All unsaved changes are lost.