Troubleshoot Business Processes

You cantroubleshoot Business Processes using the Business Process Admin and the UKG Pro Workforce Management Business Processes error log.

Use the Business Process Admin

Use the Business Processes Admin to monitor and troubleshoot Business Processes.

  1. From the Main Menu, select Administration > Business Processes.

    The Business Process Admin is displayed in a new tab.
  2. Select any of the following tabs:
    • Deployments — Lists application deployments by tenant and version. You can redeploy or delete applications.
    • Definitions — Lists deployed process definitions. You can sort or filter definitions by tenant, category, or name.
    • Instances — Lists current running process instances. You can complete a running instance.
    • Tasks — Lists current tasks. You can reassign or complete tasks.
    • Jobs — Lists current jobs. Jobs can be manually completed.
  3. Expand results to display more detailed information about them.

Log Business Processes in UKG Pro Workforce Management

Use logs to troubleshoot errors encountered when running Business Processes.

About logs and logging

You can run logs for multiple Business Processes at the same time; consider limiting concurrent logs to 5. The Business Processes page shows the time the log was created, and the Log Status column indicates whether the log is running or has been stopped.

Logs run for a maximum of 30 minutes but can be stopped manually when you wish. See Stop logging for more information. Logs are saved for 48 hours before they are purged from the system. Consider exporting any logs you wish to save. See Export a log for more information.

If you stop logging and then start logging the same Business Process, the system creates a new log; the previous log is overwritten and cannot be retrieved. The system does not merge logs for the same Business Process.

Note: Business Processes logging might be disabled in some production environments.

Logged information

Business Processes logs contain runtime errors extracted from the stack trace that is generated when you start the log. Logs present this information:

  • Process Instance ID— The unique instance identifier of the Business Process run in which the error occurred.
  • Component — The name of the stencil set item in the Business Process that caused the error.
    Note: Stencil set items without a name appear as "—none—" in the log. To make troubleshooting more efficient, give stencil set items meaningful names when adding them to your model.
  • Error Description — The error message extracted from the stack trace that is run when you start the log. Error messages are truncated at 512 characters.
  • Log Time — The time the error was captured.

Start logging

You start a log on a running Business Process.

To start logging:

  1. From the Main Menu, navigate to Administration > Application Setup > Business Process Setup > Business Processes.
  2. From the Process Models page, select the Business Process you want to start logging.
  3. Click Tap the Start Log button.

    The Log Creation Date column displays the date and time the log was started. Time is displayed using a 24-hour clock.

    The Log Status column displays Running.

    Note:

    You might have to refresh your browser to update the Log Status column.

Stop logging

Note: The system stops logs after they have been running for 30 minutes. You can stop them manually at any time.

To stop logging:

  1. From the Main Menu, navigate to Administration > Application Setup > Business Process Setup > Business Processes.
  2. From the Process Models page, select the Business Process whose log you want to stop.
  3. Click Tap the Stop Log button.

    The Log Creation Date column retains the time stamp from when the log was started.

    The Log Status column displays Inactive.

    Note:

    You might have to refresh your browser to update the status of the Log Status column.

Display a log

To display a Business Processes log:

  1. From the Main Menu, navigate to Administration > Application Setup > Business Process Setup > Business Processes.
  2. From the Process Models page, select the Business Process whose log you want to view.
  3. Click the View Log button.

    The log is displayed in a new browser window.

    Note:

    If no errors were logged, the log displays this message:

    This table currently contains no data.

    Empty logs cannot be exported.

Export a log

The Businesses Processes log is exported as a CSV file to your browser's default download location. Error logs have file names in this format:

Process_Error_Log_<Process Definition Id>.csv

Note: Before you begin, ensure that pop-ups are enabled for your browser.

To export a Business Processes log:

  1. View the log as described in Display a log.
  2. Click the Export button. (This button is disabled if the log is empty.)

    The log is exported to your browser's default download location.