Debug a workflow solution

You can debug a solution and identify any issues quickly when developing a solution.

  1. Open a Quick Workflow solution.
  2. Click Debug button on the ribbon bar.

    The Debug page opens.

  3. Enter the initialization variable values.

    If a folder or a document initialization variable is used, you can select either option to upload the documents:

    • New: Click Browse and select one or more documents depending on the initialization variable (document or folder) used.

      • If a document variable is used, a new document instance is created and you can upload only one document.

      • If a folder variable is used, a new folder is created where you can upload multiple documents.

    • Existing: You can use an existing folder or a document to upload. You can provide an instance ID (document or folder) or leave it empty. (Folder: It creates an empty folder with no documents; Document: It creates a default empty document)

    If a data object initialization variable is used, the controls for the fields within the data object variable are displayed. You can set values for the initialization data.

  4. Click Start.

    The workflow opens in debug mode in a new browser tab in the same style as Quick Workflow.

    The Debug toolbar includes the following tools.

    Tool Name Description

    Go

    Debugs the workflow solution.

    Show Job History

    Displays the job history. You can view how the workflow solution arrived at its current state with the information, such as node name, status, a resource who performed the job, the date when the job was performed, time spent, and cost.

    Show Variables

    Displays all the variables for the job. You can change the variable values.

    You can also view and update the input and output variables for each activity. Click the activity and click Show variables.

    Show Milestones

    Displays all the current milestones set for the workflow solution. You can change the target date and/or actual date of the milestones.

    Show States

    Displays all the current states defined for the workflow solution. You can change the current state of the job.

    Show Events

    Displays all the current events defined for the workflow solution. You can raise an event.

    Information

    Displays the following job summary: Job ID, primary map name, primary map version, a resource who created the job, job creation date, job status, and job finish time. Also displays the activity information.

    Re-evaluate Skin

    Opens the Re-evaluate Skin dialog box where you can update variable values and live activities.

    Expected Finish Time

    Opens the Edit Expected Finish Time dialog box that displays the expected finish date time to complete the job. You can update the expected finish time if needed.

    Resources

    Opens the Edit Floating Role Resources dialog box that displays the list of floating roles.

    Process Design Notes

    Opens the Add Process Design Notes dialog box where you can add notes for your process.

    Active

    Zoom Slider

    Zooms in or out of the workflow.

    Overview

    Displays an overview of the job in a panel. You can navigate (pan or zoom) to a particular activity.

    Zoom to fit

    Adjusts the entire workflow on screen so that it is completely visible without scrollbars.

    Orientation

    Displays the workflow in the vertical orientation.

    Legend

    Displays the color legend for each job status.

    Refresh

    Refreshes the page.

    View Previous

    Displays the previous workflow solution.

  5. To set a breakpoint, click the activity and select Set breakpoint.

    The red square mark in the activity indicates a breakpoint. Once you set a breakpoint, the Remove breakpoint option becomes available. To remove a breakpoint, click the activity and select the option as needed.

  6. Click to debug the workflow solution.

    The execution stops at the next node that has a breakpoint set, and execution continues when you click . The job progresses only when all dependents are met.

  7. If the execution stops due to a breakpoint, you can step through activities to restart the job. Click the node and click either option:
    • Restart next: Executes the current node and stops at the next node.

    • Restart here: Restarts the job accordingly.

  8. To view the job history, click on the Debug toolbar.
    The Job History dialog box displays the history of the job with the following details: Node name, status, resource who performed the job, the performed date, time spent, and cost.

    Click Close to close the Job History dialog box.

  9. Click Close to close the Debug mode.