5.5 Load Plan Run Editor

Use to monitor Load Plan runs and to view the results of a Load Plan run.

Executing a Load Plan creates a Load Plan instance and the first Load Plan run for the instance. Every time a Load Plan instance is restarted, a Load Plan run is created for the Load Plan instance. A Load Plan run corresponds to an attempt to execute the instance.

When running, a Load Plan run starts sessions corresponding to the scenarios sequenced in the Load Plan.

The Load Plan Run Editor has the following tabs:

5.5.1 Execution

Properties Description
Instance ID Load Plan instance identifier. Every time a Load Plan is executed, a new Load Plan instance with a unique identifier is created.
Global ID Global unique instance identified for the Load Plan.
Run # Number of execution attempts of this Load Plan instance. It starts at 1 when the Load Plan is first executed, and is incremented each time the Load Plan instance is restarted.
Load Plan Name Name of the Load Plan at the time the Load Plan instance was created.
Started By User who initiated the execution.
Physical Agent Agent that started the Load Plan run. Executing a Load Plan may involve multiple agents for running the different steps. The agent displayed here, is the one that started the root step.
Context Context in which the Load Plan starts.
Start Date and time when the Load Plan run starts.
End Date and time when the Load Plan run ends. If the Load Plan is still running, this field is blank.
Duration Duration of the Load Plan run (format: hh:mm:ss).
Status Load Plan status. The possible states are Done, Error, Running, and Warning.
Return Code Return code for the Load Plan run.
Invocation Log Level Load Plan log level specified when starting the Load Plan.
Error Message Error message, if any.

5.5.2 Load Plan

Use to view the Load Plan settings.

Properties Description
Name Name of the Load Plan.
Folder Name Name of the Load Plan and Scenario folder where this Load Plan is located. If the Load Plan is not created within a folder, this field is disabled.
Keep Log History (days) Number of days for which log history will be kept for this Load Plan.
Log Sessions Indicates how logs are preserved for the sessions started by the Load Plan. Possible values are:
  • Always: Session logs are always preserved.

  • Never: Session logs are not preserved. This has no effect on Run Scenario steps that are configured as Restart from Failed Step or Restart From Failed Task, as the whole session needs to be preserved for restartability.

  • Errors: Session log is preserved only if the session completed in an error state.

Log Session Steps Indicates how logs are maintained by default for the session steps of each of the sessions started by the Load Plan. This applies only when the session log is preserved. Possible values are:
  • By Scenario Settings: Session step logs are preserved depending on the scenario settings. Scenario created from packages can preserve the steps depending on the advanced step property called Log Steps in the Journal. All steps can be preserved in other scenarios.

  • Never: Session step logs are not preserved. This has no effect on Run Scenario steps that are configured as Restart from Failed Step or Restart From Failed Task, as the whole session needs to be preserved for restartability.

  • Errors: Session step log is preserved only if the step is in an error state.

Session Tasks Log Level Default task level logging (from 1 to 5). This value corresponds to the Log Level value when starting unitary scenarios. Default is 5. When Run Scenario steps are configured as Restart from Failed Step or Restart From Failed Task, this parameter is ignored as the whole session must be preserved for restartability.
Keywords Comma separated list of keywords that are set on the sessions started from this Load Plan. It shows the effective keywords for the step at a time of execution. These keywords improve the organization of ODI logs by session folders and automatic classification. You can override these keywords at the level of the child steps.
Description Description of the Load Plan.

Concurrent Execution Controller

Properties Description
Limit Concurrent Executions If checked, enables the Concurrent Execution Controller for the Load Plan.
Violation Behavior Specifies the violation behavior action. Default is Raise Error and End Execution.
Wait Polling Interval Specifies the polling frequency (in seconds) for the wait behavior to check for its turn to run. This field accepts only a positive integer, and it is enabled only when Violation Behavior is selected as Wait.

Note: A newly generated scenario or a newly created load plan has blank as the default value, meaning that the runtime agent determines the actual value used for the polling (currently the default is 30 seconds in the runtime agent).


5.5.3 Steps

Use to view the Load Plan execution details at step level.

The Steps Hierarchy table shows the organization of the steps in the Load Plan. Each row in this table represents a step.

The Steps Hierarchy table contains the following columns:

  • Steps Hierarchy: Displays the steps hierarchy in a tree showing the name of each step.

  • Status: Depending on the step type:

    • Displays the session status, which may be Queued or Running, for a running Run Scenario step

    • Displays the step status, which may be Error, Warning, Done, or Done in previous run, for other step types

    Note:

    You can change the status of a failed Load Plan step from Error to Done to ignore this particular Load Plan step the next time the Load Pan run is restarted. This might be useful, for example, when the error causing this Load Plan step to fail cannot be fixed at the moment, and you want to execute the rest of the Load Plan regardless of this Load Plan step.
  • Start: Depending on the step type:

    • Displays the start session for a Run Scenario step. The session start will be after the step start if the step was Queued and it will be before the step start if the step was Done in previous run.

    • Displays the start step for other step types.

  • End: Depending on the step type:

    • Displays the session end for a Run Scenario step.

    • Displays the step end for other step types.

  • Duration: Depending on the step type:

    • Displays the duration of the session for a Run Scenario step.

    • Displays the duration of the step for other step types.

  • Scenario/Variable: Displays the name of the scenario for Run Scenario steps or the name of the variable evaluated in a Case step.

  • Session ID: For Run Scenario steps only: Click the Session ID to open the session started by the Load Plan for this step.

  • Return Code: Return code for step.

  • Error Message: Error message, if the step encountered an error.

  • Row Count: Overall number of rows processed.

  • Insert Count: Number of inserts processed.

  • Update Count: Number of updates processed.

  • Delete Count: Number of deletes processed

  • Error Count: Number of errors encountered.

  • Step Status: Status of the step. The possible states are Done, Done in previous run, Error, Running, and Warning.

  • Step Start: Start time of the execution of the step.

  • Step End: End time of the execution of the step.

  • Step Duration: Time taken for the execution of the step, showing the number of minutes and seconds between Step Start and Step End.

  • Step ID: ID of the step. Useful for debugging purposes.

  • Session Status: Status of the session. The possible states are Done, Error, Running, Waiting, Queued, and Warning.

  • Session Start: Start time of the execution of the session.

  • Session End: End time of the execution of the session.

  • Session Duration: Time taken for the execution of the session, showing the number of minutes and seconds between Session Start and Session End.

In the Editor toolbar, click Refresh to update the content of the Steps Hierarchy table.

If you want to show or hide columns in the table, click Select Columns... in the Steps toolbar.

Using the Steps toolbar, you can also perform the following:

  • Click Expand All or Collapse All to expand or collapse the nodes in the Steps Hierarchy table.

  • Click Show Exceptions to view exception steps of this Load Plan run. The minimum number of tree nodes are expanded to display all exception steps that were invoked during this Load Plan run. This feature is only enabled if at least one exception step exists.

The Property Inspector displays the step properties for the step that is selected in the Steps Hierarchy table. See Steps for more information on the step properties.

Note that the properties are read-only.

5.5.4 Variables

Use to view the startup values and settings of the variables used in the Load Plan.

Properties Description
Data Type Data type of the variable.
Description Description of the variable.
Logical Schema Logical schema of the variable where the refresh query to be executed.
Select Statement Query to be executed for refreshing variable value from the logical schema.
Startup Value Value of the variable when the Load Plan is started.
Variable Name Name of the variable.

"Introduction to the Load Plan Editor" in the "Using Load Plans" chapter in Oracle Fusion Middleware Developing Integration Projects with Oracle Data Integrator