Skip Headers
Oracle® Fusion Middleware Developer's Guide for Oracle Data Integrator
11g Release 1 (11.1.1)

Part Number E12643-06
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

23 Working with Oracle Data Integrator Console

This chapter describes how to work with Oracle Data Integrator Console. An overview of the Console user interface is provided.

This chapter includes the following sections:

23.1 Introduction to Oracle Data Integrator Console

Oracle Data Integrator Console is a web-based console for managing and monitoring an Oracle Data Integrator run-time architecture and for browsing design-time objects.

This section contains the following topics:

23.1.1 Introduction to Oracle Data Integrator Console

Oracle Data Integrator Console is a web-based console available for different types of users:

  • Administrators use Oracle Data Integrator Console to create and import repositories and to configure the Topology (data servers, schemas, and so forth).

  • Production operators use Oracle Data Integrator Console to manage scenarios and Load Plans, monitor sessions and Load Plan runs, and manage the content of the error tables generated by Oracle Data Integrator.

  • Business users and developers browse development artifacts in this interface, using, for example, the Data Lineage and Flow Map features.

This web interface integrates seamlessly with Oracle Fusion Middleware Control Console and allows Fusion Middleware administrators to drill down into the details of Oracle Data Integrator components and sessions.

Note:

Oracle Data Integrator Console is required for the Fusion Middleware Control Extension for Oracle Data Integrator. It must be installed and configured for this extension to discover and display the Oracle Data Integrator components in a domain.

23.1.2 Oracle Data Integrator Console Interface

Oracle Data Integrator Console is a web interface using the ADF-Faces framework.

Figure 23-1 shows the layout of Oracle Data Integrator Console.

Figure 23-1 Oracle Data Integrator Console

This image shows ODI Console.
Description of "Figure 23-1 Oracle Data Integrator Console"

Oracle Data Integrator Console displays the objects available to the current user in two Navigation tabs in the left panel:

  • Browse tab displays the repository objects that can be browsed and edited. In this tab you can also manage sessions and error tables.

  • Management tab is used to manage the repositories and the repository connections. This tab is available to connection users having Supervisor privileges, or to any user to set up the first repository connections.

The right panel displays the following tabs:

  • Search tab is always visible and allows you to search for objects in the connected repository.

  • One Master/Details tab is displayed for each object that is being browsed or edited. Note that it is possible to browse or edit several objects at the same time.

The search field above the Navigation tabs allows you to open the search tab when it is closed.

Working with the Navigation Tabs

In the Navigation tabs, you can browse for objects contained in the repository. When an object or node is selected, the Navigation Tab toolbar displays icons for the actions available for this object or node. If an action is not available for this object, the icon is grayed out. For example, you can edit and add data server objects under the Topology node in the Browse Tab, but you cannot edit Projects under the Designer node. Note that the number of tabs that you can open at the same time is limited to ten.

23.2 Using Oracle Data Integrator Console

This section explains the different types of operations available in Oracle Data Integrator console. It does not focus on each type of object that can be managed with the console, but gives keys to manage objects with the console.

This section includes the following topics:

Note:

Oracle Data Integrator Console uses the security defined in the master repository. Operations that are not allowed for a user will appear grayed out for this user.

In addition, the Management tab is available only for users with Supervisor privileges.

23.2.1 Connecting to Oracle Data Integrator Console

Oracle Data Integrator console connects to a repository via a Repository Connection, defined by an administrator.

Note that you can only connect to Oracle Data Integrator Console if it has been previously installed. See the Oracle Fusion Middleware Installation Guide for Oracle Data Integrator for more information about installing Oracle Data Integrator Console.

Note:

The first time you connect to Oracle Data Integrator Console, if no repository connection is configured, you will have access to the Management tab to create a first repository connection. See "Creating a Repository Connection" for more information. After your first repository connection is created, the Management tab is no longer available from the Login page, and is available only for users with Supervisor privileges.

Connecting to Oracle Data Integrator Console

To connect to Oracle Data Integrator Console:

  1. Open a web browser, and connect to the URL where Oracle Data Integrator Console is installed. For example: http://odi_host:8001/odiconsole/.

  2. From the Repository list, select the Repository connection corresponding to the master or work repository you want to connect.

  3. Provide a User ID and a Password.

  4. Click Sign In.

23.2.2 Generic User Operations

