1. Oracle Data Integrator Toolsリファレンス
  2. Oracle Data Integratorツール

2 Oracle Data Integratorツール

この章では、すべてのOracle Data Integratorツールをカテゴリ別にリストし、そのコマンドおよびパラメータについて説明します。

カテゴリ別Oracle Data Integratorツール

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

メタデータ

Oracle Data Integratorオブジェクト

ユーティリティ

インターネット関連タスク

ファイル

SAP

XML

イベント検出

チェンジ・データ・キャプチャ

Oracle Data Integratorツールのアルファベット順リスト

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

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>

いいえ

プロパティとその値をAntビルドファイルに渡すのに使用されます

-PROJECTHELP

いいえ

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

-HELP

いいえ

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

-VERSION

いいえ

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

-QUIET

いいえ

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

-VERBOSE

いいえ

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

-DEBUG

いいえ

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

-EMACS

いいえ

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

-LOGGER=<classname>

いいえ

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

-LISTENER=<classname>

いいえ

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

-FIND=<file>

いいえ

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

例

*.htmlファイルをftp.example.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.example.com" userid="anonymous"
          password="me@example.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

OdiApplyDeploymentArchive

このコマンドは、初期またはパッチ・デプロイメント・アーカイブ(DA)をODIリポジトリに適用する場合に使用します。

使用方法

OdiApplyDeploymentArchive -ARCHIVE_FILE_NAME=<archive_file_name>
[-APPLY_WITHOUT_CIPHER_DATA=<yes|no>] [-EXPORT_KEY=<Export_Key>]
[-CREATE_ROLLBACK_ARCHIVE=<yes|no>]
[-ROLLBACK_FILE_NAME=<rollback_file_name>]
[-INCLUDE_PHYSICAL_TOPOLOGY=<yes|no>]

パラメータ

パラメータ 必須 説明

ARCHIVE_FILE_NAME=<archive_file_name>

はい

デプロイメント・アーカイブzipファイルのフル・パスまたは完全名。

APPLY_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注1

yesに設定した場合、デプロイメント・アーカイブ内の暗号データがnullになります。noに設定した場合、エクスポート・キーを使用して暗号データが移行されます。デフォルト値は「いいえ」です。

EXPORT_KEY=<Export_Key>

いいえ
暗号データをデプロイメント・アーカイブ・オブジェクトに移行するための暗号秘密キーを指定します。

ノート:

EXPORT_KEYパラメータは暗号化された文字列である必要があります。エンコーディング・プロセスの詳細は、Oracle Data Integratorの管理のパスワードのエンコーディングを参照してください。

CREATE_ROLLBACK_ARCHIVE=<yes|no>

いいえ脚注2

ロールバック・デプロイメント・アーカイブを作成するかどうかを指定します。Yesに設定した場合、パッチの適用前にロールバック・デプロイメント・アーカイブが作成されます。Noに設定した場合、ロールバック・デプロイメント・アーカイブは作成されません。

ノート:

このオプションはパッチ・デプロイメント・アーカイブにのみ適用されます。

ROLLBACK_FILE_NAME=<rollback_file_name>

いいえ

ロールバック・デプロイメント・アーカイブの完全ファイル名。

INCLUDE_PHYSICAL_TOPOLOGY=<yes|no>

いいえ

デプロイメント・アーカイブ内の物理トポロジ・オブジェクトをターゲット・リポジトリに適用するかどうかを指定します。デフォルト値はYesです。

脚注1

APPLY_WITHOUT_CIPHER_DATAパラメータをNoに設定した場合、EXPORT_KEYパラメータを指定する必要があります。

脚注2

CREATE_ROLLBACK_ARCHIVEパラメータをYesに設定した場合、ROLLBACK_FILE_NAMEパラメータを指定する必要があります。

例

パッチ・デプロイメント・アーカイブとエクスポート・キーを使用して、リポジトリにパッチを適用し、ロールバック・デプロイメント・アーカイブを作成します。

OdiApplyDeploymentArchive -ARCHIVE_FILE_NAME=archive_file_name
-APPLY_WITHOUT_CIPHER_DATA=no -EXPORT_KEY=Export_Key
-CREATE_ROLLBACK_ARCHIVE=yes
-ROLLBACK_FILE_NAME=rollback_file_name -INCLUDE_PHYSICAL_TOPOLOGY=yes

OdiBeep

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

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

  • WAV

  • AIF

  • AU

ノート:

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

使用方法

OdiBeep [-FILE=<sound_file>]

パラメータ

パラメータ 必須 説明

-FILE

いいえ

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

例

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

OdiCreateDeploymentArchive

このコマンドは、ODIリポジトリまたはVCSラベル/タグからデプロイメント・アーカイブ(DA)を作成する場合に使用します。

使用方法

SVNの場合

OdiCreateDeploymentArchive -ARCHIVE_NAME=<archive_name>
-ARCHIVE_FILE_NAME=<archive_file_name>
[-SOURCE_TYPE=VCS|ODI]
[-ARCHIVE_TYPE=INITIAL|PATCH]
[-CREATE_WITHOUT_CIPHER_DATA=<yes|no>]
[-EXPORT_KEY=<Export_Key>]
[–VCS_LABEL=<vcs_label>]
[-VCS_TYPE=<vcs_type>]
[-VCS_AUTH_TYPE=<vcs_auth_type>]
[-VCS_URL=<vcs_url>]
[-VCS_USER=<vcs_user>]
[-VCS_PASS=<vcs_pass>]
[-VCS_PROXY_HOST=<vcs_proxy_host>]
[-VCS_PROXY_PORT=<vcs_proxy_port>]
[-VCS_PROXY_USER=<vcs_proxy_user>]
[-VCS_PROXY_PASS=<vcs_proxy_pass>]
[-INCLUDE_PHYSICAL_TOPOLOGY=<yes|no>]

Gitの場合

OdiCreateDeploymentArchive -ARCHIVE_NAME=<archive_name>
-ARCHIVE_FILE_NAME=<archive_file_name>
[-SOURCE_TYPE=VCS|ODI]
[-ARCHIVE_TYPE=INITIAL|PATCH]
[-CREATE_WITHOUT_CIPHER_DATA=<yes|no>]
[-EXPORT_KEY=<Export_Key>]
[-DESCRIPTION=<Description>]
[–VCS_TAG=<vcs_tag>]
[-VCS_TYPE=<vcs_type>]
[-VCS_AUTH_TYPE=<vcs_auth_type>]
[-VCS_URL=<vcs_url>]
[-VCS_USER=<vcs_user>]
[-VCS_PASS=<vcs_pass>]
[-VCS_PROXY_HOST=<vcs_proxy_host>]
[-VCS_PROXY_PORT=<vcs_proxy_port>]
[-VCS_PROXY_USER=<vcs_proxy_user>]
[-VCS_PROXY_PASS=<vcs_proxy_pass>]
[-VCS_SSH_PRIVATE_KEY_PATH=<vcs_ssh_private_key_path>]
[-VCS_SSH_PASS_PHRASE=<vcs_ssh_pass_phrase>]
[-VCS_SSH_PORT=<vcs_ssh_port>]
[-VCS_SSL_CERT_PATH=<vcs_ssl_cert_path>]
[-VCS_SSL_PASS_PHRASE=<vcs_ssl_pass_phrase>]
[-INCLUDE_PHYSICAL_TOPOLOGY=<yes|no>]

パラメータ

パラメータ 必須 説明

ARCHIVE_NAME=<archive_name>

はい

デプロイメント・アーカイブの名前。

ARCHIVE_FILE_NAME=<archive_file_name>

はい

デプロイメント・アーカイブzipファイルのフル・パスまたは完全名。

SOURCE_TYPE=VCS|ODI

いいえ脚注3

デプロイメント・アーカイブの作成に使用するソース。

次のソースを使用できます。

  • VCS: VCSラベル/タグから初期またはパッチ・デプロイメント・アーカイブを作成する場合。

  • ODI: ODIリポジトリ全体から初期デプロイメント・アーカイブを作成する場合。

VCS_TAG=<vcs_tag>

いいえ

VCSタグ名。

ARCHIVE_TYPE=INITIAL|PATCH

いいえ

デプロイメント・アーカイブのタイプ。INITIALまたはPATCHを指定できます。デフォルト値はPATCHです。

CREATE_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注4

Yesに設定した場合、デプロイメント・アーカイブ内の暗号データがnullになります。Noに設定した場合、エクスポート・キーを使用して暗号データが移行されます。デフォルト値は「いいえ」です。

EXPORT_KEY=<Export_Key>

いいえ

デプロイメント・アーカイブ・オブジェクト内の暗号データの暗号化に使用する暗号秘密キーを指定します。

VCS_LABEL=<vcs_label>

いいえ

VCSラベル名。

DESCRIPTION=<Description>

いいえ

このデプロイメント・アーカイブの説明。

VCS_TYPE=<vcs_type>

いいえ

VCSのタイプ。SVNまたはGitを指定できます。

VCS_AUTH_TYPE=<vcs_auth_type>

いいえ脚注5

使用するVCSの認証タイプ。

値は次のとおりです。

  • GITBASIC: Git認証の場合。

  • SVNBASIC: SVN認証の場合。

  • HTTPBASIC: HTTP基本認証の場合。

  • HTTPPROXY: HTTPプロキシ認証の場合。

  • GIT_SSH: SSH認証の場合。

  • GIT_SSL: HTTPS認証の場合。

  • FILE: ファイル・ベースの認証の場合。

VCS_URL=<vcs_url>

いいえ

VCS URL。

VCS_USER=<vcs_user>

いいえ

VCSユーザー名。

VCS_PASS=<vcs_pass>

いいえ

VCSパスワード。

VCS_PROXY_HOST=<vcs_proxy_host>

いいえ

VCSプロキシ・ホスト。

VCS_PROXY_PORT=<vcs_proxy_port>

いいえ

VCSプロキシ・ポート。

VCS_PROXY_USER=<vcs_proxy_user>

いいえ

VCSプロキシ・ユーザー。

VCS_PROXY_PASS=<vcs_proxy_pass>

いいえ

VCSプロキシのパスワード。

VCS_SSH_PRIVATE_KEY_PATH=<vcs_ssh_private_key_path>

いいえ

VCS SSH秘密キー・ファイルのパス(秘密キー認証の場合)。

VCS_SSH_PASS_PHRASE=<vcs_ssh_pass_phrase>

いいえ

VCS SSHのパス・フレーズ(秘密キーの生成時に指定した場合)

VCS_SSH_PORT=<vcs_ssh_port>

いいえ

VCS SSHポート。

VCS_SSL_CERT_PATH=<vcs_ssl_cert_path>

いいえ

VCS HTTP SSL証明書のパス。

VCS_SSL_PASS_PHRASE=<vcs_ssl_pass_phrase>

いいえ

VCS SSLのパス・フレーズ。

INCLUDE_PHYSICAL_TOPOLOGY=<yes|no>

いいえ

リポジトリ内の物理トポロジ・オブジェクトをデプロイメント・アーカイブに含めるかどうかを指定します。デフォルト値はYesです。

脚注3

SOURCE_TYPEパラメータにVCSを指定した場合、VCS_TAG/VCS_LABELパラメータを指定する必要があります。

脚注4

CREATE_WITHOUT_CIPHER_DATAパラメータをNoに設定した場合、EXPORT_KEYパラメータを指定する必要があります。

脚注5

VCS_AUTH_TYPEパラメータにGITBASICまたはSVNBASICを指定した場合、VCS_URL、VCS_USERおよびVCS_PASSパラメータを指定する必要があります。

VCS_AUTH_TYPEパラメータにSVNBASICを指定した場合、VCS_SSH_PORTパラメータを指定する必要があります。

VCS_AUTH_TYPEパラメータにHTTPPROXYを指定した場合、VCS_PROXY_HOST、VCS_PROXY_PORT、VCS_PROXY_USERおよびVCS_PROXY_PASSパラメータを指定する必要があります。

VCS_AUTH_TYPEパラメータにGIT_SSHを指定した場合、VCS_SSH_PRIVATE_KEY_PATHおよびVCS_SSH_PASS_PHRASEパラメータを指定する必要があります。

VCS_AUTH_TYPEパラメータにGIT_SSLを指定した場合、VCS_SSL_CERT_PATHおよびVCS_SSL_PASS_PHRASEパラメータを指定する必要があります。

例

SVNラベルから暗号を含めたパッチ・デプロイメント・アーカイブを作成します。

OdiCreateDeploymentArchive -ARCHIVE_NAME=archive_name
-ARCHIVE_FILE_NAME=archive_file_name 
-SOURCE_TYPE=VCS 
-ARCHIVE_TYPE=PATCH
-CREATE_WITHOUT_CIPHER_DATA=no 
-EXPORT_KEY=Export_Key
–VCS_LABEL=vcs_label
-VCS_TYPE=SVN
-VCS_AUTH_TYPE=BASIC
-VCS_URL=vcs_url
-VCS_USER=vcs_user
-VCS_PASS=vcs_pass
-INCLUDE_PHYSICAL_TOPOLOGY=yes

Gitタグから初期デプロイメント・アーカイブを作成します。

OdiCreateDeploymentArchive -ARCHIVE_NAME=<archive_name> 
-ARCHIVE_TYPE=INITIAL 
-SOURCE_TYPE=VCS
–VCS_TAG=<vcs_tag>
-ARCHIVE_FILE_NAME=<archive_file_name> 
-CREATE_WITHOUT_CIPHER_DATA=<yes|no> 
-EXPORT_KEY=<Export_Key>
-INCLUDE_PHYSICAL_TOPOLOGY=<yes|no>
-VCS_URL=<vcs_url>
-VCS_USER=<vcs_user>
-VCS_PASS=<vcs_pass>

OdiDeleteScen

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

使用方法

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

パラメータ

パラメータ 必須 説明

-SCEN_NAME=<name>

はい

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

-SCEN_VERSION=<version>

はい

削除するシナリオのバージョン。

例

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

OdiDeleteScen -SCEN_NAME=DWH -SCEN_VERSION=001

OdiEnterpriseDataQuality

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

ノート:

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

使用方法

OdiEnterpriseDataQuality "-JOB_NAME=<EDQ job name>"
"-PROJECT_NAME=<EDQ project name>" "-CONTEXT=<context>"
"-LSCHEMA=<logical_schema>" "-SYNCHRONOUS=<yes|no>"

パラメータ

パラメータ 必須 説明

-JOB_NAME=<EDQ job name>

はい

Enterprise Data Qualityジョブの名前。

-PROJECT_NAME=<EDQ project name>

はい

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

-SYNCHRONOUS=<yes|no>

いいえ

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

例

プロジェクトCUSTOMERSに配置されているEnterprise Data QualityジョブCLEANSE_CUSTOMERSを実行します。 

OdiEnterpriseDataQuality "-JOB_NAME=CLEANSE_CUSTOMERS" "-PROJECT_NAME=CUSTOMERS"
"-CONTEXT=Development" "-LSCHEMA=EDQ Logical Schema" "-SYNCHRONOUS=yes"

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_KEY=<key>] [-EXPORT_MAPPING=<yes|no>]
[-EXPORT_PACK=<yes|no>] [-EXPORT_POP=<yes|no>]
[-EXPORT_TRT=<yes|no>] [-EXPORT_VAR=<yes|no>] 
[EXPORT_WITHOUT_CIPHER_DATA=<yes|no>]

パラメータ

パラメータ 必須 説明

-TODIR=<directory>

はい

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

-FORCE_OVERWRITE=<yes|no>

いいえ

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

-FROM_PROJECT=<project_id>

いいえ

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

-FROM_FOLDER=<folder_id>

いいえ

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

-FROM_PACKAGE=<package_id>

いいえ

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

-RECURSIVE_EXPORT=<yes|no>

いいえ

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

-XML_VERSION=<1.0>

いいえ

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

-XML_CHARSET=<charset>

いいえ

XMLエクスポート・ファイル内に<?xml version="1.0" encoding="ISO-8859-1"?>のタグで指定されるエンコーディング。デフォルト値はISO-8859-1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

ターゲット・ファイルのエンコーディング。デフォルト値はISO-8859-1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-EXPORT_KEY=<key>

いいえ脚注6

機密的な暗号データを暗号化するために使用される暗号秘密キーを指定します。暗号データをインポートするためにエクスポート済オブジェクトをインポートするときに、このキーを再指定する必要があります。

-EXPORT_MAPPING=<yes|no>

いいえ

マッピング・シナリオをエクスポートするかどうかを示します。デフォルト値は「いいえ」です。

-EXPORT_PACK=<yes|no>

いいえ

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

-EXPORT_POP=<yes|no>

いいえ

マッピングに関連付けられているシナリオをエクスポートするかどうかを示します。デフォルト値は「いいえ」です。

-EXPORT_TRT=<yes|no>

いいえ

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

-EXPORT_VAR=<yes|no>

いいえ

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

-EXPORT_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注7

Yesに設定した場合、オブジェクトのエクスポート時にその機密(暗号)値をnullに設定する必要があります。Noに設定した場合、またはこのパラメータを省略した場合は、-EXPORT_KEYパラメータを追加して、有効なキーを指定する必要があります。デフォルト値は「いいえ」です。

脚注6

-EXPORT_KEYパラメータを指定しない場合は、-EXPORT_WITHOUT_CIPHER_DATAパラメータを指定して、Yesに設定する必要があります。

脚注7

-EXPORT_WITHOUT_CIPHER_DATAを指定しない場合、または指定してNoに設定した場合は、-EXPORT_KEYパラメータを有効なキー値とともに指定する必要があります。

例

グローバルID 2edb524d-eb17-42ea-8aff-399ea9b13bf3のDW01プロジェクトのすべてのシナリオおよびすべての依存オブジェクトを、キーexamplekey1を使用して機密データを暗号化して、/temp/ディレクトリにエクスポートします。 

OdiExportAllScen -FROM_PROJECT=2edb524d-eb17-42ea-8aff-399ea9b13bf3 -TODIR=/temp/ -RECURSIVE_EXPORT=yes -EXPORT_KEY=examplekey1

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"

OdiExportLog

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

使用方法

OdiExportLog -TODIR=<toDir> [-EXPORT_TYPE=<logsToExport>] [-EXPORT_KEY=<key>]
[-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_WITHOUT_CIPHER_DATA=<yes|no>]

パラメータ

パラメータ 必須 説明

-EXPORT_TYPE=<logsToExport>

いいえ

次のログをエクスポートします。

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

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

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

-EXPORT_KEY=<key>

いいえ脚注8

機密的な暗号データを暗号化するために使用される暗号秘密キーを指定します。暗号データをインポートするためにエクスポート済オブジェクトをインポートするときに、このキーを再指定する必要があります。

-TODIR=<toDir>

はい

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

-ZIPFILE_NAME=<zipFileName>

いいえ

圧縮ファイルの名前。

-XML_CHARSET=<charset>

いいえ

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

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

結果ファイルのJava文字エンコーディング。デフォルト値はISO8859_1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/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>

いいえ

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

-EXPORT_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注9

Yesに設定した場合、オブジェクトのエクスポート時にその機密(暗号)値をnullに設定する必要があります。Noに設定した場合、またはこのパラメータを省略した場合は、-EXPORT_KEYパラメータを追加して、有効なキーを指定する必要があります。デフォルト値は「いいえ」です。

脚注8

-EXPORT_KEYパラメータを指定しない場合は、-EXPORT_WITHOUT_CIPHER_DATAパラメータを指定して、Yesに設定する必要があります。

脚注9

-EXPORT_WITHOUT_CIPHER_DATAを指定しない場合、または指定してNoに設定した場合は、-EXPORT_KEYパラメータを有効なキー値とともに指定する必要があります。

例

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

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

OdiExportMaster

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

使用方法

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

パラメータ

パラメータ 必須 説明

-TODIR=<toDir>

はい

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

-ZIPFILE_NAME=<zipFileName>

いいえ

圧縮ファイルの名前。

-EXPORT_KEY=<key>

いいえ脚注10

機密的な暗号データを暗号化するために使用される暗号秘密キーを指定します。暗号データをインポートするためにエクスポート済オブジェクトをインポートするときに、このキーを再指定する必要があります。

-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です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

結果ファイルのJava文字エンコーディング。デフォルト値はISO8859_1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-EXPORT_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注11

Yesに設定した場合、オブジェクトのエクスポート時にその機密(暗号)値をnullに設定する必要があります。Noに設定した場合、またはこのパラメータを省略した場合は、-EXPORT_KEYパラメータを追加して、有効なキーを指定する必要があります。デフォルト値は「いいえ」です。

脚注10

-EXPORT_KEYパラメータを指定しない場合は、-EXPORT_WITHOUT_CIPHER_DATAパラメータを指定して、Yesに設定する必要があります。

脚注11

-EXPORT_WITHOUT_CIPHER_DATAを指定しない場合、または指定してNoに設定した場合は、-EXPORT_KEYパラメータを有効なキー値とともに指定する必要があります。

例

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

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

OdiExportObject

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

使用方法

OdiExportObject -CLASS_NAME=<class_name> -I_OBJECT=<object_id> 
[-EXPORT_KEY=<key>] [-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>] [EXPORT_WITHOUT_CIPHER_DATA=<yes|no>]

パラメータ

パラメータ 必須 説明

-CLASS_NAME=<class_name>

はい

エクスポートするオブジェクトのクラス(次のクラスのリストを参照)。

-I_OBJECT=<object_id>

はい

オブジェクト識別子。この値は、オブジェクト編集ウィンドウの「バージョン」タブに表示される「グローバルID」です。

-EXPORT_KEY=<key>

いいえ脚注12

機密的な暗号データを暗号化するために使用される暗号秘密キーを指定します。暗号データをインポートするためにエクスポート済オブジェクトをインポートするときに、このキーを再指定する必要があります。

