ヘッダーをスキップ
Oracle® Fusion Middleware Oracle Data Integrator開発者ガイド
11g リリース1 (11.1.1)
B62260-04
  ドキュメント・ライブラリへ移動
ライブラリ
製品リストへ移動
製品
目次へ移動
目次

前
 
次
 

A Oracle Data Integrator Toolsリファレンス

この付録では、Oracle Data Integrator Toolsのリファレンス情報を提供します。この付録は、これらのツールを使用して統合シナリオを設計するアプリケーション開発者を対象としています。

この付録は次の項で構成されています:

A.1 Oracle Data Integrator Toolsの使用

Oracle Data Integrator Tools (Oracle Data Integratorコマンドとも呼ばれます)は、実行時に特定のタスクを処理するために用意されているコマンドです。これらのタスクは、一定の時間待機したり音を鳴らすなどの簡単なタスクの場合や、ANTスクリプトを実行したりサーバーから電子メールを読み込むなどの高度なタスクの場合があります。

これらは、パッケージ、プロシージャ・コマンドまたはナレッジ・モジュール・コマンドで使用され、コマンドラインから直接使用することもできます。


注意:

Oracle Data Integratorの以前のバージョンでは、内部Javaクラス(SnpsSendMailやSendMailなど)を使用したJythonまたはJavaスクリプトからの組込みツールのコールがサポートされていました。このメソッドを使用したツールの使用方法は、バージョン10.1.3.2.0以降非推奨になっているため、使用しないでください。



注意:

コマンド内で改行は使用できません。


A.1.1 パッケージでのツールの使用

Oracle Data Integratorのツールをパッケージに追加して使用する方法は、10.3.1.4項「Oracle Data Integratorツール・ステップの追加」を参照してください。

パッケージ内では、ツール・ステップに順序を付け、その成否に従ってステップを編成できます。詳細は、10.4項「ステップの順序の定義」および10.3.6項「ステップのレイアウトの調整」を参照してください。

パッケージでは、ツール・パラメータ変数値、順序またはOracle Data Integrator置換メソッド・コールでツールを直接使用できます。詳細は、第12章「プロシージャ、変数、順序およびユーザー関数の使用」を参照してください。

A.1.2 ナレッジ・モジュールまたはプロシージャ・コマンドでのツールの使用

KMまたはプロシージャでOracle Data Integratorツールを使用する方法は、12.1項「プロシージャの使用」を参照してください。

ナレッジ・モジュールまたはプロシージャでは、ツール・パラメータ変数値、順序、Oracle Data Integrator置換メソッド・コール、またはSELECT文の結果でツールを直接使用できます。詳細は、第12章「プロシージャ、変数、順序およびユーザー関数の使用」を参照してください。

A.1.3 コマンドラインからのツールの使用


注意:

この項で説明されているタスクの実行に必要なコマンドライン・スクリプトは、Oracle Data Integrator Standalone Agentがインストールされている場合のみ使用できます。スタンドアロン・エージェントのインストール方法は、Oracle Fusion Middleware Oracle Data Integratorインストレーション・ガイドを参照してください。


コマンドラインからOracle Data Integratorツールを使用するには:

  1. シェル(UNIX)またはコマンドライン・プロンプト(Windows)を起動します。

  2. Oracle Data Integratorをインストールしたディレクトリのoracledi/agent/binサブディレクトリに移動します。

  3. 次の構文を使用して、startcmd.bat (Windows)またはstartcmd.sh (UNIX)コマンドを起動します:

    startcmd <command_name> [<command_parameters>]*
    

重要な注意事項

コマンドラインからツールを起動する場合は、次の点に注意してください。

  • Windowsプラットフォームでは、等号(=)またはスペースが含まれているコマンド引数は、二重引用符で囲む必要があります。Windowsのコマンド・コールはUNIXのコマンド・コールとは異なることがあります。例:

    <command_name>パラメータは大文字と小文字が区別されます。

    startcmd.bat OdiSleep "-DELAY=5000" (Windows)
    ./startcmd.sh OdiSleep -DELAY=5000 (UNIX)
    
  • ツールによっては、実行の際にリポジトリへの接続を必要とするものがあります。odiparamsファイルにリポジトリ接続が構成されていることを確認してください。詳細は、4.3項「エージェントの管理」を参照してください。

  • 次のODIツールは、コマンドラインからの直接起動をサポートしていません。

    • OdiInvokeWebService

    • OdiRetrieveJournalData

    • OdiRefreshJournalCount

A.2 オープン・ツールの使用

オープン・ツール機能には、パッケージやプロシージャで使用できるカスタムのサード・パーティ・ツールを開発するための拡張可能なプラットフォームがあります。Oracle Data Integratorに付属の標準ツールと同じように、オペレーティング・システムと相互に作用し、データを操作できます。

オープン・ツールはJavaで記述されています。独自のオープン・ツールの記述方法については、A.3項「オープン・ツールの開発」を参照してください。

オープン・ツールは、次のいくつかのファイルが格納されたJavaパッケージ(.zipまたは.jar)として配布されます:

A.2.1 オープン・ツールのインストールおよび宣言

オープン・ツールを使用するには、その前に、オープン・ツールをインストールして追加する必要があります。

A.2.1.1 オープン・ツールのインストール

オープン・ツールをインストールするには、クラスパスまたはこのオープン・ツールを使用しているコンポーネントに、オープン・ツールJarを追加する必要があります。

オープン・ツールJarは、スタンドアロン・エージェントおよびStudioのドライバと同じディレクトリに追加する必要があります。詳細は、『Oracle Fusion Middleware Oracle Data Integratorインストレーション・ガイド』の「追加のドライバとオープン・ツールの追加」を参照してください。

オープン・ツールJarとJava EEエージェントをデプロイするためには、このエージェントのサーバー・テンプレートを生成する必要があります。オープン・ツールは、WLSテンプレート生成ウィザードの「ライブラリおよびドライバ」リストに表示されます。詳細は、4.3.2.1.2項「EEエージェントのためのサーバー・テンプレートの作成」を参照してください。


注意:

この操作は、ツールを使用する各ODI Studio、およびこのツールを使用してセッションを実行する各エージェントに対して実行する必要があります。


A.2.1.2 新しいオープン・ツールの宣言

この操作は、マスター・リポジトリでオープン・ツールを宣言し、このオープン・ツールをOracle Data Integrator Studioに表示できるようにします。

新しいツールを宣言するには、次のいずれかを実行します:

  1. Oracle Data Integrator Studioで、「ODI」メニューから「オープン・ツールの追加/削除」を選択します。「オープン・ツールの追加」ダイアログが開きます。

  2. 「オープン・ツールの追加/削除」ダイアログの「オープン・ツール・クラス名」フィールドにクラス名を入力します。

または:

  1. 「ClassPathで検索します」をクリックし、オープン・ツールのJavaクラス名を参照します。クラスを名前で検索するには、上部のフィールドに名前の一部を入力します。

  2. 「OK」をクリックします。

    Oracle Data Integratorで現在使用可能なすべてのクラスの中には、オープン・ツールでないツールのクラスも表示されることに注意してください。クラスを追加するには、そのクラスの名前を把握している必要があります。

  3. 「オープン・ツールの追加」をクリックします。

  4. 目的のオープン・ツールが含まれている行を選択します。

    • クラスパス上で見つかると、提供されているアイコン、構文、説明、プロバイダおよびバージョン番号が表示されます。

    • 見つからない場合は、エラー・メッセージが表示されます。

      クラスパスを変更するか、オープン・ツールを適切なディレクトリに移動してください。


    注意:

    この操作は、指定のマスター・リポジトリに対して1回のみ実行する必要があります。



    注意:

    名前がSnpまたはOdiで開始するオープン・ツール名は使用できません。名前がこれらの文字列で開始するオープン・ツールは無視されます。


A.2.2 パッケージまたはプロシージャでのオープン・ツールの使用

オープン・ツールは、Oracle Data Integratorにデフォルトで付属しているツールと同様に、パッケージまたはプロシージャで使用できます。

A.3 オープン・ツールの開発

オープン・ツールはJavaパッケージで、インタフェースoracle.odi.sdk.opentools.IOpenToolを実装するコンパイル済Javaクラスが含まれています。すべてのクラスおよびメソッドの詳細は、Oracle Data Integrator Open Tools APIリファレンス(Javadoc)を参照してください。

オープン・ツール・パッケージには通常2つのアイコンも含まれており、Oracle Data Integratorグラフィカル・インタフェースでオープン・ツールを表すために使用されます。

A.3.1 クラス

次の表は、オープン・ツールのクラスおよびインタフェースを示しています。

クラスまたはインタフェース 説明

IOpenTool

すべてのオープン・ツールが実装する必要のあるインタフェース。

OpenToolAbstract

いくつかのヘルパー・メソッドを備えたインタフェースの抽象化。可能なかぎり、インタフェースを直接実装するのではなく、このクラスを拡張してください。

IOpenToolParameter

オープン・ツールで使用されるパラメータが実装する必要のあるインタフェース。ほとんどの場合は、このインタフェースを実装せずに、OpenToolParameterを使用します。

OpenToolParameter

IOpenToolParameterの完全な実装。各OpenToolParameterが1つのパラメータを保持します。

OpenToolsExecutionException

オープン・ツールのメソッドによって必要に応じてスローされる例外クラス。

SimpleOpenToolExample

オープン・ツールの簡単な例であり、開始点として使用できます。


A.3.2 新しいオープン・ツールの開発

ここでは、基本的なオープン・ツールであるSimpleMessageBoxの開発について説明します。このクラスのソース・コードは、demo/plugins/srcディレクトリにあります。

  1. 構文を定義します。この例では、オープン・ツールは次のようにコールされます:

    SimpleMessageBox "-TEXT=<text message>" "-TITLE=<window title>"
    
  2. 16x16および32x32のアイコンを作成します(通常は.gif形式)。

  3. クラスを作成し、実装します。A.3.2.1項「クラスの実装」を参照してください。

  4. クラスをコンパイルし、2つのアイコン・ファイルが含まれたパッケージを作成します。

  5. A.2.1項「オープン・ツールのインストールおよび宣言」の説明に従って、オープン・ツールのインストールと宣言を実行します。

A.3.2.1 クラスの実装

クラスの実装は、次の手順で構成されます。

  1. 宣言

  2. パッケージのインポート

  3. パラメータの定義

  4. 情報関数の実装

  5. 実行

A.3.2.1.1 宣言

クラスを宣言するには、その前に、パッケージ名を指定する必要があります。

パッケージ名の指定

適切な名前のパッケージにクラスを配置します。パッケージ名は、インストール時にオープン・ツールを識別するために使用されます。

package com.myCompany.OpenTools;

クラスの宣言

オープン・ツールの開発には、2つの基本的な手法があります:

  • 既存のクラスを拡張してオープン・ツールに変換します。この場合は、インタフェースIOpenToolを既存のクラスに直接実装します。

  • 新規のクラスを開発します。この場合は、抽象クラスOpenToolAbstractを拡張する方法が最も容易です。このクラスには、パラメータで使用するための追加のヘルパー・メソッドも含まれています。

public class SimpleMessageBox extends OpenToolAbstract {

A.3.2.1.2 パッケージのインポート

ほぼすべてのオープン・ツールには、次のオープン・ツールSDKパッケージをインポートする必要があります。

import oracle.odi.sdk.opentools.IOpenTool; /* All Open Tool classes need these three classes */

import oracle.odi.sdk.opentools.IOpenToolParameter;

import oracle.odi.sdk.opentools.OpenToolExecutionException;

import oracle.odi.sdk.opentools.OpenToolAbstract; /* The abstract class we extend for the Open Tool */

import oracle.odi.sdk.opentools.OpenToolParameter; /* The class we use for parameters */

この例では、メッセージ・ボックスを作成するために次のパッケージも必要です:

import javax.swing.JOptionPane; /* Needed for the message box used in this example */
A.3.2.1.3 パラメータの定義

OpenToolParameterオブジェクトを格納するプロパティを追加します。このプロパティは、構文に対してオブジェクトを定義する目的と、実際のユーザーからパラメータの値を取得する目的の両方に使用されます。このオープン・ツールのパラメータは、次のように静的配列を使用して定義するのが最も簡単です。この配列は、アクセッサ関数を介してアクセスされるため、プライベートにする必要があります。

private static final IOpenToolParameter[] mParameters = new IOpenToolParameter[]
{
    new OpenToolParameter("-TEXT", "Message text", "Text to show in the messagebox (Mandatory).", true),
    new OpenToolParameter("-TITLE", "Messagebox title", "Title of the messagebox.", false)
};

OpenToolParameter()コンストラクタに渡される4つのパラメータは、次のとおりです。

  1. パラメータのコード(先頭のハイフンを含みます)。このコードは、getSyntax()によって戻される構文に対応している必要があります。

  2. ユーザーが理解しやすい名前。この名前は、ユーザーがグラフィカル・インタフェースを使用してパラメータを設定する際に使用されます。

  3. 説明のヘルプ・テキスト。

  4. パラメータが必須かどうか。これはユーザーに表示する目印です。


    注意:

    Oracle Data Integratorでは、パラメータに必須フラグを付けなくてもかまいません。ただし、入力されるパラメータの組合せはすべて処理可能である必要があります。


パラメータを取得するには、アクセッサ関数getParameters()を実装する必要があります。

public IOpenToolParameter[] getParameters()
{
      return mParameters;
}
A.3.2.1.4 情報関数の実装

オープン・ツールに関する情報を戻す関数であるgetDescription()getVersion()getProvider()を実装します。

public String getDescription() { return "This Open Tool displays a message box when executed."; }
public String getVersion() { return "v1.0"; }
public String getProvider() { return "My Company, Inc."; }

getSyntax()関数によって、Oracle Data Integratorのグラフィカル・インタフェースに表示されるオープン・ツールの名前と、パラメータの初期値が決定されます。パラメータ名が、getParameters()によって戻されたパラメータ名と一致していることを確認します。

public String getSyntax()
{
        return "SimpleMessageBox \"-TEXT=<text message>\" \"-TITLE=<window title>\"";
}

getIcon()メソッドが、適切なサイズの2つのイメージにパスを戻します。次の例のようになります。

public String getIcon(int pIconType)
{
        switch (pIconType)
        {
               case IOpenTool.SMALL_ICON:
               return "/com/myCompany/OpenTools/images/SimpleMessageBox_16.gif";
             case IOpenTool.BIG_ICON:
             return "/com/myCompany/OpenTools/images/SimpleMessageBox_32.gif";
             default:
             return "";
     }
}
A.3.2.1.5 実行

最後は、オープン・ツールが提供する機能を実際に実行するexecute()メソッドです。この場合は、メッセージ・ボックスが表示されます。OpenToolAbstractクラスを拡張する場合は、getParameterValue()メソッドを使用すると、実行時に設定されるパラメータ値を容易に取得できます。


注意:

すべての実行を捕捉して、OpenToolExecutionExceptionのみが発生するように対処する必要があります。


public void execute() throws OpenToolExecutionException
{
     try
     {
     if (getParameterValue("-TITLE") == null || getParameterValue("-TITLE").equals("")) /* title was not filled in by user */
     {
               JOptionPane.showMessageDialog(null, (String) getParameterValue("-TEXT"), (String) "Message", JOptionPane.INFORMATION_MESSAGE);
          } else
          {
               JOptionPane.showMessageDialog(null, (String) getParameterValue("-TEXT"),
                       (String) getParameterValue("-TITLE"),
                       JOptionPane.INFORMATION_MESSAGE);
          }
     }
     /* Traps any exception and throw them as OpenToolExecutionException */
     catch (IllegalArgumentException e)
     {
          throw new OpenToolExecutionException(e);
     }
}

A.3.3 実行時のオープン・ツール

一般に、オープン・ツール・クラスは、非常に簡潔にインスタンス化されます。次のように使用されます。

インストール

ユーザーがオープン・ツールのインストールを選択すると、Oracle Data Integratorはクラスをインスタンス化し、getDescription()getProvider()getIcon()およびgetVersion()の各メソッドをコールして、クラスに関する情報を取得します。

パッケージでの使用

オープン・ツールがパッケージ内で使用される場合、そのクラスは、getDescription()getProvider()getIcon()およびgetVersion()の各メソッドをコールするために一時的にインスタンス化されます。さらに、オープン・ツールのコード名とそのデフォルト引数を取得するために、getSyntax()がコールされます。getParameters()メソッドは、引数のリストをユーザーに対して表示するためにコールされます。

実行

オープン・ツールがパッケージまたはプロシージャ内で実行される都度、クラスは繰り返しインスタンス化されます。実行完了後までインスタンスが維持されることはありません。execute()メソッドは1回のみコールされます。


ヒント:

付録A「オープン・ツールの使用」およびオープン・ツールSDKドキュメント(JavaDoc)も参照してください。


A.4 カテゴリ別ODIツール

この項では、Oracle Data Integratorツールのリストをカテゴリ別に示します:

A.5 ODIツールのアルファベット順リスト

この項では、Oracle Data Integratorツールのリストをアルファベット順に示します。

A.5.1 OdiAnt

このコマンドを使用してAntビルドファイルを実行します。

Antビルドファイルの詳細および例は、オンライン・ドキュメント(http://jakarta.apache.org/ant/manual/index.html)を参照してください。

使用方法

OdiAnt -BUILDFILE=<file> -LOGFILE=<file> [-TARGET=<target>]
[-D<property name>=<property value>]* [-PROJECTHELP] [-HELP]
[-VERSION] [-QUIET] [-VERBOSE] [-DEBUG] [-EMACS]
[-LOGGER=<classname>] [-LISTENER=<classname>] [-FIND=<file>]

パラメータ

パラメータ 必須 説明

-BUILDFILE=<file>

はい

Antビルドファイル。Antコマンドが含まれているXMLファイルです。

-LOGFILE=<file>

はい

指定のファイルをロギングに使用します。

-TARGET=<target>

いいえ

ビルド・プロセスのターゲット。

-D<property name>=<property value>

いいえ

プロパティとその値のリスト。

-PROJECTHELP

いいえ

プロジェクトに関するヘルプを表示します。

-HELP

いいえ

Antのヘルプを表示します。

-VERSION

いいえ

Antのバージョンを表示します。

-QUIET

いいえ

非冗長モードで実行します。

-VERBOSE

いいえ

冗長モードで実行します。

-DEBUG

いいえ

デバッグ情報を印刷します。

-EMACS

いいえ

ロギング情報を装飾なしで表示します。

-LOGGER=<classname>

いいえ

ロギングを実行するJavaクラス。

-LISTENER=<classname>

いいえ

クラス・インスタンスをリスナーとして追加します。

-FIND=<file>

いいえ

ファイル・システムのルートからAntビルドファイルを検索して使用します。


*.htmlファイルをftp.mycompany.com/download/publicディレクトリから、FTPを介してC:\tempディレクトリにダウンロードします。

ステップ1: Antビルドファイルを生成します。

OdiOutFile -FILE=c:\temp\ant_cmd.xml
<?xml version="1.0"?>
<project name="myproject" default="ftp" basedir="/">
     <target name="ftp">
          <ftp action="get" remotedir="/download/public" 
          server="ftp.mycompany.com" userid="anonymous"
          password="me@mycompany.com">
                <fileset dir="c:\temp">
           <include name="**/*.html"/>
                </fileset>
     </ftp>
   </target>
</project>

ステップ2: Antビルドファイルを実行します。

OdiAnt -BUILDFILE=c:\temp\ant_cmd.xml -LOGFILE=c:\temp\ant_cmd.log

A.5.2 OdiBeep

このコマンドを使用して、エージェントをホスティングしているマシン上のデフォルトのビープ音またはサウンド・ファイルを再生します。

次のファイル形式がデフォルトでサポートされています。

  • WAV

  • AIF

  • AU


注意:

他のファイル形式を再生するには、アプリケーション・クラスパスに適切なJavaSoundサービス・プロバイダ・インタフェース(JavaSound SPI)を追加する必要があります。


使用方法

OdiBeep [-FILE=<sound_file>]

パラメータ

パラメータ 必須 説明

-FILE

いいえ

再生するサウンド・ファイルのパスおよびファイル名。指定しない場合は、マシンのデフォルト・ビープ音が使用されます。


サウンド・ファイルc:\wav\alert.wavを再生します。

OdiBeep -FILE=c:\wav\alert.wav

A.5.3 OdiDataQuality

このコマンドを使用して、データ品質プロジェクトを起動するバッチ・ファイルを実行します。

使用方法

OdiDataQuality -BATCH_FILE=<batch_file> [-OUT_FILE=<stdout_file>]
[-ERR_FILE=<stderr_file>] [-SYNCHRONOUS=<yes|no>]

パラメータ

パラメータ 必須 説明

-BATCH_FILE=<batch_file>

はい

実行するデータ品質バッチ・ファイルの場所。ファイル名は絶対パスで指定する必要があります。このバッチ・ファイルはオペレーティング・システムに依存しており、runprojectNと呼ばれています。

例:

C:\oracle\oracledq\metabase_data\metabase\oracledq\project2\scripts\runproject2.cmd

-OUT_FILE=<stdout_file>

いいえ

標準出力のリダイレクト先となるファイル。リダイレクトしない場合は空白のままとし、絶対パスを使用します。

-ERR_FILE=<stderr_file>

いいえ

標準エラーのリダイレクト先となるファイル。リダイレクトしない場合は空白のままとし、絶対パスを使用します。

-SYNCHRONOUS=<yes|no>

いいえ

YESに設定すると、このツールは品質プロセスの完了を待機してから終了します。この場合は、エラー・コードを戻す可能性があります。NOに設定すると、品質プロセスの完了を待機せずに、ただちに終了します。


次のコマンドは、C:\oracle\oracledq\metabase_data\metabase\oracledqディレクトリにエクスポートされたデータ品質プロジェクトを実行します。

OdiDataQuality 
"-BATCH_FILE=C:\oracle\oracledq\metabase_data\metabase\oracledq\project2\scripts\runproject2.cmd "
"-OUT_FILE=C:\temp\output file" "-SYNCHRONOUS=YES"

A.5.4 OdiDeleteScen

このコマンドを使用して、指定のシナリオ・バージョンを削除します。

使用方法

OdiDeleteScen -SCEN_NAME=<name> -SCEN_VERSION=<version>

パラメータ

パラメータ 必須 説明

-SCEN_NAME=<name>

はい

削除するシナリオの名前。

-SCEN_VERSION=<version>

はい

削除するシナリオの名前。


バージョン001のDWHシナリオを削除します。

OdiDeleteScen -SCEN_NAME=DWH -SCEN_VERSION=001

A.5.5 OdiEnterpriseDataQuality

このコマンドを使用して、Oracle Enterprise Data Quality (Datanomic)ジョブを呼び出します。


注意:

EnterpriseDataQualityツールは、Oracle Enterprise Data Qualityバージョン8.1.6以降をサポートしています。


使用方法

OdiEnterpriseDataQuality "-JOB_NAME=<EDQ job name>" 
"-PROJECT_NAME=<EDQ project name>" "-HOST=<EDQ server hostname>" 
"-PORT=<EDQ server JMX port>" "-USER=<EDQ user>"
"-PASSWORD=<EDQ user's password>" "-SYNCHRONOUS=<yes|no>" "-DOMAIN=-<EDQ_DOMAIN>"

パラメータ

パラメータ 必須 説明

-JOB_NAME=<EDQ job name>

はい

Enterprise Data Qualityジョブの名前

-PROJECT_NAME=<EDQ project name>

はい

Enterprise Data Qualityプロジェクトの名前

-HOST=<EDQ server hostname>

はい

Enterprise Data Qualityサーバーのホスト名。例: localhost

-PORT=<EDQ server JMX port>

はい

Enterprise Data QualityサーバーのJMXポート。例: 9005

-USER=<EDQ user>

はい

Enterprise Data Qualityサーバー・ユーザーのユーザー名。例: dnadmin

-PASSWORD=<EDQ user's password>

はい

Enterprise Data Qualityユーザーのパスワード

-SYNCHRONOUS=<yes|no>

いいえ

yesに設定すると、ツールは品質プロセスの完了を待機してから、可能性のあるエラー・コードで復帰します。noに設定すると、ツールは品質プロセスの完了を待機せずに、ただちに正常に終了します

-DOMAIN=<EDQ_DOMAIN>

いいえ

MBeanドメインの名前。デフォルトはdndirectorです。


次のコマンドは、CUSTOMERSという名前のプロジェクトに配置されているCLEANSE_CUSTOMERSと呼ばれるEnterprise Data Qualityジョブを実行します:

EnterpriseDataQuality "-JOB_NAME=CLEANSE_CUSTOMERS" "-PROJECT_NAME=CUSTOMERS"
"-HOST=machine.oracle.com" "-PORT=9005" "-USER=odi" "-PASSWORD=odi”
"DOMAIN=dndirector"

A.5.6 OdiExportAllScen

このコマンドを使用して、接続しているリポジトリからシナリオのグループをエクスポートします。

エクスポート・ファイルは、SCEN_<scenario name><scenario version>.xmlという名前です。このコマンドは、デザイナおよびオペレータで使用可能なエクスポート機能の動作を再現します。

使用方法

OdiExportAllScen -TODIR=<directory> [-FORCE_OVERWRITE=<yes|no>] 
[-FROM_PROJECT=<project_id>] [-FROM_FOLDER=<folder_id>]
[-FROM_PACKAGE=<package_id>] [-RECURSIVE_EXPORT=<yes|no>]
[-XML_VERSION=<1.0>] [-XML_CHARSET=<charset>]
[-JAVA_CHARSET=<charset>] [-EXPORT_PACK=<YES|NO>]
[-EXPORT_POP=<YES|NO>] [-EXPORT_TRT=<YES|NO>]
[-EXPORT_VAR=<YES|NO>]

パラメータ

パラメータ 必須 説明

-TODIR=<directory>

はい

エクスポート・ファイルが作成されるディレクトリ。

-FORCE_OVERWRITE=<yes|no>

いいえ

yesに設定すると、既存のエクスポート・ファイルが警告なしに上書きされます。デフォルトはNoです。

-FROM_PROJECT=<project_id>

いいえ

エクスポートするシナリオが含まれているプロジェクトのID。これは、プロジェクト・ウィンドウの「バージョン」タブに表示される内部識別子です。このパラメータが設定されていない場合は、すべてのプロジェクトのシナリオがエクスポートの対象になります。

-FROM_FOLDER=<folder_id>

いいえ

エクスポートするシナリオが含まれているフォルダのID。これは、フォルダ・ウィンドウの「バージョン」タブに表示される内部識別子です。このパラメータが設定されていない場合は、すべてのフォルダのシナリオがエクスポートの対象になります。

-FROM_PACKAGE=<package_id>

いいえ

エクスポートするシナリオが含まれているソース・パッケージのID。これは、パッケージ・ウィンドウの「バージョン」タブに表示される内部識別子です。このパラメータが設定されていない場合は、すべてのコンポーネントのシナリオがエクスポートの対象になります。

-RECURSIVE_EXPORT=<yes|no>

いいえ

yesに設定すると、すべての子オブジェクト(スケジュール)がシナリオとともにエクスポートされます。デフォルトはyesです。

-XML_VERSION=<1.0>

いいえ

XMLヘッダーに表示するXMLバージョンを設定します。デフォルトは1.0です。

-XML_CHARSET=<charset>

いいえ

XMLエクスポート・ファイル内に<?xml version="1.0" encoding="ISO-8859-1"?>のタグで指定されるエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

ターゲット・ファイルのエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-EXPORT_PACK=<YES|NO>

いいえ

パッケージに関連付けられているシナリオをエクスポートするかどうかを示します。デフォルト値はYESです。

-EXPORT_POP=<YES|NO>

いいえ

インタフェースに関連付けられているシナリオをエクスポートするかどうかを示します。デフォルト値はNOです。

-EXPORT_TRT=<YES|NO>

いいえ

プロシージャに関連付けられているシナリオをエクスポートするかどうかを示します。デフォルト値はNOです。

-EXPORT_VAR=<YES|NO>

いいえ

変数に関連付けられているシナリオをエクスポートするかどうかを示します。デフォルト値はNOです。


内部識別子10022DW01プロジェクトのすべてのシナリオとすべての依存オブジェクトを/temp/ディレクトリにエクスポートします。

OdiExportAllScen -FROM_PROJECT=10022 -TODIR=/temp/ -RECURSIVE_EXPORT=yes

A.5.7 OdiExportEnvironmentInformation

このコマンドを使用して、指定したディレクトリに技術環境の詳細をカンマ区切り(.csv)ファイルでエクスポートします。この情報は、メンテナンスやサポートの際に必要です。

使用方法

OdiExportEnvironmentInformation -TODIR=<toDir> -FILE_NAME=<FileName>
[-CHARSET=<charset>] [-SNP_INFO_REC_CODE=<row_code>]
[-MASTER_REC_CODE=<row_code>] [-WORK_REC_CODE=<row_code>]
[-AGENT_REC_CODE=<row_code>] [-TECHNO_REC_CODE=<row_code>]
[-RECORD_SEPARATOR_HEXA=<rec_sep>]
[-FIELD_SEPARATOR_HEXA=<field_sep] [-TEXT_SEPARATOR=<text_sep>]

パラメータ

パラメータ 必須 説明

-TODIR=<toDir>

はい

エクスポートのターゲット・ディレクトリ。

-FILE_NAME=<FileName>

はい

CSVエクスポート・ファイルの名前。デフォルトはsnps_tech_inf.csvです。

-CHARSET=<charset>

いいえ

エクスポート・ファイルのキャラクタ・セット。

-SNP_INFO_REC_CODE=<row_code>

いいえ

Oracle Data Integratorの現在のバージョンおよび現在のユーザーを記述した行を識別するためのコード。このコードは、レコードの最初のフィールドで使用されます。デフォルトはSUNOPSISです。

-MASTER_REC_CODE=<row_code>

いいえ

マスター・リポジトリに関する情報が含まれている行のコード。デフォルトはMASTERです。

-WORK_REC_CODE=<row_code>

いいえ

作業リポジトリに関する情報が含まれている行のコード。デフォルトはWORKです。

-AGENT_REC_CODE=<row_code>

いいえ

実行中の各種エージェントに関する情報が含まれている行のコード。デフォルトはAGENTです。

-TECHNO_REC_CODE=<row_code>

いいえ

データ・サーバーとそのバージョンなどに関する情報が含まれている行のコード。デフォルトはTECHNOです。

-RECORD_SEPARATOR_HEXA=<rec_sep>

いいえ

ファイル内の行(またはレコード)を区切る1文字以上の16進コードの文字。デフォルトはO0D0Aです。

-FIELD_SEPARATOR_HEXA=<field_sep>

いいえ

レコード内のフィールドを区切る1文字以上の16進コードの文字。デフォルトは2Cです。

-TEXT_SEPARATOR=<text_sep>

いいえ

STRINGフィールドを区切る16進コードの文字。デフォルトは22です。


技術環境の詳細を/temp/snps_tech_inf.csvエクスポート・ファイルにエクスポートします。

OdiExportEnvironmentInformation "-TODIR=/temp/"
"-FILE_NAME=snps_tech_inf.csv" "-CHARSET=ISO8859_1" 
"-SNP_INFO_REC_CODE=SUNOPSIS" "-MASTER_REC_CODE=MASTER"
"-WORK_REC_CODE=WORK" "-AGENT_REC_CODE=AGENT"
"-TECHNO_REC_CODE=TECHNO" "-RECORD_SEPARATOR_HEXA=0D0A"
"-FIELD_SEPARATOR_HEXA=2C" "-TEXT_SEPARATOR_HEXA=22"

A.5.8 OdiExportLog

このコマンドを使用して、実行ログをZIPエクスポート・ファイルにエクスポートします。

使用方法

OdiExportLog -TODIR=<toDir> [-EXPORT_TYPE=<logsToExport>]
[-ZIPFILE_NAME=<zipFileName>] [-XML_CHARSET=<charset>]
[-JAVA_CHARSET=<charset>] [-FROMDATE=<from_date>] [-TODATE=<to_date>] 
[-AGENT=<agent>] [-CONTEXT=<context>] [-STATUS=<status>] 
[-USER_FILTER=<user>] [-NAME=<sessionOrLoadPlanName>]

パラメータ

パラメータ 必須 説明

-EXPORT_TYPE=<logsToExport>

いいえ

ログをエクスポートする対象を指定します:

  • LOAD_PLAN_RUN: 子セッションの階層に沿ってロード計画実行が起動したセッションもすべて含め、エクスポート基準と一致するすべてのロード計画実行がエクスポートされます。

  • SESSION: エクスポート・フィルタ基準と一致するすべてのセッション・ログがエクスポートされます。ロード計画セッションはすべてセッション・ログのエクスポート時に除外されます。

  • ALL: フィルタ基準と一致するすべてのロード計画実行とセッション・ログがエクスポートされます。

-TODIR=<toDir>

はい

エクスポートのターゲット・ディレクトリ。

-ZIPFILE_NAME=<zipFileName>

いいえ

圧縮ファイルの名前。

-XML_CHARSET=<charset>

いいえ

エクスポート・ファイルに指定されるXMLバージョン。XMLファイル・ヘッダーのxml versionパラメータで、<?xml version="1.0" encoding="ISO-8859-1"?>のように指定されます。デフォルト値はISO-8859-1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

結果ファイルのJava文字エンコーディング。デフォルト値はISO8859_1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-FROMDATE=<from_date>

いいえ

エクスポートの開始日。yyyy/MM/dd hh:mm:ssの書式を使用します。この日付以降のすべてのセッションがエクスポートされます。

-TODATE=<to_date>

いいえ

エクスポートの終了日。yyyy/MM/dd hh:mm:ssの書式を使用します。この日付までのすべてのセッションがエクスポートされます。

-AGENT=<agent>

いいえ

指定した名前のエージェント(<agent>)によって実行されたセッションのみをエクスポートします。

-CONTEXT=<context>

いいえ

指定したコンテキスト(<context>)で実行されたセッションのみをエクスポートします。

-STATUS=<status>

いいえ

指定した状態のセッションのみをエクスポートします。状態の種類は、「完了」、「エラー」、「キュー」、「実行中」、「待機中」および「警告」です。

-USER_FILTER=<user>

いいえ

指定したユーザー(<user>)が起動したセッションのみをエクスポートします。

-NAME=<sessionOrLoadPlanName>

いいえ

エクスポートするセッションまたはロード計画の名前。


ログをエクスポートして圧縮し、/temp/log2.zipエクスポート・ファイルを生成します。

OdiExportLog "-EXPORT_TYPE=ALL" "-TODIR=/temp/" "-ZIPFILE_NAME=log2.zip"
"-XML_CHARSET=ISO-8859-1" "-JAVA_CHARSET=ISO8859_1"

A.5.9 OdiExportMaster

このコマンドを使用して、マスター・リポジトリをディレクトリまたはzipファイルにエクスポートします。マスター・リポジトリに格納されているバージョンまたはソリューション(あるいはその両方)をエクスポートするオプションがあります。

使用方法

OdiExportMaster -TODIR=<toDir> [-ZIPFILE_NAME=<zipFileName>]
[-EXPORT_SOLUTIONS=<yes|no>] [-EXPORT_VERSIONS=<yes|no>]
[-XML_CHARSET=<charset>] [-JAVA_CHARSET=<charset>]

パラメータ

パラメータ 必須 説明

-TODIR=<toDir>

はい

エクスポートのターゲット・ディレクトリ。

-ZIPFILE_NAME=<zipFileName>

いいえ

圧縮ファイルの名前。

-EXPORT_SOLUTIONS=<yes|no>

いいえ

リポジトリに格納されているすべてのソリューションをエクスポートします。

-EXPORT_VERSIONS=<yes|no>

いいえ

リポジトリに格納されているオブジェクトのすべてのバージョンをエクスポートします。

-XML_CHARSET=<charset>

いいえ

エクスポート・ファイルに指定されるXMLバージョン。XMLファイル・ヘッダーのxml versionパラメータで、<?xml version="1.0" encoding="ISO-8859-1"?>のように指定されます。デフォルト値はISO-8859-1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

結果ファイルのJava文字エンコーディング。デフォルト値はISO8859_1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html


マスター・リポジトリをエクスポートして圧縮し、export.zipファイルを生成して/temp/ディレクトリに格納します。

OdiExportMaster "-TODIR=/temp/" "-ZIPFILE_NAME=export.zip"
"-XML_CHARSET=ISO-8859-1" "-JAVA_CHARSET=ISO8859_1"
"-EXPORT_VERSIONS=YES"

A.5.10 OdiExportObject

このコマンドを使用して、現在のリポジトリからオブジェクトをエクスポートします。このコマンドは、ユーザー・インタフェースで使用可能なエクスポート機能の動作を再現します。

使用方法

OdiExportObject -CLASS_NAME=<class_name> -I_OBJECT=<object_id>
[-EXPORT_DIR=<directory>][-EXPORT_NAME=<export_name>|-FILE_NAME=<file_name>] 
[-FORCE_OVERWRITE=<yes|no>][-RECURSIVE_EXPORT=<yes|no>] [-XML_VERSION=<1.0>]
[-XML_CHARSET=<charset>] [-JAVA_CHARSET=<charset>]

パラメータ

パラメータ 必須 説明

-CLASS_NAME=<class_name>

はい

エクスポートするオブジェクトのクラス。クラスのリストは次の表を参照してください。

-I_OBJECT=<object_id>

はい

オブジェクト識別子。オブジェクト編集ウィンドウの「バージョン」タブに表示される内部識別子です。

-FILE_NAME=<file_name>

いいえ

エクスポート・ファイルの名前。絶対パスまたはEXPORT_DIRからの相対パスを指定できます。

このファイル名は、Oracle Data Integrator標準エクスポート・ファイルの接頭辞および接尾辞に準拠しているかどうかに関係なく指定できます。この標準に完全に準拠する場合は、かわりにEXPORT_NAMEパラメータを使用します。EXPORT_NAMEが設定されている場合、このパラメータは使用できません。

-EXPORT_DIR=<directory>

いいえ

オブジェクトがエクスポートされるディレクトリ。このディレクトリ内に作成されたエクスポート・ファイルには、FILE_NAMEおよびEXPORT_NAMEパラメータに従って名前が指定されます。

FILE_NAMEまたはEXPORT_NAMEが指定されていない場合、エクスポート・ファイルには、<object_prefix>_<object_name>.xmlという名前が自動的に指定されます。たとえば、Datawarehouseというプロジェクトは、PRJ_Datawarehouse.xmlにエクスポートされます。

-EXPORT_NAME=<export_name>

いいえ

エクスポート名。このパラメータを使用して、<object_prefix>_<export_name>.xmlという名前のエクスポート・ファイルを生成します。このパラメータはFILE_NAMEとは併用できません。

-FORCE_OVERWRITE=<yes|no>

いいえ

yesに設定すると、同じ名前の既存のエクスポート・ファイルが強制的に上書きされます。デフォルトはNoです。

-RECURSIVE_EXPORT=<yes|no>

いいえ

yesに設定すると、すべての子オブジェクトが現在のオブジェクトとともにエクスポートされます。たとえば、プロジェクトをエクスポートしている場合は、そのプロジェクト内のすべてのフォルダ、KMなどが、プロジェクト・エクスポート・ファイルにエクスポートされます。デフォルトはYesです。

-XML_VERSION=<1.0>

いいえ

XMLヘッダーに表示するXMLバージョンを設定します。デフォルトは1.0です。

-XML_CHARSET=<charset>

いいえ

XMLファイル内に<?xml version="1.0" encoding="ISO-8859-1"?>のタグで指定されるエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

ターゲット・ファイルのエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html


クラスのリスト

オブジェクト クラス名

SnpCol

条件/フィルタ

SnpCond

コンテキスト

SnpContext

データ・サーバー

SnpConnect

データストア

SnpTable

フォルダ

SnpFolder

インタフェース

SnpPop

言語

SnpLang

モデル

SnpModel

パッケージ

SnpPackage

物理スキーマ

SnpPschema

プロシージャまたはKM

SnpTrt

プロシージャまたはKMのオプション

SnpUserExit

プロジェクト

SnpProject

リファレンス

SnpJoin

シナリオ

SnpScen

順序

SnpSequence

Step

SnpStep

Sub-Model

SnpSubModel

テクノロジ

SnpTechno

ユーザー関数

SnpUfunc

変数

SnpVar

オブジェクトのバージョン

SnpData


内部識別子10022DW01プロジェクトとその依存オブジェクトすべてを/temp/dw1.xmlエクスポート・ファイルにエクスポートします。

OdiExportObject -CLASS_NAME=SnpProject -I_OBJECT=10022
-FILE_NAME=/temp/dw1.xml -FORCE_OVERWRITE=yes
-RECURSIVE_EXPORT=yes

A.5.11 OdiExportScen

このコマンドを使用して、現在の作業リポジトリからシナリオをエクスポートします。

使用方法

OdiExportScen -SCEN_NAME=<scenario_name> -SCEN_VERSION=<scenario_version>
[-EXPORT_DIR=<directory>][-FILE_NAME=<file_name>|EXPORT_NAME=<export_name>]
[-FORCE_OVERWRITE=<yes|no>][-RECURSIVE_EXPORT=<yes|no>] [-XML_VERSION=<1.0>]
[-XML_CHARSET=<encoding>] [-JAVA_CHARSET=<encoding>]

パラメータ

パラメータ 必須 説明

-SCEN_NAME=<scenario_name>

はい

エクスポートするシナリオの名前。

-SCEN_VERSION=<scenario_version>

はい

エクスポートするシナリオのバージョン。

-FILE_NAME=<file_name>

はい

エクスポート・ファイルの名前。絶対パスまたはEXPORT_DIRからの相対パスを指定できます。

このファイル名は、シナリオのOracle Data Integrator標準エクスポート・ファイルの接頭辞および接尾辞に準拠しているかどうかに関係なく指定できます。この標準に完全に準拠する場合は、かわりにEXPORT_NAMEパラメータを使用します。EXPORT_NAMEが設定されている場合、このパラメータは使用できません。

-EXPORT_DIR=<directory>

いいえ

シナリオがエクスポートされるディレクトリ。このディレクトリ内に作成されたエクスポート・ファイルには、FILE_NAMEおよびEXPORT_NAMEパラメータに従って名前が指定されます。

FILE_NAMEまたはEXPORT_NAMEが指定されていない場合、エクスポート・ファイルには、SCEN_<scenario_name> <scenario_version>.xmlという名前が自動的に指定されます。

-EXPORT_NAME=<export_name>

いいえ

エクスポート名。このパラメータを使用して、SCEN_<export_name>.xmlという名前のエクスポート・ファイルを生成します。このパラメータはFILE_NAMEとは併用できません。

-FORCE_OVERWRITE=<yes|no>

いいえ

Yesの場合は、既存のエクスポート・ファイルが上書きされます。

-RECURSIVE_EXPORT=<yes|no>

いいえ

シナリオの下にあるオブジェクトが強制的にエクスポートされます。デフォルトはYesです。

-XML_VERSION=<1.0>

いいえ

生成されたXMLファイル内に<?xml version="1.0" encoding="ISO-8859-1"?>のタグで指定されるバージョン。デフォルト値は1.0です。

-XML_CHARSET=<encoding>

いいえ

XMLファイル内に<?xml version="1.0" encoding="ISO-8859-1"?>のタグで指定されるエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-JAVA_CHARSET=<encoding>

いいえ

ターゲット・ファイルのエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html


LOAD_DWHシナリオとその依存オブジェクトすべてをバージョン1で/temp/load_dwh.xmlエクスポート・ファイルにエクスポートします。

OdiExportScen -SCEN_NAME=LOAD_DWH -SCEN_VERSION=1
-FILE_NAME=/temp/load_dwh.xml -RECURSIVE_EXPORT=yes

A.5.12 OdiExportWork

このコマンドを使用して、作業リポジトリをディレクトリまたはZIPエクスポート・ファイルにエクスポートします。

使用方法

OdiExportWork -TODIR=<directory> [-ZIPFILE_NAME=<zipFileName>]
[-XML_CHARSET=<charset>] [-JAVA_CHARSET=<charset>]

パラメータ

パラメータ 必須 説明

-TODIR=<directory>

はい

エクスポートのターゲット・ディレクトリ。

-ZIPFILE_NAME=<zipFileName>

いいえ

圧縮ファイルの名前。

-XML_CHARSET=<charset>

いいえ

エクスポート・ファイルに指定されるXMLバージョン。XMLファイル・ヘッダーのxml versionパラメータで、<?xml version="1.0" encoding="ISO-8859-1"?>のように指定されます。デフォルト値はISO-8859-1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

結果ファイルのJava文字エンコーディング。デフォルト値はISO8859_1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html


作業リポジトリをエクスポートして圧縮し、/temp/workexport.zipエクスポート・ファイルを生成します。

OdiExportWork "-TODIR=/temp/" "-ZIPFILE_NAME=workexport.zip"

A.5.13 OdiFileAppend

このファイルを使用して、一連のファイルを単一ファイルに連結します。

使用方法

OdiFileAppend -FILE=<file> -TOFILE=<target_file> [-OVERWRITE=<yes|no>]
[-CASESENS=<yes|no>] [-HEADER=<n>] [-KEEP_FIRST_HEADER=<yes|no]

パラメータ

パラメータ 必須 説明

-FILE=<file>

はい

連結するファイルのフル・パス。汎用文字を指定するには「*」を使用します。

例:

/var/tmp/*.log (/var/tmpフォルダ内にあるlog拡張子のファイルすべて)

arch_*.lst (arch_で開始するlst拡張子のファイルすべて)

-TOFILE=<target_file>

はい

ターゲット・ファイル。

-OVERWRITE=<yes|no>

いいえ

ターゲット・ファイルが存在する場合に上書きするかどうかを示します。デフォルトでは、値はNoに設定されています。

-CASESENS=<yes|no>

いいえ

ファイル検索時に、Oracle Data Integratorで大文字と小文字が区別されるかどうかを示します。デフォルトでは、ファイルは大文字で検索されます。

-HEADER=<n>

いいえ

連結前にソース・ファイルから削除するヘッダー行の行数。デフォルトでは、行は削除されません。

HEADERパラメータを省略すると、連結ではファイル編集が不要になるため、より迅速に実行されます。

-KEEP_FIRST_HEADER=<yes|no>

いいえ

連結時に最初のファイルのヘッダー行を維持するために使用されます。


/var/tmpフォルダの*.logファイルを/home/all_files.logファイルに連結します。

OdiFileAppend -FILE=/var/tmp/*.log -TOFILE=/home/all_files.log

各店の日次売上のファイルを、最初のファイルのヘッダーを維持しながら連結します。

OdiFileAppend -FILE=/data/store/sales_*.dat -TOFILE=/data/all_stores.dat
-OVERWRITE=yes -HEADER=1 -KEEP_FIRST_HEADER=yes

A.5.14 OdiFileCopy

このコマンドを使用して、ファイルまたはフォルダをコピーします。

使用方法

OdiFileCopy -DIR=<directory> -TODIR=<target_directory> [-OVERWRITE=<yes|no>]
[-RECURSE=<yes|no>] [-CASESENS=<yes|no>]

OdiFileCopy -FILE=<file> -TOFILE=<target_file>|-TODIR=<target_directory>
[-OVERWRITE=<yes|no>] [-RECURSE=<yes|no>] [-CASESENS=<yes|no>]

パラメータ

パラメータ 必須 説明

-DIR=<directory>

-FILE省略時は、はい

コピーするディレクトリ(またはフォルダ)。

-FILE=<file>

-DIR省略時は、はい

コピーするファイルのフル・パス。汎用文字を指定するには「*」を使用します。

例:

/var/tmp/*.log (/var/tmpフォルダ内にあるlog拡張子のファイルすべて)

arch_*.lst (arch_で開始するlst拡張子のファイルすべて)

-TODIR=<target_directory>

-DIR指定時は、はい

コピーのターゲット・ディレクトリ。

ディレクトリをコピーする場合(-DIR)、このパラメータは、コピーされるディレクトリの名前を示します。

1つ以上のファイルをコピーする場合(-FILE)、このパラメータは、コピー先ディレクトリを示します。

-TOFILE=<target_file>

-TODIR省略時は、はい

宛先ファイル。このパラメータは、-DIRパラメータとは併用できません。

このパラメータで、次のことを指定します。

  • コピーするファイルが1つのみの場合は、宛先ファイルの名前(汎用文字は使用不可)。

  • 複数のファイルをコピーする場合は、宛先ファイルの新しい名前のマスク。

TODIRとTOFILEは同時に使用できないパラメータです。両方を指定すると、TODIRのみが考慮され、TOFILEは無視されます。

-OVERWRITE=<yes|no>

いいえ

フォルダのファイルがすでに存在している場合、上書きするかどうかを示します。デフォルトでは、値はNoに設定されています。

-RECURSE=<yes|no>

いいえ

ディレクトリに別のディレクトリが含まれている場合に、ファイルを再帰的にコピーするかどうかを示します。Noの値を指定すると、ディレクトリ内のファイルのみがコピーされ、サブディレクトリはコピーされません。デフォルトはYesです。

-CASESENS=<yes|no>

いいえ

ファイル検索時に、Oracle Data Integratorで大文字と小文字が区別されるかどうかを示します。デフォルトでは、検索対象のファイルはすべて大文字です(Noに設定されます)。


hostsファイルを/etcディレクトリから/homeディレクトリにコピーします。

OdiFileCopy -FILE=/etc/hosts -TOFILE=/home/hosts

*.csvファイルすべてを/etcディレクトリから/homeディレクトリに上書きでコピーします。

OdiFileCopy -FILE=/etc/*.csv -TODIR=/home -OVERWRITE=yes

*.csvファイルすべてを/etcディレクトリから/homeディレクトリにコピーし、拡張子を.txtに変更します。

OdiFileCopy -FILE=/etc/*.csv -TOFILE=/home/*.txt -OVERWRITE=yes

C:\odiディレクトリとそのサブディレクトリをC:\Program Files\odiディレクトリにコピーします。

OdiFileCopy -DIR=C:\odi "-TODIR=C:\Program Files\odi" -RECURSE=yes

A.5.15 OdiFileDelete

このコマンドを使用して、ファイルまたはディレクトリを削除します。

このツールの最も一般的なユースケースを次の表に示します:

  • xは指定されていることを意味します。

  • oは省略されていることを意味します。

-DIR -FILE -RECURSE 動作

x

x

x

名前のあるすべてのファイル、または-FILEで指定されたマスクと一致する名前のファイルがすべて、-DIRとそのすべてのサブディレクトリから削除されます。

x

o

x

-FILEのサブディレクトリが削除されます。

x

x

o

名前のあるすべてのファイル、または-FILEで指定されたマスクと一致する名前のファイルがすべて-DIRから削除されます。

x

o

o

-DIRが削除されます。


使用方法

OdiFileDelete -DIR=<directory> | -FILE=<file> [-RECURSE=<yes|no>] [-CASESENS=<yes|no>]
[-NOFILE_ERROR=<yes|no>] [-FROMDATE=<from_date>] [-TODATE=<to_date>] 

パラメータ

パラメータ 必須 説明

-DIR=<directory>

-FILE省略時は、はい

  1. -FILEを省略した場合は、削除するディレクトリ(フォルダ)の名前を指定します。

  2. -FILEを指定した場合は、ファイルを削除するパスを指定します。

-FILE=<file>

-DIR省略時は、はい

削除するファイルの名前またはマスク。-DIRを省略した場合は、フル・パスを指定してください。ワイルドカード文字を指定するには「*」を使用します。

例:

/var/tmp/*.log (/var/tmpディレクトリ内にある.logファイルすべて)

/bin/arch_*.lst (arch_で開始する.lstファイルすべて)

-RECURSE=<yes|no>

いいえ

  1. -FILEが省略されている場合、-RECURSEパラメータは無効です。すべてのサブディレクトリが暗黙的に削除されます。

  2. -FILEが指定されてい場合は、このディレクトリとそのサブディレクトリすべてからファイルを削除するかどうかを-RECURSEパラメータで指定します。

デフォルトはYesです。

-CASESENS=<yes|no>

いいえ

Oracle Data Integratorがファイル名を照合する際に、大文字と小文字を区別するかどうかを指定します。

-NOFILE_ERROR=<yes|no>

はい

指定のディレクトリまたはファイルがない場合、エラーを生成するかどうかを指定します。

-FROMDATE=<from_date>

いいえ

変更日がこの日付より後のファイルが削除されます。日付は、yyyy/MM/dd hh:mm:ssの書式で指定する必要があります。

FROM_DATEは対象に含まれません。

-FROMDATEを省略した場合は、変更日が-TODATEの日付より前のすべてのファイルが削除されます。

FROMDATEとTODATEの両方のパラメータを省略した場合は、-FILEパラメータ値と一致するすべてのファイルが削除されます。

-TODATE=<to_date>

いいえ

変更日がこの日付より前のファイルが削除されます。日付は、yyyy/MM/dd hh:mm:ssの書式で指定する必要があります。

TO_DATEは対象に含まれません。

-TODATEを省略した場合は、変更日が-FROMDATEの日付より後のすべてのファイルが削除されます。

FROMDATEとTODATEの両方のパラメータを省略した場合は、-FILEパラメータ値と一致するすべてのファイルが削除されます。



注意:

-DIRパラメータと-FILEパラメータを組み合せてファイルとディレクトリを同時に削除することはできません。その場合は、OdiFileDeleteを2回コールする必要があります。


c:\data\inputディレクトリからmy_data.datファイルを削除します。ファイルが欠落している場合はエラーを生成します。

OdiFileDelete -FILE=c:\data\input\my_data.dat -NOFILE_ERROR=yes

binディレクトリからすべての.txtファイルを削除します。ただし、.TXTファイルは除きます。

OdiFileDelete "-FILE=c:\Program Files\odi\bin\*.txt" -CASESENS=yes

次の文も同じ結果になります。

OdiFileDelete "-DIR=c:\Program Files\odi\bin" "-FILE=*.txt" -CASESENS=yes

/bin/usr/nothingToDoHereディレクトリを削除します。

OdiFileDelete "-DIR=/bin/usr/nothingToDoHere"

C:\tempディレクトリから、変更時刻が10/01/2008 00:00:00から10/31/2008 22:59:00までの間(10/01/2008から10/31/2008までは対象外)のファイルをすべて削除します。

OdiFileDelete -DIR=C:\temp -FILE=* -NOFILE_ERROR=NO -FROMDATE=FROMDATE=10/01/2008 00:00:00 -TODATE=10/31/2008 22:59:00

C:\tempディレクトリから、変更時刻が10/31/2008 17:00:00より前のすべてのファイルを削除します。ディレクトリ内に日付基準を満たす削除対象ファイルがない場合は、エラーがスローされます。

OdiFileDelete -DIR=C:\temp -FILE=* -NOFILE_ERROR=YES -TODATE=10/31/2008 17:00:00

C:\tempディレクトリから、変更時刻が10/01/2008 08:00:00より後のすべてのファイルを削除します。

OdiFileDelete -DIR=C:\temp -FILE=* -NOFILE_ERROR=NO -FROMDATE=10/01/2008 08:00:00

A.5.16 OdiFileMove

このコマンドを使用して、ファイルまたはディレクトリを別のファイルまたはディレクトリに移動(または名前を変更)します。

使用方法

OdiFileMove -FILE=<file> -TODIR=<target_directory>|-TOFILE=<target_file>
[-OVERWRITE=<yes|no>] [-RECURSE=<yes|no>] [-CASESENS=<yes|no>]

OdiFileMove -DIR=<directory> -TODIR=<target_directory> [-OVERWRITE=<yes|no>]
[-RECURSE=<yes|no>] [-CASESENS=<yes|no>]

パラメータ

パラメータ 必須 説明

-DIR=<directory>

-FILE省略時は、はい

移動または名前を変更するディレクトリ(またはフォルダ)。

-FILE=<file>

-DIR省略時は、はい

移動または名前を変更するファイルのフル・パス。汎用文字を指定するには「*」を使用します。

例:

/var/tmp/*.log (/var/tmpディレクトリ内にあるlog拡張子のファイルすべて)

arch_*.lst (arch_で開始するlst拡張子のファイルすべて)

-TODIR=<target_directory>

-DIR指定時は、はい

移動のターゲット・ディレクトリ。

ディレクトリを移動する場合(-DIR)、このパラメータはディレクトリの新しい名前を示します。

1つ以上のファイルを移動する場合(-FILE)、このパラメータは移動先ディレクトリを示します。

-TOFILE=<target_file>

-TODIR省略時は、はい

ターゲット・ファイル。このパラメータは、-DIRパラメータとは併用できません。

このパラメータで、次のことを指定します。

- 単一のファイルを移動する場合は、ターゲット・ファイルの新しい名前(汎用文字は使用不可)。

- 複数のファイルを移動する場合は、新しいファイル名のマスク。

-OVERWRITE=<yes|no>

いいえ

ファイルまたはディレクトリがすでに存在している場合、上書きするかどうかを示します。デフォルトでは、値はnoです。

-RECURSE=<yes|no>

いいえ

ディレクトリに別のディレクトリが含まれている場合に、ファイルを再帰的に移動するかどうかを示します。noの値を指定すると、移動するディレクトリ内のファイルのみが移動し、サブディレクトリは移動しません。

-CASESENS=<yes|no>

いいえ

ファイル検索時に、Oracle Data Integratorで大文字と小文字が区別されるかどうかを示します。デフォルトでは、検索対象のファイルはすべて大文字です。


hostというファイルの名前をhosts.oldに変更します。

OdiFileMove -FILE=/etc/hosts -TOFILE=/etc/hosts.old

hostsファイルを/etcディレクトリから/home/odiディレクトリに移動します。

OdiFileMove -FILE=/etc/hosts -TOFILE=/home/odi/hosts

すべての*.csvファイルを/etcディレクトリから/home/odiディレクトリに上書きで移動します。

OdiFileMove -FILE=/etc/*.csv -TODIR=/home/odi -OVERWRITE=yes

すべての*.csvファイルを/etcディレクトリから/home/odiディレクトリに移動し、拡張子を.txtに変更します。

OdiFileMove -FILE=/etc/*.csv -TOFILE=/home/odi/*.txt -OVERWRITE=yes

C:\odiディレクトリの名前をC:\odi_is_wonderfulに変更します。

OdiFileMove -DIR=C:\odi -TODIR=C:\odi_is_wonderful

C:\odiディレクトリとそのサブフォルダをC:\Program Files\odiディレクトリに移動します。

OdiFileMove -DIR=C:\odi "-TODIR=C:\Program Files\odi" -RECURSE=yes

A.5.17 OdiFileWait

このコマンドを使用して、ファイル・イベントを管理します。このコマンドは、ディレクトリを定期的にスキャンし、特定の数のファイルがマスクと一致して表示されることを、指定のタイムアウトに達するまで待機します。指定のファイルが見つかると、これらのファイルに対してアクションがトリガーされます。

使用方法

OdiFileWait -DIR=<directory> -PATTERN=<pattern>
[-ACTION=<DELETE|COPY|MOVE|APPEND|ZIP|NONE>] [-TODIR=<target_directory>]
[-TOFILE=<target_file>] [-OVERWRITE=<yes|no>] [-CASESENS=<yes|no>]
[-FILECOUNT=<n>] [-TIMEOUT=<n>] [-POLLINT=<n>] [-HEADER=<n>]
[-KEEP_FIRST_HEADER=<yes|no>] [-NOFILE_ERROR=<yes|no>]

パラメータ

パラメータ 必須 説明

-ACTION=

<DELETE|COPY|MOVE|APPEND|ZIP|NONE>

いいえ

見つかったファイルに対するアクション:

DELETE: 見つかったファイルを削除します。

COPY: 見つかったファイルをTODIRディレクトリにコピーします。

MOVE: 見つかったファイルをTODIRフォルダに移動するか、TOFILEで指定された名前に変更します。

APPEND: 見つかったすべてのファイルを連結し、TOFILEで指定された結果ファイルを作成します。ソース・ファイルは削除されます。

ZIP: 見つかったファイルを圧縮し、TOFILEで指定されたZIPファイルに格納します。

NONE: アクションを実行しません。これがデフォルトの動作です。

-DIR=<directory>

はい

スキャンするディレクトリ(またはフォルダ)

-PATTERN=<pattern>

はい

スキャンするファイル名のマスク。汎用文字を指定するには「*」を使用します。

例:

*.log (log拡張子のファイルすべて)

arch_*.lst (arch_で開始するlst拡張子のファイルすべて)

-TODIR=<target_directory>

いいえ

アクションのターゲット・ディレクトリ。アクションによって次のようになります:

COPY: ファイルのコピー先ディレクトリ。

MOVE: ファイルの移動先ディレクトリ。

-TOFILE=<target_file>

いいえ

宛先ファイル。アクションによって次のようになります:

MOVE: 移動したファイルの名前変更マスク。

APPEND: 連結の結果ファイルの名前。

ZIP: ZIP結果ファイルの名前。

COPY: コピーされたファイルの名前変更マスク。名前変更ルールは、次のとおりです。

  • 元のファイル名の英数文字が、<target_file>で指定された英数文字で置換されます。

  • -TOFILEの「?」は、元の記号がこの位置に保持されます。

  • -TOFILEの「*」は、元のファイル名の残りの記号すべてを意味します。

-OVERWRITE=<yes|no>

いいえ

宛先ファイルが存在する場合に、そのファイルを上書きするかどうかを示します。デフォルトでは、値はnoに設定されています。

このオプションをAPPENDと併用すると、ターゲット・ファイルには、最後に処理されたファイルの内容のみが格納されます。

-CASESENS=<yes|no>

いいえ

ファイル検索で大文字と小文字が区別されるかどうかを示します。デフォルトでは、検索対象のファイルは大文字です。

-FILECOUNT=<n>

いいえ

待機するファイルの最大数(デフォルトは0)。この数に到達すると、コマンドは終了します。

0の値では、タイムアウトに到達するまで、すべてのファイルを待機します。

このパラメータが0で、タイムアウトも0の場合、このパラメータは暗黙的に1に設定されます。

-TIMEOUT=<n>

いいえ

ミリ秒単位の最大待機時間(デフォルトは0)。

この待機時間に到達すると、FILECOUNTパラメータの値に関係なく、コマンドは次のコマンドに制御を譲ります。

0の値は、待機時間が無制限であることを示します(FILECOUNTパラメータに指定されたメッセージ読取り最大数まで待機します)。

-POLLINT=<n>

いいえ

新規ファイルを検索する間隔(ミリ秒単位)。デフォルトは1000 (1秒)に設定されています。これは、Oracle Data Integratorが1秒間隔で新しいメッセージを検索することを意味します。OdiFileWaitの最中に書き込まれたファイルは、この間隔の合間に(ファイル・サイズ未変更で)閉じた後でのみ検索の対象となります。

-HEADER=<n>

いいえ

このパラメータはAPPENDアクションでのみ有効です。

連結前にファイルから削除するヘッダー行の行数。デフォルトでは削除されません(0)。

-KEEP_FIRST_HEADER=<yes|no>

いいえ

このパラメータはAPPENDアクションでのみ有効です。

連結時に最初のファイルのヘッダー行を維持するために使用されます。デフォルトはYesです。

-NOFILE_ERROR=<yes|no>

いいえ

ファイルが見つからない場合の動作を示します。

No (デフォルト)の値は、ファイルが見つからない場合もエラーを生成しないことを示します。


c:\eventsディレクトリのflag.txtファイルを時間制限なしで待機し、ファイルが検出された場合は先に進みます。

OdiFileWait -ACTION=NONE -DIR=c:\events -PATTERN=flag.txt -FILECOUNT=1
-TIMEOUT=0 -POLLINT=1000

c:\eventsディレクトリのflag.txtファイルを時間制限なしで待機し、ファイルが検出された場合はそのファイルを削除します。

OdiFileWait -ACTION=DELETE -DIR=c:\events -PATTERN=flag.txt -FILECOUNT=1
-TIMEOUT=0 -POLLINT=1000

売上ファイル(*.dat)を5分間待機し、c:\sales_inディレクトリを1秒間隔でスキャンして、C:\sales_okディレクトリのsales.datファイルに連結します。その際、最初のファイルのヘッダーは維持します。

OdiFileWait -ACTION=APPEND -DIR=c:\sales_in -PATTERN=*.dat
TOFILE=c:\sales_ok\sales.dat -FILECOUNT=0 -TIMEOUT=350000 -POLLINT=1000
-HEADER=1 -KEEP_FIRST_HEADER=yes -OVERWRITE=yes

売上ファイル(*.dat)を5分間待機し、c:\sales_inディレクトリを1秒間隔でスキャンして、C:\sales_okディレクトリにファイルをコピーします。その際、ファイルは上書きしません。

OdiFileWait -ACTION=COPY -DIR=c:\sales_in -PATTERN=*.dat -TODIR=c:\sales_ok
-FILECOUNT=0 -TIMEOUT=350000 -POLLINT=1000 -OVERWRITE=no

売上ファイル(*.dat)を5分間待機し、c:\sales_inディレクトリを1秒間隔でスキャンして、これらのファイルをzipファイルにアーカイブします。

OdiFileWait -ACTION=ZIP -DIR=c:\sales_in -PATTERN=*.dat
-TOFILE=c:\sales_ok\sales.zip -FILECOUNT=0 -TIMEOUT=350000
-POLLINT=1000 -OVERWRITE=yes

売上ファイル(*.dat)を5分間待機し、c:\sales_inディレクトリを1秒間隔でスキャンして、C:\sales_okディレクトリにファイルを移動します。その際、ファイルは上書きしません。ファイル名に.bakを追加します。

OdiFileWait -ACTION=MOVE -DIR=c:\sales_in -PATTERN=*.dat
-TODIR=c:\sales_ok -TOFILE=*.bak -FILECOUNT=0 -TIMEOUT=350000
-POLLINT=1000 -OVERWRITE=no

A.5.18 OdiFtpGet

このコマンドを使用して、FTPサーバーからファイルをダウンロードします。

使用方法

OdiFtpGet -HOST=<ftp server host name> -USER=<ftp user> 
[PASSWORD=<ftp user password>] -REMOTE_DIR=<remote dir on ftp host>
[-REMOTE_FILE=<file name under the -REMOTE_DIR>] -LOCAL_DIR=<local dir>
[-LOCAL_FILE=<file name under the –LOCAL_DIR>] [-PASSIVE_MODE=<yes|no>] 
[-TIMEOUT=<time in seconds>] 

パラメータ

パラメータ 必須 説明

-HOST=<host name of the Ftp server>

はい

FTPサーバーのホスト名。

-USER=<host name of the Ftp user>

はい

FTPサーバーのユーザー。

-PASSWORD=<password of the Ftp user>

いいえ

FTPユーザーのパスワード。

-REMOTE_DIR=<dir on ftp host>

はい

リモートFTPホスト上のディレクトリ・パス。

-REMOTE_FILE=<file name under -REMOTE DIR>

いいえ

-REMOTE_DIR引数で指定されたディレクトリのファイル名。この引数が欠落している場合は、-LOCAL_FILEファイル名を使用してファイルがコピーされます。-LOCAL_FILE引数も欠落している場合は、-LOCAL_DIRが-REMOTE_DIRに再帰的にコピーされます。

-LOCAL_DIR=<local dir path>

はい

ローカル・マシン上のディレクトリ・パス。

-LOCAL_FILE=<local file>

いいえ

-LOCAL_DIR引数で指定されたディレクトリのファイル名。この引数が欠落している場合は、-LOCAL_DIRにあるすべてのファイルおよびディレクトリが、-REMOTE_DIRに再帰的にコピーされます。

コピーするファイルをフィルタ処理するには、「*」を使用して汎用文字を指定します。

例:

  • *.log (log拡張子のファイルすべて)

  • arch_*.lst (arch_で開始するlst拡張子のファイルすべて)

-PASSIVE_MODE

いいえ

Noに設定すると、FTPセッションでアクティブ・モードが使用されます。デフォルト値はyesで、パッシブ・モードで実行されます。

-TIMEOUT=<timeout value>

いいえ

ソケット接続がタイムアウトするまでの秒数。


FTPサーバー・マシン上のリモート・ディレクトリ/test_copy555をローカル・ディレクトリC:\temp\test_copyに再帰的にコピーします。

OdiFtpGet -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp\test_copy -REMOTE_DIR=/test_copy555

FTPサーバー・マシン上のリモート・ディレクトリ/にあるSales*.txtパターンと一致するすべてのファイルをローカル・ディレクトリC:\temp\にコピーします。また、FTP接続にはアクティブ・モードを使用します。

OdiFtpGet -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales*.txt -REMOTE_DIR=/ -PASSIVE_MODE=NO

A.5.19 OdiFtpPut

このコマンドを使用して、ローカル・ファイルをFTPサーバーにアップロードします。

使用方法

OdiFtpPut -HOST=<ftp server host name> -USER=<ftp user> 
[PASSWORD=<ftp user password>] -REMOTE_DIR=<remote dir on ftp host>
[-REMOTE_FILE=<file name under the -REMOTE_DIR>] -LOCAL_DIR=<local dir>
[-LOCAL_FILE=<file name under the –LOCAL_DIR>] [-PASSIVE_MODE=<yes|no>] 
[-TIMEOUT=<time in seconds>] 

パラメータ

パラメータ 必須 説明

-HOST=<host name of the Ftp server>

はい

FTPサーバーのホスト名。

-USER=<host name of the Ftp user>

はい

FTPサーバーのユーザー。

-PASSWORD=<password of the Ftp user>

いいえ

FTPユーザーのパスワード。

-REMOTE_DIR=<dir on ftp host>

はい

リモートFTPホスト上のディレクトリ・パス。

-REMOTE_FILE=<file name under -REMOTE DIR>

いいえ

-REMOTE_DIR引数で指定されたディレクトリのファイル名。この引数が欠落している場合は、-LOCAL_FILEファイル名を使用してファイルがコピーされます。-LOCAL_FILE引数も欠落している場合は、-LOCAL_DIRが-REMOTE_DIRに再帰的にコピーされます。

-LOCAL_DIR=<local dir path>

はい

ローカル・マシン上のディレクトリ・パス。

-LOCAL_FILE=<local file>

いいえ

-LOCAL_DIR引数で指定されたディレクトリのファイル名。この引数が欠落している場合は、-LOCAL_DIRにあるすべてのファイルおよびディレクトリが、-REMOTE_DIRに再帰的にコピーされます。

コピーするファイルをフィルタ処理するには、「*」を使用して汎用文字を指定します。

例:

  • *.log (log拡張子のファイルすべて)

  • arch_*.lst (arch_で開始するlst拡張子のファイルすべて)

-PASSIVE_MODE

いいえ

Noに設定すると、FTPセッションでアクティブ・モードが使用されます。デフォルト値はyesで、パッシブ・モードで実行されます。

-TIMEOUT=<timeout value>

いいえ

ソケット接続がタイムアウトするまでの秒数。


ローカル・ディレクトリC:\temp\test_copyをFTPサーバー・マシン上のリモート・ディレクトリ/test_copy555に再帰的にコピーします。

OdiFtpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password>
 -LOCAL_DIR=C:\temp\test_copy -REMOTE_DIR=/test_copy555"

ローカル・ディレクトリC:\temp\にあるSales*.txtパターンと一致するすべてのファイルをFTPサーバー・マシン上のリモート・ディレクトリ/にコピーします。

OdiFtpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales*.txt -REMOTE_DIR=/

ローカル・ディレクトリC:\temp\にあるSales1.txtファイルをFTPサーバー・マシン上のリモート・ディレクトリ/Sample1.txtファイルとしてコピーします。

OdiFtpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales1.txt -REMOTE_DIR=/Sample1.txt 

A.5.20 OdiGenerateAllScen

このコマンドを使用して、フォルダまたはプロジェクトに含まれ、マーカーによってフィルタ処理された設計時コンポーネント(パッケージ、インタフェース、プロシージャまたは変数)から一連のシナリオを生成します。

使用方法

OdiGenerateAllScen -PROJECT=<project_id> [-FOLDER=<folder_id>]
[-MODE=<REPLACE|CREATE>] [-GRPMARKER=<marker_group_code>
-MARKER=<marker_code>] [-GENERATE_PACK=<YES|NO>]
[-GENERATE_POP=<YES|NO>] [-GENERATE_TRT=<YES|NO>]
[-GENERATE_VAR=<YES|NO>]

パラメータ

パラメータ 必須 説明

-PROJECT=<project_id>

はい

シナリオを生成するコンポーネントが含まれているプロジェクトのID。

-FOLDER=<folder_id>

いいえ

シナリオを生成するコンポーネントが含まれているフォルダのID。

-MODE=<REPLACE|CREATE>

いいえ

シナリオ生成モード:

  • 置換(デフォルト): 最後に生成されたシナリオが新規に生成されたシナリオで置換されます。その際、名前またはバージョンは変更されません。このシナリオにリンクしているスケジュールは削除されます。

    シナリオがない場合は、新規のシナリオが生成されます。

  • 作成: コンポーネントに最後に生成されたシナリオと同じ名前の新規シナリオが作成されます。バージョン番号は、最新バージョンが整数の場合は自動的に増分され、整数でない場合は現在の日付に設定されます。

    そのコンポーネントにシナリオが作成されていない場合は、シナリオの最初のバージョンが自動的に作成されます。

    新しいシナリオの名前は、「シナリオ命名規則」ユーザー・パラメータに従ったコンポーネント名に基づいて命名されます。

-GRPMARKER=<marker_group_code>

いいえ

シナリオを生成するコンポーネントのフィルタ処理に使用するマーカーが含まれているグループ。

GRPMARKERとMARKERを指定すると、マーカー・コードとマーカー・グループ・コードで識別され、マーカーにフラグが指定されているコンポーネントに対してのみシナリオが(再)生成されます。

-MARKER=<marker_code>

いいえ

シナリオを生成するコンポーネントのフィルタ処理に使用するマーカー。

GRPMARKERとMARKERを指定すると、マーカー・コードとマーカー・グループ・コードで識別され、マーカーにフラグが指定されているコンポーネントに対してのみシナリオが(再)生成されます。

-GENERATE_PACK=<YES|NO>

いいえ

パッケージに関連付けられているシナリオを(再)生成するかどうかを指定します。デフォルト値はYESです。

-GENERATE_POP=<YES|NO>

いいえ

インタフェースに関連付けられているシナリオを(再)生成するかどうかを指定します。デフォルト値はNOです。

-GENERATE_TRT=<YES|NO>

いいえ

プロシージャに関連付けられているシナリオを(再)生成するかどうかを指定します。デフォルト値はNOです。

-GENERATE_VAR=<YES|NO>

いいえ

変数に関連付けられているシナリオを(再)生成するかどうかを指定します。デフォルト値はNOです。


OdiGenerateAllScen -PROJECT=1003は、現在のリポジトリでIDが1003のプロジェクトに、すべてのシナリオを生成します。

A.5.21 OdiImportObject

このコマンドを使用して、エクスポート・ファイルの内容をリポジトリにインポートします。このコマンドは、ユーザー・インタフェースから使用可能なインポート機能の動作を再現します。

このツールを使用する際は注意が必要です。リポジトリに存在しないオブジェクトに依存するオブジェクトをインポートすると、正しく機能しない可能性があります。このAPIは、上位レベルのオブジェクト(プロジェクト、モデルなど)をインポートする目的で使用することをお薦めします。


警告:

インポート・タイプと、オブジェクトをリポジトリにインポートする順序は、慎重に指定してください。インポートの詳細は、第20章「エクスポート/インポート」を参照してください。


使用方法

OdiImportObject -FILE_NAME=<FileName> [-WORK_REP_NAME=<workRepositoryName>]
-IMPORT_MODE=<DUPLICATION | SYNONYM_INSERT |  SYNONYM_UPDATE | SYNONYM_INSERT_UPDATE> [-IMPORT_SCHEDULE=<yes|no>]

パラメータ

パラメータ 必須 説明

-FILE_NAME=<FileName>

はい

インポートするXMLエクスポート・ファイルの名前。

-WORK_REP_NAME=<workRepositoryName>

いいえ

オブジェクトのインポート先作業リポジトリの名前。この作業リポジトリは、接続しているマスター・リポジトリに定義されている必要があります。このパラメータの指定を省略すると、オブジェクトは現在のマスター・リポジトリまたは作業リポジトリにインポートされます。

-IMPORT_MODE=<DUPLICATION | SYNONYM_INSERT | SYNONYM_UPDATE | SYNONYM_INSERT_UPDATE>

はい

オブジェクトのインポート・モード。デフォルト値はDUPLICATIONです。詳細は、20.1.3項「インポート・タイプ」を参照してください。

-IMPORT_SCHEDULE=<yes|no>

いいえ

選択したファイルがシナリオ・エクスポート・ファイルの場合は、そのファイルに格納されているスケジュールをインポートします。デフォルトはnoです。


/temp/DW01.xmlエクスポート・ファイル(プロジェクト)をWORKREP作業リポジトリにDUPLICATIONモードを使用してインポートします。

OdiImportObject -FILE_NAME=/temp/DW01.xml -WORK_REP_NAME=WORKREP
-IMPORT_MODE=DUPLICATION

A.5.22 OdiImportScen

このコマンドを使用して、エクスポート・ファイルから現在の作業リポジトリにシナリオをインポートします。

使用方法

OdiImportScen -FILE_NAME=<FileName> [-IMPORT_MODE=<DUPLICATION |
SYNONYM_INSERT | SYNONYM_UPDATE | SYNONYM_INSERT_UPDATE>] [IMPORT_SCHEDULE=<yes|no>

パラメータ

パラメータ 必須 説明

-FILE_NAME=<FileName>

はい

エクスポート・ファイルの名前。

-IMPORT_MODE=<DUPLICATION | SYNONYM_INSERT | SYNONYM_UPDATE | SYNONYM_INSERT_UPDATE>

いいえ

シナリオのインポート・モード。デフォルト値はDUPLICATIONです。インポート・タイプの詳細は、20.1.3項「インポート・タイプ」を参照してください。

-IMPORT_SCHEDULE=<yes|no>

いいえ

シナリオ・エクスポート・ファイルに格納されているスケジュールをインポートします。デフォルトはnoです。


/temp/load_dwh.xmlエクスポート・ファイル(シナリオ)を現在の作業リポジトリにDUPLICATIONモードを使用してインポートします。

OdiImportScen -FILE_NAME=/temp/load_dwh.xml -IMPORT_MODE=DUPLICATION 

A.5.23 OdiInvokeWebService


注意:

このツールはOdiExecuteWebServiceツールに代わるものです。


このコマンドを使用して、HTTP/HTTPSを介してWebサービスを呼び出し、レスポンスをXMLファイルに書き込みます。

このツールは、記述ファイル(WSDL)のURLが提供されているWebサービスのポートで、特定の操作を呼び出します。

この操作にWebサービス・リクエストが必要な場合は、リクエスト・ファイルで、またはツール・コール(<XML Request>)に直接書き込まれて提供されます。このリクエスト・ファイルには、2つの異なる形式(XML本文のみに対応するXML、またはSOAPのヘッダーと本文が格納された完全なSOAPエンベロープに対応するSOAP)をRESPONSE_FILE_FORMATパラメータで指定できます。Webサービス・リクエストのレスポンスは、後でOracle Data Integratorで処理できるXMLファイルに書き込まれます。Webサービス操作が一方向でレスポンスを返さない場合、レスポンス・ファイルは生成されません。


注意:

このツールは、コマンドラインでstartcmdを使用して実行できません。


使用方法

OdiInvokeWebService -URL=<url> -PORT=<port> -OPERATION=<operation>
[<XML Request>][-REQUEST_FILE=<xml_request_file>] [-RESPONSE_MODE=<NO_FILE|NEW_FILE|FILE_APPEND>]
[-RESPONSE_FILE=<xml_response_file>] [-RESPONSE_XML_ENCODING=<charset>]
[-RESPONSE_FILE_CHARSET=<charset>] 
[-RESPONSE_FILE_FORMAT=<XML|SOAP>][-HTTP_USER=<user>]
[-HTTP_PASS=<password>] [-TIMEOUT=<timeout>]

パラメータ

パラメータ 必須 説明

-URL=<url>

はい

Webサービスを記述しているWebサービス記述ファイル(WSDL)のURL。

-PORT_TYPE=<port_type>

はい

呼び出すWSDLポート・タイプの名前。

-OPERATION=<operation>

はい

呼び出すWebサービス操作の名前。

<XML Request>

いいえ

SOAP (Simple Object Access Protocol)形式のリクエスト・メッセージ。このメッセージは、OdiInvokeWebServiceコールの直後の行に指定する必要があります。

このリクエストは、場所がREQUEST_FILEパラメータで指定されているファイルを介して渡すこともできます。

-REQUEST_FILE=<xml_request_file>

いいえ

SOAP (Simple Object Access Protocol)形式のリクエスト・メッセージが含まれているXMLファイルの場所。

このリクエストは、ツール・コール(<xmlRequest>)に直接書き込むこともできます。

-RESPONSE_MODE=<NO_FILE|NEW_FILE|FILE_APPEND>

いいえ

レスポンス・ファイルの生成モード。このパラメータの値は、次のいずれかです。

  • NO_FILE (デフォルト): レスポンス・ファイルは生成されません。

  • NEW_FILE: 新しいレスポンス・ファイルが生成されます。既存のファイルがある場合は上書きされます。

  • FILE_APPEND: レスポンスがファイルに追加されます。ファイルが存在しない場合は作成されます。

-RESPONSE_FILE=<file>

場合による

結果を書き込むファイルの名前。-RESPONSE_MODEがNEW_FILEまたはAPPENDの場合は必須です。

-RESPONSE_FILE_CHARSET=<charset>

場合による

レスポンス・ファイルの文字エンコーディング。次の表を参照してください。-RESPONSE_MODEがNEW_FILEまたはAPPENDの場合は必須です。

-RESPONSE_XML_ENCODING=<charset>

場合による

レスポンス・ファイルのXML宣言ヘッダーに示される文字エンコーディング。次の表を参照してください。-RESPONSE_MODEがNO_FILEでない場合は必須です。

-RESPONSE_FILE_FORMAT=<XML|SOAP>

いいえ

リクエストおよびレスポンス・ファイルの形式。

  • XMLを選択すると(デフォルト)、リクエストはSOAP本文として処理されます。リクエストを送信する前に、デフォルトのSOAPヘッダーとエンベロープ・コンテンツがこの本文に追加されます。レスポンスはSOAPエンベロープとヘッダーから取り除かれ、レスポンス・ファイルにはレスポンスの本文のみが書き込まれます。

  • SOAPを選択すると、リクエストは完全なSOAPエンベロープとして処理され、そのまま送信されます。レスポンスもそのままレスポンス・ファイルに書き込まれます。

-HTTP_USER=<user>

いいえ

HTTPサーバーで認証するユーザー・アカウント。

-HTTP_PASS=<password>

いいえ

HTTPユーザーのパスワード。

-TIMEOUT=<timeout>

いいえ

Webサービス・リクエストは、この時間が経過するまで応答を待機した後、サーバーがレスポンスを戻さないと判断してエラーを生成します。デフォルトは15秒。


次の表に、最も一般的なXML/Java文字エンコーディングの一部を示します。より完全なリストは、次の場所から入手できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

XMLキャラクタ・セット Javaキャラクタ・セット

US-ASCII

ASCII

UTF-8

UTF8

UTF-16

UTF-16

ISO-8859-1

ISO8859_1


次のWebサービス・コールは、指定された国の首都を戻します(ISO国別コードはリクエストで送信されます)。リクエストおよびレスポンスの形式と、使用できるポートおよび操作が、URLパラメータで渡されるWSDLに定義されていることに注意してください。

OdiInvokeWebService -
-URL=http://www.oorsprong.org/websamples.countryinfo/CountryInfoService.wso
?WSDL -PORT_TYPE=CountryInfoServiceSoapType -OPERATION=CapitalCity
-RESPONSE_MODE=NEW_FILE -RESPONSE_XML_ENCODING=ISO-8859-1
"-RESPONSE_FILE=/temp/result.xml" -RESPONSE_FILE_CHARSET=ISO8859_1 -RESPONSE_FILE_FORMAT=XML
<CapitalCityRequest>
<sCountryISOCode>US</sCountryISOCode>
</CapitalCityRequest>

生成した/temp/result.xmlファイルの内容は、次のようになります。

<CapitalCityResponse>
<m:CapitalCityResponse>
<m:CapitalCityResult>Washington</m:CapitalCityResult>
</m:CapitalCityResponse>
</CapitalCityResponse>

パッケージ

Oracle Data Integratorには、パッケージ内でOdiInvokeWebServiceをコールするための特別なグラフィカル・インタフェースが用意されています。詳細は、第15章「Oracle Data IntegratorでのWebサービスの使用」を参照してください。

A.5.24 OdiKillAgent

このコマンドを使用して、スタンドアロン・エージェントを停止します。

アプリケーション・サーバーにデプロイされているJava EEエージェントは、このツールでは停止できません。アプリケーション・サーバーのユーティリティを使用して停止する必要があります。

使用方法

OdiKillAgent (-PORT=<TCP/IP Port>|-NAME=<physical_agent_name>) [-IMMEDIATE=<yes|no>] [-MAX_WAIT=<timeout>]

パラメータ

パラメータ 必須 説明

-PORT=<TCP/IP Port>

いいえ

このパラメータを指定すると、ローカル・マシンの指定ポートで実行中のエージェントが停止されます。

-NAME=<physical_agent_name>

はい

このパラメータを指定すると、指定した名前の物理エージェントが停止されます。このエージェントには、ローカルまたはリモートのエージェントを指定できます。エージェントはマスター・リポジトリで宣言する必要があります。

-IMMEDIATE=<yes|no>

いいえ

このパラメータをyesに設定すると、実行中のセッションの完了を待機せずにエージェントが停止されます。noに設定すると、実行中のセッションがすべて完了した後、またはMAX_WAITタイムアウトに到達した後で、エージェントが停止されます。デフォルト値はNoです。

-MAX_WAIT=<timeout>

いいえ

このパラメータは、IMMEDIATEがNoに設定されている場合に使用できます。このパラメータには、実行中のセッションに関係なくエージェントを停止するタイムアウトをミリ秒単位で定義します。デフォルトは0です。これは、タイムアウトが発生せず、実行中のセッションすべてが完了した後で、エージェントが停止されることを意味します。


ODI_AGT_001物理エージェントをただちに停止します。

OdiKillAgent -NAME=ODI_AGT_001 -IMMEDIATE=yes

A.5.25 OdiMkDir

このコマンドを使用して、ディレクトリ構造を作成します。

親ディレクトリが存在しない場合、このコマンドは親ディレクトリを再帰的に作成します。

使用方法

OdiMkDir -DIR=<directory>

パラメータ

パラメータ 必須 説明

-DIR=<directory>

はい

作成するディレクトリ(またはフォルダ)。


C:\tempにodiディレクトリを作成します。C:\tempがない場合はそのディレクトリも作成されます。

OdiMkDir "-DIR=C:\temp\odi"

A.5.26 OdiOSCommand

このコマンドを使用して、コマンドを実行するオペレーティング・システムのコマンド・シェルを呼び出し、出力結果をファイルにリダイレクトします。

次のオペレーティング・システムがサポートされます。

  • Windows 95、98、ME (command.comを使用)

  • Windows NT、2000、XP (cmdを使用)

  • POSIX準拠のOS (shを使用)

次のオペレーティング・システムはサポートされていません。

  • Mac OS

使用方法

OdiOSCommand [-OUT_FILE=<stdout_file>] [-ERR_FILE=<stderr_file>]
[-FILE_APPEND=<yes|no>] [-WORKING_DIR=<workingdir>]
[-SYNCHRONOUS=<yes|no>]]  [CR/LF <command> |
-COMMAND=<command>]

パラメータ

パラメータ 必須 説明

-COMMAND=<command>

はい

実行するコマンド。スペースを使用する引数はコマンド・シェルで適切に解釈されるように引用符で囲みます。複数行コマンドの場合は、OdiOSCommand行の後に-COMMANDパラメータを指定せずに、コマンド全体をRAWテキストとして渡します。

-OUT_FILE=<stdout_file>

いいえ

標準出力のリダイレクト先ファイルの絶対名。

-ERR_FILE=<stderr_file>

いいえ

標準エラー出力のリダイレクト先ファイルの絶対名。

-FILE_APPEND=<yes|no>

いいえ

出力ファイルを上書きせずに追加するかどうか。

-WORKING_DIR=<workingdir>

いいえ

コマンドが実行されるディレクトリ。

-SYNCHRONOUS=<yes|no>

いいえ

yesの場合、セッションはコマンドの終了を待機します。noの場合、セッションはエラー・コード0で即時に続行します。デフォルトでは、同期モードで実行されます。


次のコマンドは、c:\work\load.batファイル(Windowsマシン)を実行し、出力ストリームをファイルに追加します。

OdiOSCommand "-OUT_FILE=c:\work\load-out.txt"
"-ERR_FILE=c:\work\load-err.txt" "-FILE_APPEND=YES"
"-WORKING_DIR=c:\work" c:\work\load.bat

A.5.27 OdiOutFile

このコマンドを使用して、テキスト・ファイルに内容を書き込むか追加します。

使用方法

OdiOutFile -FILE=<file_name> [-APPEND] [-CHARSET_ENCODING=<encoding>]
[-XROW_SEP=<hexadecimal_line_break>] [CR/LF <text> | -TEXT=<text>]

パラメータ

パラメータ 必須 説明

-FILE=<file_name>

はい

ターゲット・ファイル。パスは、絶対パスまたは実行エージェントの場所に対する相対パスを指定できます。

-APPEND

いいえ

<Text>をファイルの最後に追加するかどうかを示します。このパラメータが指定されていない場合は、現存するファイルが上書きされます。

-CHARSET_ENCODING=<encoding>

いいえ

ターゲット・ファイルのエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-XROW_SEP=<hexadecimal_line_break>

いいえ

行セパレータ(改行)として使用する文字の16進コード。0A (UNIXの改行)がデフォルトになります。Windowsの改行の場合は値を0D0Aにします。

CR/LF <text> または -TEXT=<text>

はい

ファイルに書き込むテキスト。このテキストは、OdiOutFileコマンドの次の行(改行のCR/LFがテキストの始まりを示す)に入力することも、-TEXTパラメータを使用して定義することもできます。このOracle Data IntegratorコマンドをOSのコマンドラインからコールする場合は、-TEXTパラメータを使用してください。テキストには、変数または代入メソッドを指定できます。


次のコマンドは、コマンドを実行したエージェントのUNIXマシンに/var/tmp/my_file.txtファイルを生成します。

OdiOutFile -FILE=/var/tmp/my_file.txt
Welcome to Oracle Data Integrator
This file has been overwritten by <%=odiRef.getSession("SESS_NAME")%> 

次のコマンドは、コマンドを実行するエージェントのNTマシンのhostsファイルにPLUTONエントリを追加します。

OdiOutFile -FILE=C:\winnt\system32\drivers\etc\hosts -APPEND
195.10.10.6 PLUTON pluton

A.5.28 OdiPingAgent

このコマンドを使用して、指定のエージェントに対してテストを実行します。このコマンドは、エージェントが開始されていないとエラーになります。

使用方法

OdiPingAgent -AGENT_NAME=<physical_agent_name>

パラメータ

パラメータ 必須 説明

-AGENT_NAME=<physical_agent_name>

はい

テストする物理エージェントの名前。

AGENT_NAMEを使用する古い構文も有効ですが、非推奨です。


物理エージェントAGENT_SOLARIS_DEVをテストします。

OdiPingAgent -AGENT_NAME=AGENT_SOLARIS_DEV

A.5.29 OdiPurgeLog

このコマンドを使用して、実行ログをパージします。

OdiPurgeLogツールは、フィルタ基準と一致するすべてのセッション・ログまたはロード計画実行(あるいはその両方)をパージします。

PURGE_TYPEパラメータは、パージするオブジェクトを定義します。

  • SESSIONを選択すると、基準と一致するすべてのセッション・ログがパージされます。親セッションが基準と一致すると、子セッションと孫セッションがパージされます。ロード計画の実行によって起動されたセッションは子セッションも含めて、パージされません

  • LOAD_PLAN_RUNを選択すると、基準と一致するすべてのロード計画ログがパージされます。ロード計画実行から起動されたセッションは、ロード計画実行自体に関連付けられているセッションが基準と一致しない場合でもすべてパージされることに注意してください。

  • ALLを選択すると、基準と一致するセッション・ログとロード計画実行の両方がパージされます。

COUNTパラメータを使用すると、ログに保持する(フィルタ処理後の)セッションまたはロード計画実行(あるいはその両方)の件数を定義できます。ARCHIVEパラメータを使用すると、パージしたセッションまたはロード計画実行(あるいはその両方)を自動的にアーカイブできます。


注意:

「実行中」、「待機中」または「キュー」ステータスのロード計画およびセッションはパージされません。


使用方法

OdiPurgeLog [-PURGE_TYPE=<SESSION|LOAD_PLAN_RUN|ALL>]
[-COUNT=<session_number>][-FROMDATE=<from_date>] [TODATE=<to_date>]
[-CONTEXT_CODE=<context_code>] [-USER_NAME=<user_name>]
[-AGENT_NAME=<agent_name>] [-PURGE_REPORTS=<Yes|No>] [-STATUS=<D|E|M>]
[-NAME=<session_or_load_plan_name>] [-ARCHIVE=<Yes|No>] [-TODIR=<directory>]
[-ZIPFILE_NAME=<zipfile_name>] [-XML_CHARSET=<charset>] [-JAVA_CHARSET=<charset>]

パラメータ

パラメータ 必須 説明

-PURGE_TYPE=<SESSION|LOAD_PLAN_RUN|ALL>

いいえ

フィルタ基準: セッション・ログのみ、ロード計画ログのみ、または両方をパージします。デフォルトはSESSIONです。

-COUNT=<session_number>

いいえ

指定したフィルタ基準と一致するセッションまたはロード計画実行(あるいはその両方)の最新件数を保持し、残りをパージします。このパラメータが未指定またはゼロの場合は、フィルタ基準と一致するすべてのセッションまたはロード計画実行(あるいはその両方)をパージします。

-FROMDATE=<from_date>

いいえ

フィルタ基準: パージの開始日。yyyy/MM/dd hh:mm:ssの書式を使用します。

-FROMDATEを省略すると、最も古いセッションまたはロード計画実行(あるいはその両方)からパージが実行されます。

-TODATE=<to_date>

いいえ

フィルタ基準: パージの終了日。yyyy/MM/dd hh:mm:ssの書式を使用します。

-TODATEを省略すると、最新のセッションまたはロード計画実行(あるいはその両方)までパージが実行されます。

-CONTEXT_CODE=<context_code>

いいえ

フィルタ基準: <context_code>で実行されたセッションまたはロード計画実行(あるいはその両方)のみをパージします。

CONTEXT_CODEを省略すると、すべてのコンテキストに対してパージが実行されます。

-USER_NAME=<user_name>

いいえ

フィルタ基準: <user_name>で起動されたセッションまたはロード計画実行(あるいはその両方)のみをパージします。

-AGENT_NAME=<agent_name>

いいえ

フィルタ基準: <agent_name>で実行されたセッションまたはロード計画実行(あるいはその両方)のみをパージします。

-PURGE_REPORTS=<0|1>

いいえ

1の場合は、シナリオ・レポート(各シナリオの実行ノードの下に表示)もパージされます。

-STATUS=<D|E|M>

いいえ

フィルタ基準: 指定した状態のセッションまたはロード計画実行(あるいはその両方)のみをパージします。

  • D: 完了

  • E: エラー

  • M: 警告

このパラメータが指定されていない場合は、前述のすべての状態のセッションまたはロード計画実行(あるいはその両方)がパージされます。

-NAME=<session_or_load_plan_name>

いいえ

フィルタ基準: セッション名またはロード計画名のフィルタ。

-ARCHIVE=<Yes|No>

いいえ

Yesに設定すると、パージする前にセッションまたはロード計画実行(あるいはその両方)をエクスポートします。

-TODIR=<directory>

いいえ

エクスポートのターゲット・ディレクトリ。このパラメータは、ARCHIVEがyesに設定されている場合は必須です。

-ZIPFILE_NAME=<zipfile_name>

いいえ

圧縮ファイルの名前。

エクスポートのターゲット・ディレクトリ。このパラメータは、ARCHIVEがyesに設定されている場合は必須です。

-XML_CHARSET=<charset>

いいえ

エクスポート・ファイルのXMLエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

エクスポート・ファイルのエンコーディング。デフォルト値はISO8859_1です。サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html


2001/03/25 00:00:00から2001/08/31 21:59:00に実行されたすべてのセッションをパージします。

OdiPurgeLog "-FROMDATE=2001/03/25 00:00:00" "-TODATE=2001/08/31 21:59:00"

内部エージェントによってGLOBALコンテキストで実行され、現在はエラー・ステータスのロード計画実行すべてをパージします。

OdiPurgeLog "-PURGE_TYPE=LOAD_PLAN_RUN" "-CONTEXT_CODE=GLOBAL" 
"-AGENT_NAME=Internal" "-STATUS=E"

A.5.30 OdiReadMail

このコマンドを使用して、電子メールおよび添付ファイルをPOPまたはIMAPアカウントから読み取ります。

このコマンドは、USERPASSで指定された接続パラメータを使用して、メール・サーバーMAILHOSTに接続します。実行エージェントは、MAX_MSG件のメッセージを受信するまで、またはTIMEOUTで指定された最大待機時間に達するまで、メールボックスからメッセージを読み取ります。抽出されたメッセージは、SUBJECTおよびSENDERのパラメータで指定されているようなフィルタと一致している必要があります。これらの基準を満たすメッセージは、その内容と添付ファイルがFOLDERパラメータで指定されたディレクトリに抽出されます。KEEPパラメータがnoに設定されている場合、取得したメッセージはメールボックスから削除されます。

使用方法

OdiReadMail -MAILHOST=<mail_host> -USER=<mail_user>
-PASS=<mail_user_password> -FOLDER=<folder_path>
[-PROTOCOL=<pop3|imap>] [-FOLDER_OPT=<none|sender|subject>] 
[-KEEP=<no|yes>] [-EXTRACT_MSG=<yes|no>] [-EXTRACT_ATT=<yes|no>]
[-MSG_PRF=<my_prefix>] [-ATT_PRF=<my_prefix>] [-USE_UCASE=<no|yes>]
[-NOMAIL_ERROR=<no|yes>] [-TIMEOUT=<timeout>] [-POLLINT=<pollint>]
[-MAX_MSG=<max_msg>] [-SUBJECT=<subject_filter>] [-SENDER=<sender_filter>]
[-TO=<to_filter>] [-CC=<cc_filter>]

パラメータ

パラメータ 必須 説明

-MAILHOST=<mail_host>

はい

POPまたはIMAPメール・サーバーのIPアドレス。

-USER=<mail_user>

はい

有効なメール・サーバーのアカウント。

-PASS=<mail_user_password>

はい

メール・サーバー・アカウントのパスワード。

-FOLDER=<folder_path>

はい

添付ファイルおよびメッセージ用のストレージ・フォルダのフル・パス。

-PROTOCOL=<pop3|imap>

いいえ

メール・アクセスのタイプ(POP3またはIMAP)。デフォルトはPOP3です。

-FOLDER_OPT=<none|sender|subject>

いいえ

次のパラメータに従ってFOLDERディレクトリにサブディレクトリを作成できます。

  • none (デフォルト): アクションなし。

  • sender: 送信者の外部名でサブディレクトリが作成されます。

  • subject: メッセージの件名でサブディレクトリが作成されます。

senderおよびsubjectフォルダ・オプションでは、スペースと、英数字以外の文字(@など)は、生成されたフォルダ名ではアンダースコアに置き換えられます。

-KEEP=<no|yes>

いいえ

yes: フィルタと一致するメッセージを読み込んだ後、そのメッセージをメールボックス内に保持します。

no (デフォルト): フィルタと一致するメッセージを読み込んだ後、そのメッセージをメールボックスから削除します。

-EXTRACT_MSG=<yes|no>

いいえ

yes (デフォルト): メッセージの本文をファイルに抽出します。

no: メッセージの本文をファイルに抽出しません。

-EXTRACT_ATT=<yes|no>

いいえ

yes (デフォルト): 添付ファイルをファイルに抽出します。

no: 添付ファイルを抽出しません。

-MSG_PRF=<my_prefix>

いいえ

メッセージ本文を格納するファイルの接頭辞。デフォルトはMSGです。

-ATT_PRF=<my_prefix>

いいえ

添付ファイルを格納するファイルの接頭辞。元のファイル名は維持されます。

-USE_UCASE=<no|yes>

いいえ

yes: ファイル名を強制的に大文字にします。

no (デフォルト): 元の大文字と小文字を維持します。

-NOMAIL_ERROR=<no|yes>

いいえ

yes: メールが指定の基準と一致しない場合は、エラーを生成します。

no (デフォルト): 指定の基準に対応するメールがない場合は、エラーを生成しません。

-TIMEOUT=<timeout>

いいえ

ミリ秒単位の最大待機時間(デフォルトは0)。

この待機時間に到達すると、コマンドは終了します。

0の値(デフォルト)は、待機時間が無制限であることを示します(MAX_MSGパラメータで指定された最大メッセージ数に達するまで)。

-POLLINT=<pollint>

いいえ

新しいメッセージをスキャンする検索間隔(ミリ秒単位)。デフォルトは1000 (1秒)です。

-MAX_MSG=<max_msg>

いいえ

抽出するメッセージの最大数(デフォルトは1)。この数に到達すると、コマンドは終了します。

-SUBJECT=<subject_filter>

いいえ

件名に応じたメッセージのフィルタ処理に使用するパラメータ。

-SENDER=<sender_filter>

いいえ

送信者に応じたメッセージのフィルタ処理に使用するパラメータ。

-TO=<to_filter>

いいえ

アドレスに応じたメッセージのフィルタ処理に使用するパラメータ。このオプションを繰り返し使用すると、複数のフィルタを作成できます。

-CC=<cc_filter>

いいえ

コピーのアドレスに応じたメッセージのフィルタ処理に使用するパラメータ。このオプションを繰り返し使用すると、複数のフィルタを作成できます。


supportのメールを自動受信します。添付ファイルは切り離してエージェントのマシンのC:\supportフォルダに格納します。10秒の最大待機時間で、すべてのメッセージを待機します。

OdiReadMail -MAILHOST=mail.mymail.com -USER=myaccount -PASS=mypass
-KEEP=no -FOLDER=c:\support -TIMEOUT=0 -MAX_MSG=0
-SENDER=support@mycompany.com -EXTRACT_MSG=yes -MSG_PRF=TXT
-EXTRACT_ATT=yes

1分間隔で新しいメッセージをチェックし、メッセージが10件になるまで無期限で待機します。

OdiReadMail -MAILHOST=mail.mymail.com -USER=myaccount -PASS=mypass
-KEEP=no -FOLDER=c:\support -TIMEOUT=0 -MAX_MSG=10 -POLLINT=60000
-SENDER=support@mycompany.com -EXTRACT_MSG=yes -MSG_PRF=TXT
-EXTRACT_ATT=yes

A.5.31 OdiRefreshJournalCount

このコマンドを使用して、指定のジャーナル化サブスクライバについて、指定の表リストまたはCDCセットに対して消費する行の数をリフレッシュします。このリフレッシュは、論理スキーマと指定のコンテキスト上で実行されるため、制限されることがあります。


注意:

このコマンドは、簡易モードまたは一貫モードでジャーナル化された表に適しています。また、コマンドラインでstartcmdを使用して実行することはできません。


使用方法

OdiRefreshJournalCount -LSCHEMA=<logical_schema> -SUBSCRIBER_NAME=<subscriber_name>
(-TABLE_NAME=<table_name> | -CDC_SET_NAME=<cdc set name>)
[-CONTEXT=<context>] [-MAX_JRN_DATE=<to_date>]

パラメータ

パラメータ 必須 説明

-LSCHEMA=<logical_schema>

はい

ジャーナル化された表が格納されている論理スキーマ。

-TABLE_NAME=<table_name>

簡易CDCでは必須

チェックするジャーナル化表の名前、マスクまたはリスト。このパラメータでは3つの書式を使用できます。

  • 表名

  • 表名マスク: このマスクはポーリングする表を選択します。マスクはSQL LIKE構文を使用して指定されます。%記号は不特定数の文字、_記号はワイルドカードとして動作します。

  • 表名リスト: カンマ区切りの表名のリスト。上で定義したマスクは使用できません

このオプションは簡易モードでジャーナル化されたモデルの表でのみ機能します。

このパラメータはCDC_SET_NAMEとは併用できません。CDC_SET_NAMEが設定されていない場合は必須です。

-CDC_SET_NAME=<cdcSetName>

一貫性セットCDCでは必須

チェックするCDCセットの名前。

このオプションは一貫性モードでジャーナル化されたモデルの表でのみ機能します。

このパラメータはTABLE_NAMEとは併用できません。TABLE_NAMEが設定されていない場合は必須です。

-SUBSCRIBER_NAME=<subscriber_name>

はい

カウントをリフレッシュするサブスクライバの名前。

-CONTEXT=<context>

いいえ

論理スキーマを解決するコンテキスト。コンテキストの指定を省略すると、実行コンテキストが使用されます。

-MAX_JRN_DATE=<to_date>

いいえ

ジャーナル化イベントが考慮される最終日(日時)。


SALES_APPLICATIONスキーマのCUSTOMERS表で、SALES_SYNCサブスクライバについて記録されている変更数をリフレッシュします。このデータストアは簡易モードでジャーナル化されます。

OdiRefreshJournalCount -LSCHEMA=SALES_APPLICATION
-TABLE_NAME=CUSTOMERS -SUBSCRIBER_NAME=SALES_SYNC

SALES_APPLICATIONスキーマのSALES CDCセットのすべての表で、SALES_SYNCサブスクライバについて記録されている変更数をリフレッシュします。このデータストアは一貫性のセットCDCでジャーナル化されます。

OdiRefreshJournalCount -LSCHEMA=SALES_APPLICATION
-SUBSCRIBER_NAME=SALES_SYNC -CDC_SET_NAME=SALES

A.5.32 OdiReinitializeSeq

このコマンドを使用して、Oracle Data Integrator順序を再初期化します。

使用方法

OdiReinitializeSeq -SEQ_NAME=<sequence_name> -CONTEXT=<context>
-STD_POS=<position>

パラメータ

パラメータ 必須 説明

-SEQ_NAME=<sequence_name>

はい

再初期化する順序の名前。グローバル順序の場合はGLOBAL、プロジェクト順序の場合は<project code>を接頭辞として使用する必要があります。

-CONTEXT=<context>

はい

順序の再初期化が必要なコンテキスト。

-STD_POS=<position>

はい

順序の再初期化が必要な位置。


GLOBALコンテキストのグローバル順序SEQ_Iをゼロにリセットします。

OdiReinitializeSeq -SEQ_NAME=GLOBAL.SEQ_I -CONTEXT=GLOBAL
-STD_POS=0

A.5.33 OdiRetrieveJournalData

このコマンドを使用して、指定したジャーナル化サブスクライバについて、指定の表リストまたはCDCセットのジャーナル化イベントを取得します。この取得は、表を格納しているテクノロジに固有の方法で実行されます。この取得は、論理スキーマと指定のコンテキスト上で実行されます。


注意:

このツールは、簡易モードまたは一貫性セット・モードでジャーナル化された表に対して機能します。また、コマンドラインでstartcmdを使用して実行することはできません。


使用方法

OdiRetrieveJournalData -LSCHEMA=<logical_schema> -SUBSCRIBER_NAME=<subscriber_name> 
(-TABLE_NAME=<table_name> | -CDC_SET_NAME=<cdc_set_name>)
[-CONTEXT=<context>] [-MAX_JRN_DATE=<to_date>]

パラメータ

パラメータ 必須 説明

-LSCHEMA=<logical_schema>

はい

ジャーナル化された表が格納されている論理スキーマ。

-TABLE_NAME=<table_name>

いいえ

チェックするジャーナル化表の名前、マスクまたはリスト。このパラメータでは3つの書式を使用できます。

  • 表名

  • 表名マスク: このマスクはポーリングする表を選択します。マスクはSQL LIKE構文を使用して指定されます。%記号は不特定数の文字、_記号はワイルドカードとして動作します。

  • 表名リスト: カンマ区切りの表名のリスト。上で定義したマスクは使用できません

このオプションは簡易モードでジャーナル化されたモデルの表でのみ機能します。

このパラメータはCDC_SET_NAMEとは併用できません。CDC_SET_NAMEが設定されていない場合は必須です。

-CDC_SET_NAME=<cdc_set_name>

いいえ

更新するCDCセットの名前。

このオプションは一貫性モードでジャーナル化されたモデルの表でのみ機能します。

このパラメータはTABLE_NAMEとは併用できません。TABLE_NAMEが設定されていない場合は必須です。

-SUBSCRIBER_NAME=<subscriber_name>

はい

データを取得するサブスクライバの名前。

-CONTEXT=<context>

いいえ

論理スキーマを解決するコンテキスト。コンテキストの指定を省略すると、実行コンテキストが使用されます。

-MAX_JRN_DATE=<to_date>

いいえ

ジャーナル化イベントが考慮される最終日(日時)。


SALES_APPLICATIONスキーマのCUSTOMERS表で、SALES_SYNCサブスクライバのジャーナル化イベントを取得します。

OdiRetrieveJournalData -LSCHEMA=SALES_APPLICATION
-TABLE_NAME=CUSTOMERS -SUBSCRIBER_NAME=SALES_SYNC

A.5.34 OdiReverseGetMetaData

このコマンドを使用して、リバース表内の指定モデルのメタデータをJDBCドライバの機能を介してリバースエンジニアリングします。通常、このコマンドの前にはOdiReverseResetTable、後にはOdiReverseSetMetaDataがあります。


注意:

  • このコマンドは標準のリバースエンジニアリングと同様のテクニックを使用しており、使用されるJDBCドライバの機能に依存しています。

  • 実行タイプのリポジトリではメタデータを使用できないため、このコマンドの使用は開発タイプのリポジトリに制限されます。


使用方法

OdiReverseGetMetaData -MODEL=<model_id>

パラメータ

パラメータ 必須 説明

-MODEL=<model_id>

はい

リバースエンジニアリングするモデル。


RKMの現在のモデルをリバースします。

OdiReverseGetMetaData -MODEL=<%=odiRef.getModel("ID")%>

A.5.35 OdiReverseManageShortcut

このコマンドは、モデル内でショートカットがリバースエンジニアリングされたときに、ショートカットをどのように処理するかを定義するために使用します。

使用方法

OdiReverseManageShortcut "-MODEL=<model_id>" "-MODE=MATERIALIZING_MODE"

パラメータ

パラメータ 必須 説明

-MODEL=<model_id>

はい

リバースするモデルの内部識別子。

-MODE=ALWAYS_MATERIALIZE|ALWAYS_SKIP|PROMPT

はい

このオプションには、次の値を使用できます:

  • ALWAYS_MATERIALIZE: 競合するショートカットが常にマテリアライズされ、データストアがリバースされます(デフォルト)。

  • ALWAYS_SKIP: 競合するショートカットが常にスキップされ、リバースされません。

  • PROMPT: 検出されたショートカット競合ダイアログが表示されます。競合するショートカットの処理方法を定義できます。競合するデータストアのショートカットをマテリアライズし、リバースエンジニアリングする場合は、「マテリアライズ」を選択します。競合するショートカットをスキップする場合は、「マテリアライズ」の選択を解除します。選択を解除したデータストアはリバースされず、ショートカットがそのまま残ります。


OdiReverseManageShortcut -MODEL=125880 -MODE=ALWAYS_MATERIALIZE

A.5.36 OdiReverseResetTable

このコマンドを使用して、指定のモデルに対するリバース表の内容をリセットします。このコマンドは、通常、カスタマイズされたリバースエンジニアリング・プロセスの最初に使用されます。

使用方法

OdiReverseResetTable -MODEL=<model_id>

パラメータ

パラメータ 必須 説明

-MODEL=<model_id>

はい

リバースするモデルの内部識別子。


OdiReverseResetTable -MODEL=123001

A.5.37 OdiReverseSetMetaData

このコマンドを使用して、指定のデータ・モデルについて、リバース表のメタデータをリポジトリに統合します。

使用方法

OdiReverseSetMetaData -MODEL=<model_id> [-USE_TABLE_NAME_FOR_UPDATE=<true|false>]

パラメータ

パラメータ 必須 説明

-MODEL=<model_id>

はい

リバースするモデルの内部識別子。

-USE_TABLE_NAME_FOR_UPDATE=<true|false>

いいえ

  • trueの場合は、TABLE_NAMEがターゲット表の更新キーとして使用されます。

  • false (デフォルト)の場合は、RES_NAMEがターゲット表の更新キーとして使用されます。


OdiReverseSetMetaData -MODEL=123001 -USE_TABLE_NAME_FOR_UPDATE=true

A.5.38 OdiSAPALEClient and OdiSAPALEClient3

このコマンドを使用して、XMLソース・ファイルからSAP Internal Documents (IDoc)を生成し、これらのIDocをALE (Application Link Enabling)を使用してリモートtRFC Server (SAP R/3 Server)に転送します。


注意:

OdiSAPALEClientツールは、SAP Java Connector 2.xをサポートしています。SAP Java Connectors 3.xを使用する場合は、OdiSAPALEClient3ツールを使用してください。


OdiSAPALEClientの使用方法

OdiSAPALEClient -USER=<sap_logon> -ENCODED_PASSWORD=<password>
-GATEWAYHOST=<gateway_host> -SYSTEMNR=<system_number> -MESSAGESERVERHOST=<message_server> -R3NAME=<system_name> -APPLICATIONSERVERSGROUP=<group_name>
[-DIR=<directory>] [-FILE=<file>] [-CASESENS=<yes|no>]
[-MOVEDIR=<target_directory>] [-DELETE=<yes|no>] [-POOL_KEY=<pool_key>]
[-LANGUAGE=<language>] [-CLIENT=<client>] [-MAX_CONNECTIONS=<n>]
[-TRACE=<no|yes>]

OdiSAPALEClient3の使用方法

OdiSAPALEClient3 -USER=<sap_logon> -ENCODED_PASSWORD=<password>
-GATEWAYHOST=<gateway_host> -SYSTEMNR=<system_number> -MESSAGESERVERHOST=<message_server> -R3NAME=<system_name> -APPLICATIONSERVERSGROUP=<group_name>
[-DIR=<directory>] [-FILE=<file>] [-CASESENS=<yes|no>]
[-MOVEDIR=<target_directory>] [-DELETE=<yes|no>] [-POOL_KEY=<pool_key>]
[-LANGUAGE=<language>] [-CLIENT=<client>] [-MAX_CONNECTIONS=<n>]
[-TRACE=<no|yes>]

パラメータ

パラメータ 必須 説明

-USER=<sap_logon>

はい

SAPログオン。このユーザーはシステム・ユーザーの場合があります。

-PASSWORD=<password>

非推奨

SAPログオン・パスワード。このコマンドは非推奨です。かわりにENCODED_PASSWORDを使用してください。

-ENCODED_PASSWORD=<password>

はい

暗号化されたSAPログオン・パスワード。このパスワードはOSコマンドencode <password>を使用して暗号化できます。

-GATEWAYHOST=<gateway_host>

いいえ

ゲートウェイ・ホスト。MESSAGESERVERHOSTを指定しない場合は必須です。

-SYSTEMNR=<system_number>

いいえ

SAPシステム番号。GATEWAYHOSTを使用する場合は必須です。SAPシステム番号を使用すると、SAPロード・バランシング機能を使用できます。

-MESSAGESERVERHOST=<message_server>

いいえ

メッセージ・サーバーのホスト名。GATEWAYHOSTを指定しない場合は必須です。GATEWAYHOSTMESSAGESERVERHOSTの両方のパラメータを指定した場合は、MESSAGESERVERHOSTが使用されます。

-R3NAME=<system_name>

いいえ

SAPシステムの名前(r3name)。MESSAGESERVERHOSTを使用する場合は必須です。

-APPLICATIONSERVERSGROUP=<group_name>

いいえ

アプリケーション・サーバーのグループ名。MESSAGESERVERHOSTを使用する場合は必須です。

-DIR=<directory>

いいえ

XMLソース・ファイル・ディレクトリ。このパラメータは、-FILEを指定しない場合に考慮されます。少なくとも-DIRまたは-FILEのいずれかのパラメータを指定する必要があります。

-FILE=<file>

いいえ

ソースXMLファイルの名前。このパラメータを省略すると、-DIRのすべてのファイルが処理されます。少なくとも-DIRまたは-FILEのいずれかのパラメータを指定する必要があります。

-CASESENS=<yes|no>

いいえ

ソース・ファイル名の大文字と小文字が区別されるかどうかを示します。デフォルトはNOです。

-MOVEDIR=<target_directory>

いいえ

このパラメータを指定すると、処理にソース・ファイルがこのディレクトリに移動します。

-DELETE=<yes|no>

いいえ

処理後にソース・ファイルを削除します。デフォルトはyesです。

-POOL_KEY=<pool_key>

いいえ

接続プールの名前。デフォルトはODIです。

-LANGUAGE=<language>

いいえ

エラー・メッセージで使用する言語コード。デフォルトはENです。

-CLIENT=<client>

いいえ

クライアント識別子。デフォルトは001です。

-MAX_CONNECTIONS=<n>

いいえ

プールの最大接続数。デフォルトは3です。

-TRACE=<no|yes>

いいえ

生成されたIDocファイルをソース・ファイル・ディレクトリにアーカイブします。ソース・ファイルが(-MOVEDIRパラメータの指定で)移動すると、生成されたIDocsも移動します。デフォルトはnoです。


/sapディレクトリのすべてのファイルを処理し、SAPサーバーにIDocsとして送信します。処理後に、オリジナルのXMLと生成されたファイルは/logディレクトリに格納されます。

OdiSAPALEClient -USER=ODI -ENCODED_PASSWORD=xxx -SYSTEMNR=002
-GATEWAYHOST=GW001 -DIR=/sap -MOVEDIR=/log -TRACE=yes

A.5.39 OdiSAPALEServer and OdiSAPALEServer3

このコマンドを使用して、ALE (Application Link Enabling)を介して転送されたSAP IDocsを受信するtRFCリスナーを起動します。このリスナーにより、着信IDocsが指定されたディレクトリのXMLファイルに変換されます。


注意:

OdiSAPALEServerツールは、SAP Java Connector 2.xをサポートしています。SAP Java Connectors 3.xを使用する場合は、OdiSAPALEServer3ツールを使用してください。


OdiSAPALEServerの使用方法

OdiSAPALEServer -USER=<sap_logon> -ENCODED_PASSWORD=<password>
-GATEWAYHOST=<gateway_host> -SYSTEMNR=<system_number>
-GATEWAYNAME=<gateway_name> -PROGRAMID=<program_id> -DIR=<target_directory>
[-TIMEOUT=<n>] [-POOL_KEY=<pool_key>] [-LANGUAGE=<Language>]
[-CLIENT=<client>] [-MAX_CONNECTIONS=<n>]
[-INTERREQUESTTIMEOUT=<n>] [-MAXREQUEST=<n>] [-TRACE=<no|yes>]

OdiSAPALEServer3の使用方法

OdiSAPALEServer3 -USER=<sap_logon> -ENCODED_PASSWORD=<password>
-GATEWAYHOST=<gateway_host> -SYSTEMNR=<system_number>
-GATEWAYNAME=<gateway_name> -PROGRAMID=<program_id> -DIR=<target_directory>
[-TIMEOUT=<n>] [-POOL_KEY=<pool_key>] [-LANGUAGE=<Language>]
[-CLIENT=<client>] [-MAX_CONNECTIONS=<n>]
[-INTERREQUESTTIMEOUT=<n>] [-MAXREQUEST=<n>] [-TRACE=<no|yes>]

パラメータ

パラメータ 必須 説明

-USER=<UserName>

はい

SAPログオン。このユーザーはシステム・ユーザーの場合があります。

-ENCODED_PASSWORD=<password>

はい

暗号化されたSAPログオン・パスワード。このパスワードはOSコマンドencode <password>を使用して暗号化できます。

-GATEWAYHOST=<gateway_host>

はい

ゲートウェイ・ホスト。

-SYSTEMNR=<system_number>

はい

SAPシステム番号。

-GATEWAYNAME=<gateway_name>

はい

ゲートウェイ名。

-PROGRAMID=<program_id>

はい

プログラムID。tRFCサーバーによって使用される外部名です。

-DIR=<target_directory>

はい

ターゲットXMLファイルを格納するディレクトリ。これらのファイルの名前は、<IDOC Number>.xmlとなり、IDocタイプに基づいて名付けられたサブディレクトリに配置されます。デフォルトは./FromSAPです。

-POOL_KEY=<pool_key>

はい

接続プールの名前。デフォルトはODIです。

-LANG=<language>

はい

エラー・メッセージで使用する言語コード。デフォルトはENです。

-CLIENT=<client>

はい

SAPクライアント識別子。デフォルトは001です。

-TIMEOUT=<n>

いいえ

サーバーの存続期間(ミリ秒単位)。この期間の終了時にサーバーは自動的に停止します。このタイムアウトがゼロに設定されている場合、サーバーの存続期間は無限です。デフォルトは0です。

-MAX_CONNECTIONS=<n>

はい

接続のプールに対する最大許容接続数。デフォルトは3です。

-INTERREQUESTTIMEOUT=<n>

いいえ

nミリ秒の間隔の合間にIDOCを受信しない場合、リスナーは停止します。このタイムアウトがゼロに設定されている場合、タイムアウトは無限です。デフォルトは0です。

-MAXREQUEST=<n>

いいえ

リスナーが停止するまでの最大リクエスト数。このパラメータがゼロに設定されている場合、サーバーで予期されるリクエスト数は無限です。デフォルトは0です。

注意: -TIMEOUT-INTERREQUESTTIMEOUTおよび-MAXREQUESTをすべてゼロに設定したり未設定にしておくと、-MAXREQUESTに1の値が自動的に適用されます。

-TRACE=<no|yes>

いいえ

デバッグ・トレースをアクティブにします。デフォルトはnoです。


2つのIDocファイルを待機し、/tempディレクトリにターゲットXMLファイルを生成します。

OdiSAPALEServer -POOL_KEY=ODI -MAX_CONNECTIONS=3 -CLIENT=001
-USER=ODI -ENCODED_PASSWORD=xxx -LANGUAGE=EN
-GATEWAYHOST=SAP001 -SYSTEMNR=002 -GATEWAYNAME=GW001
-PROGRAMID=ODI01 -DIR=/tmp -MAXREQUEST=2

A.5.40 OdiScpGet

このコマンドを使用して、SSHサーバーからファイルをダウンロードします。

使用方法

OdiScpGet -HOST=<ssh server host name> -USER=<ssh user> [-PASSWORD=<ssh user password>] -REMOTE_DIR=<remote dir on ftp host> [-REMOTE_FILE=<file name under the REMOTE_DIR>] -LOCAL_DIR=<local dir> [-LOCAL_FILE=<file name under the LOCAL_DIR>][-PASSIVE_MODE=<yes|no>] -TIMEOUT=<time in seconds>] [-IDENTITY_FILE=<full path to the private key file of the user>] [-KNOWNHOSTS_FILE=<full path to known hosts file>][COMPRESSION=<yes|no>][-STRICT_HOSTKEY_CHECKING=<yes|no>][-PROXY_HOST=<proxy server host name>] [-PROXY_PORT=<proxy server port>] [-PROXY_TYPE=<HTTP|SOCKS5>]

パラメータ

パラメータ 必須 説明

-HOST=<host name of the SSH server>

はい

SSHサーバーのホスト名。

-USER=<host name of the SSH user>

はい

SSHサーバーのユーザー。

-PASSWORD=<password of the Ftp user>

いいえ

SSHユーザーのパスワードまたはパスワードで保護されたアイデンティティ・ファイルのパスフレーズ。–IDENTITY_FILE引数が指定されている場合、この値はパスワードで保護された秘密鍵ファイルのパスフレーズとして使用されます。公開鍵認証に失敗した場合は、通常のユーザー・パスワード認証になります。

-REMOTE_DIR=<dir on remote SSH>

はい

リモートFTPホスト上のディレクトリ・パス。

-REMOTE_FILE=<file name under -REMOTE DIR>

いいえ

-REMOTE_DIR引数で指定されたディレクトリのファイル名。リモート・ファイル名と一致するサブディレクトリもすべてローカル・フォルダに転送されます。

この引数が欠落している場合は、-LOCAL_FILEファイル名を使用してファイルがコピーされます。-LOCAL_FILE引数も欠落している場合は、-LOCAL_DIRが-REMOTE_DIRに再帰的にコピーされます。

-LOCAL_DIR=<local dir path>

はい

ローカル・マシン上のディレクトリ・パス。

-LOCAL_FILE=<local file>

いいえ

-LOCAL_DIR引数で指定されたディレクトリのファイル名。この引数が欠落している場合は、-LOCAL_DIRにあるすべてのファイルおよびディレクトリが、-REMOTE_DIRに再帰的にコピーされます。

コピーするファイルをフィルタ処理するには、「*」を使用して汎用文字を指定します。

例:

  • *.log (log拡張子のファイルすべて)

  • arch_*.lst (arch_で開始するlst拡張子のファイルすべて)

-IDENTITY_FILE=<full path to the private key file of the user>

いいえ

ローカル・ユーザーの秘密鍵ファイル。この引数を指定すると、公開鍵認証が実施されます。–PASSWORD引数は、パスワードで保護された秘密鍵ファイルのパスワードとして使用されます。公開鍵認証に失敗した場合は、通常のユーザー・パスワード認証になります。

-KNOWNHOSTS_FILE=<full path to the known hosts file on the local machine>

いいえ

ローカル・マシンのKnown_Hostsファイルのフル・パス。Known_Hostsファイルには、ユーザーが信頼しているリモート・マシンのホスト・キーがすべて格納されます。この引数が欠落している場合は、Known_Hostsファイルとして<user home dir>/.ssh/Known_hostsファイル(存在する場合)が使用されます。

-COMPRESSION=<yes|no>

いいえ

データ圧縮を使用する場合はYesに設定します。デフォルトはNoです。

-STRICT_HOSTKEY_CHECKING=<YES|NO>

いいえ

この引数の値はYESまたはNOです。YES値が渡されると、厳密なホストキー・チェックが実行され、リモートSSHホスト・キーが–KNOWNHOSTS_FILEパラメータで指定された既知のホストに存在しない場合は、認証に失敗します。デフォルト値はYESです。

-PROXY_HOST

いいえ

接続に使用されるプロキシ・サーバーのホスト名。

-PROXY_PORT

いいえ

プロキシ・サーバーのポート番号。

-PROXY_TYPE

いいえ

接続するプロキシ・サーバーのタイプ。可能な値はHTTPまたはSOCKS5のみです。

-TIMEOUT=<timeout value>

いいえ

ソケット接続がタイムアウトするまでの秒数。


SSHサーバー・マシン上のリモート・ディレクトリ/test_copy555をローカル・ディレクトリC:\temp\test_copyに再帰的にコピーします。

OdiScpGet -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password>
 -LOCAL_DIR=C:\temp\test_copy -REMOTE_DIR=/test_copy555

SSHサーバー・マシン上のリモート・ディレクトリ/にあるSales*.txtパターンと一致するすべてのファイルをローカル・ディレクトリC:\temp\にコピーします。

OdiScpGet -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password>
 -LOCAL_DIR=C:\temp -REMOTE_FILE=Sales*.txt -REMOTE_DIR=/

SSHサーバー・マシン上のリモート・ディレクトリ/にあるSales1.txtファイルをローカル・ディレクトリC:\temp\にSample1.txtファイルとしてコピーします。

OdiScpGet -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password>
 -REMOTE_DIR=/ REMOTE_FILE=Sales1.txt -LOCAL_DIR=C:\temp 
-LOCAL_FILE=Sample1.txt

SSHサーバー・マシン上のリモート・ディレクトリ/にあるSales1.txtファイルをローカル・ディレクトリC:\temp\にSample1.txtファイルとしてコピーします。アイデンティティ・ファイルのパスおよび既知のホスト・ファイルのパスを指定して、公開鍵認証を実施します。

OdiScpGet -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> 
-REMOTE_DIR=/ -REMOTE_FILE=Sales1.txt -LOCAL_DIR=C:\temp 
-LOCAL_FILE=Sample1.txt -IDENTITY_FILE=C:\Documents and Settings\username\.ssh\id_dsa -KNOWNHOSTS_FILE= C:\Documents and Settings\username\.ssh\Known_Hosts

SSHサーバー・マシン上のリモート・ディレクトリ/にあるSales1.txtファイルをローカル・ディレクトリC:\temp\にSample1.txtファイルとしてコピーします。アイデンティティ・ファイルのパスを指定して、公開鍵認証を実施します。STRICT_HOSTKEY_CHECKINGパラメータにNOの値を渡すことで、すべてのホストを信頼します。

OdiScpGet -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -REMOTE_DIR=/ -REMOTE_FILE=Sales1.txt -LOCAL_DIR=C:\temp -LOCAL_FILE=Sample1.txt -IDENTITY_FILE=C:\Documents and Settings\username\.ssh\id_dsa -STRICT_HOSTKEY_CHECKING=NO

A.5.41 OdiScpPut

このコマンドを使用して、ファイルをSSHサーバーにアップロードします。

使用方法

OdiScpPut -HOST=<SSHserver host name> -USER=<SSH user> [-PASSWORD=<SSH user password>] -LOCAL_DIR=<local dir> [-LOCAL_FILE=<file name under the LOCAL_DIR>] -REMOTE_DIR=<remote dir on ftp host> [-REMOTE_FILE=<file name under the REMOTE_DIR>] [-PASSIVE_MODE=<yes|no>] [-TIMEOUT=<time in seconds>] [-IDENTITY_FILE=<full path to the private key file of the user>][-KNOWNHOSTS_FILE=<full path to known hosts file>][-COMPRESSION=<yes|no>][-STRICT_HOSTKEY_CHECKING=<yes|no>] <-PROXY_HOST=<proxy server host name>][-PROXY_PORT=<proxy server port>] [-PROXY_TYPE=<HTTP|SOCKS5>]

パラメータ

パラメータ 必須 説明

-HOST=<host name of the SSH server>

はい

SSHサーバーのホスト名。

-USER=<host name of the SSH user>

はい

SSHサーバーのユーザー。

-PASSWORD=<password of the SSH user>

いいえ

SSHユーザーのパスワードまたはパスワードで保護されたアイデンティティ・ファイルのパスフレーズ。–IDENTITY_FILE引数が指定されている場合、この値はパスワードで保護された秘密鍵ファイルのパスフレーズとして使用されます。公開鍵認証に失敗した場合は、通常のユーザー・パスワード認証になります。

-REMOTE_DIR=<dir on remote SSH

はい

リモートFTPホスト上のディレクトリ・パス。

-REMOTE_FILE=<file name under -REMOTE DIR>

いいえ

-REMOTE_DIR引数で指定されたディレクトリのファイル名。この引数が欠落している場合は、-LOCAL_FILEファイル名を使用してファイルがコピーされます。-LOCAL_FILE引数も欠落している場合は、-LOCAL_DIRが-REMOTE_DIRに再帰的にコピーされます。

-LOCAL_DIR=<local dir path>

はい

ローカル・マシン上のディレクトリ・パス。

-LOCAL_FILE=<local file>

いいえ

-LOCAL_DIR引数で指定されたディレクトリのファイル名。この引数が欠落している場合は、-LOCAL_DIRにあるすべてのファイルおよびディレクトリが、-REMOTE_DIRに再帰的にコピーされます。

コピーするファイルをフィルタ処理するには、「*」を使用して汎用文字を指定します。

例:

  • *.log (log拡張子のファイルすべて)

  • arch_*.lst (arch_で開始するlst拡張子のファイルすべて)

-IDENTITY_FILE=<full path to the private key file of the user>

いいえ

ローカル・ユーザーの秘密鍵ファイル。この引数を指定すると、公開鍵認証が実施されます。–PASSWORD引数は、パスワードで保護された秘密鍵ファイルのパスワードとして使用されます。公開鍵認証に失敗した場合は、通常のユーザー・パスワード認証になります。

-KNOWNHOSTS_FILE=<full path to the known hosts file on the local machine>

いいえ

ローカル・マシンのKnown_Hostsファイルのフル・パス。Known_Hostsファイルには、ユーザーが信頼しているリモート・マシンのホスト・キーがすべて格納されます。この引数が欠落している場合は、Known_Hostsファイルとして<user home dir>/.ssh/Known_hostsファイル(存在する場合)が使用されます。

-COMPRESSION=<yes|no>

いいえ

データ圧縮を使用する場合はYesに設定します。デフォルトはNoです。

-STRICT_HOSTKEY_CHECKING=<YES|NO>

いいえ

この引数の値はYESまたはNOです。YES値が渡されると、厳密なホストキー・チェックが実行され、リモートSSHホスト・キーが–KNOWNHOSTS_FILEパラメータで指定された既知のホストに存在しない場合は、認証に失敗します。デフォルト値はYESです。

-PROXY_HOST

いいえ

接続に使用されるプロキシ・サーバーのホスト名。

-PROXY_PORT

いいえ

プロキシ・サーバーのポート番号。

-PROXY_TYPE

いいえ

接続するプロキシ・サーバーのタイプ。可能な値はHTTPまたはSOCKS5のみです。

-TIMEOUT=<timeout value>

いいえ

ソケット接続がタイムアウトするまでの秒数。


ローカル・ディレクトリC:\temp\test_copyをFTPサーバー・マシン上のリモート・ディレクトリ/test_copy555に再帰的にコピーします。

OdiSftpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp\test_copy -REMOTE_DIR=/test_copy555

ローカル・ディレクトリC:\temp\にあるSales*.txtパターンと一致するすべてのファイルをFTPサーバー・マシン上のリモート・ディレクトリ/にコピーします。

OdiSftpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales*.txt -REMOTE_DIR=/

ローカル・ディレクトリC:\temp\にあるSales1.txtファイルをFTPサーバー・マシン上のリモート・ディレクトリ/Sample1.txtファイルとしてコピーします。

OdiSftpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales1.txt -REMOTE_DIR=/ -REMOTE_FILE=Sample1.txt

ローカル・ディレクトリC:\temp\にあるSales1.txtファイルをFTPサーバー・マシン上のリモート・ディレクトリ/Sample1.txtファイルとしてコピーします。アイデンティティ・ファイルのパスおよび既知のホスト・ファイルのパスを指定して、公開鍵認証を実施します。

OdiSftpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales1.txt -REMOTE_DIR=/ -REMOTE_FILE=Sample1.txt -IDENTITY_FILE=C:\Documents and Settings\username\.ssh\id_dsa -KNOWNHOSTS_FILE= C:\Documents and Settings\username\.ssh\Known_Hosts

ローカル・ディレクトリC:\temp\にあるSales1.txtファイルをFTPサーバー・マシン上のリモート・ディレクトリ/Sample1.txtファイルとしてコピーします。アイデンティティ・ファイルのパスを指定して、公開鍵認証を実施します。STRICT_HOSTKEY_CHECKINGパラメータにNOの値を渡すことで、すべてのホストを信頼します。

OdiSftpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales1.txt -REMOTE_DIR=/ -REMOTE_FILE=Sample1.txt -IDENTITY_FILE=C:\Documents and Settings\username\.ssh\id_dsa -STRICT_HOSTKEY_CHECKING=NO

A.5.42 OdiSendMail

このコマンドを使用して、電子メールをSMTPサーバーに送信します。

使用方法

OdiSendMail -MAILHOST=<mail_host> -FROM=<from_user> -TO=<address_list>
[-CC=<address_list>] [-BCC=<address_list>] [-SUBJECT=<subject>]
[-ATTACH=<file_path>]* [-MSGBODY=<message_body> | CR/LF<message_body>]

パラメータ

パラメータ 必須 説明

-MAILHOST=<mail_host>

はい

SMTPサーバーのIPアドレス。

-FROM=<from_user>

はい

メッセージの送信者のアドレス。

例: support@mycompany.com

送信者の外部名を送信するには、次の表記法を使用できます。

"-FROM=Support center <support@mycompany.com>"

-TO=<address_list>

はい

受信者の電子メール・アドレス・リスト(カンマ区切り)。

例:

"-TO=sales@mycompany.com, support@mycompany.com"

-CC=<address_list>

いいえ

コピー(CC)受信者の電子メール・アドレス・リスト(カンマ区切り)。

例:

-CC=info@mycompany.com

-BCC=<address_list>

いいえ

コピー(BCC)受信者の電子メール・アドレス・リスト(カンマ区切り)。

例:

-BCC=manager@mycompany.com

-SUBJECT=<subject>

いいえ

メッセージの目的(件名)。

-ATTACH=<file_path>

いいえ

メッセージに結合するファイルの実行エージェントに対する相対パス。複数のファイルを結合するには、-ATTACH=...を繰り返す必要があります。

例: ファイル.profileおよび.cshrcをメールに添付する場合は、次のようにします。

-ATTACH=/home/usr/.profile -ATTACH=/home/usr/.cshrc

CR/LF <message_body>

または-MSGBODY=<message_body>

いいえ

メッセージ本文(テキスト)。このテキストは、OdiSendMailコマンドの次の行(改行のCR/LFがメール本文の始まりを示す)に入力することも、-MSGBODYパラメータを使用して定義することもできます。このOracle Data IntegratorコマンドをOSのコマンドラインからコールする場合は、-MSGBODYパラメータを使用してください。


OdiSendMail -MAILHOST=mail.mymail.com "-FROM=Application Oracle Data
Integrator<odi@mymail.com>" -TO=admin@mymail.com "-SUBJECT=Execution OK"
-ATTACH=C:\log\job.log -ATTACH=C:\log\job.bad
Hello Administrator !
Your process finished successfully. Attached are your files.
Have a nice day!
Oracle Data Integrator.

A.5.43 OdiSftpGet

このコマンドを使用して、SFTPサブシステムが有効なSSHサーバーからファイルをダウンロードします。

使用方法

OdiSftpGet -HOST=<ssh server host name> -USER=<ssh user> [-PASSWORD=<ssh user password>] -REMOTE_DIR=<remote dir on ftp host> [-REMOTE_FILE=<file name under the REMOTE_DIR>] -LOCAL_DIR=<local dir> [-LOCAL_FILE=<file name under the LOCAL_DIR>] [-PASSIVE_MODE=<yes|no>] [-TIMEOUT=<time in seconds>] [-IDENTITY_FILE=<full path to the private key file of the user>] [-KNOWNHOSTS_FILE=<full path to known hosts file>][COMPRESSION=<yes|no>][-STRICT_HOSTKEY_CHECKING=<yes|no>][-PROXY_HOST=<proxy server host name>][-PROXY_PORT=<proxy server port>] [-PROXY_TYPE=<HTTP| SOCKS5>]

パラメータ

パラメータ 必須 説明

-HOST=<host name of the SSH server>

はい

SSHサーバーのホスト名。

コロン(:)を前に付けることにより、ポート番号をホスト名に追加できます。例: machine.oracle.com:25

ポートが指定されていない場合、デフォルトでポート22が使用されます。

-USER=<host name of the SSH user>

はい

SSHサーバーのユーザー。

-PASSWORD=<password of the SSH user>

いいえ

SSHユーザーのパスワード。

-REMOTE_DIR=<dir on SSH host>

はい

リモートSSHホスト上のディレクトリ・パス。

-REMOTE_FILE=<file name under -REMOTE DIR>

いいえ

-REMOTE_DIR引数で指定されたディレクトリのファイル名。この引数が欠落している場合は、-LOCAL_FILEファイル名を使用してファイルがコピーされます。-LOCAL_FILE引数も欠落している場合は、-LOCAL_DIRが-REMOTE_DIRに再帰的にコピーされます。

-LOCAL_DIR=<local dir path>

はい

ローカル・マシン上のディレクトリ・パス。

-LOCAL_FILE=<local file>

いいえ

-LOCAL_DIR引数で指定されたディレクトリのファイル名。この引数が欠落している場合は、-LOCAL_DIRにあるすべてのファイルおよびディレクトリが、-REMOTE_DIRに再帰的にコピーされます。

コピーするファイルをフィルタ処理するには、「*」を使用して汎用文字を指定します。

例:

  • *.log (log拡張子のファイルすべて)

  • arch_*.lst (arch_で開始するlst拡張子のファイルすべて)

-IDENTITY_FILE=<full path to the private key file of the user>

いいえ

ローカル・ユーザーの秘密鍵ファイル。この引数を指定すると、公開鍵認証が実施されます。–PASSWORD引数は、パスワードで保護された秘密鍵ファイルのパスワードとして使用されます。公開鍵認証に失敗した場合は、通常のユーザー・パスワード認証になります。

-KNOWNHOSTS_FILE=<full path to the known hosts file on the local machine>

いいえ

ローカル・マシンのKnown_Hostsファイルのフル・パス。Known_Hostsファイルには、ユーザーが信頼しているリモート・マシンのホスト・キーがすべて格納されます。この引数が欠落している場合は、Known_Hostsファイルとして<user home dir>/.ssh/Known_hostsファイル(存在する場合)が使用されます。

-COMPRESSION=<yes|no>

いいえ

データ圧縮を使用する場合はYesに設定します。デフォルトはNoです。

-STRICT_HOSTKEY_CHECKING=<YES|NO>

いいえ

この引数の値はYESまたはNOです。YES値が渡されると、厳密なホストキー・チェックが実行され、リモートSSHホスト・キーが–KNOWNHOSTS_FILEパラメータで指定された既知のホストに存在しない場合は、認証に失敗します。デフォルト値はYESです。

-PROXY_HOST

いいえ

接続に使用されるプロキシ・サーバーのホスト名。

-PROXY_PORT

いいえ

プロキシ・サーバーのポート番号。

-PROXY_TYPE

いいえ

接続するプロキシ・サーバーのタイプ。可能な値はHTTPまたはSOCKS5のみです。

-TIMEOUT=<timeout value>

いいえ

ソケット接続がタイムアウトするまでの秒数。


SSHサーバー・マシン上のリモート・ディレクトリ/test_copy555をローカル・ディレクトリC:\temp\test_copyに再帰的にコピーします。

OdiSftpGet -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp\test_copy -REMOTE_DIR=/test_copy555

SSHサーバー・マシン上のリモート・ディレクトリ/にあるSales*.txtパターンと一致するすべてのファイルをローカル・ディレクトリC:\temp\にコピーします。

OdiSftpGet -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -REMOTE_FILE=Sales*.txt -REMOTE_DIR=/

SSHサーバー・マシン上のリモート・ディレクトリ/にあるSales1.txtファイルをローカル・ディレクトリC:\temp\Sample1.txtファイルとしてコピーします。

OdiSftpGet -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -REMOTE_DIR=/ -LOCAL_FILE=Sales1.txt -LOCAL_DIR=C:\temp -LOCAL_FILE=Sample1.txt

SSHサーバー・マシン上のリモート・ディレクトリ/にあるSales1.txtファイルをローカル・ディレクトリC:\temp\にSample1.txtファイルとしてコピーします。アイデンティティ・ファイルのパスおよび既知のホスト・ファイルのパスを指定して、公開鍵認証を実施します。

OdiSftpGet -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -REMOTE_DIR=/ -REMOTE_FILE=Sales1.txt -LOCAL_DIR=C:\temp -LOCAL_FILE=Sample1.txt -IDENTITY_FILE=C:\Documents and Settings\username\.ssh\id_dsa -KNOWNHOSTS_FILE= C:\Documents and Settings\username\.ssh\Known_Hosts

SSHサーバー・マシン上のリモート・ディレクトリ/にあるSales1.txtファイルをローカル・ディレクトリC:\temp\にSample1.txtファイルとしてコピーします。アイデンティティ・ファイルのパスを指定して、公開鍵認証を実施します。STRICT_HOSTKEY_CHECKINGパラメータにNOの値を渡すことで、すべてのホストを信頼します。

OdiSftpGet -HOST=dev3 -USER=test_ftp -PASSWORD=<password> -REMOTE_DIR=/ -REMOTE_FILE=Sales1.txt -LOCAL_DIR=C:\temp -LOCAL_FILE=Sample1.txt -IDENTITY_FILE=C:\Documents and Settings\username\.ssh\id_dsa -STRICT_HOSTKEY_CHECKING=NO

A.5.44 OdiSftpPut

このコマンドを使用して、SFTPサブシステムが有効なSSHサーバーにファイルをアップロードします。

使用方法

OdiSftpPut -HOST=<ftp server host name> -USER=<ftp user> [-PASSWORD=<ftp user password>] -LOCAL_DIR=<local dir> [-LOCAL_FILE=<file name under the LOCAL_DIR>] -REMOTE_DIR=<remote dir on ftp host> [-REMOTE_FILE=<file name under the REMOTE_DIR>] [-PASSIVE_MODE=<yes | no>][-TIMEOUT=<time in seconds>] [-IDENTITY_FILE=<full path to the private key file of the user>] [-KNOWNHOSTS_FILE=<full path to known hosts file>][COMPRESSION=<yes|no>][-STRICT_HOSTKEY_CHECKING=<YES | NO>][-PROXY_HOST=<proxy server host name>][-PROXY_PORT=<proxy server port>][-PROXY_TYPE=<HTTP | SOCKS5>]

パラメータ

パラメータ 必須 説明

-HOST=<host name of the SSH server>

はい

SSHサーバーのホスト名。

コロン(:)を前に付けることにより、ポート番号をホスト名に追加できます。例: machine.oracle.com:25

ポートが指定されていない場合、デフォルトでポート22が使用されます。

-USER=<host name of the SSH user>

はい

SSHサーバーのユーザー。

-PASSWORD=<password of the SSH user>

いいえ

SSHユーザーのパスワードまたはパスワードで保護されたアイデンティティ・ファイルのパスフレーズ。–IDENTITY_FILE引数が指定されている場合、この値はパスワードで保護された秘密鍵ファイルのパスフレーズとして使用されます。公開鍵認証に失敗した場合は、通常のユーザー・パスワード認証になります。

-REMOTE_DIR=<dir on remote SSH

はい

リモートFTPホスト上のディレクトリ・パス。

-REMOTE_FILE=<file name under -REMOTE DIR>

いいえ

-REMOTE_DIR引数で指定されたディレクトリのファイル名。この引数が欠落している場合は、-LOCAL_FILEファイル名を使用してファイルがコピーされます。-LOCAL_FILE引数も欠落している場合は、-LOCAL_DIRが-REMOTE_DIRに再帰的にコピーされます。

-LOCAL_DIR=<local dir path>

はい

ローカル・マシン上のディレクトリ・パス。

-LOCAL_FILE=<local file>

いいえ

-LOCAL_DIR引数で指定されたディレクトリのファイル名。この引数が欠落している場合は、-LOCAL_DIRにあるすべてのファイルおよびディレクトリが、-REMOTE_DIRに再帰的にコピーされます。

コピーするファイルをフィルタ処理するには、「*」を使用して汎用文字を指定します。

例:

  • *.log (log拡張子のファイルすべて)

  • arch_*.lst (arch_で開始するlst拡張子のファイルすべて)

-IDENTITY_FILE=<full path to the private key file of the user>

いいえ

ローカル・ユーザーの秘密鍵ファイル。この引数を指定すると、公開鍵認証が実施されます。–PASSWORD引数は、パスワードで保護された秘密鍵ファイルのパスワードとして使用されます。公開鍵認証に失敗した場合は、通常のユーザー・パスワード認証になります。

-KNOWNHOSTS_FILE=<full path to the known hosts file on the local machine>

いいえ

ローカル・マシンのKnown_Hostsファイルのフル・パス。Known_Hostsファイルには、ユーザーが信頼しているリモート・マシンのホスト・キーがすべて格納されます。この引数が欠落している場合は、Known_Hostsファイルとして<user home dir>/.ssh/Known_hostsファイル(存在する場合)が使用されます。

-COMPRESSION=<yes|no>

いいえ

データ圧縮を使用する場合はYesに設定します。デフォルトはNoです。

-STRICT_HOSTKEY_CHECKING=<YES|NO>

いいえ

この引数の値はYESまたはNOです。YES値が渡されると、厳密なホストキー・チェックが実行され、リモートSSHホスト・キーが–KNOWNHOSTS_FILEパラメータで指定された既知のホストに存在しない場合は、認証に失敗します。デフォルト値はYESです。

-PROXY_HOST

いいえ

接続に使用されるプロキシ・サーバーのホスト名。

-PROXY_PORT

いいえ

プロキシ・サーバーのポート番号。

-PROXY_TYPE

いいえ

接続するプロキシ・サーバーのタイプ。可能な値はHTTPまたはSOCKS5のみです。

-TIMEOUT=<timeout value>

いいえ

ソケット接続がタイムアウトするまでの秒数。


ローカル・ディレクトリC:\temp\test_copyをFTPサーバー・マシン上のリモート・ディレクトリ/test_copy555に再帰的にコピーします。

OdiSftpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp\test_copy -REMOTE_DIR=/test_copy555

ローカル・ディレクトリC:\temp\にあるSales*.txtパターンと一致するすべてのファイルをFTPサーバー・マシン上のリモート・ディレクトリ/にコピーします。

OdiSftpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales*.txt -REMOTE_DIR=/

ローカル・ディレクトリC:\temp\にあるSales1.txtファイルをFTPサーバー・マシン上のリモート・ディレクトリ/Sample1.txtファイルとしてコピーします。

OdiSftpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales1.txt -REMOTE_DIR=/Sample1.txt

ローカル・ディレクトリC:\temp\にあるSales1.txtファイルをFTPサーバー・マシン上のリモート・ディレクトリ/Sample1.txtファイルとしてコピーします。アイデンティティ・ファイルのパスおよび既知のホスト・ファイルのパスを指定して、公開鍵認証を実施します。

OdiSftpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales1.txt -REMOTE_DIR=/Sample1.txt -IDENTITY_FILE=C:\Documents and Settings\username\.ssh\id_dsa -KNOWNHOSTS_FILE= C:\Documents and Settings\username\.ssh\Known_Hosts

ローカル・ディレクトリC:\temp\にあるSales1.txtファイルを、FTPサーバー・マシン上のリモート・ディレクトリ/にSample1.txtファイルとしてコピーします。アイデンティティ・ファイルのパスを指定して、公開鍵認証を実施します。STRICT_HOSTKEY_CHECKINGパラメータにNOの値を渡すことで、すべてのホストを信頼します。

OdiSftpPut -HOST=machine.oracle.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales1.txt -REMOTE_DIR=/Sample1.txt -IDENTITY_FILE=C:\Documents and Settings\username\.ssh\id_dsa -STRICT_HOSTKEY_CHECKING=NO

A.5.45 OdiSleep

このコマンドを使用して、<delay>ミリ秒間待機します。

使用方法

OdiSleep -DELAY=<delay>

パラメータ

パラメータ 必須 説明

-DELAY=<delay>

はい

待機するミリ秒数。


OdiSleep -DELAY=5000

A.5.46 OdiSqlUnload

このコマンドを使用して、SQL問合せの結果をファイルに書き込みます。

このコマンドは、接続パラメータが<driver><url><user>および<encoded_pass>によって指定されたデータ・サーバーに対してSQL問合せ<sql_query>を実行します。その結果セットは<file_name>に書き込まれます。

使用方法

OdiSqlUnload -FILE=<file_name> -DRIVER=<driver> -URL=<url> -USER=<user>
-PASS=<password> [-FILE_FORMAT=<file_format>] [-FIELD_SEP=<field_sep> |
-XFIELD_SEP=<field_sep>] [-ROW_SEP=<row_sep> | -XROW_SEP=<row_sep>]
[-DATE_FORMAT=<date_format>][-CHARSET_ENCODING=<encoding>]
[-XML_CHARSET_ENCODING=<encoding>][-FETCH_SIZE=<array_fetch_size>]
( CR/LF <sql_query> | -QUERY=<sql_query> | -QUERY_FILE=<sql_query_file> )

パラメータ

パラメータ 必須 説明

-FILE=<file_name>

はい

実行エージェントに対して相対的な出力ファイルへのフル・パス

-DRIVER=<driver>

はい

データ・サーバーへの接続に使用するJDBCドライバの名前。

-URL=<url>

はい

データ・サーバーへのJDBC URL。

-USER=<user>

はい

SQL問合せの実行に使用されるデータ・サーバー上のユーザーのログイン。

-PASS=<password>

はい

データ・サーバーにログインするための暗号化されたパスワード。このパスワードは、システム・コマンドencode <clear_text_password>を使用して暗号化できます。

エージェント(.batまたは.sh)は、Oracle Data Integratorインスール・ディレクトリの/binサブディレクトリにあります。

-FILE_FORMAT=<file_format>

いいえ

次の3種類のいずれかのファイル形式を指定します。

  • fixed: 固定サイズ記録

  • variable: 可変サイズ記録

  • xml: XMLファイル

<file_format>の指定を省略すると、形式はvariable.にデフォルト設定されます。

<file_format>がxmlの場合は、次の構造のXMLノードが生成されます。

<TABLE>

<ROW>

<column_name>![CDATA[VALUE]]</column_name>

<column_name>![CDATA[VALUE]]</column_name>

...

</ROW>

....

</TABLE>

-FIELD_SEP=<field_sep>

いいえ

FILE_FORMAT=variableの場合のASCII形式のフィールド・セパレータ文字。デフォルトの<field_sep>はタブ文字です。

-XFIELD_SEP=<field_sep>

いいえ

FILE_FORMAT=variableの場合の16進形式のフィールド・セパレータ文字。デフォルトの<field_sep>はタブ文字です。

-ROW_SEP=<row_sep>

いいえ

ASCII形式のレコード・セパレータ文字。デフォルトの<row_sep>はWindowsの改行です。たとえば、次の値を使用できます。

  • Unix: -ROW_SEP=\n

  • Windows: -ROW_SEP=\r\n

-XROW_SEP=<row_sep>

いいえ

16進形式のレコード・セパレータ文字。例: 0A。

-DATE_FORMAT=<date_format>

いいえ

日付データ型に使用する出力書式。この日付書式はJavaの日時書式パターンを使用して指定されます。これらのパターンのリストは、http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.htmlを参照してください。

-CHARSET_ENCODING=<encoding>

いいえ

ターゲット・ファイルのエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングの完全なリストは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-XML_CHARSET_ENCODING=<encoding>

いいえ

XMLファイル内に<?xml version="1.0" encoding="ISO-8859-1"?>のタグで指定されるエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングのリストは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

-FETCH_SIZE=<array_fetch_size>

いいえ

データ・サーバーとの通信ごとに、Data Integratorによってリクエストされる(レコードの読取り)行数。

-CR/LF=<sql_query> | -QUERY=<sql_query> | -QUERY_FILE=<sql_query_file>

はい

データ・サーバーに対して実行するSQL問合せ。問合せは、有効なレコードセットを戻すSELECT文またはストアド・プロシージャへのコールである必要があります。この問合せは、OdiSqlUnloadコマンドの次の行(改行のCR/LFが問合せの始まりを示す)に入力できます。-QUERYパラメータを使用して問合せを提供することも、-QUERY_FILEパラメータで指定されたファイルに問合せを格納することもできます。このコマンドをOSのコマンドラインからコールする場合は、-QUERYまたは-QUERY_FILEパラメータを使用する必要があります。

REQUESTおよびREQUEST_FILEを使用する古い構文も有効ですが、非推奨です。


次のコマンドは、Customers表での問合せの結果が格納されているカンマ区切りのC:\temp\clients.csvファイルを生成します。

OdiSqlUnload -FILE=C:\temp\clients.csv -DRIVER=sun.jdbc.odbc.JdbcOdbcDriver
-URL=jdbc:odbc:NORTHWIND_ODBC -USER=sa
-PASS=NFNEKKNGGJHAHBHDHEHJDBGBGFDGGH -FIELD_SEP=;
"-DATE_FORMAT=dd/MM/yyyy hh:mm:ss"

select cust_id, cust_name, cust_creation_date from Northwind.dbo.Customers

A.5.47 OdiStartLoadPlan

このコマンドを使用して、ロード計画を開始します。

使用方法

OdiStartLoadPlan -LOAD_PLAN_NAME=<load_plan_name> [-LOG_LEVEL=<log_level>] [-CONTEXT=<context_code>]
[-AGENT_URL=<agent_url>] [-AGENT_CODE=<logical_agent_code>] 
[-ODI_USER=<ODI User>] [-ODI_PASS=<ODI Password>] [-KEYWORDS=<Keywords>]
 [-<PROJECT_CODE>.<VARIABLE>=<var_value> ...]

パラメータ

パラメータ 必須 説明

-LOAD_PLAN_NAME=<load_plan_name>

はい

開始するロード計画の名前。

-LOG_LEVEL=<log_level>

いいえ

保持するロギング情報のレベル。この値以下のログ・レベルが定義されているすべてのセッションは、セッション完了時に、セッション・ログに保持されます。ただし、オブジェクトの実行が異常終了した場合は、この設定にかかわらず、すべてのタスクが保持されます。

ログ・レベル6は、ログ・レベル5と動作は同じですが、変数と順序の追跡が追加されていることに注意してください。詳細は、12.2.3.11項「変数と順序の追跡」を参照してください。

[-CONTEXT=<context_code>]

はい

実行コンテキストのコード。このパラメータを省略すると、コール元セッションの実行コンテキストで、ロード計画が開始されます(ある場合)。

[-AGENT_URL=<agent_url>]

いいえ

ロード計画を開始するリモート・エージェントのURL。

[-AGENT_CODE=<logical_agent_code>]

いいえ

このロード計画の開始を担当する論理エージェントのコード。このパラメータと-AGENT_URLを省略すると、現在のエージェントがこのロード計画を開始します。エージェントURLが指定されている場合、無視されます。

[-ODI_USER=<ODI user>]

いいえ

ロード計画の開始に使用するOracle Data Integratorユーザー。このユーザーの権限が使用されます。このパラメータを省略すると、ロード計画は、親セッションを起動したユーザーの権限を使用して開始されます。

[-ODI_PASS=<ODI Password>]

いいえ

Oracle Data Integratorユーザーのパスワード。このパスワードはエンコードされている必要があります。-ODI_USERを指定した場合、このパラメータは必須です。

-KEYWORDS=<keywords>

いいえ

このロード計画に関連付けられているキーワードのリスト。これらのキーワードによって、ロード計画実行の識別が容易になります。このリストは、カンマ区切りのキーワード・リストです。

-<VARIABLE>=<value>

いいえ

値がロード計画の実行に対するデフォルトとして設定されているプロジェクト変数またはグローバル変数のリスト。プロジェクト変数は<project_code>.<variable_name>、グローバル変数はGLOBAL.<variable_name>で指定します。このリストは、-<variable>=<value>という形式です。


同じエージェントのグローバル・コンテキストでロード計画LOAD_DWHを開始します:

OdiStartLoadPlan -LOAD_PLAN_NAME=LOAD_DWH -CONTEXT=GLOBAL

A.5.48 OdiStartScen

このコマンドを使用して、シナリオを開始します。

オプションのAGENT_CODEパラメータは、このシナリオを現在のエージェント以外の別のエージェントに適用する場合に使用します。

SYNC_MODEパラメータを使用すると、同期モードまたは非同期モードでシナリオを開始できます。


注意:

開始するシナリオは、コマンドが起動されるリポジトリに存在している必要があります。シナリオを本番に移行する場合は、このコマンドを使用して、コールされるシナリオをすべて取り込みます。ソリューションは、この目的でシナリオをグループ化するのに役立ちます。


使用方法

OdiStartScen -SCEN_NAME=<scenario> -SCEN_VERSION=<version>
[-CONTEXT=<context>] [-ODI_USER=<odi user> -ODI_PASS=<odi password>]
[-SESSION_NAME=<session_name>] [-LOG_LEVEL=<log_level>]
[-AGENT_CODE=<logical_agent_name>] [-SYNC_MODE=<1|2>]
[-KEYWORDS=<keywords>] [-<VARIABLE>=<value>]*

パラメータ

パラメータ 必須 説明

-SCEN_NAME=<scenario>

はい

開始するシナリオの名前。

-SCEN_VERSION=<version>

はい

開始するシナリオのバージョン。-1のバージョンを指定すると、最新バージョンのシナリオが実行されます。

-CONTEXT=<context>

いいえ

実行コンテキストのコード。このパラメータを省略すると、コール元セッションの実行コンテキストで、シナリオが実行されます。

-ODI_USER=<odi user>

いいえ

シナリオの実行に使用するOracle Data Integratorユーザー。このユーザーの権限が使用されます。このパラメータを省略すると、シナリオは、親セッションを起動したユーザーの権限を使用して実行されます。

-ODI_PASS=<odi password>

いいえ

Oracle Data Integratorユーザーのパスワード。このパスワードはエンコードされている必要があります。ユーザーを指定した場合、このパラメータは必須です。

-SESSION_NAME=<session_name>

いいえ

実行ログに表示するセッションの名前。

-LOG_LEVEL=<log_level>

いいえ

実行ログに保持するトレース・レベル(0から5)。デフォルト値は5。

-AGENT_CODE=<logical_agent_name>

いいえ

このシナリオの実行を担当する論理エージェントの名前。このパラメータを省略すると、現在のエージェントがこのシナリオを実行します。

-SYNC_MODE=<1|2>

いいえ

シナリオの同期モード。

1 - 同期モード(デフォルト)。シナリオの実行が終了するまで、コール元セッションの実行は抑制されます。

2 - 非同期モード。コール元セッションの実行は、コールされたシナリオの復帰に関係なく続行します。

-KEYWORDS=<keywords>

いいえ

このセッションに関連付けられているキーワードのリスト。これらのキーワードによって、セッションの識別が容易になります。このリストは、カンマ区切りのキーワード・リストです。

-<VARIABLE>=<value>

いいえ

シナリオの実行時に値が設定される変数のリスト。このリストは「PROJECT.VARIABLE=値」または「GLOBAL.VARIABLE=値」の形式で指定します。


本番コンテキストでシナリオLOAD_DWHのバージョン2を開始します(同期モード)。

OdiStartScen -SCEN_NAME=LOAD_DWH -SCEN_VERSION=2
-CONTEXT=CTX_PRODUCTION

エージェント「UNIX Agent」が現在のコンテキストでシナリオLOAD_DWHのバージョン2を非同期モードで開始します。その際は、START_DATE (ローカル)変数とCOMPANY_CODE (グローバル)変数の値を渡します。

OdiStartScen -SCEN_NAME=LOAD_DWH -SCEN_VERSION=2 -SYNC_MODE=2
"-AGENT_CODE=UNIX Agent" -MY_PROJECT.START_DATE=10-APR-2002
-GLOBAL.COMPANY_CODE=SP4356

A.5.49 OdiUnZip

このコマンドを使用して、アーカイブ・ファイルをディレクトリに解凍します。

使用方法

OdiUnZip -FILE=<file> -TODIR=<target_directory> [-OVERWRITE=<yes|no>]
[-ENCODING=<file_name_encoding>]

パラメータ

パラメータ 必須 説明

-FILE=<file>

はい

解凍するZIPファイルへのフル・パス。

-TODIR=<target_file>

はい

宛先ディレクトリまたはフォルダ。

-OVERWRITE=<yes|no>

いいえ

解凍先ディレクトリにファイルがすでに存在している場合に、上書きするかどうかを示します。デフォルトはNoです。

-ENCODING=<file_name_encoding>

いいえ

アーカイブ・ファイル内部でファイル名に使用される文字エンコーディング。可能な値のリストは、次を参照してください:

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

デフォルトは、プラットフォームのデフォルトの文字エンコーディングです。


C:\archive\ディレクトリのarchive_001.zipファイルをC:\TEMPディレクトリに解凍します。

OdiUnZip "-FILE=C:\archive\archive_001.zip" -TODIR=C:\TEMP\

A.5.50 OdiUpdateAgentSchedule

このコマンドを使用して、エージェントがタスクのスケジュールを強制的に再計算するようにします。

使用方法

OdiUpdateAgentSchedule -AGENT_NAME=<physical_agent_name>

パラメータ

パラメータ 必須 説明

-AGENT_NAME=<physical_agent_name>

はい

更新する物理エージェントの名前。


この例では、agt_s1という名前の物理エージェントがスケジュールを更新します。

OdiUpdateAgentSchedule -AGENT_NAME=agt_s1

A.5.51 OdiWaitForChildSession

このコマンドを使用して、現在のセッションの(OdiStartScenツールを使用して開始された)子セッションが完了するまで待機します。

このコマンドは、<parent_sess_number>で指定したセッションから起動されたセッションの終了を<polling_interval>秒間隔でチェックします。これらのすべての子セッション(場合によっては名前やキーワードでフィルタ処理される)が終了すると(ステータスは完了、警告またはエラー)、このコマンドは終了します。

使用方法

OdiWaitForChildSession [-PARENT_SESS_NO=<parent_sess_number>]
[-POLL_INT=<polling_interval>] 
[-SESSION_NAME_FILTER=<session_name_filter>]
[-SESSION_KEYWORDS=<session_keywords>]
[-MAX_CHILD_ERROR=ALL|<error_number>]

パラメータ

パラメータ 必須 説明

-PARENT_SESS_NO=<parent_sess_number>

いいえ

親セッションのID。このパラメータの指定を省略すると、現在のセッションIDが使用されます。

-POLL_INT=<polling_interval>

いいえ

一連の子セッションの各終了テストの間隔(秒単位)。デフォルトは1です。

-SESSION_NAME_FILTER=<session_name_filter>

いいえ

名前がこのフィルタと一致する子セッションのみがテストされます。このフィルタには、SQL LIKE形式のパターンを使用できます。

-SESSION_KEYWORDS=<session_keywords>

いいえ

このカンマ区切りリストのすべてのキーワードと一致する子セッションのみがテストされます。リストの各要素には、SQL LIKE形式のパターンを使用できます。

-MAX_CHILD_ERROR= ALL | <error_number>

いいえ

このパラメータを使用すると、特定の数の子セッションがエラーで終了した場合に、OdiWaitForChildSessionを終了できます。

  • ALL: すべての子セッションがエラーで終了した場合にエラーになります。

  • <error_number>: <error_number>件以上の子セッションがエラーで終了した場合にエラーになります。

このパラメータがゼロ、負数または未指定の場合、OdiWaitForChildSessionは、障害が発生した子セッションの数に関係なく、エラー・ステータスで終了することはありません。


5秒のポーリング間隔で、現在のセッションの子セッションの中で、名前が「LOADxxx」に類似し、「MANDATORY」と「CRITICAL」のキーワードがある子セッションすべての終了を待機します。

OdiWaitForChildSession -PARENT_SESS_NO=<%=odiRef.getSession("SESS_NO")%>
-POLL_INT=5 -SESSION_NAME_FILTER=LOAD%
-SESSION_KEYWORDS=MANDATORY,CRITICAL

A.5.52 OdiWaitForData

このコマンドを使用して、表または一連の表について特定の数の行を待機します。このコマンドは、データが格納されている特定の数のオブジェクト(ビューなど)にも適用できます。

OdiWaitForDataコマンドは、表または一連の表に特定の数のレコードが移入されているかどうかをテストします。このテストは、いずれかの表で目的の数の行(-UNIT_ROWCOUNT)が検出されるか、すべての表を対象として累積で目的の数の行(-GLOBAL_ROWCOUNT)が検出されるか、またはタイムアウト(-TIMEOUT)に到達するかの、いずれかの条件が満たされるまで一定の間隔で(-POLLINT)繰り返されます。

検出された一連の行には、フィルタを適用できます。フィルタは、明示的なSQL where句(-SQLFILTER)、またはフィールド値と演算句を決定する-RESUME_KEY_xxxパラメータ(あるいはその両方)で指定されます。この2つの方法は累積(AND)されます。

行数は、絶対条件(表内の合計行数に対する)または差分条件(格納された参照値と現在の行数値の差異)のいずれかで判断できます。

複数の表を扱う場合は、次のようになります。

  • -SQLFILTERパラメータと-RESUME_KEY_xxxパラメータは、関係するすべての表に適用されます。

  • -UNIT_ROWCOUNTパラメータは、特定の表の個々について想定される行数を判断します。-GLOBAL_ROWCOUNTパラメータは、一連の表全体で累積された行数の合計を判断します。関係している表が1つのみの場合、-UNIT_ROWCOUNTパラメータと-GLOBAL_ROWCOUNTパラメータは同等です。

使用方法

OdiWaitForData -LSCHEMA=<logical_schema> -TABLE_NAME=<table_name>
[-OBJECT_TYPE=<list of object types>] [-CONTEXT=<context>]
[-RESUME_KEY_VARIABLE=<resumeKeyVariable> 
-RESUME_KEY_COL=<resumeKeyCol>
[-RESUME_KEY_OPERATOR=<resumeKeyOperator>]|-SQLFILTER=<SQLFilter>]
[-TIMEOUT=<timeout>] [-POLLINT=<pollInt>] 
[-GLOBAL_ROWCOUNT=<globalRowCount>]
[-UNIT_ROWCOUNT=<unitRowCount>] [-TIMEOUT_WITH_ROWS_OK=<yes|no>]
[-INCREMENT_DETECTION=<no|yes> [-INCREMENT_MODE=<M|P|I>]
[-INCREMENT_SEQUENCE_NAME=<incrementSequenceName>]]

パラメータ

パラメータ 必須 説明

-LSCHEMA=<logical_schema>

はい

表が格納されている論理スキーマ。

-TABLE_NAME=<table_name>

はい

チェックする表の名前、マスクまたは表名のリスト。このパラメータでは3つの書式を使用できます。

  • 表名。

  • 表名マスク: このマスクはポーリングする表を選択します。マスクはSQL LIKE構文を使用して指定されます。%記号は不特定数の文字、_記号は単一文字のワイルドカードです。

  • 表名リスト。カンマ区切りの表名のリストです。上で定義したマスクを使用できます。

-OBJECT_TYPE=<list of object types>

いいえ

チェックするオブジェクトのタイプ。デフォルトでは、表のみがチェックされます。他のオブジェクトをチェック対象とするには、オブジェクト・タイプのカンマ区切りリストを指定します。次のオブジェクト・タイプがサポートされています。

  • T: 表

  • V: ビュー

-CONTEXT=<context>

いいえ

論理スキーマを解決するコンテキスト。コンテキストの指定を省略すると、実行コンテキストが使用されます。

-SQLFILTER=<SQLFilter>

いいえ

表に適用する明示的なSQLフィルタ。この文は、チェックされた表を格納しているテクノロジで有効な文である必要があります。

この文にはWHEREキーワードを使用できません。

-RESUME_KEY_VARIABLE=<resumeKeyVariable>

-RESUME_KEY_COL=<resumeKeyCol>

[-RESUME_KEY_OPERATOR=<resumeKeyOperator>]

いいえ

RESUME_KEY_xxxパラメータを使用すると、ポーリングした表で検出された一連の行をフィルタ処理できます。

  • <key_column>: チェックした表の列名。

  • <operator>: チェックした表を格納しているテクノロジで有効な比較演算子。このパラメータを省略すると、デフォルトで「>」の値が使用されます。

  • <variable_name>: 事前に値が設定されている変数の名前。変数名の前には、「:」(連結)または「#」(代入)を接頭辞として付ける必要があります。変数の有効範囲は、Oracle Data Integrator構文で、グローバル変数の場合はGLOBAL.<variable name>、プロジェクト変数の場合は<project code>.<variable name>を明記してください。

-TIMEOUT=<timeout>

いいえ

データをポーリングする最大期間(ミリ秒単位)。この値がゼロの場合、タイムアウトは無限です。デフォルトは0です。

-POLLINT=<pollInt>

いいえ

データの各ポーリング間で待機する期間(ミリ秒単位)。デフォルト1000です。

-UNIT_ROWCOUNT=<unitRowCount>

いいえ

コマンドを終了するためにポーリング対象の表で必要とされる行数。デフォルトは1です。

-GLOBAL_ROWCOUNT=<globalRowCount>

いいえ

コマンドを終了するために一連の表全体で累積的に必要とされる合計行数。指定しないと、デフォルト値の 1 が使用されます。

-INCREMENT_DETECTION=<no|yes>

いいえ

コマンドで行数が考慮されるモードを、絶対条件(表内の合計行数に対する)または差分条件(格納された参照値と現在の行数値の差異)のいずれかで定義します。

  • yesに設定すると、行カウントは差分モードで実行されます。表内の他の行数が、格納された参照値と比較されます。参照値はINCREMENT_MODEパラメータによって異なります。

  • noに設定すると、カウントは、絶対行数モードで実行されます。

デフォルトはnoです。

-INCREMENT_MODE=<M|P|I>

いいえ

このパラメータは、連続するOdiWaitForDataコール間の参照値の永続性モードを指定します。

可能な値は次のとおりです。

  • M: メモリー。参照値は非永続的です。OdiWaitForDataがコールされると、参照値は、ポーリングされる表の行数と等しい値になります。OdiWaitForDataが終了すると、値は消失します。このモードの後続のコールでは、新しい参照値が設定されます。

  • P: 永続。参照値は永続的です。この参照値は、OdiWaitForDataの開始時に増分順序から読み取られ、OdiWaitForDataの終了時に増分順序に保存されます。増分順序が設定されていない場合(初回コール時)は、現在の表の行数が使用されます。

  • I: 初期。参照値は初期化され、永続的です。この参照値は、OdiWaitForDataの開始時に、ポーリングされる表の行数と等しい値になります。OdiWaitForDataの終了時には、永続モード用として増分順序に保存されます。

デフォルトはMです。

マスクまたは表のリストがポーリングされた場合、永続または初期モードの使用はサポートされません。

-INCREMENT_SEQUENCE_NAME=<incrementSequenceName>

いいえ

このパラメータは、参照値の永続性のために使用する自動的に割り当てられた記憶領域の名前を指定します。この増分順序はリポジトリに格納されます。この名前の指定を省略すると、表の名前が使用されます。

この増分順序はOracle Data Integratorの順序ではありません。OdiWaitForDataへのコールの外部では順序として使用できません。

-TIMEOUT_WITH_ROWS_OK=<yes|no>

いいえ

このパラメータがYに設定されている場合に、少なくとも1行が検出され、必要な行数が挿入される前にタイムアウトが発生すると、リターン・コード0でAPIが終了します。それ以外の場合はエラーが発生します。デフォルトはYesです。


ORA_WAITFORDATAスキーマのDE1P1表に、フィルタと一致するレコードが200件格納されるまで待機します。

OdiWaitForData -LSCHEMA=ORA_WAITFORDATA -TABLE_NAME=DE1P1
-GLOBAL_ROWCOUNT=200 "-SQLFILTER=DATMAJ >
to_date('#MAX_DE1_DATMAJ_ORACLE_CHAR', 'DD/MM/YYYY HH24:MI:SS')"

SQLSRV_SALESのCITY_SRC表またはCITY_TRG表に新しいデータが表示されるまで最大4時間待機します。

OdiWaitForData LSCHEMA=SQLSRV_SALES TABLE_NAME=CITY%
-TIMEOUT=14400000 -INCREMENT_DETECTION=yes

A.5.53 OdiWaitForLogData

このコマンドを使用して、ジャーナル化された表またはそのリストで、変更が特定の件数に達するまで待機します。

OdiWaitForLogDataコマンドは、表または表のグループで行が変更されたかどうかを判断します。この変更は、Oracle Data Integratorのチェンジ・データ・キャプチャ(CDC)を簡易モード(-TABLE_NAMEパラメータを使用)または一貫性モード(-CDC_SET_NAMEパラメータを使用)で使用して検出されます。テストは、いずれかの表で目的の数(-UNIT_ROWCOUNT)の行変更が検出されるか、すべての表を対象として累積で目的の数(-GLOBAL_ROWCOUNT)の行変更が検出されるか、またはタイムアウト(-TIMEOUT)に到達するかの、いずれかの条件が満たされるまで、-POLLINTミリ秒間隔で繰り返されます。


注意:

このコマンドでは、ジャーナル化されたすべての操作(挿入、更新および削除)が考慮されます。

このコマンドは、簡易モードまたは一貫性モードでジャーナル化された表にのみ適しています。


使用方法

OdiWaitForLogData -LSCHEMA=<logical_schema>  -SUBSCRIBER_NAME=<subscriber_name>
(-TABLE_NAME=<table_name> | -CDC_SET_NAME=<cdcSetName>)
[-CONTEXT=<context>] [-TIMEOUT=<timeout>] [-POLLINT=<pollInt>]
[-GLOBAL_ROWCOUNT=<globalRowCount>] 
[-UNIT_ROWCOUNT=<unitRowCount> [-OPTIMIZED_WAIT=<yes|no|AUTO>]
[-TIMEOUT_WITH_ROWS_OK=<yes|no>]

パラメータ

パラメータ 必須 説明

-CONTEXT=<context>

いいえ

論理スキーマを解決するコンテキスト(コンテキスト・コード)。コンテキストの指定を省略すると、実行コンテキストが使用されます。

-GLOBAL_ROWCOUNT=<globalRowCount>

いいえ

コマンドを終了するために、表またはCDCセットで必要とされる変更の合計数。デフォルトは1です。

-LSCHEMA=<logical_schema>

はい

ジャーナル化された表が格納されている論理スキーマ。

-OPTIMIZED_WAIT=<yes|no|AUTO>

いいえ

ジャーナルへのアクセスに使用する方法。

  • yes: 最適化された方法。この方法は最近のバージョンのジャーナル化で機能します。非最適化モードよりも迅速に実行されます。

  • no: 最適化されていない方法。ジャーナル化表に対してカウントが実行されます。パフォーマンスは低下しますが、旧バージョンのジャーナル化機能と互換性があります。

  • AUTO: 複数の表がチェックされる場合は、最適化された方法が使用されます。それ以外の場合は、最適化されていない方法が使用されます。

デフォルトはAUTOです。

-POLLINT=<pollInt>

いいえ

各ポーリング間で待機する期間(ミリ秒単位)。デフォルト2000です。

-SUBSCRIBER_NAME=<subscriber_name>

はい

ジャーナル化情報の取得に使用するサブスクライバの名前。

-TABLE_NAME=<table_name>

はい

チェックするジャーナル化表の名前、マスクまたはリスト。このパラメータでは3つの書式を使用できます。

  • 表名

  • 表名マスク: このマスクはポーリングする表を選択します。マスクはSQL LIKE構文を使用して指定されます。%記号は不特定数の文字、_記号はワイルドカードとして動作します。

  • 表名リスト: カンマ区切りの表名のリスト。上で定義したマスクは使用できません

このオプションは簡易モードでジャーナル化されたモデルの表でのみ機能します。

このパラメータはCDC_SET_NAMEとは併用できません。CDC_SET_NAMEが設定されていない場合は必須です。

-CDC_SET_NAME=<cdcSetName>

はい

チェックするCDCセットの名前。このCDCセット名は完全修飾のモデル・コードで、通常はPHYSICAL_SCHEMA_NAME.MODEL_CODEです。

<%=odiRef.getObjectName("L", "model_code", "logical_schema", "D")%>のように、代入メソッドAPIコールを使用して、現在のコンテキストに取得できます。

このオプションは一貫性モードでジャーナル化されたモデルの表でのみ機能します。

このパラメータはTABLE_NAMEとは併用できません。TABLE_NAMEが設定されていない場合は必須です。

-TIMEOUT=<timeout>

いいえ

変更をポーリングする最大期間(ミリ秒単位)。この値がゼロの場合、タイムアウトは無限です。デフォルトは0です。

-TIMEOUT_WITH_ROWS_OK=<yes|no>

いいえ

このパラメータがyesに設定されている場合に、少なくとも1行が検出され、事前定義の行数がポーリングされる前にタイムアウトが発生すると、リターン・コード0でAPIが終了します。それ以外の場合はエラーが発生します。デフォルトはyesです。

-UNIT_ROWCOUNT=<unitRowCount>

いいえ

コマンドを終了するためにポーリングされる表のいずれかで必要とされる変更の数。デフォルトは1です。

-UNIT_ROWCOUNT-CDC_SET_NAMEが同時に考慮されることはありません。


SALES_APPLICATIONスキーマのCUSTOMERS表で、SALES_SYNCサブスクライバについて記録されている行の変更が200になるまで待機します。

OdiWaitForLogData -LSCHEMA=SALES_APPLICATION
-TABLE_NAME=CUSTOMERS -GLOBAL_ROWCOUNT=200
-SUBSCRIBER_NAME=SALES_SYNC

A.5.54 OdiWaitForTable

このコマンドを使用して、表が作成されて事前定義の行数が移入されるまで待機します。

OdiWaitForTableコマンドは、指定の表が作成され、その表に特定の数のレコードが移入されたかどうかを定期的にテストします。このテストは、表が存在して目的の数の行(-GLOBAL_ROWCOUNT)が格納されるか、タイムアウト(-TIMEOUT)に到達するかの、いずれかの条件が満たされるまで-POLLINTミリ秒間隔で繰り返されます。

使用方法

OdiWaitForTable -CONTEXT=<context> -LSCHEMA=<logical_schema>
-TABLE_NAME=<table_name> [-TIMEOUT=<timeout>] [-POLLINT=<pollInt>]
[-GLOBAL_ROWCOUNT=<globalRowCount>]
[-TIMEOUT_WITH_ROWS_OK=<yes|no>]

パラメータ

パラメータ 必須 説明

-CONTEXT=<context>

いいえ

論理スキーマを解決するコンテキスト。コンテキストの指定を省略すると、実行コンテキストが使用されます。

-GLOBAL_ROWCOUNT=<globalRowCount>

いいえ

コマンドを終了するために表に必要とされる合計行数。デフォルトは1です。未指定の場合、表に新規行が挿入されたときにコマンドは終了します。

-LSCHEMA=<logical_schema>

はい

表を検索する論理スキーマ。

-POLLINT=<pollInt>

いいえ

各テスト間で待機する期間(ミリ秒単位)。デフォルト1000です。

-TABLE_NAME=<table_name>

はい

検索する表の名前。

-TIMEOUT=<timeout>

いいえ

表を検索する最大期間(ミリ秒単位)。この値がゼロの場合、タイムアウトは無限です。デフォルトは0です。

-TIMEOUT_WITH_ROWS_OK=<yes|no>

いいえ

このパラメータがyesに設定されている場合に、少なくとも1行が検出され、必要な行数が挿入される前にタイムアウトが発生すると、リターン・コード0でAPIが終了します。それ以外の場合はエラーが発生します。デフォルトはYesです。


ORA_WAITFORDATAスキーマのDE1P1表に、少なくとも1件のレコードが格納されるまで待機します。

OdiWaitForTable -LSCHEMA=ORA_WAITFORDATA -TABLE_NAME=DE1P1
-GLOBAL_ROWCOUNT=1

A.5.55 OdiXMLConcat

このコマンドを使用して、複数のXMLファイルから単一のファイルに要素を連結します。

このツールは、一連のソースXMLファイルから指定要素のインスタンスをすべて抽出し、単一のターゲットXMLファイルに連結します。このツールは、適格なXMLを解析して生成します。生成されたファイルに対するDTDの変更または生成は処理しません。既存のDTDへの参照は、HEADERパラメータで指定するか、-KEEP_XML_PROLOGUEを使用して元のファイルから保持できます。


注意:

このツールでは、XMLネームスペースはサポートされません。-ELEMENT_NAMEパラメータには、要素名のローカル部分を(ネームスペースも接頭辞値も付けずに)指定します。


使用方法

OdiXMLConcat -FILE=<file_filter> -TOFILE=<target_file> -XML_ELEMENT=<element_name> [-CHARSET_ENCODING=<encoding>] IF_FILE_EXISTS=<overwrite|skip|error>] [-KEEP_XML_PROLOGUE=<all|xml|doctype|none>] [-HEADER=<header>] [-FOOTER=<footer>]

パラメータ

パラメータ 必須 説明

-FILE=<file_filter>

はい

ソースXMLファイルのフィルタ。このフィルタでは、ファイルの標準的なワイルドカード(?*)を使用します。ファイル名とディレクトリ名の両方を指定します。ソース・ファイルは同じフォルダまたは異なるフォルダから取得できます。

次に、有効なファイル・フィルタを示します。

  • /tmp/files_*/customer.xml

  • /tmp/files_*/*.*

  • /tmp/files_??/customer.xml

  • /tmp/files/customer_*.xml

  • /tmp/files/customer_??.xml

-TOFILE=<target_file>

はい

要素の連結先ターゲット・ファイル。

-XML_ELEMENT=<element_name>

はい

ソース・ファイルから内容および子要素とともに抽出するXML要素(囲んでいる<>文字、接頭辞およびネームスペース情報を除く)のローカル名。

この要素の検出は再帰的ではありません。<element_name>の指定のインスタンスに<element_name>の別のインスタンスが含まれている場合は、上位レベルの要素のみが考慮され、子要素は最上位要素の内容の単なる一部として抽出されます。

-CHARSET_ENCODING=<encoding>

いいえ

ターゲット・ファイルのエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングの完全なリストは、http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.htmlのURLで確認できます。

-IF_FILE_EXISTS=<overwrite|skip|error>

いいえ

ターゲット・ファイルが存在する場合の動作を定義します。

  • overwrite: ターゲット・ファイルが存在する場合は上書きします。

  • skip: このファイルには何もしません。

  • error: エラーになります。

-KEEP_XML_PROLOGUE=<all|xml|doctype|none>

いいえ

ソース・ファイルのXMLプロローグをターゲット・ファイルにコピーします。このパラメータの値に従って、XMLプロローグの次の部分が保持されます。

  • all: すべてのプロローグ(XMLおよびドキュメント・タイプ宣言)をコピーします。

  • xml: XML宣言<?xml...?>のみをコピーし、ドキュメント・タイプ宣言はコピーしません。

  • doctype: ドキュメント・タイプ宣言のみをコピーし、XML宣言はコピーしません。

  • none: ソース・ファイルからプロローグをコピーしません。

注意: すべてまたは一部のプロローグを保持しない場合は、HEADERパラメータで指定する必要があります。

-HEADER=<header>

いいえ

各ターゲット・ファイルのプロローグ(ある場合)の後に追加する文字列。このパラメータを使用すると、カスタマイズしたXMLプロローグまたはルート要素を作成できます。

-FOOTER=<footer>

いいえ

各ターゲット・ファイルの終わりに追加する文字列。このパラメータを使用すると、ヘッダーに追加されたルート要素を閉じることができます。


次の例では、ord_iサブフォルダにあるord1.xmlord2.xmlなどのファイルのIDOC要素の内容をMDSLS.TXT.XMLというファイルに連結します。その際、ターゲット・ファイルには<WMMBID02>というルート要素も追加されます。

OdiXMLConcat "-FILE=./ord_i/ord*.xml" "-TOFILE=./MDSLS.TXT.XML" -XML_ELEMENT=IDOC "-CHARSET_ENCODING=UTF-8" -IF_FILE_EXISTS=overwrite -KEEP_XML_PROLOGUE=xml "-HEADER=<WMMBID02>" "-FOOTER=</WMMBID02>"

OdiXMLConcat "-FILE=./o?d_*/ord*.xml" "-TOFILE=./MDSLS.TXT.XML" -XML_ELEMENT=IDOC "-CHARSET_ENCODING=UTF-8" -IF_FILE_EXISTS=overwrite -KEEP_XML_PROLOGUE=none "-HEADER=<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<WMMBID02>" "-FOOTER=</WMMBID02>"

次の例では、ord_iサブフォルダにあるord1.xmlord2.xmlなどのファイルのEDI要素をMDSLS2.XMLというファイルに連結します。このファイルには、すべての<EDI>要素の上にEDI_BATCHという新しいルート要素が追加されます。

OdiXMLConcat "-FILE=./o?d_?/ord*.xml" "-TOFILE=./MDSLS2.XML" -XML_ELEMENT=EDI "-CHARSET_ENCODING=UTF-8" -IF_FILE_EXISTS=overwrite -KEEP_XML_PROLOGUE=xml "-HEADER= <EDI_BATCH>" "-FOOTER=</EDI_BATCH>"

A.5.56 OdiXMLSplit

このコマンドを使用して、単一のXMLファイルを複数のファイルに分割します。

このツールは、単一のソースXMLファイルに保存されている指定要素のインスタンスをすべて抽出し、複数のターゲットXMLファイルに分割します。このツールは、適格なXMLを解析して生成します。生成されたファイルに対するDTDの変更または生成は処理しません。既存のDTDへの参照は、HEADERパラメータで指定するか、-KEEP_XML_PROLOGUEを使用して元のファイルから保持できます。


注意:

このツールでは、XMLネームスペースはサポートされません。-ELEMENT_NAMEパラメータには、要素名のローカル部分を(ネームスペースも接頭辞値も付けずに)指定します。


使用方法

OdiXMLSplit -FILE=<file> -TOFILE=<file_pattern> -XML_ELEMENT=<element_name> [-CHARSET_ENCODING=<encoding>] [-IF_FILE_EXISTS=<overwrite|skip|error>] [-KEEP_XML_PROLOGUE=<all|xml|doctype|none>] [-HEADER=<header>] [-FOOTER=<footer>]

パラメータ

パラメータ 必須 説明

-FILE=<file>

はい

分割するソースXMLファイル。

-TOFILE=<file_pattern>

はい

ターゲット・ファイルのファイル・パターン。各ファイルは、生成される番号順序または分割の実行に使用されるXML要素の属性値を表すマスクを含んだパターンに従って命名されます。

  • 順序番号マスク: *(スター)値を使用してファイル番号値の場所を示します。たとえば、<file_ pattern>arget_*.xmlの場合、作成されるファイルはtarget_1.xmltarget_2.xmlなどの名前になります。

  • 属性値マスク: 角カッコの間に、ファイル名を作成するために挿入する<element_name>の属性の名前を指定します。たとえば、Customer_[CUSTID].xmlでは、分割に使用される要素の属性CUSTIDの値に応じてcustomer_041.xmlcustomer_123.xmlなどの名前のファイルが作成されます。値がいくつかの連続する要素にわたって繰り返される場合は、ターゲット・ファイルがOVERWRITEパラメータの値に従って上書きされる可能性があります。

パターンを使用して、単一のディレクトに異なるファイルを作成することも、異なるディレクトリに各ファイルを作成することもできます。次に、有効なパターンを示します。

  • /tmp/files_*/customer.xml

  • /tmp/files_[CUSTID]/customer.xml

  • /tmp/files/customer_*.xml

  • /tmp/files/customer_[CUSTID].xml

-XML_ELEMENT=<element_name>

はい

ソース・ファイルから内容および子要素とともに抽出するXML要素(囲んでいる<>文字、接頭辞およびネームスペース情報を除く)のローカル名。

この要素の検出は再帰的ではありません。<element_name>の指定のインスタンスに<element_name>の別のインスタンスが含まれている場合は、上位レベルの要素のみが考慮され、子要素は最上位要素の内容の単なる一部として抽出されます。

-CHARSET_ENCODING=<encoding>

いいえ

ターゲット・ファイルのエンコーディング。デフォルト値はISO-8859-1です。サポートされているエンコーディングの完全なリストは、http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.htmlのURLで確認できます。

-IF_FILE_EXISTS=<overwrite|skip|error>

いいえ

ターゲット・ファイルが存在する場合の動作を定義します。

  • overwrite: ターゲット・ファイルが存在する場合は上書きします。

  • skip: このファイルには何もしません。

  • error: エラーになります。

-KEEP_XML_PROLOGUE=<all|xml|doctype|none>

いいえ

ソース・ファイルのXMLプロローグをターゲット・ファイルにコピーします。このパラメータの値に従って、XMLプロローグの次の部分が保持されます。

  • all: すべてのプロローグ(XMLおよびドキュメント・タイプ宣言)をコピーします。

  • xml: XML宣言<?xml...?>のみをコピーし、ドキュメント・タイプ宣言はコピーしません。

  • doctype: ドキュメント・タイプ宣言のみをコピーし、XML宣言はコピーしません。

  • none: ソース・ファイルからプロローグをコピーしません。

注意: すべてまたは一部のプロローグを保持しない場合は、HEADERパラメータで指定する必要があります。

-HEADER=<header>

いいえ

各ターゲット・ファイルのプロローグ(ある場合)の後に追加する文字列。このパラメータを使用すると、カスタマイズしたXMLプロローグまたはルート要素を作成できます。

-FOOTER=<footer>

いいえ

各ターゲット・ファイルの終わりに追加する文字列。このパラメータを使用すると、ヘッダーに追加されたルート要素を閉じることができます。


次の例では、MDSLS.TXT.XMLというファイルを複数のファイルに分割します。ord1.xmlord2.xmlなどのファイルが作成され、ソース・ファイルに保存されているIDOC要素の各インスタンスが格納されます。

OdiXMLSplit "-FILE=./MDSLS.TXT.XML" "-TOFILE=./ord_i/ord*.xml" -XML_ELEMENT=IDOC "-CHARSET_ENCODING=UTF-8" -IF_FILE_EXISTS=overwrite -KEEP_XML_PROLOGUE=xml "-HEADER= <WMMBID02>" "-FOOTER= </WMMBID02>"

次の例では、前述の例と同様の方法でMDSLS.TXT.XMLというファイルを分割します。ただし、分割するIDOC要素のBEGIN属性の値を使用してファイル名が指定される点が前述の例とは異なります。この例ではXMLプロローグが保持されませんが、すべてヘッダーに生成されています。

OdiXMLSplit "-FILE= ./MDSLS.TXT.XML" "-TOFILE=./ord_i/ord[BEGIN].xml" -XML_ELEMENT=IDOC "-CHARSET_ENCODING=UTF-8" -IF_FILE_EXISTS=overwrite -KEEP_XML_PROLOGUE=none "-HEADER= <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<WMMBID02>" "-FOOTER=</WMMBID02>"

A.5.57 OdiZip

このコマンドを使用して、ディレクトリまたは複数のファイルからZIPファイルを作成します。

使用方法

OdiZip -DIR=<directory> -FILE=<file> -TOFILE=<target_file> [-OVERWRITE=<yes|no>]
[-RECURSE=<yes|no>] [-CASESENS=<yes|no>]
[-ENCODING=<file_name_encoding>]

パラメータ

パラメータ 必須 説明

-DIR=<directory>

FILEを指定しない場合は、はい

生成するZIPファイルのルートになるベース・ディレクトリ(またはフォルダ)。-DIRのみを指定して-FILEを指定しないと、このディレクトリの下にあるすべてのファイルが圧縮されます。

-FILE=<file>

DIRを指定しない場合は、はい

アーカイブするファイルのベース・ディレクトリからのパス。-FILEのみを指定して-DIRを指定しないと、-FILEが相対パスの場合は、現在の作業ディレクトリがデフォルトのディレクトリになります。

汎用文字を指定するには「*」を使用します。

例:

/var/tmp/*.log (/var/tmpディレクトリ内にあるlog拡張子のファイルすべて)

arch_*.lst (arch_で開始するlst拡張子のファイルすべて)

-TOFILE=<target_file>

はい

ターゲットZIPファイル。

-OVERWRITE=<yes|no>

いいえ

ターゲットZIPファイルがすでに存在している場合は、上書きするか(yes)、単に更新するか(no)を示します。デフォルトでは、既存のZIPファイルがある場合は更新されます。

-RECURSE=<yes|no>

いいえ

他のディレクトリが含まれるディレクトリの場合に、アーカイブを再帰的に実行するかどうかを示します。noの値を指定すると、コピーするディレクトリに含まれるファイルのみ(サブフォルダを含まない)がアーカイブされます。

-CASESENS=<yes|no>

いいえ

ファイル検索で大文字と小文字が区別されるかどうかを示します。デフォルトでは、ファイルは大文字で検索されます。

-ENCODING=<file_name_encoding>

いいえ

アーカイブ・ファイル内部でファイル名に使用される文字エンコーディング。

サポートされているエンコーディングは、次のURLで確認できます。

http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

デフォルトは、プラットフォームのデフォルトの文字エンコーディングです。


C:\Program files\odiディレクトリのアーカイブを作成します。

OdiZip "-DIR=C:\Program Files\odi" -FILE=*.* -TOFILE=C:\TEMP\odi_archive.zip

C:\Program files\odiディレクトリのアーカイブを作成します。このアーカイブにはodiディレクトリが保持されます。

OdiZip "-DIR=C:\Program Files" -FILE=odi\*.* -TOFILE=C:\TEMP\odi_archive.zip