This section describes the generic operations available in Oracle Data Integrator Console for a typical user.

This section includes the following operations:

Note:

Creating, editing, and deleting operations are not allowed for Scenarios and Load Plans. For more information on the possible actions that can be performed with these objects in ODI Console, see Section 23.2.3, "Managing Scenarios and Sessions" and Section 23.2.4, "Managing Load Plans".

Viewing an Object

To view an object:

  1. Select the object in the Browse or Management Navigation tab.

  2. Click View in the Navigation tab toolbar. The simple page or the Master/Detail page for the object opens.

Editing an Object

To edit an object:

  1. Select the object in the Browse or Management Navigation tab.

  2. Click Update in the Navigation tab toolbar. The edition page for the object opens.

  3. Change the value for the object fields.

  4. Click Save in the edition page for this object.

Creating an Object

To create an object:

  1. Navigate to the parent node of the object you want to create in the Browse or Management Navigation tab. For example, to create a Context, navigate to the Topology > Contexts node in the Browse tab.

  2. Click Create in the Navigation tab toolbar. An Add dialog for this object appears.

  3. Provide the values for the object fields.

  4. Click Save in the Add dialog of this object. The new object appears in the Navigation tab.

Deleting an Object

To delete an object:

  1. Select the object in the Browse or Management Navigation tab.

  2. Click Delete in the Navigation tab toolbar.

  3. Click OK in the confirmation window.

Searching for an Object