-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に設定すると、同じ名前の既存のエクスポート・ファイルが強制的に上書きされます。デフォルト値は「いいえ」です。

-RECURSIVE_EXPORT=<yes|no>

いいえ

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

-XML_VERSION=<1.0>

いいえ

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

-XML_CHARSET=<charset>

いいえ

XMLファイル内に<?xml version="1.0" encoding="ISO-8859-1"?>のタグで指定されるエンコーディング。デフォルト値はISO-8859-1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

ターゲット・ファイルのエンコーディング。デフォルト値はISO8859_1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-EXPORT_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注13

Yesに設定した場合、オブジェクトのエクスポート時にその機密(暗号)値をnullに設定する必要があります。Noに設定した場合、またはこのパラメータを省略した場合は、-EXPORT_KEYパラメータを追加して、有効なキーを指定する必要があります。デフォルト値は「いいえ」です。

脚注12

-EXPORT_KEYパラメータを指定しない場合は、-EXPORT_WITHOUT_CIPHER_DATAパラメータを指定して、Yesに設定する必要があります。

脚注13

-EXPORT_WITHOUT_CIPHER_DATAを指定しない場合、または指定してNoに設定した場合は、-EXPORT_KEYパラメータを有効なキー値とともに指定する必要があります。

クラスのリスト

オブジェクト クラス名

列

SnpCol

条件/フィルタ

SnpCond

コンテキスト

SnpContext

データ・サーバー

SnpConnect

データストア

SnpTable

フォルダ

SnpFolder

インタフェース

SnpPop

言語

SnpLang

ロード計画

SnpLoadPlan

マッピング

SnpMapping

モデル

SnpModel

パッケージ

SnpPackage

物理スキーマ

SnpPschema

プロシージャまたはKM

SnpTrt

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

SnpUserExit

プロジェクト

SnpProject

リファレンス

SnpJoin

再使用可能マッピング

SnpMapping

シナリオ

SnpScen

Sequence

SnpSequence

ステップ

SnpStep

サブモデル

SnpSubModel

テクノロジ

SnpTechno

ユーザー関数

SnpUfunc

変数

SnpVar

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

SnpVer

例

グローバルIDが2edb524d-eb17-42ea-8aff-399ea9b13bf3のDW01プロジェクトを、すべての依存オブジェクトとともに/temp/dw1.xmlエクスポート・ファイルにエクスポートします。 

OdiExportObject -CLASS_NAME=SnpProject
-I_OBJECT=2edb524d-eb17-42ea-8aff-399ea9b13bf3 -EXPORT_KEY=examplekey1
-FILE_NAME=/temp/dw1.xml -FORCE_OVERWRITE=yes
-RECURSIVE_EXPORT=yes

OdiExportScen

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

使用方法

OdiExportScen -SCEN_NAME=<scenario_name> -SCEN_VERSION=<scenario_version>
[-EXPORT_KEY=<key>] [-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>] [EXPORT_WITHOUT_CIPHER_DATA=<yes|no>]

パラメータ

パラメータ 必須 説明

-SCEN_NAME=<scenario_name>

はい

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

-SCEN_VERSION=<scenario_version>

はい

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

-EXPORT_KEY=<key>

いいえ脚注14
機密的な暗号データを暗号化するために使用される暗号秘密キーを指定します。暗号データをインポートするためにエクスポート済オブジェクトをインポートするときに、このキーを再指定する必要があります。

ノート:

EXPORT_KEYパラメータは暗号化された文字列である必要があります。エンコーディング・プロセスの詳細は、Oracle Data Integratorの管理のパスワードのエンコーディングを参照してください。

-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です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-JAVA_CHARSET=<encoding>

いいえ

ターゲット・ファイルのエンコーディング。デフォルト値はISO8859_1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-EXPORT_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注15

Yesに設定した場合、オブジェクトのエクスポート時にその機密(暗号)値をnullに設定する必要があります。Noに設定した場合、またはこのパラメータを省略した場合は、-EXPORT_KEYパラメータを追加して、有効なキーを指定する必要があります。デフォルト値は「いいえ」です。

脚注14

-EXPORT_KEYパラメータを指定しない場合は、-EXPORT_WITHOUT_CIPHER_DATAパラメータを指定して、Yesに設定する必要があります。

脚注15

-EXPORT_WITHOUT_CIPHER_DATAを指定しない場合、または指定してNoに設定した場合は、-EXPORT_KEYパラメータを有効なキー値とともに指定する必要があります。

例

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

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

OdiExportWork

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

使用方法

OdiExportWork -TODIR=<directory> [-ZIPFILE_NAME=<zipFileName>]
[-EXPORT_KEY=<key>] [-XML_CHARSET=<charset>] [-JAVA_CHARSET=<charset>]
[EXPORT_WITHOUT_CIPHER_DATA=<yes|no>]

パラメータ

パラメータ 必須 説明

-TODIR=<directory>

はい

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

-ZIPFILE_NAME=<zipFileName>

いいえ

圧縮ファイルの名前。

-EXPORT_KEY=<key>

いいえ脚注16

機密的な暗号データを暗号化するために使用される暗号秘密キーを指定します。暗号データをインポートするためにエクスポート済オブジェクトをインポートするときに、このキーを再指定する必要があります。

-XML_CHARSET=<charset>

いいえ

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

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

結果ファイルのJava文字エンコーディング。デフォルト値はISO8859_1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-EXPORT_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注17

Yesに設定した場合、オブジェクトのエクスポート時にその機密(暗号)値をnullに設定する必要があります。Noに設定した場合、またはこのパラメータを省略した場合は、-EXPORT_KEYパラメータを追加して、有効なキーを指定する必要があります。デフォルト値は「いいえ」です。

脚注16

-EXPORT_KEYパラメータを指定しない場合は、-EXPORT_WITHOUT_CIPHER_DATAパラメータを指定して、Yesに設定する必要があります。

脚注17

-EXPORT_WITHOUT_CIPHER_DATAを指定しない場合、または指定してNoに設定した場合は、-EXPORT_KEYパラメータを有効なキー値とともに指定する必要があります。

例

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

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

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>

いいえ

ターゲット・ファイルがすでに存在する場合に上書きするかどうかを示します。デフォルト値は「いいえ」です。

-CASESENS=<yes|no>

いいえ

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

-HEADER=<n>

いいえ

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

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

-KEEP_FIRST_HEADER=<yes|no>

いいえ

連結時に最初のファイルのヘッダー行を維持します。デフォルト値はYesです。

例

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

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

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省略時は、はい

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

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

ディレクトリの場所は常に、論理スキーマのデータ・スキーマ・ディレクトリを基準とする必要があります。

-FILE=<file>

-DIR省略時は、はい

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

例:

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

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

ファイルの場所は常に、論理スキーマのデータ・スキーマ・ディレクトリを基準とする必要があります。

-RECURSE=<yes|no>

いいえ

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

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

デフォルト値はYesです。

-CASESENS=<yes|no>

いいえ

Oracle Data Integratorがファイル名を照合する際に、大文字と小文字を区別するかどうかを指定します。デフォルト値は「いいえ」です。

-NOFILE_ERROR=<yes|no>

はい

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

-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

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は無視されます。

-SRC_LSCHEMA=<source_file>

いいえ

論理スキーマ値に基づいてデータ・サーバー上に配置されているファイル。たとえば、論理スキーマはデータ・サーバーを指示している可能性があります。ファイルをHDFSからアクセスする必要がある場合、このツールは、このデータ・サーバーからファイルにアクセスします。

-TGT_LSCHEMA=<target_file>

いいえ

論理スキーマ値に基づいてデータ・サーバー上に配置されているファイル。たとえば、論理スキーマはデータ・サーバーを指示している可能性があります。ファイルをHDFSからアクセスする必要がある場合、このツールは、このデータ・サーバーからファイルにアクセスします。

-OVERWRITE=<yes|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

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>

いいえ

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

-RECURSE=<yes|no>

いいえ

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

-CASESENS=<yes|no>

いいえ

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

例

hostsというファイルの名前を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

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>

いいえ

宛先ファイルが存在する場合に、そのファイルを上書きするかどうかを示します。デフォルト値は「いいえ」です。

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

-CASESENS=<yes|no>

いいえ

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

-FILECOUNT=<n>

いいえ

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

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

このパラメータが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

OdiFtp

このコマンドを使用して、FTPプロトコルでリモート・システムに接続し、リモート・システムで標準FTPコマンドを実行します。スクリプトからのトレースは、オペレータ・ナビゲータのOdiFtpステップを表すタスクの実行詳細に対して記録されます。

使用方法

OdiFtp -HOST=<ftp server host name> -USER=<ftp user>
[-PASSWORD=<ftp user password>] -REMOTE_DIR=<remote dir on ftp host>
-LOCAL_DIR=<local dir> [-PASSIVE_MODE=<yes|no>] [-TIMEOUT=<time in seconds>]
[-STOP_ON_FTP_ERROR=<yes|no>] -COMMAND=<command>

パラメータ

パラメータ 必須 説明

-HOST=<ftp server host name>

はい

FTPサーバーのホスト名。

-USER=<ftp user>

はい

FTPサーバーのユーザー。

-PASSWORD=<ftp user password>

いいえ

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

-REMOTE_DIR=<remote dir on ftp host>

はい

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

-LOCAL_DIR=<local dir>

はい

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

-PASSIVE_MODE=<yes|no>

いいえ

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

-TIMEOUT=<time in seconds>

いいえ

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

-STOP_ON_FTP_ERROR=<yes|no>

いいえ

Yes (デフォルト)に設定すると、FTPエラーが発生した場合、ステップが完了まで実行されるのではなく停止されます。

-COMMAND=<command>

はい

実行するraw FTPコマンド。複数行コマンドの場合は、OdiFtp行の後に-COMMANDパラメータを指定せずに、コマンド全体をrawテキストとして渡します。

サポートされるコマンド:

APPE、CDUP、CWD、DELE、LIST、MKD、NLST、PWD、QUIT、RETR、RMD、RNFR、RNTO、SIZE、STOR

例

リモート・ホスト上で、ディレクトリを作成し、そのディレクトリに移動し、ファイルをそのディレクトリに配置し、そのサイズをチェックするスクリプトを実行します。スクリプトにより別のファイルが追加され、新しいサイズがチェックされ、そのファイルの名前がdailyData.csvに変更されます。ディレクトリが存在する場合でもスクリプトが続行されるように、-STOP_ON_FTP_ERRORパラメータがNoに設定されています。 

OdiFtp -HOST=machine.example.com -USER=odiftpuser -PASSWORD=<password>
-LOCAL_DIR=/tmp -REMOTE_DIR=c:\temp -PASSIVE_MODE=YES -STOP_ON_FTP_ERROR=No
MKD dataDir
CWD dataDir
STOR customers.csv
SIZE customers.csv
APPE new_customers.csv customers.csv
SIZE customers.csv
RNFR customers.csv
RNTO dailyData.csv

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>]

ノート:

ローカルまたはリモートのファイル名の一部として%が必要な場合は、%だけではなく%25を渡す必要があります。

%25は自動的に%に解決されます。

たとえば、ファイル名をtemp%resultにする必要がある場合、REMOTE_FILE=temp%25resultまたは-LOCAL_FILE=temp%25resultとして渡す必要があります。

パラメータ

パラメータ 必須 説明

-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 the 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=<yes|no>]

いいえ

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

-TIMEOUT=<time in seconds>

いいえ

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

-TGT_LSCHEMA=<target_file>

いいえ

論理スキーマ値に基づいて解決されたデータ・サーバー上に配置されているファイル。たとえば、LSCHEMAはデータ・サーバーを指示している可能性があります。このツールは、このデータ・サーバーからファイルにアクセスします。

例

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

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

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

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

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>]

ノート:

ローカルまたはリモートのファイル名の一部として%が必要な場合は、%だけではなく%25を渡す必要があります。

%25は自動的に%に解決されます。

たとえば、ファイル名をtemp%resultにする必要がある場合、REMOTE_FILE=temp%25resultまたは-LOCAL_FILE=temp%25resultとして渡す必要があります。

パラメータ

パラメータ 必須 説明

-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 the 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=<yes|no>

いいえ

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

-TIMEOUT=<time in seconds>

いいえ

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

ノート:

OdiFtp実行を正常に完了するためには、ユーザーのホーム・ディレクトリ内にLIST権限を持っている必要があります。

例

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

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

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

OdiFtpPut -HOST=machine.example.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.example.com -USER=test_ftp -PASSWORD=<password> -LOCAL_DIR=C:\temp -LOCAL_FILE=Sales1.txt -REMOTE_DIR=/Sample1.txt

OdiGenerateAllScen

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

使用方法

