• All Files

Kofax Reporting Platform Component

The Kofax Reporting Platform component enables you to test the Kofax Reporting Server ability to process work.

Test Platform

Settings Page

Select what to test. Select the type of platform Test:

  • Check KR Central Site Services.
  • Check KR Application Sender Services.
  • Check KR ETL Agent Services.
  • Check Message Queue (MSMQ) KR Central Site Server Service.
  • Check Message Queue (MSMQ) KR Application Sender Server Service.
  • Check KR Central Site Server Free Space.
  • Check KR ETL Server Free Space.
  • Check KR Central Site Receiver Status.
  • Check KR Application Sender Status.
  • Check KR Central Site Server Windows Event Log.
  • Check KR Application Sender Server Windows Event Log.
  • Check KR ETL Server Windows Event Log.
  • Check KR ETL Server Log File Error Count.

Depending on the Test selection, complete the following input:

Computer Name. Enter the Host Name or IP Address of the target KR computer. Use a '.' for the computer name if it is a local computer.

Credentials. Enter the Windows authentication information for the target computer. The Windows account should have local administrator rights on the target KR computer.

Drive. Enter the appropriate drive letter.

Event ID. Enter the Event ID to be tested. If not known, leave blank.

Event Type. Select the type of event you want tested: Error or Warning.

Filter by records older than. Select a search range by time in minutes, and then provide the following (both items are required, and the defaults are set for the KfxReporting_ETL_Agent.log format):

  • Date/Time Regular Expression. Enter an expression to use for locating the date time in the log record.You can click and select an option from the list to help build the expression. Click Help for Regular Expressions to access the Microsoft Regular Expression Syntax web page.
  • Date/Time Pattern. Enter the date/time pattern to use to parse the date time string, or leave the default. Click Help for Date/Time Pattern to access the Microsoft Custom DateTime Format Strings web page.

Log File Name. Browse to select, or enter the log file path (UNC share or local file path to: C:\ProgramData\Kofax\Reporting\KofaxReportingETLAgent\Log\KfxReporting_ETL_Agent.log).

Match Keywords in the Event Log. When selected, at least one of the keywords entered must match the Event Log message to be successful. If this option is not selected, then none of the entered keywords should match to be successful. Define up to three keywords:

  • Keyword 1. Type the first keyword to match to the Event Log message.
  • Or Keyword 2. Type the keyword to march if the Keyword 1 is not matched.
  • Or Keyword 3. Type the keyword to match if Keyword 1 and Keyword 2 are not matched.

Maximum number of errors. Enter the maximum number of search string matches to return. A -1 (the default) indicates unlimited number of search string matches indicating an error.

Retrieve messages logged within the last. Enter an appropriate number of seconds. Kofax Monitor retrieves only those logs generated from zero seconds to the specified number of seconds. You should enter the number of seconds best fitting the events you are testing.

Search for. Enter a search string using simple text, or using regular expressions. The default value of ERROR|WARN counts all log records with an ERROR or WARN status.

  • Text. Enter the search text.
  • Text matching a regular expression. Select one of the default expressions, or click and select a search option from the list. You can optionally type additional text. Click Help for Regular Expressions to access the Microsoft Regular Expression Syntax web page.

Service Names. Enter the Windows Service Name for the desired Windows Service. (Default values for KR required services are pre-filled.)

Source Name. Select the source name of the log entry: WSA-Receiver, WSA-Sender, or KofaxReportingETLAgent.

Threshold. Enter the appropriate threshold value.

URL. Enter the URL for the KR server status. Replace the <host> with the KR server name and <port> with the port number (if not the default port). If using an SSL connection, use the URL format: https://<host>:<ssl port>.

Test Definition Page

Resource Name. The name of the Monitor Resource associated with the Test.

Test Description. Text automatically generated from your selections.

Expected Response. The expected response for this Test. (Limited to 255 characters.)

 

Run the Test. Add the Test. Adjust the Time Out value if needed. Turn on Debug Messages if needed.

If you selected Check KR Central Site Server Free Space, Check KR ETL Server Free Space, or Check KR ETL Server Log File Error Count, you can enable and select an output Metric.

Click Next.

Next Steps Page

This is the end of the Test. Choose to add another Test or end the Platform Component section of the Wizard.

Was this helpful?

Thank you.