Load Plan Structure Introduction to Load Plans

14-6 Oracle Fusion Middleware Developers Guide for Oracle Data Integrator The Properties Panel, located under the Steps Hierarchy table, displays the properties for the object that is selected in the Steps Hierarchy table.

14.2 Creating a Load Plan

This section describes how to create a new Load Plan in ODI Studio.

1. Define a new Load Plan. See

Section 14.2.1, Creating a New Load Plan for more information.

2. Add Steps into the Load Plan and define the Load Plan Sequence. See

Section 14.2.2, Defining the Load Plan Step Sequence for more information.

3. Define how the exceptions should be handled. See

Section 14.2.4, Handling Load Plan Exceptions and Restartability for more information.

14.2.1 Creating a New Load Plan

Load Plans can be created from the Designer or Operator Navigator. To create a new Load Plan:

1. In Designer Navigator or Operator Navigator, click New Load Plan in the toolbar

of the Load Plans and Scenarios accordion. The Load Plan Editor is displayed.

2. In the Load Plan Editor, type in the Name and a Description for this Load Plan.

3. Optionally, set the following parameters: ■ Log Sessions : Select how the session logs should be preserved for the sessions started by the Load Plan. Possible values are: – Always : Always keep session logs Default – Never : Never keep session logs. Note that for Run Scenario steps that are configured as Restart from Failed Step or Restart from Failed Task, the agent will behave as if the parameter is set to Error as the whole session needs to be preserved for restartability. – Error : Only keep the session log if the session completed in an error state. Collapse All Collapses all tree nodes in the Steps Hierarchy table. Add Step Opens a Add Step menu. You can either select the Add Step Wizard or a Quick Step tool to add a step. See Section 14.2.2.1, Adding Load Plan Steps for more information. Remove Step Removes the selected step and all its child steps. Reorder arrows: Move Up, Move Down, Move Out, Move In Use the reorder arrows to move the selected step to the required position. Table 14–2 Cont. Load Plan Editor Toolbar Icon Name Description Working with Load Plans 14-7 ■ Log Session Step: Select how the logs should be maintained for the session steps of each of the session started by the Load Plan. Note that 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. Note that for scenarios created from packages, you can specify whether to preserve or not the steps in the advanced step property called Log Steps in the Journal. Other scenarios preserve all the steps Default. – Never : Never keep session step logs. Note that for Run Scenario steps that are configured as Restart from Failed Step or Restart from Failed Task, the agent will behave as if the parameter is set to Error as the whole session needs to be preserved for restartability. – Errors : Only keep session step log if the step is in an error state. ■ Session Task Log Level : Select the log level for the sessions. This value corresponds to the Log Level value when starting unitary scenarios. Default is 5. Note that when Run Scenario steps are configured as Restart from Failed Step or Restart From Failed Task, this parameter is ignored as the whole session needs to be preserved for restartability. ■ Keywords : Enter a comma separated list of keywords that will be set on the sessions started from this load plan. These keywords improve the organization of ODI logs by session folders and automatic classification. Note that you can overwrite these keywords at the level of the child steps. See Section 21.3.3, Managing the Log for more information.

4. Go to the Steps tab and add steps as described in

Section 14.2.2, Defining the Load Plan Step Sequence . 5. If your Load Plan requires conditional branching, or if your scenarios use variables, go to the Variables tab and declare variables as described in Section 14.2.3.1, Declaring Load Plan Variables . 6. To add exception steps that are used in the event of a load plan step failing, go to the Exceptions tab and define exception steps as described in Section 14.2.4.1, Defining Exceptions Flows .

7. From the File menu, click Save.

The Load Plan appears in the Load Plans and Scenarios accordion. You can organize your Load Plans by grouping related Load Plans and Scenarios into a Load Plan and Scenarios folder.

14.2.2 Defining the Load Plan Step Sequence

Load Plans are an organized hierarchy of child steps. This hierarchy allows conditional processing of steps in parallel or in series. The execution flow can be configured at two stages: ■ At Design-time, when defining the Steps Hierarchy: – When you add a step to a Load Plan, you select the step type. The step type defines the possible child steps and how these child steps are executed: in parallel, in series, or conditionally based on the value of a variable Case step. See Table 14–1 for more information on step types. – When you add a step to a Load Plan, you also decide where to insert the step. You can add a child step, a sibling step after the selected step, or a sibling step 14-8 Oracle Fusion Middleware Developers Guide for Oracle Data Integrator before the selected step. See Section 14.2.2.1, Adding Load Plan Steps for more information. – You can also reorganize the order of the Load Plan steps by dragging the step to the wanted position or by using the arrows in the Step table toolbar. See Table 14–2 for more information. ■ At design-time and run-time by enabling or disabling a step. In the Steps hierarchy table, you can enable or disable a step. Note that disabling a step also disables all its child steps. Disabled steps and all their child steps are not executed when you run the load plan. This section contains the following topics: ■ Adding Load Plan Steps ■ Editing Load Plan Steps ■ Deleting a Step ■ Duplicating a Step

14.2.2.1 Adding Load Plan Steps

A Load Plan step can be added either by using the Add Step Wizard or by selecting the Quick Step tool for a specific step type. See Table 14–1 for more information on the different types of Load Plan steps. To create Run Scenario steps, you can also drag components such as packages, integration interfaces, variables, procedures, or scenarios from the Designer Navigator into the Steps Hierarchy table. Oracle Data Integrator automatically creates a Run Scenario step for the inserted component. When a Load Plan step is added, it is inserted into the Steps Hierarchy with the minimum required settings. See Section 14.2.2.2, Editing Load Plan Steps for more information on how to configure Load Plan steps. Adding a Load Plan Step with the Add Step Wizard To insert Load Plan step with the Add Step Wizard:

1. Open the Load Plan Editor and go to the Steps tab.

2. Select a step in the Steps Hierarchy table.

3. In the Load Plan Editor toolbar, select Add Step Add Step Wizard.

4. In the Add Step Wizard, select: ■ Step Type . Possible step types are: Serial, Parallel, Run Scenario, Case, When, and Else. See Table 14–1 for more information on the different step types. ■ Step Location . This parameter defines where the step is added. – Add a child step to selection : The step is added under the selected step. – Add a sibling step after selection : The step is added on the same level after the selected step. – Add a sibling step before selection : The step is added on the same level before the selected step.

5. Click Next.

Note: Only values that are valid for the current selection are displayed for the Step Type and Step Location.