OdiGenerateAllScen -PROJECT=<project_id> [-FOLDER=<folder_id>]
[-MODE=<REPLACE|REGENERATE|CREATE>] [-GRPMARKER=<marker_group_code>
[-MARKER=<marker_code>] [-MATERIALIZED=<yes|no>]
[-GENERATE_MAP=<yes|no>] [-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|REGENERATE|CREATE>

いいえ

シナリオ生成モード:

  • REPLACE(デフォルト): オブジェクトごとに、最終バージョンのシナリオを、同じ内部ID、名前およびバージョンの新しいシナリオで上書きします。セッション、シナリオ・レポートおよびスケジュールは削除されます。

    オブジェクトに対するシナリオが存在していない場合は、バージョン番号001のシナリオが作成されます。

  • REGENERATE: オブジェクトごとに、最終バージョンのシナリオを、同じ内部ID、名前およびバージョンの新しいシナリオで上書きします。スケジュール、セッション、シナリオ・レポート、変数選択および同時実行制御設定が保持されます。

    オブジェクトに対するシナリオが存在していない場合、このモードではシナリオは作成されません。

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

    オブジェクトに対するシナリオが存在していない場合は、オブジェクト名に基づいて命名されたバージョン番号001のシナリオが作成されます。

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

-GRPMARKER=<marker_group_code>

いいえ

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

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

-MARKER=<marker_code>

いいえ

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

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

-MATERIALIZED=<yes|no>

いいえ

すべての下層オブジェクトがマテリアライズされるものとしてシナリオを生成するかどうかを指定します。デフォルト値は「いいえ」です。

-GENERATE_MAP=<yes|no>

いいえ

マッピングからシナリオを生成するかどうかを指定します。デフォルト値は「いいえ」です。

-GENERATE_PACK=<yes|no>

いいえ

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

-GENERATE_POP=<yes|no>

いいえ

マッピングに関連付けられているシナリオを(再)生成するかどうかを指定します。デフォルト値は「いいえ」です。

-GENERATE_TRT=<yes|no>

いいえ

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

-GENERATE_VAR=<yes|no>

いいえ

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

例

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

OdiGenerateAllScen -PROJECT=1003

OdiImportObject

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

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

警告:

インポート・タイプと、オブジェクトをリポジトリにインポートする順序は、慎重に指定してください。インポートの詳細は、『Oracle Data Integratorでの統合プロジェクトの開発』の「エクスポートおよびインポート」を参照してください。

使用方法

OdiImportObject -FILE_NAME=<FileName> [-WORK_REP_NAME=<workRepositoryName>]
[-IMPORT_MODE=<DUPLICATION|SYNONYM_INSERT|SYNONYM_UPDATE|SYNONYM_INSERT_UPDATE>]
[-EXPORT_KEY=<key>] [-UPGRADE_KEY=<upgradeKey>]
[IMPORT_WITHOUT_CIPHER_DATA=<yes|no>]

パラメータ

パラメータ 必須 説明

-FILE_NAME=<FileName>

はい

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

-WORK_REP_NAME=<workRepositoryName>

いいえ

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

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

はい

オブジェクトのインポート・モード。デフォルト値はDUPLICATIONです。インポート・タイプの詳細は、『Oracle Data Integratorでの統合プロジェクトの開発』のインポート・モードに関する項を参照してください。

-EXPORT_KEY=<key>

いいえ脚注18

機密的な暗号データを暗号化するために使用される暗号秘密キーを指定します。暗号データをインポートするためにエクスポート済オブジェクトをインポートするときに、このキーを指定する必要があります。

-UPGRADE_KEY=<upgradeKey>

いいえ

旧バージョン(12c以前)のOracle Data Integratorからリポジトリ・オブジェクトをインポートするためのアップグレード・キー。

-IMPORT_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注19

Yesに設定した場合、オブジェクトのインポート時にその機密(暗号)値をnullに設定する必要があります。Noに設定した場合、またはこのパラメータを省略した場合は、-EXPORT_KEYパラメータを追加して、有効なキーを指定する必要があります。デフォルト値は「いいえ」です。

脚注18

-EXPORT_KEYパラメータを指定しない場合は、-IMPORT_WITHOUT_CIPHER_DATAパラメータを指定して、Yesに設定する必要があります。

脚注19

-EXPORT_WITHOUT_CIPHER_DATAを指定しない場合、または指定してNoに設定した場合は、-EXPORT_KEYパラメータを有効なキー値とともに指定する必要があります。

例

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

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

OdiImportScen

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

使用方法

OdiImportScen -FILE_NAME=<FileName>
[-IMPORT_MODE=<DUPLICATION|SYNONYM_INSERT|SYNONYM_UPDATE|SYNONYM_INSERT_UPDATE>]
[-EXPORT_KEY=<key>] [-IMPORT_SCHEDULE=<yes|no>] [-FOLDER=<parentFolderGlobalId>]
[-UPGRADE_KEY=<upgradeKey>] [IMPORT_WITHOUT_CIPHER_DATA=<yes|no>]

パラメータ

パラメータ 必須 説明

-FILE_NAME=<FileName>

はい

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

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

いいえ

シナリオのインポート・モード。デフォルト値はDUPLICATIONです。インポート・タイプの詳細は、『Oracle Data Integratorでの統合プロジェクトの開発』のインポート・モードに関する項を参照してください。

-EXPORT_KEY=<key>

いいえ脚注20

機密的な暗号データを暗号化するために使用される暗号秘密キーを指定します。暗号データをインポートするためにエクスポート済オブジェクトをインポートするときに、このキーを指定する必要があります。

-IMPORT_SCHEDULE=<yes|no>

いいえ

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

-FOLDER=<parentFolderGlobalId>

いいえ

親シナリオ・フォルダのグローバルID。このパラメータはインポート・モードがDUPLICATIONに設定されている場合にのみ使用します。OdiImportScenコマンドはインポート・モードがDUPLICATIONの場合にのみ検索して親を変更するために、これは他のインポート・モードの場合はすべて無視されます。

-UPGRADE_KEY=<upgradeKey>

いいえ

旧バージョン(12c以前)のOracle Data Integratorからリポジトリ・オブジェクトをインポートするためのアップグレード・キー。

-IMPORT_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注21

Yesに設定した場合、オブジェクトのインポート時にその機密(暗号)値をnullに設定する必要があります。Noに設定した場合、またはこのパラメータを省略した場合は、-EXPORT_KEYパラメータを追加して、有効なキーを指定する必要があります。デフォルト値は「いいえ」です。

脚注20

-EXPORT_KEYパラメータを指定しない場合は、-IMPORT_WITHOUT_CIPHER_DATAパラメータを指定して、Yesに設定する必要があります。

脚注21

-IMPORT_WITHOUT_CIPHER_DATAを指定しない場合、または指定してNoに設定した場合は、-EXPORT_KEYパラメータを有効なキー値とともに指定する必要があります。

例

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

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

OdiInvokeRESTfulService

InvokeRESTfulServiceツールは、ODIからRESTサービスを呼び出すときに使用します。サービスに送信するリクエストはリクエスト・ファイルで送信するか、またはツール・コマンド(<RequestBody>)で直接指定できます。RESTfulサービス・リクエストのレスポンスはファイルにフィードされ、これをOracle Data Integratorで使用できます。このツールはマルチパートのリクエストもサポートしているため、パラメータを使用してマルチパート本文のパートの詳細を指定できます。

このツールはREST URLを直接的には受け入れません。そのかわりとして、このツールではRESTデータ・サーバーおよび呼び出す操作を受け入れて、そこからREST URLを導出しRESTを呼び出します。REST操作とデータ・サーバーの詳細および、これらをODI StudioのUIを使用して定義する方法の詳細は、RESTデータ・サーバーおよびStudio UIのドキュメントを参照してください。

InvokeRESTfulServiceツールには2つの重要な機能があります。

  • ページ区切り型の呼出し— RESTサービスの中には、1回のサービス呼出しで取得できるデータ(またはレコード)の最大量が制限されるものがあります。そのようなサービスはリクエストのレスポンスが複数のページで返されるため、レスポンスが後続のページにも及ぶことがあります。そのようなサービスを呼び出して、すべてのレスポンスを1回のツール呼び出しでフェッチするように、ツールを構成できます。ページ区切り関連のツール・パラメータを指定すると、ツール内部で各ページに対して呼び出しが繰り返し実行され、すべてのレスポンスがフェッチされます。

  • チャンク・アップロードのサポート — RESTサービスの中には、1回の呼出しでアップロードできるデータ量が制限されるものがあります。このようなサービスではチャンクでのデータのアップロードがサポートされます。このRESTツールでは、そのようなチャンク・アップロード操作を1回のツール呼び出しで実行します。

ツールは指定されたパラメータに基づいて、通常、チャンク型、ページ区切り型のどのタイプの呼出しであるのかを判断します。

使用方法

このコマンドは、ODIからRestfulサービスを呼び出す場合に使用します。 

OdiInvokeRESTfulService [-CONTEXT=<ODI_Context>] 
-LSCHEMA=<Logical_Schema> [-REQUEST_BODY_FILE=<Request_File> | 
-REQUEST_BODY=<RequestBody> | <RequestBody>] [-
REQUEST_HDFS_LSCHEMA=<Request_HDFS_Logical_Schema>] [-
CHUNK_SIZE=<Chunk_Size>] [-CHUNK_PREFIX=<Chunk_Prefix>][-
PRE_OPERATION=<Pre_Operation>] [-
PRE_OPERATION_BODY=<Pre_Operation_Body>] -OPERATION=<Rest Operation> 
[-POST_OPERATION=<Post_Operation>] [-
POST_OPERATION_BODY=<Post_Operation_Body>] [-HEADER.<name>=<value>]* 
[-HEADER_IGNORE_DEFAULT=<YES|NO>] [-
REQUEST_BODY_PART_NAME=<Body_Part_Name> & -
REQUEST_BODY_PART_CONTENT_TYPE=<Body_Part_Content_Type> & -
REQUEST_BODY_PART_VALUE=<Body Part Value>]* [[-
REQUEST_QUERY.name=<value>]* | -
ENCODED_REQUEST_QUERY_STRING=<Encoded_Request_Query_String>] [-
REQUEST_QUERY_IGNORE_DEFAULT=<YES|NO>]  [-
REQUEST_TEMPLATE.<Variable_Name>=<Variable_Value>]*  [-
REQUEST_TEMPLATE_IGNORE_DEFAULT=<YES|NO>] [-
RESPONSE_FILE=<Response_File>] [-RESPONSE_HDFS_LSCHEMA=<Response HDFS 
LSchema>][-RESPONSE_MODE=<NEW_FILE|FILE_APPEND>] [-
RESPONSE_FILE_CHARSET=<javaCharset>][-TIMEOUT=<timeout>] [-
RETRY_COUNT=<Retry_Count>] [-RETRY_INTERVAL=<Retry_Interval>] [-
FAILURE_STATUS_CODES=<Failure Status codes>] [-
TRACE_FILE=<Trace_File>] [-TRACE_FILE_MODE=<NEW_FILE|FILE_APPEND>] [-
NEXT_REQUEST_RESOLVER=<Next_Request_Resolver>] [-
TOTAL_COUNT_FIELD_RESOLVER=<Total_Count_Field_Resolver>] [-
RESOLVER_OVERWRITE_CLASS=<Resolver_Overwrite_Class>] [-
RESPONSE_DATA_CONTAINER=<Response_Data_Container>]
[<RequestBody>]

パラメータ

パラメータ 必須 説明

CONTEXT

いいえ

ODIコンテキスト。指定しなかった場合、呼出し側セッションのコンテキストで実行されます。

LSCHEMA

はい

RESTデータ・ソースに構成された論理スキーマ。

REQUEST_BODY_FILE

いいえ

リクエスト本文が含まれているファイルの名前。リクエスト本文はツール呼出しの後続の行で(<RequestBody>)直接指定するか、または、これをパラメータとして使用せずに–REQUEST_BODYの値として指定することもできます。すべてが指定されている場合、-REQUEST_BODY_FILEパラメータが考慮されます。マルチパート・リクエストの場合、このパラメータは無視されます。

REQUEST_BODY

いいえ

リクエスト本文をこのパラメータで指定できます。詳細は、REQUEST_BODY_FILEおよび<RequestBody>パラメータを参照してください。

REQUEST_HDFS_LSCHEMA

いいえ

リクエスト・ファイルのHDFSファイル構成。リクエスト本文がHDFS形式のファイルである場合にのみ適用されます。この構成は、ファイル形式のマルチパート本文コンテンツの場合に適用されます。

CHUNK_SIZE

いいえ

REQUEST_BODY_FILEパラメータで指定された入力ファイルは、ここで指定したサイズのチャンクに分割されます。これらのファイルは一時ディレクトリに作成されます。たとえば、入力ファイル名がdata.txtである場合、チャンク名はdata-a、data-b、..data-aa、data-ab、..、data-aaa、data-aabのようになります。

このツールでは現在考慮されているチャンクに応じて、チャンクに関連付けられた次の実行時テンプレートを保持します。
odi.CHUNK_PATH
odi.CHUNK_NAME
odi.CHUNK_SIZE
odi.CHUNK_INDEX
このパラメータが存在する場合、そのツール呼出しはチャンク・アップロードです。

CHUNK_PREFIX

いいえ

REQUEST_BODY_FILEパラメータでディレクトリ・パスを指定した場合、そのディレクトリ内にある、この接頭辞で始まるすべてのファイルがチャンク・ファイルであると見なされます。

REQUEST_BODY_FILEパラメータが実際の入力ファイルを指し示している場合、この接頭辞を使用してチャンク・ファイル名が構築されます。たとえば、"segment_"という値を指定した場合、チャンク・ファイルの名前はsegment_a、segment_b、segment_c…..、segment_aa、segment_ab…..、segment_aaaのようになります。指定しなかった場合で、REQUEST_BODY_FILEパラメータに実際の入力ファイルのパスが含まれている場合は、入力ファイルの名前が接頭辞として使用されます。たとえば、入力ファイルの名前がdata.txtの場合、"data"が接頭辞になります。これは、チャンク・ファイルの作成時の実行テンプレートodi.CHUNK_PREFIXの値としても使用されます。この接頭辞パラメータを指定しなかった場合で、REQUEST_BODY_FILEパラメータがディレクトリを指し示している場合、ディレクトリ内のすべてのファイル・コンテンツがアップロード対象のチャンク・ファイルであると見なされます。

このパラメータが存在する場合、そのツール呼出しはチャンク・アップロードです。

PRE_OPERATION

いいえ

物理スキーマで定義されているREST操作。指定した場合、この操作が最初に呼び出される操作となり、この操作が一度のみ呼び出されます。この操作では、RESTリクエストの呼出し中にHEADER、REQUEST_QUERY、ENCODEDおよびREQUEST_TEMPLATEのツール・パラメータが考慮されません。

PRE_OPERATION_BODY

いいえ

これは、PRE_OPERATIONの呼出しのリクエスト本文を指定する場合に使用します。ファイル・パスまたは実行時テンプレート{odi.CHUNK_PATH}を指定できます。ファイル・パス(HDFSまたはローカル)を指定した場合、この操作の呼出し時にそのパスがリクエスト本文として追加されます。

実行時テンプレート{odi.CHUNK_PATH}を指定した場合、最初のチャンク・ファイルに対応する値が次の実行時テンプレートに割り当てられます。

  • odi.CHUNK_PATH — 最初のチャンクのパスを取得します。

  • odi.CHUNK_NAME — 最初のチャンク・ファイルの名前。

  • odi.CHUNK_SIZE — 最初のチャンク・ファイルのサイズ。

  • odi.CHUNK_INDEX — 0 (最初のチャンクの索引)

REQUEST_BODY_PART_VALUEパラメータが指定されている場合、このチャンクはマルチパート本文の1つのパートしてアップロードされます。そうでない場合は、このチャンク・ファイルがリクエスト本文に設定されます。このパラメータを指定しなかった場合、PRE_OPERATIONはリクエスト本文なしで呼び出されます。

OPERATION

はい

物理スキーマで定義されているREST操作。これがメインの操作です。メイン操作は必須です。指定した場合、PRE_OPERATIONで指定された操作が呼び出された後に、この操作が呼び出され、その後にPOST_OPERATIONで指定された操作が呼び出されます。繰り返し呼び出される可能性がある操作は、この操作のみです。この操作が複数回呼び出される可能性があるのは、チャンク・アップロード型の呼出しまたはページ区切りの呼出しの場合のみです。

チャンク・アップロードの呼出しの場合、各チャンク・ファイルについて操作がループ形式で呼び出されます。最初のチャンクがPRE_OPERATION (PRE_OPERATION_BODYパラメータを参照)によってアップロードされる場合、最初のチャンクに対してこの操作は呼び出されません。同様に、最後のチャンクがPOST_OPERATION (POST_OPERATION_BODYパラメータを参照)でアップロードされる場合は、最後のチャンクに対してこの操作は呼び出されません。

たとえば: - 合計で10個のチャンクが作成または特定されていて、PRE_OPERATION_BODY = {odi.CHUNK_PATH}、POST_OPERATION_BODY = {odi.CHUNK_PATH}の場合、OPERATIONパラメータで指定された操作は8回実行されます。

この操作がi thチャンクに対して呼び出されたとき、この操作の実行時テンプレートは次の値に置換されます。

  • odi.CHUNK_PATH— i th チャンクのパスを示します。

  • odi.CHUNK_NAME — i thチャンクの名前を示します。

  • odi.CHUNK_SIZE — i thチャンクのサイズを示します。

  • odi.CHUNK_INDEX — (i-1)を表します。索引は0から始まるためです。

POST_OPERATION

いいえ

物理スキーマで定義されているREST操作。指定した場合、この操作が最後に呼び出される操作となり、この操作が一度のみ呼び出されます。この操作では、RESTリクエストの呼出し中にHEADER、REQUEST_QUERY、ENCODED、REQUEST_TEMPLATEなどのパラメータが考慮されません。

POST_OPERATION_BODY

いいえ

これは、POST_OPERATIONの呼出しのリクエスト本文を指定する場合に使用します。ファイル・パスまたは実行時テンプレート{odi.CHUNK_PATH}を指定できます。ファイル・パス(HDFSまたはローカル)を指定した場合、この操作の呼出し時にそのパスがリクエスト本文として追加されます。実行テンプレート{odi.CHUNK_PATH}を指定した場合、odi.CHUNK_PATHに最後のチャンクのパスが渡され、さらに次の実行時テンプレートには最後のチャンク・ファイルに対応する値が割り当てられます。

  • odi.CHUNK_NAME — 最後のチャンク・ファイルの名前を示します。

  • odi.CHUNK_SIZE — 最後のチャンク・ファイルのサイズを示します。

  • odi.CHUNK_INDEX — 0 (最後のチャンクの索引)

REQUEST_BODY_PART_VALUEパラメータが指定されている場合、このチャンクはマルチパート本文の1つのパートしてアップロードされます。そうでない場合は、このチャンク・ファイルがリクエスト本文に設定されます。このパラメータを指定しなかった場合、このPOST_OPERATIONはリクエスト本文なしで呼び出されます。

HEADER

いいえ

RESTサービスを呼び出すときに使用されるhttpヘッダー。ツールの呼出し中に、次のように複数のヘッダーを渡すこともできます。

-HEADER.Content-Type=application/text –HEADER.Authorization=DAD9AFFA34D5==

HEADER_IGNORE_DEFAULT=YES/NO

いいえ

これは、OPERATIONパラメータで指定されたメイン操作の呼出し時にのみ適用されます。物理スキーマで定義されているヘッダーを無視するか否かを示すフラグです。"Yes"を選択した場合、メイン操作から呼出しリクエストが作成されるときに、物理スキーマ操作で定義されているヘッダーが無視されます。"No"を選択した場合、物理スキーマ操作で定義されているヘッダーと、ツールのHEADERパラメータで指定されたヘッダーがマージされます。両者が矛盾する場合は、物理スキーマで定義されているパラメータよりもHEADERパラメータが優先されます。

デフォルト値は"NO"です。

REQUEST_BODY_PART_NAME

いいえ

これはマルチパート・コンテンツの名前を指定する場合に使用します。このパラメータは-REQUEST_BODY_PART_VALUEと-REQUEST_BODY_PART_CONTENT_TYPEパラメータとともに指定します。マルチパート・フィールドが指定されていて、ユーザーがヘッダーにマルチパート・コンテンツを明示的に指定していない場合、デフォルトでHeader.ContentTypeが"multipart-mixed"に設定されます。マルチパート・リクエストの場合、-REQUEST_BODY_FILEおよび<RequestBody>は無視されます。

REQUEST_BODY_PART_CONTENT_TYPE

いいえ

これはマルチパート・コンテンツのコンテンツ・タイプを指定する場合に使用します。本文パートの各コンテンツについて繰り返しが可能です。

次に、簡単な呼出しを示します。
OdiInvokeRESTfulService "-CONTEXT=GLOBAL" "-LSCHEMA=LSchema" "-OPERATION=PostOperationWithMultipartBody""-
HEADER.Content-Type=multipart/mixed" "-REQUEST_BODY_PART_NAME=empDataAsXml""-
REQUEST_BODY_PART_NAME=empDataAsJson" "-REQUEST_BODY_PART_VALUE=/path/employee.xml" "-
REQUEST_BODY_PART_VALUE=/path/employee.json" "-REQUEST_BODY_PART_CONTENT_TYPE=application/xml" "-
REQUEST_BODY_PART_CONTENT_TYPE=application/json"
ここでは、マルチパート本文の中に、XMLとJSONの2つの本文パートがあります。

REQUEST_BODY_PART_VALUE

いいえ

このパラメータがある場合、リクエストにマルチパート・コンテンツがあるものと見なされます。このパラメータは、本文パートの値を指定する場合に使用します。ファイル・パスまたは値を指定できます。対応する本文パートのコンテンツ・タイプ値が-REQUEST_BODY_PART_CONTENT_TYPE = "none"の場合、値はテキストとして処理され、それ以外の場合はファイル・パスとして処理されます。実行テンプレート{odi.CHUNK_PATH}も指定できます。

REQUEST_QUERY

いいえ

このパラメータは、REST URL.に付加する問合せパラメータを渡す場合に使用します。

ノート:

問合せパラメータ値の形式はプレーン・テキストです(URIエンコーディングされていない)。

たとえば :

  • -REQUEST_QUERY.userId={userId}

  • -REQUEST_QUERY.appId=1324

  • -REQUEST_QUERY.loginKey={loginId}

これらのパラメータは、-ENCODED_REQUEST_QUERY_STRINGが指定されている場合は無視されます。

ENCODED_REQUEST_QUERY_STRING

いいえ

リクエスト問合せパラメータの別の指定方法を指定します。このパラメータを使用すると、–REQUEST_QUERYパラメータの繰り返しを回避できます。エンコーディングされた値を使用する必要があります。値を供給する-REQUEST_TEMPLATEとともに使用できます。

userId={userId}&appId=1234

このパラメータを指定した場合、すべての–REQUEST_QUERYパラメータが無視されます。

REQUEST_QUERY_IGNORE_DEFAULT

いいえ

これは、OPERATIONパラメータで指定されるメイン操作の初期化時にのみ適用されます。物理スキーマで定義されたリクエスト問合せを無視するか否かを示すフラグです。"Yes"を選択した場合、メイン操作から呼出しリクエストを作成するときに、物理スキーマ操作で定義されているリクエスト問合せが無視されます。"No"を選択した場合、物理スキーマ操作で定義されているリクエスト問合せと、ツールのREQUEST_QUERYパラメータで指定されたリクエスト問合せがマージされます。両者が矛盾する場合は、物理スキーマで定義されているパラメータよりもREQUEST_QUERYパラメータが優先されます。

デフォルト値は"NO"です。

REQUEST_TEMPLATE

いいえ

ユーザーが指定する標準のテンプレートです。これは、RESTリソース・パスやヘッダー・パラメータ、問合せパラメータ(-REQUEST_QUERY |-ENCODED_REQUEST_QUERY_STRINGで指定される)に含まれるテンプレート変数(中カッコで囲まれた値)を置換する場合に使用します。

たとえば:

  • -REQUEST_TEMPLATE.userId=#GLOBAL.USER_ID

  • -REQUEST_TEMPLATE.loginId=test

  • -REQUEST_TEMPLATE.pwd=#GLOBAL.MY_REST_PWD

REQUEST_TEMPLATE_IGNORE_DEFAULT

いいえ

これは、OPERATIONパラメータで指定されたメイン操作の呼出し時にのみ適用されます。物理スキーマで定義されたリクエスト・テンプレートを無視するか否かを示すフラグです。"Yes"を選択した場合、メイン操作から呼出しリクエストを作成するときに、物理スキーマ操作で定義されているリクエスト・テンプレートが無視されます。"No"を選択した場合、物理スキーマ操作で定義されているリクエスト・テンプレートと、ツールのREQUEST_TEMPLATEパラメータで指定されたリクエスト問合せがマージされます。両者が矛盾する場合は、物理スキーマで定義されているパラメータよりもREQUEST_TEMPLATEパラメータが優先されます。

デフォルト値は"NO"です。

RESPONSE_FILE

いいえ

このパラメータで、REST呼出しのレスポンスを書き込むファイルの名前を指定します。このパラメータを指定しなかった場合、REST呼出しでレスポンスが生成された場合に、レスポンスが破棄されます。

RESPONSE_HDFS_LSCHEMA

いいえ

このパラメータはレスポンス・ファイルのHDFSファイル構成を示します。これはレスポンス・ファイルがHDFSで作成されるときに適用されます。

APPEND_RESPONSE

いいえ

RESPONSE_FILEパラメータが指定されていない場合は、無視されます。"NO"を指定した場合、レスポンスを格納するファイルが常に新規作成されます。"Yes"を指定した場合、レスポンスは既存のレスポンス・ファイル(存在する場合)に追加されます。存在しない場合、新しいレスポンス・ファイルが作成されます。

デフォルト値は"NO"です。

RESPONSE_FILE_CHARSET

いいえ

このパラメータは、RESTサービスから文字データのレスポンスが返される場合にのみ適用されます。この文字データがレスポンス・ファイルに書き込まれるときに、このエンコーディングが使用されます。RESTレスポンスがバイナリ・ファイルである場合は、このパラメータは指定しないでください。

TIMEOUT

いいえ

サーバーからのレスポンスをRESTサービス呼出しに待機させる時間(ミリ秒単位)を指定します。この時間を超えた場合、サーバーからレスポンスが返らないと見なされ、エラーが生成されます。値を指定しなかった場合、無限の待機時間を表すことになり、呼出しでタイムアウトは発生しません。

RETRY_COUNT

いいえ

このパラメータでは、タイムアウトなど、ネットワーク関連の問題が原因でRESTサービスにアクセスできなかった場合に、RESTツールでRESTへのアクセスを何度試みるかを指定します。

デフォルト値は3です。

RETRY_INTERVAL

いいえ

このパラメータは再試行の実行間隔(ミリ秒)を指定します。

デフォルト値は10000です。

FAILURE_STATUS_CODES

いいえ

このパラメータには障害を示すステータス・コードをカンマ区切り値で指定します。REST呼出しからこれらのステータス・コードが渡されると、ツールの実行が停止され、ツールからエラーが生成されます。

たとえば"-FAILURE_STATUS_CODE=403,404"

TRACE_FILE

いいえ

入手したすべてのレスポンス・ステータスとヘッダー情報は、デバッグ用としてこのファイルに書き込まれます。

APPEND_TRACE

いいえ

TRACE_FILEパラメータが指定されていない場合、このパラメータは無視されます。"NO"を指定した場合、トレース情報を格納するファイルが常に新規作成されます。"Yes"を指定した場合、トレース情報は既存のトレース・ファイル(存在する場合)に追加されます。存在しない場合、新しいファイルが作成されます。

デフォルト値は"NO"です。

NEXT_REQUEST_RESOLVER

いいえ

Xpath式、JSONPath式、ヘッダー名、リンク・ヘッダー関係または正の数値式(ページ・サイズを示す)を格納できます。値がXpath式またはJSONPath式である場合は、これがレスポンス・データに適用され、HTTP URLまたは文字列値の値を取得します。解決された値が完全なREST URLである場合は、実行時テンプレートodi.OPERATION_URL_OVERRIDEの値として設定されます。解決された値がURLでない場合は、実行時テンプレートodi.PAGE_TOKEN (ページ区切り呼出し)またはodi.UPLOAD_ID (チャンク・アップロード呼出し)の値として設定されます。

たとえば — 
JsonPath : - $.account.container[0].name
Xpath - /account/container[1]/name/text()

値が数値(ページ・サイズ)である場合、ページ・オフセットの増分値としてこの値が使用されます。ページ・オフセットの開始値は0です。新しいページ・オフセット値が実行時テンプレートodi.PAGE_TOKENに設定されます。この実行時テンプレートが必須問合せパラメータの値である操作を定義できます。

値が文字列である場合、レスポンス・ヘッダー・キーまたはリンク・ヘッダー関係として処理されます。まず、レスポンス・ヘッダーにそのヘッダー・キーが含まれているかの確認が行われます。レスポンス・ヘッダーでヘッダー・キーが見つからない場合は、リンク・ヘッダーであると見なされます。RESTレスポンス内のリンク・ヘッダーが解析され、関係値を基に次ページのリンクが特定されます。使用できるリンク・ヘッダー関係の値はnextやnext pageなどです。数値のリンク・ヘッダー関係はツールでサポートされません。次ページのURLが特定されると、実行時テンプレートodi.OPERATION_URL_OVERRIDEに設定されます。

たとえば — GitHub REST APIが次ページURL情報をリンク・ヘッダーhttps://developer.github.com/guides/traversing-with-pagination/で指定します。

NEXT_REQUEST_RESOLVERパラメータに、解決できないXpath式やJSONPath式またはリンク・ヘッダー関係が格納されている場合、またはnullまたは空(0、""、"null"など)を表す値を示している場合、最後の結果(最終ページ)として処理されます。

ノート:

実行時テンプレートodi.OPERATION_URL_OVERRIDEが設定されると、任意の操作が初期化されたときに、操作で定義されているリソース・パスがこの値でオーバーライドされます。たとえば: - PRE_OPERATIONが呼び出されてこの実行時テンプレートが設定されると、OPERATIONおよびPOST_OPERATIONはこの値をリソース・パスとして使用します。これらの操作で定義されているリソース・パスは無視されます。

TOTAL_COUNT_FIELD_RESOLVER

いいえ

このパラメータはページ区切り型の呼出しで使用されます。ページ区切り型レスポンス内に合計レコード数が存在する場合、Xpath式またはJsonPath式を指定して合計レコード数をRESTレスポンスから抽出する必要があります。この合計値を各ページ区切り型レスポンスから読み取り、その値が新たに算出したページ・オフセット値よりも小さいかどうかをチェックします。指定した場合、この値を使用して最後のページが特定されます(終了条件)。詳細は、LinkedIn REST APIの例のページ区切り型レスポンスの処理を参照してください。

RESOLVER_OVERWRITE_CLASS

いいえ

ページ区切り型の呼出しや、チャンク・アップロード型呼出しのアップロードURLなど、NEXT_REQUEST_RESOLVERパラメータで次ページを特定できない場合には、独自の実装を指定できます。oracle.odi.runtime.rest.INextRequestResolverインタフェースを実装するクラスの完全修飾名を指定する必要があります。このクラスで、process()をオーバーライドする必要があります。このクラスはODIクラス・パスから利用できる必要があります。

ノート:

パブリックで参照できるこれらのクラスはSDKライブラリで入手できます。 
public interface oracle.odi.runtime.rest.INextRequestResolver {
	
	public boolean process(oracle.odi.runtime.rest.INextRequestResolver restToolProvider , 
			oracle.odi.runtime.rest.IOdiToolRestRequest request,
			java.io.InputStream response /*REST response input stream */, javax.ws.rs.core.MultivaluedMap<String,Object> 
responseHeaders /*REST response headers*/) throws Exception; 
}

  1. restToolProvider – ツール・パラメータへのアクセスを提供します。たとえば — String tokenParamName= restToolProvider.getToolParameterValue("-PAGE_TOKEN_PARAM_NAME", String.class);の場合。これには次のメソッドがあります。

    • getRuntimeTemplates()– 実行時テンプレートへのアクセスを提供します。

    • getChunkFiles()– ツールによって作成または特定されたチャンク・ファイルへのアクセスを提供します。

  2. request — ツールが実行した最後のRESTリクエストの詳細が格納されます。提供される詳細は、requestPath、requestQueries、requestHeadersおよびhttpMethodです。ページ区切り呼出しにさらにページが存在する場合は、ユーザーはこれらの詳細を変更し、プロセス()からtrueを返すことができます。直後のREST呼出しが同じ動作である場合は、この編集されたリクエスト・オブジェクトが使用されます。

  3. response— 最後の呼出しの結果として取得されるレスポンス・ストリーム。これを処理して、次のリクエストの構築に必要な詳細を取得できます。

  4. responseHeaders— 最後のRESTリクエストから取得されるレスポンス・ヘッダー。これを使用して、次のリクエストを構築できます。

この実装で、ページ区切り型呼出しの終了条件を処理する必要があります。つまり、ページ区切り型呼出しで最後のページに到達したときに、process ()メソッドからfalseを返すようにする必要があります。ページ区切り型呼出しでは、process()からfalseが返されるまでRESTツールが実行し続けます。

OdiToolRestRequestインタフェース・パラメータには次のメソッドがあり、次のような値へのアクセスと変更が可能です。

  • String getRequestPath() — 最後のリクエストのリクエスト・パスを取得します。

  • void setRequestPath(String requestPath) — 次の呼出しのリクエスト・パスを変更します。

  • MultivaluedMap<String,Object> getRequestQueries()— 最後の呼出しで使用されたリクエスト問合せを取得します。

  • void setRequestQueries(Multivalued<MapString>, Object requestQueries)- 次の呼出しのリクエスト問合せを設定します。

  • MultivaluedMap<String,Object> getRequestHeaders() — 最後の呼出しのリクエスト・ヘッダーを取得します。

  • setRequestHeaders(MultivaluedMap<String,Object> requestHeaders()— 次の呼出しのリクエスト・ヘッダーを設定します。

  • getMethod() — 最後の呼出しで使用されたhttpメソッドを取得します。

  • setMethod(String method) — 次の呼出しのHTTPメソッドを設定します。

これらのsetterメソッドを使用して、後続のリクエストの動作を変更できます(動作が同じである場合のみ)。たとえば、PRE_OPERATIONの呼出しの結果、process()が呼ばれた場合、このリクエスト・オブジェクトに変更を加えても意味はありません。次の呼出しは、OPERATIONパラメータで指定される異なる操作であるからです。この操作から新しいリクエスト・オブジェクトが呼び出されます。しかし、実行時テンプレートodi.OPERATION_URL_OVERRIDEを使用することで、後続のすべての操作にわたってリソース・パスをオーバーライドできます。PRE_OPERATIONの後、process()メソッドの呼出しでこの実行時テンプレートを設定すると、OPERATIONおよびPOST_OPERATIONがこれをリクエスト・パスとみなし、それらの操作で定義されているリクエスト・パスを無視します。

RESPONSE_DATA_CONTAINER

いいえ

この値は、レスポンスから実際のデータを抽出するためのXpath(XMLレスポンスの場合)またはJSONPath(JSONレスポンスの場合)です。すべてのREST呼出しレスポンスからこのフィールドの解決値を収集し、完全なレスポンスを取得します。レスポンスがプレーン・テキストである場合、レスポンス全体が取得されます。値がXpath式"/account/"である場合、収集後の最終的なxmlレスポンスのルート要素が"account "になります。ページ区切り型JSONレスポンス・データは常に配列形式です。各ページ区切り型レスポンス・データの配列をマージして最終的なレスポンスを構築できますが、最終的なレスポンスも配列です。

<RequestBody>

いいえ

RESTリクエストの本文。REQUEST_BODY_FILE値を指定した場合、このフィールドは使用されません。このメッセージはOdiInvokeRESTfulService呼出しの直後の行(別の行、または、-REQUEST_BODYパラメータを使用)で指定する必要があります。

使用上の推奨事項

odiInvokeRESTfulServiceツールの使用上の推奨事項は、使用上の推奨事項を参照してください。

例

次に、OdiInvokeRESTfulServiceをページ区切り関数またはチャンク・アップロード関数に使用する例を示します。

odiInvokeRESTfulServiceツールの使用上の推奨事項

次に、odiInvokeRESTfulServiceツールの一般的な使用上の推奨事項を示します。

  1. このツールでは、指定されたパラメータに基づいて呼出しタイプが特定されます。呼出しのタイプとして、通常、チャンク・アップロード、ページ区切りの3つがあります。CHUNK_SIZEまたはCHUNK_PREFIXのパラメータがある場合、その呼出しはチャンク・アップロード型の呼出しです。これらのパラメータが存在せず、NEXT_REQUEST_RESOLVERまたはRESOLVER_OVERWRITE_CLASSパラメータが存在する場合は、その呼出しはページ区切り型です。それ以外の呼出しはすべて通常の呼出しと見なされ、REST操作の指定にはOPERATIONパラメータのみを使用することが推奨されます。

  2. ページ・サイズを示すパラメータ(maxResults、countなど)を問合せパラメータとして渡し、取得を最適化できます。渡さなかった場合、RESTサービスからデフォルト・サイズのページが返されます。どちらの場合でも、ツール・パラメータを使用して呼出しを繰り返し、完全なレスポンスを構築できます。ページ・サイズを指定する場合、RESTサービスが課しているサイズ上限を超えない値を指定してください。

  3. JSONでXPathに相当するのはJsonPathです。詳細は、https://github.com/jayway/JsonPathを参照してください。リンクhttp://jsonpath.herokuapp.com/を使用して、JSONPath式を評価できます。RESTツールはJayway実装を使用します。

  4. このツールはリゾルバ式(NEXT_REQUEST_RESOLVER、TOTAL_COUNT_RESOLVERまたはRESPONSE_DATA_CONTAINER_RESOLVERで指定)に基づいて、レスポンスのコンテンツがJSONとXMLのどちらなのかを判断します。たとえば、レスポンスがJSONであることが予測される場合、Xpathリゾルバ式を指定しないようにする必要があります。

  5. Xpath式またはJSONPath式をパラメータNEXT_REQUEST_RESOLVERに渡す場合、これらの式は文字列値(トークン、アップロードIDまたはURL)に解決される必要があります。1つのアイテムを含むJSON配列も、JSONPath式の有効な解決値であると見なされます。

    • JSONPathの場合、有効な解決値は、"ABCDEF"、12345、["ABCDEF"]、[12345]、http://host:port/context/resourcepath/のように表現されます。

    • Xpath式の場合、有効な解決値は、ABCDEF、12345、http://host:port/context/resourcepath/のように表現されます。

  6. URLパスや問合せ、ヘッダーを構築するときに実行時テンプレートを使用できます。これらのテンプレートの値は実行時に決定されます。実行時テンプレートはすべて、名前がodiの接頭辞で始まります。これにより実行時テンプレートとユーザー定義の通常のテンプレートを区別できます。実行時テンプレートは、PRE_OPERATION_BODY、POST_OPERATION_BODYおよびREQUEST_BODY_PART_VALUEといったパラメータの値としても使用できます。

  7. 次に、このツールで識別可能な実行時テンプレートを示します。すべてのREST呼出しにおいて、実行時テンプレートの値がツールによって一度のみまたは複数回設定されます。ユーザーが定義する通常のテンプレートと同様に、実行時テンプレートの値はREST物理スキーマの操作定義で初期値として指定できます。ツール・パラメータREQUEST_TEMPLATEを使用して実行時テンプレートを初期化することはできません。

    • odi.CHUNK_PREFIX— CHUNK_PREFIXパラメータの値を表すテンプレートで、チャンク・ファイルの作成時に一度だけ設定されます。

    • odi.UPLOAD_ID — 最初の呼出しレスポンスでアップロード・セッションIDが解決されると(NEXT_REQUEST_RESOLVERを使用)、そのアップロード・セッションIDがこの実行時テンプレートに格納されます。これはチャンク・アップロード呼出しで設定されます。これは一度だけ設定されます。

      RESOLVER_OVERWRITE_CLASS パラメータを使用して、独自の実装を指定できます。

    • odi.PAGE_TOKEN — 次ページ・リクエストのページ・トークンまたはページ・オフセットが格納される実行時テンプレートです。ページ区切り呼出しに使用されます。各ページのレスポンスの後に新しい値が設定され、NEXT_REQUEST_RESOLVERを使用して処理されます。

      RESOLVER_OVERWRITE_CLASSパラメータを使用して、独自の実装を指定できます。

    • odi.OPERATION_URL_OVERRIDE – NEXT_REQUEST_RESOLVERでURLが返された場合、そのURLがこの実行時テンプレートに設定されます。チャンク・アップロード型の場合、一度だけ設定されます。ページ区切り型の場合、ページのレスポンスが処理されるたびに設定されます。RESOLVER_OVERWRITE_CLASS パラメータを使用して、独自の実装を指定できます。

    1. チャンク・アップロード型の呼出しの場合、チャンク・ファイルが特定または作成されたときに、次のテンプレートが設定されます。

      odi.TOTAL_CHUNK_SIZE — すべてのチャンク・ファイルをまとめた合計サイズ。

    2. 次の実行時テンプレートは、特定のチャンク・ファイルがアップロード対象として選択されたときに設定されます。

      • odi.CHUNK_PATH — 一時ディレクトリ内のチャンク・ファイルの絶対パス。

      • odi.CHUNK_NAME — チャンクの名前。

      • odi.CHUNK_SIZE — チャンクのサイズ。通常これは、すべてのチャンクで同一です。ただし、最後のチャンクについては異なる場合があります。

      • odi.CHUNK_INDEX — 使用されるチャンクの索引(開始値0)。最初の索引が使用される場合、この値は0です。

ページ区切りの例

OdiInvokeRESTfulServiceツールのページ区切り関数の例を次に示します。

TwitterフォロワAPI

参照リンク: https://dev.twitter.com/overview/api/cursoring

次のTwitter APIについて考察します。次のAPIはフォロワのIDを一覧表示します: https://api.twitter.com/1.1/followers/ids.json?screen_name=<your-screen-name>

このAPIのデフォルトのページ・サイズは15であると仮定します。最初の呼出しのレスポンスは次のようになります。

{
  "ids": [
    2552855054,
    4345418177,
    3803100858,
    56422577,
    3326965752,
    3075258528,
    3302261082,
    297834835,
    2927402418,
    56053134,
    78849029,
    70703605,
    2850513554,
    161289980,
    548960923
  ],
  "next_cursor": 1434098452051477000,
  "next_cursor_str": "1434098452051476935",
  "previous_cursor": 0,
  "previous_cursor_str": "0"
}

"getFollowers"という操作をURL: https://api.twitter.com/1.1/followers/ids.json?screen_name=<your-screen-name>を使用して定義します。

2番目の操作では、問合せパラメータとしてcursor={odi.PAGE_TOKEN}を渡します。

RESTツールのパラメータ
PRE_OPERATION=getFollowers
OPERATION=getFollowers
REQUEST_QUERY.cursor={odi.PAGE_TOKEN} // This will be added to main operation only
NEXT_REQUEST_RESOLVER=$.next_cursor_str
RESPONSE_DATA_CONTAINER_RESOLVER=$.ids

JSONPath式$.next_cursor_strが、値"1434098452051476935"に解決されます。これを2番目のREST呼出しのパラメータ・カーソルに渡す値として使用します。

https://api.twitter.com/1.1/followers/ids.json?screen_name=<your-screen-name>&cursor=1434098452051476935

{
  "ids": [
    548960923,
    435520948,
    338402626,
    80845228
  ],
  "next_cursor": 0,
  "next_cursor_str": "0",
  "previous_cursor": -1434098452051477000,
  "previous_cursor_str": "-1434098452051476935"
}

レスポンス内の次のカーソルの値は0です。これは残っているページがないことを示しているため、このレスポンスの書込み後にツールの実行を停止できることを意味しています。パラメータRESPONSE_DATA_CONTAINER_RESOLVERを使用して、レスポンスから必要なデータをフェッチします。最後のレスポンスは次のようになります。 

[
    2552855054,
    4345418177,
    3803100858,
    56422577,
    3326965752,
    3075258528,
    3302261082,
    297834835,
    2927402418,
    56053134,
    78849029,
    70703605,
    2850513554,
    161289980,
    548960923,
    548960923,
    435520948,
    338402626,
    80845228
  ]

Google Drive API

Twitter REST APIのページ区切りと同様に、次のリクエストで使用するページ・トークン問合せパラメータの値を、レスポンス内のページ・ポインタを使用して取得します。

次のAPI URLについて考察します: https://developers.google.com/apis-explorer/#s/drive/v2/drive.files.list?_h=1

サンプル・レスポンス

{
"kind": "drive#fileList",
 "etag": "\"rCKCAyesbPCaBxGt0eDJcEBQNUI/HNdpkEyt-3gaIlW8i4TRzGJXk-w\"",
 "selfLink": "https://www.googleapis.com/drive/v2/files?maxResults=3",
"nextPageToken": "EAIaqgELEgBSoQEKjwEKaPjz",
 "nextLink": "https://www.googleapis.com/drive/v2/files?
maxResults=3&pageToken=EAIaqgELEgBSoQEKjwEKaPjz",
 "items": [
  ...
 ]
}

操作"getFiles"をURL: https://developers.google.com/apis-explorer/#s/drive/v2/drive.files.list?_h=1を使用して定義します。

RESTツールのパラメータ
PRE_OPERATION=getFiles
OPERATION=getFiles
REQUEST_QUERY.pageToken={odi.PAGE_TOKEN} // This will be added to main operation only
NEXT_REQUEST_RESOLVER=$.nextPageToken   
RESPONSE_DATA_CONTAINER_RESOLVER=$.items

JSONPath式$.nextPageTokenが、値EAIaqgELEgBSoQEKjwEKaPjzに解決されます。

前述のパラメータを使用して、RESTツールが2番目の呼出しのURLを次のように構築します。

https://developers.google.com/apis-explorer/#s/drive/v2/drive.files.list?_h=1&pageToken=EAIaqgELEgBSoQEKjwEKaPjz

Google drive APIでは、次ページを指す完全なURLがnextLinkとしてレスポンスで提供されるため、これをかわりに使用してページ区切り型の結果を蓄積できます。

NEXT_REQUEST_RESOLVERを次のように設定します。

RESTツールのパラメータ
PRE_OPERATION=getFiles
OPERATION=getFiles
REQUEST_QUERY.pageToken={odi.PAGE_TOKEN} // This will be added to main operation only
NEXT_REQUEST_RESOLVER=$.nextLink   
RESPONSE_DATA_CONTAINER_RESOLVER=$.items

Salesforce REST API (Chatter REST API)

これもTwitter REST APIのページ区切りとほぼ同じですが、RESTレスポンス内の次ページ・ポインタが実際のURLのみである点が異なります。Google drive APIおよびTwitter APIの場合は、次ページ・ポインタがトークンで、このトークンが問合せパラメータ<PageTokenParam>の値として2番目以降のリクエストに渡されます。

参照リンク: http://help.salesforce.com/HTViewSolution?id=000175552&language=en_US

Salesforce Chatter API URLの接尾辞は、/services/data/v25.0/chatter/feeds/news/me/feed-items?pageSize=25のような形式です。

ここで、問合せパラメータのpageSizeはページ・サイズを表しています。pageSizeの指定は任意です。レスポンスにはフィールドnextPageUrlが含まれます。値は、結果の次のページを取得するための完全なREST URLになります。

LinkedIn会社の更新の取得(オフセット・ベースのページ区切り)

Linked REST APIのページ区切りのサポートは前述のREST APIとは異なります。

参照リンク: https://developer.linkedin.com/docs/rest-api

次のREST APIについて考察します — https://api.linkedin.com/v1/companies/1337/updates

上述のURLに対するgetCompanyUpdates操作を定義します。

RESTツールのパラメータ
PRE_OPERATION=getCompanyUpdates
OPERATION=getCompanyUpdates
NEXT_REQUEST_RESOLVER=10 //Page size. Specified in the below    URL using count parameter
RESPONSE_DATA_CONTAINER_RESOLVER=$.values
TOTAL_COUNT_FIELD_RESOLVER=$._total
REQUEST_QUERY.start={odi.PAGE_TOKEN} // Will be used by main operation only

REQUEST_QUERYまたはENCODED_REQUEST_QUERY_STRINGを使用して、問合せ文字列に問合せパラメータの開始を追加している場合、最初のREST呼出しは次のURLで開始されます。最初の呼出しはPRE_OPERATIONの呼出しであるため、ツールで指定されたREQUEST_QUERYパラメータは考慮されません: https://api.linkedin.com/v1/companies/1337/updates?start=0&count=10&format=json

  1. 最初の呼出しのレスポンス

    {
  "_count": 10,
  "_start": 0,
  "_total": 26,
  "values":  [
      …
  ]
}

    レスポンスが処理される度、NEXT_REQUEST_RESOLVERで指定されている数だけodi.PAGE_TOKEN実行時テンプレートの値が増加します。新しい開始値は0+10=10です。これは合計のレコード数26(TOTAL_RECORDSで指定されたJSONPath式で抽出)を下回っています。そのため、次のページが存在することがわかります。

    2番目のREST呼出しURLは、https://api.linkedin.com/v1/companies/1337/updates?start=10&count=10&format=jsonです。

  2. 2番目の呼出しのレスポンス

    {
  "_count": 10,
  "_start": 10,
  "_total": 28,
  "values":  [
      …
  ]
}

    新しい開始値は、10+10=20です。これは合計レコード数28を下回っています(前回は26。RESTサービスの最後に新たに2件のレコードが追加されています)。そのため、次のページが存在することがわかります。

    3番目のREST呼出しURLは、https://api.linkedin.com/v1/companies/1337/updates?start=20&count=10&format=jsonです。

  3. 3番目の呼出しのレスポンス

    {
  "_count": 10,
  "_start": 20,
  "_total": 24,
  "values":  [
      …
  ]
}

    新しい開始値は、20+10=30です。これは合計レコード数24 (前回のリクエスト時は28でしたが、RESTサービスの最後で4件のレコードが削除されたため24になりました)を上回っています。そのため、これは最後のページだということがわかります。

    合計レコード数の値はレスポンスごとに抽出されて、最後のページの判定に使用されます。

ノート:

  1. count問合せパラメータを使用してページ・サイズを指定しなかった場合、RESTサービスからデフォルト・サイズのページが返されます。その場合、このデフォルトのページ・サイズがNEXT_REQUEST_RESOLVERパラメータの値として指定されるようにする必要があります。ツールではサービスのデフォルトのページ・サイズを特定できません。

  2. ツールではこのページ区切りを内部リゾルバを使用して解決しています。このリゾルバを使用するには、NEXT_REQUEST_RESOLVERとTOTAL_RECORDSの値を指定する必要があり、NEXT_REQUEST_RESOLVERには数値(ページ・サイズを表す)を指定する必要があります。

RESOLVER_OVERWRITE_CLASSを使用した独自実装の記述

RESTツールのパラメータ

RESOLVER_OVERWRITE_CLASS=myCom.LinkedInPaginationResolver

public class OffsetBasedPaginationResolver implements INextRequestResolver {
	private int mStartIndex = 0; // Default value of the start index
	public OffsetBasedPaginationResolver(){
	}
	public OffsetBasedPaginationResolver(int startIndex){
		mStartIndex = startIndex;
	}
	@Override
	public boolean process(IRestToolProvider restToolProvider,
			IOdiToolRestRequest request,
			InputStream responseData, MultivaluedMap<String,Object> responseHeaders)
			throws Exception {
		int pageSize = Integer.parseInt(restToolProvider.getToolParameterValue(IRestToolProvider.PARAM_NEXT_REQUEST_RESOLVER).toString());
		String totalCountResolverExpression = restToolProvider.getToolParameterValue(IRestToolProvider.PARAM_TOTAL_COUNT_FIELD_RESOLVER).toString();
		long totalRecords = InvokeRESTfulServiceSupport.getPathLongValue(responseData, totalCountResolverExpression);
		mStartIndex+= pageSize;
		if(mStartIndex <= totalRecords){
			restToolProvider.getRuntimeTemplates().put(IRestToolProvider.RUNTIME_TEMPLATE_PAGE_TOKEN, mStartIndex);
			return true;
		}
		return false;
	}
}

Oracle Storage Cloud Service API – リスト・コンテナ

Oracle Storage Cloud Service REST APIのページ区切りのサポートは、レスポンスからの次ページ・トークンの抽出方法において前述のREST APIとは異なります。

参照リンク: http://docs.oracle.com/cloud/latest/storagecs_common/SSAPI/op-v1-%7Baccount%7D-get.html#request

次のREST APIについて考察します。ここで、上限はMAX_LIMIT=10000 (デフォルトであり最大値)です。デフォルトのページ・サイズまたはMAX_LIMITは5であると仮定します。

最初の呼出しURLは、https://<your_domain>.storage.oraclecloud.com/v1/<your_account>?format=jsonです。

上述のURLに対するlistContainers操作を定義します。

RESTツールのパラメータ
PRE_OPERATION=listContainers
OPERATION=listContainers
REQUEST_QUERY.marker={odi.PAGE_TOKEN}
NEXT_REQUEST_RESOLVER =$[-1:].name   //This will fetch the name field from last record. To fetch the name field from first record use JSONPath expression “$[:1]”

最初の呼出しのサンプル・レスポンス

[{"name":"container-10","count":0,"bytes":0,"accountId":{"id":15935},"deleteTimestamp":0.0,"containerId":{"id":223537}},
{"name":"container1","count":0,"bytes":0,"accountId":{"id":15935},"deleteTimestamp":0.0,"containerId":{"id":223427}},
{"name":"container10","count":0,"bytes":0,"accountId":{"id":15935},"deleteTimestamp":1.45984151022644E9,"containerId":{"id":223433}},
{"name":"container2","count":0,"bytes":0,"accountId":{"id":15935},"deleteTimestamp":0.0,"containerId":{"id":223379}},
{"name":"container3","count":0,"bytes":0,"accountId":{"id":15935},"deleteTimestamp":0.0,"containerId":{"id":223380}}]

次ページのリゾルバはJSON配列に解決されます。

[“container3”]

RESTツールはこのJSON配列からcontainer3の値を抽出します。

2ページ目の新しいREST URLは、https://<your_domain>.storage.oraclecloud.com/v1/<your_account>?marker=container3です。

レスポンス・データ上のJSONPath式$..nameの解決値 

[
   "container-10",
   "container1",
   "container10",
   "container2",
   "container3"]

ここで、レスポンス形式がXMLの場合のシナリオについて考察します: https://<your_domain>.storage.oraclecloud.com/v1/<your_account>?format=xml

上述のURLに対するlistContainersXml操作を定義します。

RESTツールのパラメータ
PRE_OPERATION=listContainersXml
OPERATION=listContainersXml
REQUEST_QUERY.marker={odi.PAGE_TOKEN}
NEXT_REQUEST_RESOLVER=/account/container[last()]/name/text()  //This will fetch the name field from last record. To fetch the name field from first record use Xpath expression “/account/container[1]/name/text()”
RESPONSE_DATA_CONTAINER_RESOLVER=/account   //This will be root element in the accumulated response

最初の呼出しのサンプル・レスポンス

<?xml version="1.0" encoding="UTF-8"?>
<account><container><accountId><id>15935</id></accountId><bytes>0</bytes><containerId><id>223537</id></containerId><count>0</count><deleteTimestamp>0.0</deleteTimestamp><name>container-10</name></container>
<container><accountId><id>15935</id></accountId><bytes>0</bytes><containerId><id>223427</id></containerId><count>0</count><deleteTimestamp>0.0</deleteTimestamp><name>container1</name></container>
<container><accountId><id>15935</id></accountId><bytes>0</bytes><containerId><id>223433</id></containerId><count>0</count><deleteTimestamp>1.45984154E9</deleteTimestamp><name>container10</name></container>
<container><accountId><id>15935</id></accountId><bytes>0</bytes><containerId><id>223379</id></containerId><count>0</count><deleteTimestamp>0.0</deleteTimestamp><name>container2</name></container>
<container><accountId><id>15935</id></accountId><bytes>0</bytes><containerId><id>223380</id></containerId><count>0</count><deleteTimestamp>0.0</deleteTimestamp><name>container3</name></container></account>

次ページのリゾルバは値container3に解決され、この値がmarker問合せパラメータの次の値として使用されます。

Oracle Storage Cloud Service API – オブジェクト・コンテンツ取得(オブジェクトのダウンロード)

このAPIはコンテナに格納されているオブジェクトの取得をサポートしています。Rangeヘッダーを使用してオブジェクトをチャンクとして取得できます。このAPIにはダウンロードのバイト数に上限がありません。RESTツールのページ区切りサポートを使用することで、このオブジェクトを複数のチャンクとしてダウンロードできます。

コンテナcontainer1に格納されているmydataという名前のオブジェクトをダウンロードする場合、最初の呼出しURLは、https://<your_domain>.storage.oraclecloud.com/v1/<your_account>/container1/mydataです

ツール・パラメータHEADERを使用して初期のRangeヘッダーを設定する必要があります。

RESTツールのパラメータ
HEADER.Range=bytes=1-99
RESOLVER_OVERWRITE_CLASS=com.StorageCSPaginationResolver

現在の範囲と合計バイト・サイズを取得するため、レスポンス・ヘッダーContent-Rangeを解析する実装が必要になります。サンプルの値は"bytes 1-99/2677"です。1-99は範囲で、2677は合計のバイト数です。StorageCSPaginationResolverのprocess()のレスポンスは、"bytes=100-199"という文字列値になります。この値が、2番目のREST呼出しの新しいRangeヘッダー値として渡されます。実装内で終了条件も処理する必要があります。新しい範囲の算出時に下の範囲が合計バイト数の値を下回った場合、ページが残っていないことを示しています。process()の戻り値の型はブール値であるため、process()からfalse値を返す必要があります。

GitHub API

このAPIはLinkヘッダー・ベースのページ区切りサポートの例です。

最初のREST呼出しは、https://api.github.com/search/code?q=addClass+user:mozilla&page=1というURLで始まります。

RESTツールのパラメータ
NEXT_REQUEST_RESOLVER=next // It is a link header relation
RESPONSE_DATA_CONTAINER_RESOLVER=$.items
レスポンス・ヘッダー"Link "には次の値が含まれています。 
https://api.github.com/search/code?q=addClass+user%3Amozilla&page=2; rel="next", 
https://api.github.com/search/code?q=addClass+user%3Amozilla&page=34; rel="last"

このリンク・ヘッダーはRESTツールで解析され、関係"next"に対応するリンクが抽出されます。

次の呼出しのURLは、https://api.github.com/search/code?q=addClass+user%3Amozilla&page=2です。

レスポンスのリンク・ヘッダー値に関係"next"で表現される関係が現れなくなるまで、この動作が繰り返されます。

次のように、独自のリゾルバ実装を用意して実現することも可能です。

RESTツールのパラメータ
NEXT_REQUEST_RESOLVER=next
RESOLVER_OVERWRITE_CLASS=com.GitHubPaginationResolver
RESPONSE_DATA_CONTAINER_RESOLVER=$.items

TwitterタイムラインAPI

ノート:

TwitterツイートAPIのページ区切りのサポートは、前述のOracle Storage Cloud Service APIと同様です。

RESTサービスの初期URLについて考察します — https://api.twitter.com/1.1/search/tweets.json?q=<screen_name>

上述のURLを使用する"getTweets"操作を定義します。

RESTツールのパラメータ 
PRE_OPERATION=getTweets
OPERATION=getTweets
REQUEST_QUERY.since_id={odi.PAGE_TOKEN}
NEXT_REQUEST_RESOLVER=$[:1].id_str   //This will give the id_str from the first record
RESPONSE_DATA_CONTAINER_RESOLVER=$.statuses

2番目の呼出しURLは、https://api.twitter.com/1.1/search/tweets.json?q=<screen_name>&since_id=<resolved_next_page_value>です。

チャンク・アップロードの例

Twitterメディア・アップロード

参照リンク: https://dev.twitter.com/rest/reference/post/media/upload-init

3種類の操作があります。これらを次に示します。

  1. POST media/upload (INIT) – アップロード・セッションを開始するリクエスト。

    パラメータ:

    command=INIT
total_bytes=total file size

  2. POST media/upload (APPEND) - マルチパート/フォームデータ形式

    パラメータ:

    command=APPEND
media_id= the media_id returned from the INIT command
media= The raw binary file content being uploaded. <=5MB // media is multipart body part field name. 
segment_index= An ordered index of file chunk.It must be between 0-999 inclusive. The first segment has index 0, second segment has index 1, and so on.

  3. POST media/upload (FINALIZE)

    パラメータ:

    command=FINALIZE
media_id= the media_id returned from the INIT command

たとえば — 1 GB (1073741824バイト)のメディアをアップロードすると仮定します。

物理スキーマに2つのRest操作を作成する必要があります。次の操作を定義します。

  • Initialize(POST) = https://upload.twitter.com/1.1/media/upload.json?command=INIT&total_bytes=1073741824

  • Upload (POST)=https://upload.twitter.com/1.1/media/upload.json?command=APPEND&media_id={odi.UPLOAD_ID}&segment_index={odi.CHUNK_INDEX}

  • Finalize(POST)=https://upload.twitter.com/1.1/media/upload.json?command=FINALIZE&media_id={odi.UPLOAD_ID}

最初の呼出しのレスポンスは次のようになります:

{
  "media_id": 710511363345354753,
  "media_id_string": "710511363345354753",
  "size": 11065,
  "expires_after_secs": 86400,
}
RESTツールのパラメータ
CONTEXT=<Context>

LSCHEMA=<Logical Schema>

INPUT_FILE=<input file path>

CHUNK_SIZE=5000000 (Nearly 5MB).This will break input file into 215 chunks

REQUEST_BODY_PART_NAME=media
     
REQUEST_BODY_PART_VALUE={odi.CHUNK_PATH}

REQUEST_BODY_PART_CONTENT_TYPE=application/json
	
PRE_OPERATION=Initialize

NEXT_REQUEST_RESOLVER=$.media_id

OPERATION=Upload    //This operation uploads all chunks.

POST_OPERATION=Finalize

TRACE_FILE=<Trace File Name>

Google Driveファイル・アップロードAPI

参照リンク: https://developers.google.com/drive/v3/web/manage-uploads#resumable

2種類の操作があります。これらを次に示します。

  1. POST files?uploadType=resumable (最初のリクエスト)

    最初のリクエストで次のHTTPヘッダーを使用します。

    1. X-Upload-Content-Type。後続のリクエストで転送されるアップロード・データのメディアMIMEタイプに設定します。

    2. X-Upload-Content-Length。後続のリクエストで転送されるアップロード・データのバイト数に設定します。このリクエストを実行する時点で長さが不明の場合は、このヘッダーは省略できます。

    3. メタデータを指定する場合: Content-Type。メタデータのデータ型に従って設定します。

    4. Content-Length。この初期リクエストの本文に指定されたバイト数に設定します。チャンク転送エンコーディングを使用する場合は不要です。

    レスポンスにはレスポンス・ヘッダーの場所が含まれ、ここにsession_uriが含まれています。

  2. PUT session_uri (チャンクのアップロード)

    チャンクをアップロードするときには、Content-Lengthヘッダーが設定されている必要があります。1 GB (1073741824バイト)のメディアをアップロードすると仮定します。物理スキーマに2つのRest操作を作成する必要があります。

    次の操作を定義します。

    1. InitialRequest (POST)= https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable

      物理スキーマに操作を定義する際に、X-Upload-Content-Type、X-Upload-Content-Lengthなど、必要なヘッダーを設定します。

    2. Upload (PUT)=https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable (このurlは無視され、

      最初の操作のレスポンスで取得されたURLが使用されます。Content-Typeヘッダーを設定します。Content-Length={odi.CHUNK_SIZE}を設定します。

      最初の操作のレスポンスは次のようになります。

      HTTP/1.1 200 OK
Location: https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable&upload_id=xa298sd_sdlkj2
Content-Length: 0
RESTツールのパラメータ
CONTEXT=<Context>

LSCHEMA=<Logical Schema>

INPUT_FILE=<input file path>

CHUNK_SIZE=5000000 (Nearly 5MB).This will break input file into 215 chunks

PRE_OPERATION=InitialRequest

NEXT_REQUEST_RESOLVER=Location   (Location is expected to be a response header)

OPERATION=Upload

TRACE_FILE=<Trace File Name>

COMMVAULT API (チャンクによるファイルのアップロード)

参照リンク: https://documentation.commvault.com/commvault/v10/article?p=features/rest_api/operations/post_contentstore_share_chunk_upload.htm

2種類の操作があります。

  1. POST upload?uploadType=chunkedFile (最初のリクエスト)

    必要なすべてのヘッダーを操作内に設定します。レスポンスはDM2ContentIndexing_UploadFileResp要素で、ここにアップロードIDが含まれています。これはアップロード・リクエストのセッションIDになります。

  2. POST upload?uploadType=chunkedFile

たとえば — 1 GB (1073741824バイト)のメディアをアップロードする場合、物理スキーマに3つのRest操作を作成する必要があります。

次の操作を定義します。

  • InitUpload (POST)= SearchSvc/CVWebService.svc/contentstore/share/{shareId}/file/action/upload?uploadType=chunkedFile

    物理スキーマに操作を定義する際に、FileName、FileSize、ParentFolderPathなど、必要なヘッダーを設定します。

  • Upload (POST)= SearchSvc/CVWebService.svc/contentstore/share/{shareId}/file/action/upload?uploadType=chunkedFile&requestId={odi.UPLOAD_ID}

    アップロードで必要になるすべてのヘッダーを設定します。FileEOFヘッダーは無視します。この操作は、最後のチャンクを除くすべてのチャンクをアップロードする場合に使用します。

  • EndUpload (POST)= SearchSvc/CVWebService.svc/contentstore/share/{shareId}/file/action/upload?uploadType=chunkedFile&requestId={odi.UPLOAD_ID}

    ヘッダーFileEOF=1を設定します

最初の操作のレスポンスは、次のようなレスポンスになります。フィールドrequestIdにアップロードIDが格納されています。

<DM2ContentIndexing_UploadFileResp requestId="13213022088234198160108125214183230586134182" chunkOffset="780830" errorCode="409" />
RESTツールのパラメータ
CONTEXT=<Context>

LSCHEMA=<Logical Schema>

INPUT_FILE=<input file path>

CHUNK_SIZE=5000000 (Nearly 5MB).This will break input file into 215 chunks

PRE_OPERATION=InitUpload
	
PRE_OPERATION_BODY={odi.CHUNK_PATH} //Sets the first chunk as body of this operation

NEXT_REQUEST_RESOLVER=string(/DM2ContentIndexing_UploadFileResp/@requestId)    //Xpath expression to get the requestId

OPERATION=Upload

POST_OPERATION=EndUpload

PRE_OPERATION_BODY={odi.CHUNK_PATH} //Sets the last chunk as body of this operation

TRACE_FILE=<Trace File Name>

Oracle Storage Cloud Service

参照リンク: https://docs.oracle.com/cloud/latest/storagecs_common/CSSTO/GUID-CA3E7F7B-4B33-4C18-8CEB-652813D9ADFB.htm

2種類の操作があります。

  1. PUT accountURL/containerName/{odi.CHUNK_NAME} /

  2. PUT accountURL/containerName/manifestFile

たとえば — 1 GB (1073741824バイト)のメディアをアップロードする必要があるとします。物理スキーマに2つのRest操作を作成する必要があります。

次の操作を定義します

  • Upload (POST)=<accountURL>/{containerName}/{odi.CHUNK_NAME}

  • UploadManifest (POST)=<accountURL>/{containerName}/manifestFile

    この操作は、0バイトのマニフェスト・オブジェクトをアップロードする場合に使用します。

    この操作に次のヘッダーを設定します。

    X-Object-Manifest= {containerName}/{odi.CHUNK_PREFIX} 
Content-Length=0
RESTツールのパラメータ
CONTEXT=<Context>

LSCHEMA=<Logical Schema>

INPUT_FILE=<input file path>

CHUNK_SIZE=5000000 (Nearly 5MB).This will break input file into 215 chunks

OPERATION=Upload

END_OPERATION=UploadManifest

TRACE_FILE=<Trace File Name>

OdiInvokeWebService

ノート:

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

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

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

LOGICAL_SCHEMAパラメータを指定した場合、このツールはトポロジ・オブジェクトからの構成を使用します。既存のモードの構文は下位互換性がサポートされます。

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

ノート:

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

使用方法

新しいトポロジの構文

OdiInvokeWebService -LOGICAL_SCHEMA=<WS Logical Schema> -OPERATION=<operation> -CONTEXT=<ODI Context> (Optional)
[<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>] [-TIMEOUT=<timeout>]

既存のモードの構文

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>]

パラメータ

パラメータ 必須 説明

-LSCHEMA=<logical_schema>

いいえ

ジャーナル化された表が格納されている論理スキーマ(オプションのパラメータ)。LSCHEMAを指定する場合、OdiInvokeWebServiceは、マップされたSOAP WS物理スキーマまたはSOAP WSデータ・サーバーあるいはその両方で構成されたURL、PORT、HTTP_USERおよびHTTP_PASSを使用します。

-CONTEXT=<Odi context>

いいえ

論理スキーマを解決するコンテキスト。コンテキストの指定を省略すると、実行コンテキストが使用されます(オプションのパラメータ)。

-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形式のリクエスト・メッセージが含まれている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ユーザーのパスワード。

ノート: ODI変数をパスワードとして使用する場合、変数の内容は、エンコード・スクリプトを使用して暗号化する必要があります。

-TIMEOUT=<timeout>

いいえ

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

次の表に、最も一般的なXML/Java文字エンコーディング・スキームを示します。より詳細なリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/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をコールするための特別なグラフィカル・インタフェースが用意されています。詳細は、『Oracle Data Integratorでの統合プロジェクトの開発』の「Webサービスの使用」を参照してください。

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タイムアウトに到達した後で、エージェントが停止されます。デフォルト値は「いいえ」です。

-MAX_WAIT=<timeout>

いいえ

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

例

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

OdiKillAgent -NAME=ODI_AGT_001 -IMMEDIATE=yes

OdiManageOggProcess

このコマンドを使用して、Oracle GoldenGateプロセスを開始および停止します。

-NB_PROCESSパラメータは、操作を実行するプロセスの数を指定し、Oracle GoldenGate配信プロセスのみに適用します。

-NB_PROCESSが指定されていない場合、物理プロセスの名前は論理プロセスから導出されます。たとえば、論理スキーマR1_LSが物理プロセスR1にマップされている場合、R1という名前のOracle GoldenGateプロセスが開始または停止されます。

-NB_PROCESSに正の値が指定されている場合、順序番号がプロセスに追加され、すべてのプロセスが新しい名前で開始または停止されます。たとえば、値が3に設定され、論理スキーマR2_LSが物理プロセスR2にマップされている場合、プロセスR21、R22およびR23が開始または停止されます。

ジャーナルの開始を使用してCDC (チェンジ・データ・キャプチャ)プロセスをOracle GoldenGate JKM (ジャーナル化ナレッジ・モジュール)により開始した場合、Oracle Data Integratorでは、プロセス名に追加の順序番号が付けられたOracle GoldenGate配信プロセスが生成されます。たとえば、配信プロセスRPがジャーナルの開始アクションに使用された場合、ジャーナルの開始により、RP1という名前のOracle GoldenGate配信プロセスが生成されます。OdiManageOggProcessツールを使用してプロセスを停止および開始するには、-NB_PROCESSを1に設定します。-NB_PROCESSの最大値は、モデル内のJKMの-NB_APPLY_PROCESSパラメータの値です。

使用方法

OdiManageOggProcess -OPERATION=<start|stop>
-PROCESS_LSCHEMA=<OGG logical schema> [-NB_PROCESS=<number of processes>]

パラメータ

パラメータ 必須 説明

-OPERATION=<start|stop>

はい

プロセスで実行する操作。

-PROCESS_LSCHEMA=<OGG logical schema>

はい

プロセスの論理スキーマ。

-NB_PROCESS=<number of processes>

いいえ

操作を実行するプロセスの数。

例

論理スキーマR1_LSにマップされる、Oracle GoldenGateプロセスR1を開始します。 

OdiManageOggProcess "-OPERATION=START" "-PROCESS_LSCHEMA=R1_LS

OdiMkDir

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

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

使用方法

OdiMkDir -DIR=<directory>

パラメータ

パラメータ 必須 説明

-DIR=<directory>

はい

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

-TO_HDFS=<yes|no>

いいえ

ターゲットがHDFSであるかどうかを示します

例

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

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

OdiObjectStorageDelete

このコマンドを使用して、Oracle Object Storageに存在する、1つまたは複数のファイル、あるいはディレクトリ全体を削除します。

注意:

このツールは、Data Integration Platform Cloudにのみ適用できます。

使用方法

OdiObjectStorageDelete
-TRG_LOGICAL_SCHEMA=<trg_logical_schema_name>
-FILE_NAMES_FILTER =<file_names_filter>
-RETRY_ON_ERROR=<retry_number>
-RETRY_INTERVAL_SECONDS =<retry_interval_seconds>

パラメータ

パラメータ 必須 説明

TRG_LOGICAL_SCHEMA

はい

ターゲット論理スキーマには、削除されるファイルおよびディレクトリを含む、Oracle Object Storage Data Serverの詳細が含まれています。

FILE_NAMES_FILTER

はい

Oracle Object Storageから再帰的に削除する1つ以上のファイルまたはディレクトリを指定するフィールド。ファイルのリストを区切るためのデリミタ(|)もサポートします。

次のパターンに従います。

  • *.txt - .txtで終わるすべてのファイルを削除します

  • test* - 接頭辞“test”と一致するすべてのファイルおよびディレクトリを削除します

  • *test* - 部分文字列“test”を含むすべてのファイルおよびディレクトリを削除します

  • test.xml | test1.xml | test2.xml - 指定したすべてのファイルを削除します

  • test* | test1* - パターンtest*およびtest1*と一致するすべてのファイルおよびディレクトリを削除します

  • test.xml - 1つのファイルのみが削除されます。

RETRY_ON_ERROR

いいえ

これは、削除中に障害またはエラーが発生したときの試行回数です。

RETRY_INTERVAL_SECONDS

いいえ

再試行間隔は、再試行の間隔の秒数を示します。

例

次のコマンドを使用して、Oracle Object Storageからファイルおよびディレクトリを削除します

OdiObjectStorageDelete -TRG_LOGICAL_SCHEMA=OBJ_LS_OBJDELETE -FILE_NAMES_FILTER=*SE* -RETRY_ON_ERROR=2 -RETRY_INTERVAL_SECONDS=3

OdiObjectStorageDownload

このコマンドを使用して、1つまたは複数のファイル、あるいはディレクトリ全体を、Oracle Object StorageからHDFSまたはローカルのファイル・システムにダウンロードします。

注意:

このツールは、Data Integration Platform Cloudにのみ適用できます。

使用方法

OdiObjectStorageDownload
SRC_LOGICAL_SCHEMA=<src_logical_schema_name>
-TRG_LOGICAL_SCHEMA=<trg_logical_schema_name>
-FILE_NAMES_FILTER = <file_names_filter>
-OVERWRITE= Yes|No
-RETRY_ON_ERROR=<retry_number>
-RETRY_INTERVAL_SECONDS = <retry_interval_seconds>

パラメータ

パラメータ 必須 説明

SRC_LOGICAL_SCHEMA

はい

Oracle Object Storage Data Server用に構成されたソース論理スキーマ名。

TRG_LOGICAL_SCHEMA

はい

一般的に、ダウンロード操作では、ファイルをOracle Object StorageからローカルまたはHDFSファイル・システムにダウンロードします。ターゲット論理スキーマでは、ファイルのダウンロード先がローカルまたはHDFSファイル・システムかを指定します。

FILE_NAMES_FILTER

はい

Oracle Object Storageから再帰的にダウンロードする1つ以上のファイルを指定するフィールド。ファイルのリストを区切るためのデリミタ(|)もサポートします。

次のパターンに従います。

  • *.txt - .txtで終わるすべてのファイルをダウンロードします

  • test* - 接頭辞“test”と一致するすべてのファイルおよびディレクトリをダウンロードします

  • *test* - 部分文字列“test”を含むすべてのファイルおよびディレクトリをダウンロードします

  • test.xml | test1.xml | test2.xml - 指定したすべてのファイルをダウンロードします

  • test* | test1* - パターンtest*およびtest1*と一致するすべてのファイルをダウンロードします

  • test.xml - 1つのファイルのみがダウンロードされます。

OVERWRITE

いいえ

このパラメータは、ダウンロード操作が既存のファイルを上書きするかどうかを示します。このパラメータのデフォルト値はNoです。

RETRY_ON_ERROR

いいえ

これは、ダウンロード中に障害またはエラーが発生したときの試行回数です。

RETRY_INTERVAL_SECONDS

いいえ

再試行間隔は、再試行の間隔の秒数を示します。

例

次のコマンドを使用して、Oracle Object Storageからファイルおよびディレクトリをダウンロードします。
OdiObjectStorageDownload -SRC_LOGICAL_SCHEMA=OBJ_LS_OBJDOWNLOAD -TRG_LOGICAL_SCHEMA=FILE_LS_OBJDOWNLOAD -FILE_NAMES_FILTER=*SE* -OVERWRITE=yes -RETRY_ON_ERROR=2 -RETRY_INTERVAL_SECONDS=3

OdiObjectStorageUpload

このツールを使用して、1つまたは複数のファイル、あるいはディレクトリ全体を、HDFSまたはローカルのファイル・システムからOracle Object Storageにアップロードします。

注意:

このツールは、Data Integration Platform Cloudにのみ適用できます。

使用方法

OdiObjectStorageUpload 
-TRG_LOGICAL_SCHEMA=<trg_logical_schema_name>
-SRC_LOGICAL_SCHEMA = <src_logical_schema_name>
-FILE_NAMES_FILTER =<file_names_filter>
-OVERWRITE = Yes|No 
-RETRY_ON_ERROR =<retry_number> 
-RETRY_INTERVAL_SECONDS =<retry_interval_seconds>

パラメータ

パラメータ 必須 説明

TRG_LOGICAL_SCHEMA

はい

Oracle Object Storage Data Server用に構成されたターゲット論理スキーマ名。

SRC_LOGICAL_SCHEMA

はい

ローカルまたはHDFSファイルをOracle Object Storageにアップロードするように、ファイルまたはHDFSデータ・サーバーに構成されたソース論理スキーマ名。

FILE_NAMES_FILTER

はい

Oracle Object Storageに再帰的にアップロードする1つ以上のファイルを指定するフィールド。デリミタとして「|」で区切られたファイルのリストもサポートします。次のパターンに従います。

  • *.txt - .txtで終わるすべてのファイルをアップロードします

  • test* - 接頭辞“test”と一致するすべてのファイルおよびディレクトリをアップロードします

  • *test* - 部分文字列“test”を含むすべてのファイルおよびディレクトリをアップロードします。

  • test.xml | test1.xml | test2.xml - 指定したすべてのファイルをアップロードします。

  • test* | test1* - パターンtest*およびtest1*と一致するすべてのファイルをアップロードします

  • test.xml - 1つのファイルのみがアップロードされます。

OVERWRITE

いいえ

このパラメータは、アップロード操作が既存のファイルを上書きするかどうかを示します。このパラメータのデフォルト値はNoです。

RETRY_ON_ERROR

いいえ

これは、アップロード中に障害またはエラーが発生したときの試行回数です。

RETRY_INTERVAL_SECONDS

いいえ

再試行間隔は、再試行の間隔の秒数を示します。

ノート:

アップロード操作は選択したバケットが存在しない場合は失敗します。

例

次のコマンドを使用して、Oracle Object Storageにファイルおよびディレクトリをアップロードします。

OdiObjectStorageUpload -SRC_LOGICAL_SCHEMA=FILE_LS_OBJUPLOAD -TRG_LOGICAL_SCHEMA=OBJ_LS_OBJUPLOAD -FILE_NAMES_FILTER=*SE* -OVERWRITE=yes -RETRY_ON_ERROR=2 -RETRY_INTERVAL_SECONDS=3

OdiOggCommand

このコマンドを使用して、実行時に特定のタスクを実行しGoldenGateプロセスと対話することで、Oracle GoldenGateベースのCDCメカニズムを統合できます。

使用方法

OdiOggCommand -OPERATION="ADDEXTRACT" -LSCHEMA="%EXTRACT_LSCHEMA%"
OdiOggCommand -OPERATION="ADDREPLICAT" -LSCHEMA="%REPLICAT_LSCHEMA%"
OdiOggCommand -OPERATION="DROPPROCESS" -LSCHEMA="%PROCESS_LSCHEMA%"
OdiOggCommand -OPERATION="STARTPROCESS" –LSCHEMA="%PROCESS_LSCHEMA%"
OdiOggCommand -OPERATION="STOPPROCESS" –LSCHEMA="%PROCESS_LSCHEMA%"
OdiOggCommand -OPERATION="SAVEPARAM" –LSCHEMA="%PROCESS_LSCHEMA%" -FILEPATH="%TMP/PRMFILE%"
OdiOggCommand -OPERATION="ADDPUMP" -LSCHEMA="%EXTRACT_LSCHEMA%" -NAME="%PUMPNAME%"
OdiOggCommand -OPERATION="ADDCHECKPOINTTABLE" -LSCHEMA="%REPLICAT_LSCHEMA%" -TABLE="TABLE_NAME"
OdiOggCommand -OPERATION="DEFGEN” -LSCHEMA="%EXTRACT_LSCHEMA%" –TGT_LSCHEMA="%REPLICAT_LSCHEMA%"
OdiOggCommand -OPERATION="ADDTRANDATA" –LSCHEMA="%EXTRACT_LSCHEMA%" –TABLE_NAME="%TABLENAME%" –COLLIST="%[col1,col2]%"
OdiOggCommand -OPERATION="DBLOGIN" –LSCHEMA="%PROCESS_LSCHEMA%" -MODEL_LSCHEMA_NAME="%EXTR_MODEL_DB_LSCHEMA%"
OdiOggCommand -OPERATION="DBLOGIN" –LSCHEMA="%PROCESS_LSCHEMA%" –PSCHEMA_NAME="%REPLICAT_TGT_PSCHEMA%"

操作

操作 説明 必須パラメータ サポートされるカスタム・パラメータ 備考

ADDEXTRACT

ExtractプロセスをGoldenGateにJAgentを通じて追加します。

-LSCHEMA="%EXTRACT_LSCHEMA%"

-BEGINNOW="TRUE|FALSE"

ExtractおよびJAgentホストの詳細を取得します。

ADDREPLICAT

ReplicatプロセスをGoldenGateにJAgentを通じて追加します。

-LSCHEMA="%REPLICAT_LSCHEMA%"

該当なし

ReplicatおよびJAgentホストの詳細を取得します。

DROPPROCESS

論理スキーマに関連付けられているプロセスを削除します。

-LSCHEMA="%PROCESS_LSCHEMA%"

該当なし

プロセスのタイプおよび論理スキーマに基づいてホスト詳細を取得します。

STARTPROCESS

論理スキーマに関連付けられているプロセスを開始します。

-LSCHEMA="%PROCESS_LSCHEMA%"

該当なし

プロセスのタイプおよび論理スキーマに基づいてホスト詳細を取得します。

STOPPROCESS

論理スキーマに関連付けられているプロセスを停止します。

–LSCHEMA="%PROCESS_LSCHEMA%"

該当なし

プロセスのタイプおよび論理スキーマに基づいてホスト詳細を取得します。

SAVEPARAM

paramファイルをアップロードします。

–LSCHEMA="%PROCESS_LSCHEMA%"

-FILEPATH="%TMP/PRMFILE%"

プロセスに関連付けられているparamファイルを、論理スキーマに関連付けられているJAgentホストに保存します。

ADDPUMP

Extractプロセスに関連付けられているJAgentホストにポンプ・プロセスを追加します。

-LSCHEMA="%EXTRACT_LSCHEMA%"

-NAME="%PUMPNAME%"

ポンプ・プロセスをReplicatプロセスに関連付ける場合、ポンプの名前はREPLICAT_NAME#Pになります。

ADDCHECKPOINTTABLE

チェックポイント表を追加します。

-LSCHEMA="%REPLICAT_LSCHEMA%"

-TABLE="TABLE_NAME"

表名はJKMオプションから取得されます。

DEFGEN

defgenをロードして実行します。

-LSCHEMA="%EXTRACT_LSCHEMA%"

–TGT_LSCHEMA="%REPLICAT_LSCHEMA%"

Extractソースで実行するdefgenはターゲットのReplicatホストに保存されます。

ADDTRANDATA

Extractソースでtranデータを有効化します。

–LSCHEMA="%EXTRACT_LSCHEMA%"

–TABLE_NAME="%TABLENAME%" –COLLIST="%[col1,col2]%"

これはExtract JAgentホストに対して実行する必要があります。表と列の詳細を指定する必要があります。

DBLOGIN

GoldenGate操作を可能にするためのデータベース・ログイン。

–LSCHEMA="%PROCESS_LSCHEMA%"

-MODEL_LSCHEMA_NAME="%EXTR_MODEL_DB_LSCHEMA%"

データベースへのログインに必要なユーザー名とパスワードを、ジャーナル化されたモデル論理スキーマと現在のコンテキストから取得できます。

DBLOGIN

GoldenGate操作を可能にするためのデータベース・ログイン。

–LSCHEMA="%PROCESS_LSCHEMA%"

–PSCHEMA_NAME="%REPLICAT_TGT_PSCHEMA%"

データベースへのログインに必要なユーザー名とパスワードを、Replicatプロセスに割り当てられたモデル物理スキーマと現在のコンテキストから取得できます。

例

ExtractプロセスをGoldenGateに追加します。

OdiOggCommand -OPERATION="ADDEXTRACT" -LSCHEMA="<%=odiRef.getOggProcessLschemaName("EXTRACT")%>"

Replicatプロセスに割り当てられた物理スキーマからユーザー名とパスワードを取得して、データベースにログインします。

OdiOggCommand -OPERATION="DBLOGIN" –LSCHEMA="<%=odiRef.getOggProcessLschemaName("REPLICAT")%>" 
-PSCHEMA_NAME="<%=odiRef.getOggProcessInfo("<%=odiRef.getOggProcessLschemaName("REPLICAT")%>"),"DB_PSCHEMA")"

Extractプロセスに関連付けられているJAgentホストにポンプ・プロセスを追加します。

OdiOggCommand -OPERATION="ADDPUMP" -LSCHEMA=""<%=odiRef.getOggProcessLschemaName("EXTRACT")%>"" 
-NAME="<%=odiRef.getProcessInfo("<%=odiRef.getOggProcessLschemaName("REPLICAT")%>"),"NAME")"

OdiOSCommand

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

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

  • Windowsオペレーティング・システム(cmdを使用)

  • POSIX準拠オペレーティング・システム(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>

いいえ

出力ファイルを上書きせずに追加するかどうか。デフォルト値はYesです。

-WORKING_DIR=<workingdir>

いいえ

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

-SYNCHRONOUS=<yes|no>

いいえ

Yes (デフォルト)に設定すると、セッションはコマンドの終了を待機します。Noに設定すると、セッションはエラー・コード0で即時に続行します。デフォルトは同期モードです。

-CAPTURE_OUT_STREAM=[ON_ERROR[,]][ALL|NONE|[NSTART][,NEND]]

いいえ

出力ストリームに書き込まれるコンテンツを取得し、オペレータ内のタスク実行の詳細に表示する場合に使用します。ON_ERRORに設定されている場合、タスクが失敗した場合のみコンテンツが取得されます。ALLまたはNONEに設定されている場合、出力ストリームがすべて取得されるか、1つも取得されません。NSTARTおよびNENDを使用して、取得する行数を指定します(開始から終了まで)。

-CAPTURE_ERR_STREAM=[ON_ERROR[,]][ALL|NONE|[NSTART][,NEND]]

いいえ

エラー・ストリームに書き込まれるコンテンツを取得し、オペレータ内のタスク・エラー・メッセージに表示する場合に使用します。ON_ERRORに設定されている場合、タスクが失敗した場合のみコンテンツが取得されます。ALLまたはNONEに設定されている場合、出力ストリームがすべて取得されるか、1つも取得されません。NSTARTおよびNENDを使用して、取得する行数を指定します(開始から終了まで)。

例

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

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です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/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パラメータを使用してください。テキストには、変数または代入メソッドを指定できます。

-TO_HDFS=<yes|no>

いいえ

出力ファイルがHDFSで作成されるかどうかを示します

-TGT_LSCHEMA

いいえ

論理スキーマ値に基づいて解決されたデータ・サーバー上にファイルが配置されているかどうかを示します。

例

実行したエージェントの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")%>

実行したエージェントのWindowsシステムのファイル・ホストにエントリPLUTONを追加します。 

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

OdiPingAgent

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

使用方法

OdiPingAgent -AGENT_NAME=<physical_agent_name>

パラメータ

パラメータ 必須 説明

-AGENT_NAME=<physical_agent_name>

はい

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

例

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

OdiPingAgent -AGENT_NAME=AGENT_SOLARIS_DEV

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>] [-EXPORT_KEY=<key>] [-TODIR=<directory>]
[-ZIPFILE_NAME=<zipfile_name>] [-XML_CHARSET=<charset>] [-JAVA_CHARSET=<charset>]
[-REMOVE_TEMPORARY_OBJECTS=<yes|no>] [ARCHIVE_WITHOUT_CIPHER_DATA=<yes|no>]

パラメータ

パラメータ 必須 説明

-PURGE_TYPE=<SESSION|LOAD_PLAN_RUN|ALL>

いいえ

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

-COUNT=<session_number>

いいえ

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

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

-EXPORT_KEY=<key>

いいえ脚注22

機密的な暗号データを暗号化するために使用される暗号秘密キーを指定します。暗号データをインポートするためにエクスポート済オブジェクトをインポートするときに、このキーを再指定する必要があります。

-ARCHIVE_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注23

Yesに設定した場合、オブジェクトのアーカイブ時にその機密(暗号)値をnullに設定する必要があります。Noに設定した場合、またはこのパラメータを省略した場合は、-EXPORT_KEYパラメータを追加して、有効なキーを指定する必要があります。デフォルト値は「いいえ」です。

-TODIR=<directory>

いいえ

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

-ZIPFILE_NAME=<zipfile_name>

いいえ

圧縮ファイルの名前。

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

-XML_CHARSET=<charset>

いいえ

エクスポート・ファイルのXMLエンコーディング。デフォルト値はISO-8859-1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-JAVA_CHARSET=<charset>

いいえ

エクスポート・ファイルのエンコーディング。デフォルト値はISO8859_1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-REMOVE_TEMPORARY_OBJECTS=<yes|no>

いいえ

Yes (デフォルト)に設定すると、一時オブジェクトが削除されるように、クリーンアップ・タスクが実行されてからセッションがパージされます。

脚注 22

-EXPORT_KEYパラメータを指定しない場合は、-ARCHIVE_WITHOUT_CIPHER_DATAパラメータを指定して、Yesに設定する必要があります。

脚注23

-ARCHIVE_WITHOUT_CIPHER_DATAを指定しない場合、または指定してNoに設定した場合は、-EXPORT_KEYパラメータを有効なキー値とともに指定する必要があります。

例

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"

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

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

OdiReadMail

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

このコマンドは、-USERと-PASSで指定された接続パラメータを使用して、メール・サーバー-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です。これは、無限の待機時間を意味します(パラメータ-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.example.com -USER=myaccount -PASS=mypass
-KEEP=no -FOLDER=c:\support -TIMEOUT=0 -MAX_MSG=0
-SENDER=support@example.com -EXTRACT_MSG=yes -MSG_PRF=TXT
-EXTRACT_ATT=yes

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

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

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

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を0にリセットします。 

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

OdiRemoveTemporaryObjects

このコマンドを使用して、実行の間で残っている可能性のある一時オブジェクトを削除します。これは、ツール・パラメータで指定されたパラメータにより識別されるセッションに対してクリーンアップ・タスクを実行することで行います。

使用方法

OdiRemoveTemporaryObjects [-COUNT=<session_number>] [-FROMDATE=<from_date>]
[-TODATE=<to_date>] [-CONTEXT_CODE=<context_code>]
[-AGENT_NAME=<agent_name>] [-USER_NAME=<user_name>]
[-NAME=<session_name>] [-ERRORS_ALLOWED=<number_of_errors_allowed>]

パラメータ

パラメータ 必須 説明

-COUNT=<session_number>

いいえ

クリーンアップをスキップするセッション数。最新のセッション数(<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を省略すると、すべてのコンテキストでクリーンアップが実行されます。

-AGENT_NAME=<agent_name>

いいえ

このエージェント(<agent_name>)により実行されたセッションのみをクリーンアップします。

-USER_NAME=<user_name>

いいえ

このユーザー(<user_name>)が起動したセッションのみをクリーンアップします。

-NAME=<session_name>

いいえ

セッション名。

-ERRORS_ALLOWED=<number_of_errors_allowed>

いいえ

ステップがOKで終了するまでの許容エラー数。0に設定すると、クリーンアップ・フェーズ中に発生するエラーの数にかかわらず、ステップはOKで終了します。

例

2013/03/25 00:00:00から2013/08/31 21:59:00に実行されたすべてのセッションのクリーンアップ・タスクを実行することで、一時オブジェクトを削除します。

OdiRemoveTemporaryObjects "-FROMDATE=2013/03/25 00:00:00" "-TODATE=2013/08/31 21:59:00"

InternalエージェントによりGLOBALコンテキストで実行されたすべてのセッションのクリーンアップ・タスクを実行することで、一時オブジェクトを削除します。 

OdiRemoveTemporaryObjects "-CONTEXT_CODE=GLOBAL" "-AGENT_NAME=Internal"

OdiRetrieveHadoopLog

このコマンドを使用して、Oozie実行エージェントでの実行に関するログ情報を取得します。

使用方法

OdiRetrieveHadoopLog [-SESSION_LIST=<session-ids>] -POLLINT=<poll> -TIMEOUT=<timeout>

パラメータ

パラメータ 必須 説明

-SESSION_LIST=<session-ids>

いいえ

取得するセッションIDのカンマ区切りのリスト。空白の場合、現在実行されているOozieセッションがすべて取得されます。

-POLLINT=<poll>

いいえ

ログ・データを取得する場合の各インスタンス間の時間の長さ。秒(s)、分(m)、時、(h)、日(d),または年(y)単位があります。ゼロの場合、ログ・データは1回取得され、ツールは終了します。

-TIMEOUT=<timeout>

いいえ

ツールが実行される最大時間。秒(s)、分(m)、時、(h)、日(d)または年(y)単位があります。ゼロの場合、ポーリング間隔に応じてログがポーリングされて取得され、取得の候補となるセッションがない場合は終了します

例

現在のセッションがOozie実行エンジン内で実行されている場合、このセッションに対してHadoopログの1回かぎりの取得が実行されます。

OdiRetrieveHadopLog -SESSION_LIST=<?=odiRef.getSession("SESS_NO")?>

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

OdiReverseGetMetaData

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

ノート:

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

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

使用方法

OdiReverseGetMetaData -MODEL=<model_id>

パラメータ

パラメータ 必須 説明

-MODEL=<model_id>

はい

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

例

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

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

OdiReverseManageShortcut

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

使用方法

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

パラメータ

パラメータ 必須 説明

-MODEL=<model_id>

はい

リバースするモデルのグローバル識別子。

-MODE=ALWAYS_MATERIALIZE|ALWAYS_SKIP|PROMPT

はい

このパラメータは、パッケージまたはシナリオがODI Studioで実行される場合にのみサポートされます。

このパラメータには次の値を使用できます。

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

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

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

例

ALWAYS_MATERIALIZEモードのモデル44fa5543-a378-4442-ac64-3dabab65ef98のリバース。 

OdiReverseManageShortcut -MODEL=44fa5543-a378-4442-ac64-3dabab65ef98 -MODE=ALWAYS_MATERIALIZE

OdiReverseResetTable

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

使用方法

OdiReverseResetTable -MODEL=<model_id>

パラメータ

パラメータ 必須 説明

-MODEL=<model_id>

はい

リバースするモデルのグローバル識別子。

例

OdiReverseResetTable -MODEL=44fa5543-a378-4442-ac64-3dabab65ef98

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がターゲット表の更新キーとして使用されます。

例

TABLE_NAMEをターゲット表の更新キーとして使用する、モデル125880のリバース。 

OdiReverseSetMetaData -MODEL=44fa5543-a378-4442-ac64-3dabab65ef98 -USE_TABLE_NAME_FOR_UPDATE=true

OdiRollbackDeploymentArchive

このコマンドは、ODIリポジトリからパッチ・デプロイメント・アーカイブ(DA)をロールバックする場合に使用します。

使用方法

OdiRollbackDeploymentArchive -ROLLBACK_FILE_NAME=<rollback_file_name>
[-APPLY_WITHOUT_CIPHER_DATA=<yes|no>] [-EXPORT_KEY=<Export_Key>]

パラメータ

パラメータ 必須 説明

ROLLBACK_FILE_NAME=<rollback_file_name>

はい

ロールバック・デプロイメント・アーカイブの完全ファイル名。

APPLY_WITHOUT_CIPHER_DATA=<yes|no>

いいえ脚注24

Yesに設定した場合、デプロイメント・アーカイブ内の暗号データがnullになります。Noに設定した場合、エクスポート・キーを使用して暗号データが移行されます。デフォルト値は「いいえ」です。

EXPORT_KEY=<Export_Key>

いいえ

暗号データをデプロイメント・アーカイブ・オブジェクトに移行するための暗号秘密キーを指定します。

脚注24

APPLY_WITHOUT_CIPHER_DATAパラメータをNoに設定した場合、EXPORT_KEYパラメータを指定する必要があります。

例

最後に適用したパッチ・デプロイメント・アーカイブをエクスポート・キーを使用してロールバックします。

OdiRollbackDeploymentArchive -ROLLBACK_FILE_NAME=rollback_file_name
-APPLY_WITHOUT_CIPHER_DATA=no -EXPORT_KEY=Export_Key

OdiSAPALEClientおよびOdiSAPALEClient3

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

ノート:

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

使用方法

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を指定しない場合は必須です。-GATEWAYHOSTと-MESSAGESERVERHOSTの両方が指定された場合は、-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>

いいえ

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

-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も移動します。デフォルト値は「いいえ」です。

例

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

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

OdiSAPALEServerおよびOdiSAPALEServer3

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

ノート:

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

使用方法

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ログオン・パスワード。このパスワードはシステム・コマンド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に設定されている場合、サーバーの存続期間は無限です。デフォルト値は0 (ゼロ)です。

-MAX_CONNECTIONS=<n>

はい

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

-INTERREQUESTTIMEOUT=<n>

いいえ

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

-MAXREQUEST=<n>

いいえ

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

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

-TRACE=<no|yes>

いいえ

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

-

いいえ

SAP内のRFC宛先と一致する必要があります。SAPトランザクションSM59内のUnicode設定がこのパラメータと一致していることを検証します。

ノート: OdiSAPALEServer3に対してのみ適用されます。

例

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

OdiScpGet

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

使用方法

OdiScpGet -HOST=<ssh server host name> -USER=<ssh user>
[-PASSWORD=<ssh user password>] -REMOTE_DIR=<remote dir on ssh host>
[-REMOTE_FILE=<file name under the REMOTE_DIR>] -LOCAL_DIR=<local dir>
[-LOCAL_FILE=<file name under the LOCAL_DIR>]
[-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=<ssh server host name>

はい

SSHサーバーのホスト名。

-USER=<ssh user>

はい

SSHサーバーのユーザー。

-PASSWORD=<ssh user password>

いいえ

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

-REMOTE_DIR=<dir on remote SSH

はい

リモート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>

いいえ

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

-COMPRESSION=<yes|no>

いいえ

Yesに設定すると、データ圧縮が使用されます。デフォルト値は「いいえ」です。

-STRICT_HOSTKEY_CHECKING=<yes|no>

いいえ

Yes (デフォルト)に設定すると、厳密なホスト・キー・チェックが実行され、リモートSSHホスト・キーが–KNOWNHOSTS_FILEで指定された既知のホストに存在しない場合は、認証に失敗します。

-PROXY_HOST=<proxy server host name>

いいえ

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

-PROXY_PORT=<proxy server port>

いいえ

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

-PROXY_TYPE=<HTTP|SOCKS5>

いいえ

接続するプロキシ・サーバーのタイプ(HTTPまたはSOCKS5)。

-TIMEOUT=<time in seconds>

いいえ

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

例

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

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

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

OdiScpGet -HOST=machine.example.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.example.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.example.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.example.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

OdiScpPut

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

使用方法

OdiScpPut -HOST=<SSH server 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 ssh host>
[-REMOTE_FILE=<file name under the REMOTE_DIR>]
[-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

はい

リモート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>

いいえ

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

-COMPRESSION=<yes|no>

いいえ

Yesに設定すると、データ圧縮が使用されます。デフォルト値は「いいえ」です。

-STRICT_HOSTKEY_CHECKING=<yes|no>

いいえ

Yes (デフォルト)に設定すると、厳密なホスト・キー・チェックが実行され、リモートSSHホスト・キーが–KNOWNHOSTS_FILEで指定された既知のホストに存在しない場合は、認証に失敗します。

-PROXY_HOST=<proxy server host name>

いいえ

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

-PROXY_PORT=<proxy server port>

いいえ

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

-PROXY_TYPE=<HTTP|SOCKS5>

いいえ

接続するプロキシ・サーバーのタイプ(HTTPまたはSOCKS5)。

-TIMEOUT=<timeout value>

いいえ

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

例

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

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

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

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

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

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

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

OdiScpPut -HOST=machine.example.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ファイルをSSHサーバー上のリモート・ディレクトリ/にSample1.txtファイルとしてコピーします。アイデンティティ・ファイルのパスを指定して、公開キー認証が実施されます。-STRICT_HOSTKEY_CHECKINGパラメータにNoの値を渡すことで、すべてのホストが信頼されます。 

OdiScpPut -HOST=machine.example.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

OdiSendMail

このコマンドを使用して、電子メールをSMTPサーバーに送信します。

使用方法

OdiSendMail -MAILHOST=<mail_host> -FROM=<from_user> -TO=<address_list>
[-CC=<address_list>] [-BCC=<address_list>] [-SUBJECT=<subject>]
[-ATTACH=<file_path>]* [-PORT=<PortNumber>] [-PROTOCOL=<MailProtocol>] [-AUTH=<Yes|No>] [-AUTHMECHANISM=<MailAuthMechanism] [-USER=<Username>] [-PASS=<Password>] [-MSGBODY=<message_body> | CR/LF<message_body>]

パラメータ

パラメータ 必須 説明

-MAILHOST=<mail_host>

はい

SMTPサーバーのIPアドレス。

-FROM=<from_user>

はい

メッセージの送信者のアドレス。

例: support@example.com

送信者の外部名を送信するには、次の表記法を使用できます。

"-FROM=Support center <support@example.com>"

-TO=<address_list>

はい

受信者の電子メール・アドレス・リスト(カンマ区切り)。

例:

"-TO=sales@example.com, support@example.com"

-CC=<address_list>

いいえ

CC受信者の電子メール・アドレス・リスト(カンマ区切り)。

例:

"-CC=info@example.com"

-BCC=<address_list>

いいえ

コピー(BCC)受信者の電子メール・アドレス・リスト(カンマ区切り)。

例:

"-BCC=manager@example.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パラメータを使用してください。

-PORT

いいえ

メール・サーバーのポート番号。デフォルトは

javax.mailで使用される@ defaultポートです。

-PROTOCOL

いいえ

電子メール・プロトコル。SMTPまたはPOP3を指定できます。デフォルトはSMTPです。

-AUTH

いいえ

認証を使用する場合。値はYESまたはNOです。デフォルトはNOです。

-AUTHMECHANISMS

いいえ

メール・サーバーでサポートされる認証メカニズム。値は、PLAIN、LOGINまたはDIGEST-MD5です。

-USER

いいえ

認証の対象となるユーザー。認証が使用される場合のみです。

-PASS

いいえ

認証のパスワード。認証が使用される場合のみです。

例

OdiSendMail -MAILHOST=mail.example.com "-FROM=Application Oracle Data
Integrator<odi@example.com>" -TO=admin@example.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.

OdiSftp

このコマンドを使用して、SFTPサブシステムが有効なSSHサーバーに接続し、標準FTPコマンドをリモート・システムで実行します。スクリプトからのトレースは、オペレータ・ナビゲータのOdiSftpステップを表すタスクの実行詳細に対して記録されます。

使用方法

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

パラメータ

パラメータ 必須 説明

-HOST=<ssh server host name>

はい

SSHサーバーのホスト名。

-USER=<ssh user>

はい

SSHサーバーのユーザー。

-PASSWORD=<ssh user password>

いいえ

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

-LOCAL_DIR=<local dir>

はい

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

-REMOTE_DIR=<remote dir on ssh host>

はい

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

-TIMEOUT=<time in seconds>

いいえ

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

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

いいえ

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

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

いいえ

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

-COMPRESSION=<yes|no>

いいえ

Yesに設定すると、データ圧縮が使用されます。デフォルト値は「いいえ」です。

-STRICT_HOSTKEY_CHECKING=<yes|no>

いいえ

Yes (デフォルト)に設定すると、厳密なホスト・キー・チェックが実行され、リモートSSHホスト・キーが–KNOWNHOSTS_FILEで指定された既知のホストに存在しない場合は、認証に失敗します。

-PROXY_HOST=<proxy server host name>

いいえ

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

-PROXY_PORT=<proxy server port>

いいえ

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

-PROXY_TYPE<HTTP|SOCKS5>

いいえ

接続するプロキシ・サーバーのタイプ(HTTPまたはSOCKS5)。

STOP_ON_FTP_ERROR=<yes|no>

いいえ

Yes (デフォルト)に設定すると、エラーが発生した場合、ステップは完了まで実行されず、エラー・ステータスで停止されます。

-COMMAND=<command>

はい

実行するraw FTPコマンド。複数行コマンドの場合は、OdiSftp行の後に-COMMANDパラメータを指定せずに、コマンド全体をrawテキストとして渡します。

サポートされるコマンド:

APPE、CDUP、CWD、DELE、LIST、MKD、NLST、PWD、QUIT、RETR、RMD、RNFR、RNTO、SIZE、STOR

例

リモート・ホストで、任意のディレクトリに移動し、そのディレクトリからファイルを削除し、親ディレクトリに移動し、ディレクトリを削除するスクリプトを実行します。

OdiSftp -HOST=machine.example.com -USER=odiftpuser -PASSWORD=<password>
-LOCAL_DIR=/tmp -REMOTE_DIR=/tmp -STOP_ON_FTP_ERROR=No
CWD /tmp/ftpToolDir1
DELE ftpToolFile
CDUP
RMD ftpToolDir1

OdiSftpGet

このコマンドを使用して、SFTPサブシステムが有効なSSHサーバーからファイルをダウンロードします。

使用方法

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

ノート:

ローカルまたはリモートのファイル名の一部として%が必要な場合は、%だけではなく%25を渡す必要があります。

%25は自動的に%に解決されます。

たとえば、ファイル名をtemp%resultにする必要がある場合、REMOTE_FILE=temp%25resultまたは-LOCAL_FILE=temp%25resultとして渡す必要があります。

パラメータ

パラメータ 必須 説明

-HOST=<ssh server host name>

はい

SSHサーバーのホスト名。

コロン(:)を前に付けることにより、ポート番号をホスト名に追加できます。たとえば: machine.example.com:25

ポートが指定されていない場合、デフォルトでポート22が使用されます。

-USER=<ssh user>

はい

SSHサーバーのユーザー。

-PASSWORD=<ssh user password>

いいえ

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

-REMOTE_DIR=<remote 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>

はい

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

-LOCAL_FILE=<file name under LOCAL_DIR>

いいえ

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

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

例:

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

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

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

いいえ

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

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

いいえ

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

-COMPRESSION=<yes|no>

いいえ

Yesに設定すると、データ圧縮が使用されます。デフォルト値は「いいえ」です。

-STRICT_HOSTKEY_CHECKING=<yes|no>

いいえ

Yes (デフォルト)に設定すると、厳密なホスト・キー・チェックが実行され、リモートSSHホスト・キーが–KNOWNHOSTS_FILEで指定された既知のホストに存在しない場合は、認証に失敗します。

-PROXY_HOST=<proxy server host name>

いいえ

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

-PROXY_PORT=<proxy server port>

いいえ

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

-PROXY_TYPE=<HTTP|SOCKS5>

いいえ

接続するプロキシ・サーバーのタイプ(HTTPまたはSOCKS5)。

-TIMEOUT=<time in seconds>

いいえ

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

例

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

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

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

OdiSftpGet -HOST=machine.example.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.example.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.example.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

OdiSftpPut

このコマンドを使用して、SFTPサブシステムが有効なSSHサーバーにファイルをアップロードします。

使用方法

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

ノート:

ローカルまたはリモートのファイル名の一部として%が必要な場合は、%だけではなく%25を渡す必要があります。

%25は自動的に%に解決されます。

たとえば、ファイル名をtemp%resultにする必要がある場合、REMOTE_FILE=temp%25resultまたは-LOCAL_FILE=temp%25resultとして渡す必要があります。

パラメータ

パラメータ 必須 説明

-HOST=<ssh server host name>

はい

SSHサーバーのホスト名。

コロン(:)を前に付けることにより、ポート番号をホスト名に追加できます。たとえば: machine.example.com:25

ポートが指定されていない場合、デフォルトでポート22が使用されます。

-USER=<ssh user>

はい

SSHサーバーのユーザー。

-PASSWORD=<ssh user password>

いいえ

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

-REMOTE_DIR=<remote 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>

はい

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

-LOCAL_FILE=<file name under LOCAL_DIR>

いいえ

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

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

例:

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

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

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

いいえ

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

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

いいえ

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

-COMPRESSION=<yes|no>

いいえ

Yesに設定すると、データ圧縮が使用されます。デフォルト値は「いいえ」です。

-STRICT_HOSTKEY_CHECKING=<yes|no>

いいえ

Yes (デフォルト)に設定すると、厳密なホスト・キー・チェックが実行され、リモートSSHホスト・キーが–KNOWNHOSTS_FILEで指定された既知のホストに存在しない場合は、認証に失敗します。

-PROXY_HOST=<proxy server host name>

いいえ

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

-PROXY_PORT=<proxy server port>

いいえ

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

-PROXY_TYPE=<HTTP|SOCKS5>

いいえ

接続するプロキシ・サーバーのタイプ(HTTPまたはSOCKS5)。

-TIMEOUT=<time in seconds>

いいえ

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

例

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

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

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

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

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

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

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

OdiSftpPut -HOST=machine.example.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ファイルをSSHサーバー上のリモート・ディレクトリ/にSample1.txtファイルとしてコピーします。アイデンティティ・ファイルのパスを指定して、公開キー認証が実施されます。-STRICT_HOSTKEY_CHECKINGパラメータにNoの値を渡すことで、すべてのホストが信頼されます。 

OdiSftpPut -HOST=machine.example.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

OdiSleep

このコマンドを使用して、<delay>ミリ秒間待機します。

使用方法

OdiSleep -DELAY=<delay>

パラメータ

パラメータ 必須 説明

-DELAY=<delay>

はい

待機するミリ秒数。

例

OdiSleep -DELAY=5000

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>] [-TIME_FORMAT=<time_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>を使用して暗号化できます。

agent (.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の日時書式パターンを使用して指定されます。

-TIME_FORMAT=<time_format>

いいえ

時間データ型に使用する出力書式。

たとえば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" "-TIME_FORMAT=hh:mm:ss"

-CHARSET_ENCODING=<encoding>

いいえ

ターゲット・ファイルのエンコーディング。デフォルト値はISO-8859-1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-XML_CHARSET_ENCODING=<encoding>

いいえ

XMLファイル内に<?xml version="1.0" encoding="ISO-8859-1"?>のタグで指定されるエンコーディング。デフォルト値はISO-8859-1です。サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

-FETCH_SIZE=<array_fetch_size>

いいえ

データ・サーバーとの通信ごとに、Oracle 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パラメータを使用する必要があります。

例

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"
"-TIME_FORMAT=hh:mm:ss"
select cust_id, cust_name, cust_creation_date from Northwind.dbo.Customers

OdiStartLoadPlan

このコマンドを使用して、ロード計画を開始します。

-SYNCパラメータは、同期モードまたは非同期モードでロード計画を開始します。同期モードでは、ツールは、完了したロード計画実行と同じステータスで終了します。

使用方法

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> ...] [-SYNC=<yes|no>] [-POLLINT=<msec>]

パラメータ

パラメータ 必須 説明

-LOAD_PLAN_NAME=<load_plan_name>

はい

開始するロード計画の名前。

-LOG_LEVEL=<log_level>

いいえ

保持するロギング情報のレベル。この値以下のログ・レベルが定義されているすべてのセッションは、セッション完了時に、セッション・ログに保持されます。ただし、オブジェクトの実行が異常終了した場合は、この設定にかかわらず、すべてのタスクが保持されます。

ログ・レベル6は、ログ・レベル5と動作は同じですが、変数と順序の追跡が追加されていることに注意してください。詳細は、『Oracle Data Integratorでの統合プロジェクトの開発』の変数および順序の追跡に関する項を参照してください。

[-CONTEXT=<context_code>]

はい

実行コンテキストのコード。このパラメータを省略すると、コール元セッションの実行コンテキストで、ロード計画が開始されます(ある場合)。

[-AGENT_URL=<agent_url>]

いいえ

ロード計画を開始するリモート・エージェントのURL。

[-AGENT_CODE=<logical_agent_code>]

いいえ

このロード計画の開始を担当する論理エージェントのコード。このパラメータと-AGENT_URLを省略すると、現在のエージェントがこのロード計画を開始します。-AGENT_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>の形式になります。

-SYNC=<yes|no>

いいえ

ロード計画を同期または非同期のどちらで実行するかを指定します。

Yes (同期モード)を設定すると、ロード計画が開始され、完了またはエラーのステータスで完了するまで実行されてから、制御が返されます。

No (非同期モード)に設定すると、ロード計画が開始され、制御が返されてから、ロード計画が完了まで実行されます。デフォルト値は「いいえ」です。

-POLLINT=<msec>

いいえ

完了状態のロード計画実行のステータスのポーリング間に待機する期間(ミリ秒)。-SYNCパラメータはYesに設定されている必要があります。デフォルト値は1000 (1秒)です。この値は0より大きくなければなりません。

例

同じエージェントのGLOBALコンテキストでロード計画LOAD_DWHを開始します。 

OdiStartLoadPlan -LOAD_PLAN_NAME=LOAD_DWH -CONTEXT=GLOBAL

OdiStartOwbJob

このコマンドを使用して、Oracle Data Integrator内からOracle Warehouse Builder (OWB)オブジェクトを実行し、実行監査データをOracle Data Integratorに取得します。

このコマンドは、トポロジ・ナビゲータで作成できるOracle Warehouse Builderランタイム・リポジトリ・データ・サーバーを使用します。このデータ・サーバーは、Oracle Warehouse BuilderワークスペースにアクセスできるOracle Warehouse Builderユーザーとして接続する必要があります。このデータ・サーバーでの物理スキーマは、このユーザーがアクセスできるOracle Warehouse Builderワークスペースを表します。Oracle Data Integratorトポロジの詳細は、『Oracle Data Integratorの管理』のトポロジの設定に関する項を参照してください。

使用方法

OdiStartOwbJob -WORKSPACE=<logical_owb_repository> -LOCATION=<owb_location>
-OBJECT_NAME=<owb_object> -OBJECT_TYPE=<owb_object_type>
[-EXEC_PARAMS=<exec_params>] [-CONTEXT=<context_code>] [-LOG_LEVEL=<log_level>]
[-SYNC_MODE=<1|2>] [-POLLINT=<n>] [-SESSION_NAME=<session_name>]
[-KEYWORDS=<keywords>] [<OWB parameters>]

パラメータ

パラメータ 必須 説明

-WORKSPACE=<logical_owb_repository>

はい

OWBランタイム・リポジトリ・テクノロジの論理スキーマ。これは、実行するOracle Warehouse Builderオブジェクトを含むOracle Warehouse Builderワークスペースを表す物理スキーマに解決されます。トポロジ・ナビゲータのOWBランタイム・リポジトリ・データサーバーの下に物理スキーマを追加したときに、Oracle Warehouse Builderワークスペースが選択されています。

このマッピングのコンテキストを、-CONTEXTパラメータを使用して指定することもできます。

-LOCATION=<owb_location>

はい

実行するOracle Warehouse Builderオブジェクトを含むOracle Warehouse Builderの場所の名前。この場所は、-WORKSPACEから解決される物理ワークスペースに存在している必要があります。

-OBJECT_NAME=<owb_object>

はい

Oracle Warehouse Builderオブジェクトの名前。このオブジェクトは-LOCATIONに存在している必要があります。

-OBJECT_TYPE=<owb_object_type>

はい

Oracle Warehouse Builderオブジェクトのタイプ。たとえば:

PLSQLMAP、PROCESSFLOW、SQLLOADERCONTROLFILE、MAPPING、DATAAUDITOR、ABAPFILE

-EXEC_PARAMS=<exec_params>

いいえ

Oracle Warehouse Builder実行のためのカスタム・パラメータまたはシステム・パラメータ(あるいはその両方)。

-CONTEXT=<context_code>

いいえ

Oracle Warehouse Builderオブジェクトの実行コンテキスト。これは、論理ワークスペースが解決されるコンテキストです。Studioエディタはこの値か、またはデフォルト・コンテキストを使用します。実行は、この値か、または親セッション・コンテキストを使用します。

-LOG_LEVEL=<log_level>

いいえ

ログ・レベル(0 - 5)。デフォルト値は5です。これは、最大の詳細がログに取得されることを意味します。

-SYNC_MODE=<1|2>

いいえ

Oracle Warehouse Builderジョブの同期モード:

1 - 同期(デフォルト)。Oracle Warehouse Builderジョブが終了するまでセッションの実行が待機されます。

2 - 非同期。Oracle Warehouse Builderジョブの終了を待機せずにセッションが引き続き実行されます。

-POLLINT=<n>

いいえ

Oracle Warehouse Builder監査データをOracle Data Integratorログ表へ転送してから次の転送まで待機する期間(ミリ秒単位)。デフォルト値は0です。これは、監査データが実行の最後に転送されることを意味します。

-SESSION_NAME=<session_name>

いいえ

ログに表示されるOracle Warehouse Builderセッションの名前。

-KEYWORDS=<keywords>

いいえ

セッションに関連付けられているキーワードのカンマ区切りリスト。

<OWB parameters>

いいえ

オブジェクトに関連するOracle Warehouse Builderパラメータの値リスト。このリストは、-PARAM_NAME=valueの形式になります。Oracle Warehouse Builderシステム・パラメータは、前にOWB_SYSTEMを付ける必要があります(OWB_SYSTEM.AUDIT_LEVELなど)。

例

Oracle Workflow DEV_OWFにデプロイされたOracle Warehouse Builderプロセス・フローLOAD_USERSを実行します。 

OdiStartOwbJob -WORKSPACE=OWB_WS1 -CONTEXT=QA
-LOCATION=DEV_OWF -OBJECT_NAME=LOAD_USERS -OBJECT_TYPE=PROCESSFLOW

データベースの場所DEV_STAGEにデプロイされているOracle Warehouse Builder PL/SQLマップSTAGE_USERSを実行します。Oracle Warehouse Builder監査データを5秒ごとにポーリングおよび転送します。Oracle Data Integrator変数から値が取得される入力パラメータAGE_LIMITを渡し、PL/SQLマップに関連するOracle Warehouse Builderシステム・パラメータを指定します。 

OdiStartOwbJob -WORKSPACE=OWB_WS1 -CONTEXT=QA
-LOCATION=DEV_STAGE -OBJECT_NAME=STAGE_USERS -OBJECT_TYPE=PLSQLMAP
-POLLINT=5000 -OWB_SYSTEM.MAX_NO_OF_ERRORS=25 -AGE_LIMIT=#VAR_MINAGE

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=valueまたはGLOBAL.VARIABLE=valueの形式で指定します。

例

本番コンテキストでシナリオ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

OdiStorageCSDownload

このコマンドを使用して、1つまたは複数のファイル、あるいはディレクトリ全体を、Oracle Storage Cloud ServiceからHDFSまたはローカルのファイル・システムにダウンロードします。HDFSファイルの場合、最初にファイルがOracle Storage Cloud Service物理スキーマのローカル・ディレクトリにコピーされ(「ディレクトリ」 — 「作業スキーマ」でユーザーにより指定)、次に実際のディレクトリにダウンロードされます。

注意:

このツールは、Data Integration Platform Cloudにのみ適用できます。

使用方法

OdiStorageCSDownload
-SRC_LOGICAL_SCHEMA= <src_logical_schema>
-TRG_ LOGICAL_SCHEMA = <trg_logical_schema>
-FILE_NAMES_FILTER= <file_names_filter>
-OVERWRITE= Yes|No
-RETRY ON ERROR= <retry_number>
-RETRY_INTERVAL_SECONDS = <retry_interval_seconds>
-DECRYPT_KEY = <decrypt_key>

表2-1 パラメータ

パラメータ 必須 説明

SRC_LOGICAL_SCHEMA

はい

Oracle Storage Cloud Serviceデータ・サーバー用に構成されたソース論理スキーマ名。これにはStorage Cloud Serviceインスタンスの情報が含まれます。コンテナ情報は、論理スキーマから、構成された物理スキーマを経由して取得されます。

TRG_LOGICAL_SCHEMA

はい

Oracle Storage Cloud ServiceからHDFSのローカルのファイル・システムにダウンロードするように、HDFSデータ・サーバーのファイルに構成された論理スキーマ名。

FILE_NAMES_FILTER

はい

Oracle Storage CSから再帰的にダウンロードする1つ以上のファイルを指定するフィールド。ファイルのリストを区切るためのデリミタ(|)もサポートします。

次のパターンに従います。

  • *.txt - .txtで終わるすべてのファイルをダウンロードします

  • test* - 接頭辞“test”と一致するすべてのファイルおよびディレクトリをダウンロードします

  • *test* - 部分文字列“test”を含むすべてのファイルおよびディレクトリをダウンロードします

  • test.xml | test1.xml | test2.xml - 指定したすべてのファイルをダウンロードします

  • test* | test1* - パターンtest*およびtest1*と一致するすべてのファイルをダウンロードします

  • test.xml - 1つのファイルのみがダウンロードされます。

OVERWRITE

いいえ

このパラメータは、ダウンロード操作が既存のファイルを上書きするかどうかを示します。このパラメータのデフォルト値はNoです。

RETRY_ON_ERROR

いいえ

これは、ダウンロード中に障害またはエラーが発生したときの試行回数です。

RETRY_INTERVAL_SECONDS

いいえ

再試行間隔は、再試行の間隔の秒数を示します。

DECRYPT_KEY

いいえ

これは、ファイルまたはオブジェクトをOracle Storage Cloud Serviceからダウンロードするときに暗号化するために使用されるユーザー指定のキーです。

ノート:

このパラメータは、暗号化キーを使用して暗号化されているオブジェクトをダウンロードする場合には、NULLにはできません。

例

次のコマンドを使用して、Oracle Storage Cloud Serviceからファイルおよびディレクトリをダウンロードします。

OdiStorageCSDownload –SRC_LOGICAL_SCHEMA=src_logical_schema –TRG_LOGICAL_SCHEMA=trg_logical_schema -FILE_NAMES_FILTER=file names filter

たとえば:

OdiStorageCSDownload "-TRG_LOGICAL_SCHEMA=File_LS_Download" "-SRC_LOGICAL_SCHEMA=StorageCS_LS" "-FILE_NAMES_FILTER=myfile.txt" "-OVERWRITE=YES"

OdiStorageCSUpload

このツールを使用して、1つまたは複数のファイル、あるいはディレクトリ全体を、HDFSまたはローカルのファイル・システムからOracle Storage Cloud Serviceにアップロードします。

注意:

このツールは、Data Integration Platform Cloudにのみ適用できます。

使用方法

OdiStorageCSUpload
-TRG_LOGICAL_SCHEMA = <trg_logical_schema>
-SRC_LOGICAL_SCHEMA = <src_logical_schema>
-FILE_NAMES_FILTER = <file_names_filter>
-OVERWRITE = Yes|No
-RETRY_ON_ERROR = <retry_number>
-RETRY_INTERVAL_SECONDS = <retry_interval_seconds>
-ENCRYPT_KEY = <encrypt_key>

パラメータ

表2-2 パラメータ

パラメータ 必須 説明

TRG_LOGICAL_SCHEMA

はい

Oracle Storage Cloud Serviceデータ・サーバー用に構成されたターゲット論理スキーマ名。これにはStorage Cloud Serviceインスタンスの情報が含まれます。コンテナ情報は、論理スキーマから、構成された物理スキーマを経由して取得されます。

SRC_LOGICAL_SCHEMA

はい

ファイルをローカルまたはHDFSからOracle Storage Cloud Serviceにアップロードするように、HDFSデータ・サーバーのファイルに構成されたソース論理スキーマ名。

FILE_NAMES_FILTER

はい

Oracle Storage Cloud Serviceに再帰的にアップロードする1つ以上のファイルまたはディレクトリを指定するフィールド。デリミタとして「|」で区切られたファイルのリストもサポートします。次のパターンに従います。

  • *.txt - .txtで終わるすべてのファイルをアップロードします

  • test* - 接頭辞“test”と一致するすべてのファイルおよびディレクトリをアップロードします

  • *test* - 部分文字列“test”を含むすべてのファイルおよびディレクトリをアップロードします。

  • test.xml | test1.xml | test2.xml - 指定したすべてのファイルをアップロードします。

  • test* | test1* - パターンtest*およびtest1*と一致するすべてのファイルをアップロードします

  • test.xml - 1つのファイルのみがアップロードされます。

OVERWRITE

いいえ

このパラメータは、アップロード操作が既存のファイルを上書きするかどうかを示します。このパラメータのデフォルト値はNoです。

RETRY_ON_ERROR

いいえ

これは、アップロード中に障害またはエラーが発生したときの試行回数です。

RETRY_INTERVAL_SECONDS

いいえ

再試行間隔は、再試行の間隔の秒数を示します。

ENCRYPT_KEY

いいえ

これは、ファイルまたはオブジェクトをOracle Storage Cloud Serviceにアップロードするときに暗号化するために使用されるユーザー指定のキーです。

ノート:

このパラメータは、アップロード時にオブジェクトを暗号化する場合には、NULLにはできません。

例

次のコマンドを使用して、Oracle Storage Cloud Serviceにファイルおよびディレクトリをアップロードします。

OdiStorageCSUpload -TRG_LOGICAL_SCHEMA =<trg_logical_schema> -SRC_LOGICAL_SCHEMA = <src_logical_schema> -FILE_NAMES_FILTER=file name filter

たとえば-

OdiStorageCSUpload "-TRG_LOGICAL_SCHEMA=StorageCS_LS_Archive" "-SRC_LOGICAL_SCHEMA=File_LS_Upload" "-FILE_NAMES_FILTER=myfile.txt" "-OVERWRITE=YES"

OdiUnZip

このコマンドを使用して、アーカイブ・ファイルをディレクトリに抽出します。

使用方法

OdiUnZip -FILE=<file> -TODIR=<target_directory> [-OVERWRITE=<yes|no>]
[-ENCODING=<file_name_encoding>]

パラメータ

パラメータ 必須 説明

-FILE=<file>

はい

抽出するZIPファイルのフル・パス。

-TODIR=<target_file>

はい

宛先ディレクトリまたはフォルダ。

-OVERWRITE=<yes|no>

いいえ

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

-ENCODING=<file_name_encoding>

いいえ

アーカイブ・ファイル内部でファイル名に使用される文字エンコーディング。可能な値のリストは、次を参照してください:

https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

デフォルトは、プラットフォームのデフォルトの文字エンコーディングです。

例

C:\archive\ディレクトリのarchive_001.zipファイルをC:\TEMPディレクトリに抽出します。 

OdiUnZip "-FILE=C:\archive\archive_001.zip" -TODIR=C:\TEMP\

OdiLockUnlockVCSRepository

このコマンドを使用して、リモートVCSリポジトリをロックまたはロック解除します。

このコマンドは、VCSシステムで使用されるすべての認証タイプをサポートします。

使用方法

OdiLockUnlockVCSRepository

[-VCS_LOCK_TYPE = <lock_type>]
[-VCS_TYPE=<vcs_type>]
[-VCS_AUTH_TYPE=<vcs_auth_type>]
[-VCS_URL=<vcs_url>]
[-VCS_USER=<vcs_user>]
[-VCS_PASS=<vcs_pass>]
[-VCS_PROXY_HOST=<vcs_proxy_host>]
[-VCS_PROXY_PORT=<vcs_proxy_port>]
[-VCS_PROXY_USER=<vcs_proxy_user>]
[-VCS_PROXY_PASS=<vcs_proxy_pass>]
[-VCS_SSH_PRIVATE_KEY_PATH=<vcs_ssh_private_key_path>]
[-VCS_SSH_PASS_PHRASE=<vcs_ssh_pass_phrase>]
[-VCS_SSH_PORT=<vcs_ssh_port>]
[-VCS_SSL_CERT_PATH=<vcs_ssl_ssl_cert_path>]
[-VCS_SSL_PASS_PHRASE=<vcs_ssl_pass_phrase>]

パラメータ

パラメータ 必須 説明

VCS_LOCK_TYPE

はい

VCSリポジトリのロック・タイプ。

ロック・タイプは次のように設定できます。

  • VCSリポジトリをロックする場合はLOCK。

  • VCSリポジトリをロック解除する場合はUNLOCK。

VCS_TYPE

はい

VCSのタイプ。SVNまたはGitを指定できます。

VCS_AUTH_TYPE

はい

使用するVCSの認証タイプ。

次の値をとります。

  • BASIC: HTTP認証の場合。

  • PROXY: プロキシ認証の場合。

  • SSH: SSH認証の場合。

  • SSL: SSL認証の場合。

  • FILE: ファイル認証の場合。

  • SVNBASIC: SVN Basic認証の場合。

  • GITBASIC: GIT Basic認証の場合。

VCS_URL

はい

VCSリポジトリのURL。

VCS_USER

いいえ

VCSユーザー名。

VCS_PASS

いいえ

VCSパスワード。

VCS_PROXY_HOST

いいえ

VCSプロキシ・ホスト。(VCS_AUTH_TYPEパラメータがPROXYに設定されている場合は必須。)

VCS_PROXY_PORT

いいえ

VCSプロキシ・ポート。(VCS_AUTH_TYPEパラメータがPROXYに設定されている場合は必須。)

VCS_PROXY_USER

いいえ

VCSプロキシ・ユーザー。(VCS_AUTH_TYPEパラメータがPROXYに設定されている場合は必須。)

VCS_PROXY_PASS

いいえ

VCSプロキシのパスワード。(VCS_AUTH_TYPEパラメータがPROXYに設定されている場合は必須。)

VCS_SSH_PRIVATE_KEY_PATH

いいえ

SSH秘密キー・ファイルのパス(SSH認証が使用されている場合)。

VCS_SSH_PASS_PHRASE

いいえ

SSHのパス・フレーズ(SSH認証の場合)。

VCS_SSH_PORT

いいえ

SSHポート(SSH認証の場合)。

VCS_SSL_CERT_PATH

いいえ

SSL証明書のパス。

VCS_SSL_PASS_PHRASE

いいえ

SSLのパス・フレーズ(SSL認証の場合)。

例

./startcmd.sh -INSTANCE=OracleDIAgent1 OdiLockUnlockVCSRepository -VCS_LOCK_TYPE=<LOCK|UNLOCK> -VCS_TYPE=<GIT|SVN> -VCS_AUTH_TYPE=<BASIC | PROXY | SSH | SSL |FILE | SVNBASIC | GITBASIC> -VCS_URL=<vcs url> -VCS_USER= -VCS_PASS=<Encoded password> -VCS_SSH_PORT=22

OdiUpdateAgentSchedule

このコマンドを使用して、エージェントがタスクのスケジュールを強制的に再計算するようにします。

使用方法

OdiUpdateAgentSchedule -AGENT_NAME=<physical_agent_name>

パラメータ

パラメータ 必須 説明

-AGENT_NAME=<physical_agent_name>

はい

更新する物理エージェントの名前。

例

物理エージェントagt_s1がそのスケジュールを更新します。 

OdiUpdateAgentSchedule -AGENT_NAME=agt_s1

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>件以上の子セッションがエラーで終了した場合にエラーになります。

このパラメータが0、負数または未指定の場合、OdiWaitForChildSessionは、障害が発生した子セッションの数に関係なく、エラー・ステータスで終了することはありません。

例

5秒のポーリング間隔で、現在のセッションの子セッションの中で、名前フィルタがLOAD%、およびMANDATORYとCRITICALのキーワードがある子セッションすべての終了を待機します。 

OdiWaitForChildSession -PARENT_SESS_NO=<%=odiRef.getSession("SESS_NO")%>
-POLL_INT=5 -SESSION_NAME_FILTER=LOAD%
-SESSION_KEYWORDS=MANDATORY,CRITICAL

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の場合、タイムアウトは無限です。デフォルト値は0 (ゼロ)です。

-POLLINT=<pollInt>

いいえ

データの各ポーリング間で待機する期間(ミリ秒単位)。デフォルト値は1000です。

-UNIT_ROWCOUNT=<unitRowCount>

いいえ

コマンドを終了するためにポーリング対象の表で必要とされる行数。デフォルト値は1です。

-GLOBAL_ROWCOUNT=<globalRowCount>

いいえ

コマンドを終了するために一連の表全体で累積的に必要とされる合計行数。指定しないと、デフォルト値の 1 が使用されます。

-INCREMENT_DETECTION=<no|yes>

いいえ

コマンドで行数が考慮されるモードを、絶対条件(表内の合計行数に対する)または差分条件(格納された参照値と現在の行数値の差異)のいずれかで定義します。

  • Yesに設定すると、行カウントは差分モードで実行されます。表内の他の行数が、格納された参照値と比較されます。参照値は-INCREMENT_MODEパラメータによって異なります。

  • 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>

いいえ

この値がYesに設定されている場合に、少なくとも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

OdiWaitForLoadPlans

このコマンドを使用して、ロード計画実行が完了するまで待機します。

使用方法

OdiWaitForLoadPlans [-PARENT_SESS_NO=<parent_sess_guid>]
[-LP_NAME_FILTER=<load_plan_name_filter>] [-LP_KEYWORDS=<load_plan_keywords>]
[-MAX_LP_ERROR=ALL|<number_of_lp_errors>] [-POLLINT=<polling_interval_msec>]

パラメータ

パラメータ 必須 説明

-PARENT_SESS_NO=<parent_sess_guid>

いいえ

ロード計画を開始した親セッションのグローバルID。このパラメータの指定を省略すると、現在のセッションのグローバルIDが使用されます。

-LP_NAME_FILTER=<load_plan_name_filter>

いいえ

名前がこのフィルタと一致するロード計画実行のみが、完了ステータスであるかをテストされます。このフィルタには、SQL LIKE形式のパターンを使用できます。

-LP_KEYWORDS=<load_plan_keywords>

いいえ

キーワードにこのカンマ区切りリストのすべてのエントリを含むロード計画実行のみが、完了ステータスであるかをテストされます。リストの各要素には、SQL LIKE形式のパターンを使用できます。

-MAX_LP_ERROR=ALL|<number_of_lp_errors>

いいえ

OdiWaitForLoadPlansは、多数のロード計画実行がエラー・ステータスになった場合、エラーで終了します。

  • ALL: すべてのロード計画実行がエラー・ステータスで完了した場合にエラーとなります。

  • <number_of_lp_errors>: エラー・ステータスのロード計画実行の数が、すべてのロード計画実行の完了時にこの値<number_of_lp_errors>以上になった場合にエラーとなります。

このパラメータが指定されない場合または値が1未満の場合、OdiWaitForLoadPlansは、エラー・ステータスのロード計画実行の数に関係なく、エラー状態で終了することはありません。

-POLLINT=<polling_interval_msec>

いいえ

完了状態のロード計画実行のステータスのポーリング間に待機する期間(ミリ秒単位)。デフォルト値は1000 (1秒)です。この値は0より大きくなければなりません。

例

5秒のポーリング間隔で、現在のセッションが開始したロード計画実行の中で、名前フィルタがPOPULATE%、およびMANDATORYキーワードとCRITICALキーワードがあるロード計画実行すべての終了を待機します。選択したすべてのロード計画実行の実行が完了したときに、2つ以上のロード計画実行がエラー・ステータスである場合、OdiWaitForLoadPlansはエラーで終了します。 

OdiWaitForLoadPlans -PARENT_SESS_NO=<%=odiRef.getSession("SESS_GUID")%>
-LP_NAME_FILTER=POPULATE% -LP_KEYWORDS=MANDATORY,CRITICAL
-POLLINT=5000 -MAX_LP_ERROR=2

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の場合、タイムアウトは無限です。デフォルト値は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

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の場合、タイムアウトは無限です。デフォルト値は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

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です。サポートされているエンコーディングのなリストは、https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.htmlを参照してください

-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.xml、ord2.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.xml、ord2.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>"

OdiXMLSplit

このツールは、単一のソース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>がtarget_*.xmlの場合、作成されるファイルはtarget_1.xml、target_2.xmlなどの名前になります。

  • 属性値マスク: 角カッコの間に、ファイル名を作成するために値を挿入する<element_name>の属性の名前を指定します。たとえば、customer_[CUSTID].xmlでは、分割に使用される要素の属性CUSTIDの値に応じてcustomer_041.xml、customer_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です。サポートされているエンコーディングのなリストは、https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.htmlを参照してください

-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.xml、ord2.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>"

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>

いいえ

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

-ENCODING=<file_name_encoding>

いいえ

アーカイブ・ファイル内部でファイル名に使用する文字エンコーディング。

サポートされるエンコーディングのリストについては、次を参照してください。

https://docs.oracle.com/javase/8/docs/technotes/guides/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