To search for an object:

  1. In the Search tab, select the tab corresponding to the object you want to search:

    • Design Time tab allows you to search for design-time objects

    • Topology tab allows you to search for topology objects

    • Runtime tab allows you to search for run-time objects such as Load Plans, Scenarios, Scenario Folders, or Session Folders

    • Sessions tab allows you to search for sessions

    • Load Plan Execution tab allows you to search for Load Plan runs

  2. Set the search parameters to narrow your search.

    For example when searching design-time or topology objects:

    1. In the Search Text field, enter a part of the name of the object that you want to search.

    2. Select Case sensitive if you want the search to be case sensitive (this feature is not provided for the sessions or Load Plan execution search.

    3. Select in Models/Project (Designer tab) or Topology (Topology tab) the type of object you want to search for. Select All to search for all objects.

  3. Click Search.

  4. The Search Results appear, grouped by object type. You can click an object in the search result to open its master/details page.

23.2.3 Managing Scenarios and Sessions

This section describes the operations related to scenarios and sessions available in Oracle Data Integrator Console.

This section includes the following operations:

Importing a Scenario

To import a scenario:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Scenarios/Load Plans > Scenarios.

  3. Click Import in the Navigation tab toolbar.

  4. Select an Import Mode and select an export file in Scenario XML File.

  5. Click Import Scenario.

Exporting a Scenario

To export a scenario:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Scenarios/Load Plans > Scenarios.

  3. Click Export in the Navigation tab toolbar.

  4. In the Export Scenario dialog, set the parameters as follows:

    • From the Scenario Name list, select the scenario to export.

    • In the Encoding Java Charset field, enter the Java character set for the export file.

    • In the Encoding XML Charset field, enter the encoding to specify in the export file.

    • In the XML Version field, enter the XML Version to specify in the export file.

    • Optionally, select Include Dependant objects to export linked child objects.

  5. Click Export Scenario.

Running a Scenario

To execute a scenario:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Scenarios/Load Plans > Scenarios.

  3. Select the scenario you want to execute.

  4. Click Execute in the Navigation tab toolbar.

  5. Select an Agent, a Context, and a Log Level for this execution.

  6. Click Execute Scenario.

Stopping a Session

Note that you can perform a normal or an immediate kill of a running session. Sessions with the status Done, Warning, or Error cannot be killed.

To kill a session:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Sessions/Load Plan Executions > Sessions.

  3. Select the session you want to stop.

  4. Click Kill in the Navigation tab toolbar.

Restarting a Session

To restart a session:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Sessions/Load Plan Executions > Sessions.

  3. Select the session you want to restart.

  4. Click Restart in the Navigation tab toolbar.

  5. In the Restart Session dialog, set the parameters as follows:

    • Agent: From the list, select the agent you want to use for running the new session.

    • Log Level: From the list, select the log level. Select Log Level 6 in the Execution or Restart Session dialog to enable variable tracking. Log level 6 has the same behavior as log level 5, but with the addition of variable tracking.

  6. Click Restart Session.

Cleaning Stale Sessions

To clean stale sessions:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Sessions/Load Plan Executions > Sessions.

  3. Click Clean in the Navigation tab toolbar.

  4. In the Clean Stale Sessions dialog, select the Agent for which you want to clean stale sessions.

  5. Click OK.

Managing Data Statistics and Erroneous Records

Oracle Data Integrator Console allows you to browse the details of a session, including the record statistics. When a session detects erroneous data during a flow or static check, these errors are isolated into error tables. You can also browse and manage the erroneous rows using Oracle Data Integrator Console.

Note:

Sessions with erroneous data detected finish in Warning status.

To view the erroneous data:

  1. Select the Browse Navigation tab.

  2. Navigate to a given session using Runtime > Sessions/Load Plan Executions > Sessions. Select the session and click View in the Navigation tab toolbar.

    The Session page is displayed.

  3. In the Session page, go to the Relationships section and select the Record Statistics tab.

    This tab shows each physical table targeting in this session, as well as the record statistics.

  4. Click the number shown in the Errors column. The content of the error table appears.

    • You can filter the errors by Constraint Type, Name, Message Content, Detection date, and so forth. Click Filter Result to apply a filter.

    • Select a number of errors in the Query Results table and click Delete to delete these records.

    • Click Delete All to delete all the errors.

Note:

Delete operations cannot be undone.

23.2.4 Managing Load Plans

This section describes the operations related to Load Plans available in Oracle Data Integrator Console.

This section includes the following operations:

Importing a Load Plan

To import a Load Plan:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Scenarios/Load Plans > Load Plans.

  3. Click Import in the Navigation tab toolbar.

  4. In the Import Load Plan dialog, select an Import Mode and select an export file in the Select Load Plan XML File field.

  5. Click Import.

Note:

When you import a Load Plan that has been previously exported, the imported Load Plan does not include the scenarios referenced by the Load Plan. Scenarios used in a Load Plan need to be imported separately. See Importing a Scenario for more information.

Exporting a Load Plan

To export a Load Plan:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Scenarios/Load Plans > Load Plans.

  3. Select the Load Plan to export.

  4. Click Export in the Navigation tab toolbar.

  5. In the Export dialog, set the parameters as follows:

    • From the Load Plan Name list, select the Load Plan to export.

    • In the Encoding Java Charset field, enter the Java character set for the export file.

    • In the Encoding XML Charset field, enter the encoding to specify in the export file.

    • In the XML Version field, enter the XML Version to specify in the export file.

    • Optionally, select Include Dependant objects to export linked child objects.

  6. Click Export.

Note:

The export of a Load Plan does not include the scenarios referenced by the Load Plan. Scenarios used in a Load Plan need to be exported separately. See Exporting a Scenario for more information.

Running a Load Plan

To run a Load Plan:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Scenarios/Load Plans > Load Plans.

  3. Select the Load Plan you want to execute.

  4. Click Execute in the Navigation tab toolbar.

  5. Select a Logical Agent, a Context, a Log Level, and if your Load Plan uses variables, specify the Startup values for the Load Plan variables.

  6. Click Execute.

Stopping a Load Plan Run

Note that you can perform a normal or an immediate kill of a Load Plan run. Any running or waiting Load Plan Run can be stopped.

To stop a Load Plan Run:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Sessions/Load Plan Executions > Load Plan Executions.

  3. Select the Load Plan run you want to stop.

  4. Click Kill in the Navigation tab toolbar.

Restarting a Load Plan Run

A Load Plan can only be restarted if the selected run of the current Load Plan instance is in Error status and if there is no other instance of the same Load Plan currently running.

To restart a Load Plan Run:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Sessions/Load Plan Executions > Load Plan Executions.

  3. Select the Load Plan run you want to restart.

  4. In the Restart Load Plan Dialog, select the Physical Agent that restarts the Load Plan. Optionally, select a different log level.

  5. Click Restart in the Navigation tab toolbar.

23.2.5 Purging the Log

This section describes how to purge the log in Oracle Data Integrator Console by removing past sessions and/or Load Plan runs from the log.

To purge the log:

  1. Select the Browse Navigation tab.

  2. Navigate to Runtime > Sessions/Load Plan Executions.

  3. Click Purge in the Navigation tab toolbar.

  4. In the Purge Sessions/Load Plan Executions dialog, set the purge parameters listed in Table 23-1.

    Table 23-1 Purge Log Parameters

    Parameter Description

    Purge Type

    Select the objects to purge.

    From ... To

    Sessions and/or Load Plan runs in this time range will be deleted.

    When you choose to purge session logs only, then the sessions launched as part of the Load Plan runs are not purged even if they match the filter criteria.When you purge Load Plan runs, the Load Plan run which matched the filter criteria and the sessions launched directly as part of the Load Plan run and its child/grand sessions will be deleted.

    Context

    Sessions and/or Load Plan runs executed in this context will be deleted.

    Agent

    Sessions and/or Load Plan runs executed by this agent will be deleted.

    Status

    Session and/or Load Plan runs in this status will be deleted.

    User

    Sessions and/or Load Plan runs executed by this user will be deleted.

    Name

    Sessions and/or Load Plan runs matching this session name will be deleted. Note that you can specify session name masks using % as a wildcard.

    Purge scenario reports

    If you select Purge scenario reports, the scenario reports (appearing under the execution node of each scenario) will also be purged.


    Only the sessions and/or Load Plan runs matching the specified filters will be removed:

    • When you choose to purge session logs only, then the sessions launched as part of the Load Plan runs are not purged even if they match the filter criteria.

    • When you purge Load Plan runs, the Load Plan run which matched the filter criteria and the sessions launched directly as part of Load Plan run and its child/grand sessions will be deleted.

    • When a Load Plan run matches the filter, all its attached sessions are also purged irrespective of whether they match the filter criteria or not.

  5. Click OK.

Oracle Data Integrator Console removes the sessions and/or Load Plan runs from the log.

23.2.6 Using Data Lineage and Flow Map

This section describes how to use the Data Lineage and Flow Map features available in Oracle Data Integrator Console.

  • Data Lineage provides graph displaying the flows of data from the point of view of a given datastore. In this graph, you can navigate back and forth and follow this data flow.

  • Flow Map provides a map of the relations that exist between the data structures (models, sub-models and datastores) and design-time objects (projects, folders, packages, interfaces). This graph allows you to draw a map made of several data structures and their data flows.

This section includes the following operations:

Working with the Data Lineage

To view the Data Lineage:

  1. Select the Browse Navigation tab.

  2. Navigate to Design Time > Models > Data Lineage.

  3. Click View in the Navigation tab toolbar.

  4. In the Data Lineage page, select a Model, then a Sub-Model and a datastore in this model.

  5. Select Show Interfaces if you want that interfaces are displayed between the datastores nodes.

  6. Select the prefix to add in your datastores and interface names in the Naming Options section.

  7. Click View to draw the Data Lineage graph. This graph is centered on the datastore selected in step 4.

    In this graph, you can use the following actions:

    • Click Go Back to return to the Data Lineage options and redraw the graph.

    • Use the Hand tool and then click a datastore to redraw the lineage centered on this datastore.

    • Use the Hand tool and then click an interface to view this interface's page.

    • Use the Arrow tool to expand/collapse groups.

    • Use the Move tool to move the graph.

    • Use the Zoom In/Zoom Out tools to resize the graph.

    • Select View Options to change the display options have the graph refreshed with this new option.

Working with the Flow Map

To view the Flow Map:

  1. Select the Browse Navigation tab.

  2. Navigate to Design Time > Models > Flow Map.

  3. Click View in the Navigation tab toolbar.

  4. In the Data Lineage page, select one or more Model. Select All to select all models.

  5. Select one of more Projects. Select All to select all projects.

  6. In the Select the level of details of the map section, select the granularity of the map. The object that you select here will be the nodes of your graph.

    Check Do not show Projects, Folders... if you want the map to show only data structure.

  7. Optionally, indicate the grouping for the data structures and design-time objects in the map, using the options in the Indicate how to group Objects in the Map section.

  8. Click View to draw the Flow Map graph.

    In this graph, you can use the following actions:

    • Click Go Back to return to the Flow Map options and redraw the graph.

    • Use the Hand tool and then click a node (representing a datastore, an interface, and so forth) in the map to open this object's page.

    • Use the Arrow tool to expand/collapse groups.

    • Use the Move tool to move the graph.

    • Use the Zoom In/Zoom Out tools to resize the graph.

23.2.7 Performing Administrative Operations

This section describes the different administrative operations available in Oracle Data Integrator Console. These operations are available for a user with Supervisor privileges.

This section includes the following operations:

Creating a Repository Connection

A repository connection is a connection definition for Oracle Data Integrator Console. A connection does not include Oracle Data Integrator user and password information.

To create a repository connection:

  1. Navigate to the Repository Connections node in the Management Navigation tab.

  2. Click Create in the Navigation tab toolbar. A Create Repository Connection dialog for this object appears.

  3. Provide the values for the repository connection:

    • Connection Alias: Name of the connection that will appear on the Login page.

    • Master JNDI URL: JNDI URL of the datasource to connect the master repository database.

    • Supervisor User Name: Name of the Oracle Data Integrator user with Supervisor privileges that Oracle Data Integrator Console will use to connect to the repository. This user's password must be declared in the WLS or WAS Credential Store.

    • Work JNDI URL: JNDI URL of the datasource to connect the work repository database. If no value is given in this field. The repository connection will allow connection to the master only, and the Navigation will be limited to Topology information.

    • JNDI URL: Check this option if you want to use the environment naming context (ENC). When this option is checked, Oracle Data Integrator Console automatically prefixes the data source name with the string java:comp/env/ to identify it in the application server's JNDI directory. Note that the JNDI Standard is not supported by Oracle WebLogic Server and for global data sources.

    • Default: Check this option if you want this Repository Connection to be selected by default on the login page.

  4. Click Save. The new Repository Connection appears in the Management Navigation tab.

Testing a Data Server or a Physical Agent Connection

This sections describes how to test the data server connection or the connection of a physical agent in Oracle Data Integrator Console.

To test the data server connection:

  1. Select the Browse Navigation tab.

  2. Navigate to Topology > Data Servers.

  3. Select the data server whose connection you want to test.

  4. Click Test Connection in the Navigation tab toolbar.

  5. In the Test Connection dialog, select the:

    • Physical Agent that will carry out the test

    • Transaction on which you want to execute the command. This parameter is only displayed if there is any On Connect/Disconnect command defined for this data server. The transactions from 0 to 9 and the Autocommit transaction correspond to connection created by sessions (by procedures or knowledge modules). The Client Transaction corresponds to the client components (ODI Console and Studio).

  6. Click Test.

A dialog showing "Connection successful!" is displayed if the test has worked. If not, an error message is displayed.

To test the physical agent connection:

  1. Select the Browse Navigation tab.

  2. Navigate to Topology > Agents > Physical Agents.

  3. Select the physical agent whose connection you want to test.

  4. Click Test Connection in the Navigation tab toolbar.

A dialog showing "Connection successful!" is displayed if the test has worked. If not, an error message is displayed.

Administering Repositories

Oracle Data Integrator Console provides you with features to perform management operations (create, import, export) on repositories. These operations are available from the Management Navigation tab, under the Repositories node. These management operations reproduce in a web interface the administrative operations available via the Oracle Data Integrator Studio and allow setting up and maintaining your environment from the ODI Console.

See Chapter 3, "Administering the Oracle Data Integrator Repositories" and Chapter 20, "Exporting/Importing" for more information on these operations.

Administering Java EE Agents

Oracle Data Integrator Console allows you to add JDBC datasources and create templates to deploy physical agents into WebLogic Server.

See Chapter 4, "Setting-up the Topology" for more information on Java EE Agents, datasources and templates.

To add a datasource to a physical agent:

  1. Select the Browse Navigation tab.

  2. Navigate to Topology > Agents > Physical Agents.

  3. Select the agent you want to manage.

  4. Click Edit in the Navigation tab toolbar.

  5. Click Add Datasource

  6. Provide a JNDI Name for this datasource and select the Data Server Name. This datasource will be used to connect to this data server from the machine into which the Java EE Agent will be deployed.

  7. Click OK.

  8. Click Save to save the changes to the physical agent.

To create a template for a physical agent:

  1. Select the Browse Navigation tab.

  2. Navigate to Topology > Agents > Physical Agents.

  3. Select the agent you want to manage.

  4. Click Edit in the Navigation tab toolbar.

  5. Click Agent Deployment.

  6. Follow the steps of the Agent Deployment wizard. This wizard reproduces in a web interface the Server Template Generation wizard. See Chapter 4, "Deploying an Agent in a Java EE Application Server" for more details.