ファイル・インポート・エージェントの設定

ファイル・インポート・エージェントは、任意のコンピュータで実行されるコマンドライン・アプリケーションで、フォルダやネットワーク・ドライブなどの監視対象ファイル・システムのロケーションからコンテンツをインポートするためのソースとして機能します。その場所のコンテンツをモニターしてキャプチャし、プロシージャで定義されたルールに従ってさらに処理およびルーティングするためにインポート・プロセッサにフィードします。

ソースがモニター対象フォルダ( 「監視中の電子メール・アカウントではない」)の場合のみ、ローカル・コンピュータにファイル・インポート・エージェントをインストールして実行する必要があります。取得コマンドライン・ユーティリティは、サーバーの登録、インポート・ジョブの構成およびリストに役立ちます。

ファイル・インポート・エージェントの設定は、次のステップで構成されます:

ファイル・インポート・エージェントのダウンロードとインストール
Oracleは、Oracle Cloud Infrastructure (OCI)リージョンを更新して、Identity Cloud Service (IDCS)からIdentity and Access Management (IAM)アイデンティティ・ドメインに切り替えます。すべての新しいOracle Cloudアカウントでは、IAMアイデンティティ・ドメインが自動的に使用されます。「リージョンがIAMアイデンティティ・ドメインを使用しているかどうかに応じて」は、様々なドキュメントを使用して設定を完了します。
- リージョンが更新されている場合は、「Oracle Cloud Infrastructure Identity and Access Management (IAM)ドメイン・アプリケーションの作成」のステップに従います。
- リージョンが更新されていない場合は、「Oracle Identity Cloud Service (IDCS)アプリケーションの作成」のステップに従います。
ファイル・インポート・エージェントへのOracle Content Managementの登録
キャプチャ・コマンドライン・ユーティリティの使用

ファイル・インポート・エージェントのダウンロードとインストール

監視対象フォルダからファイルをインポートする前に、ローカル・コンピュータにファイル・インポート・エージェントをインストールする必要があります。

システム要件

ファイル・インポート・エージェントは、Oracle JDKバージョン17またはこのアプリケーションのインストール時に使用可能な最新バージョンを必要とするJavaアプリケーションです。ファイル・インポート・エージェントは、Windows、Linux、およびMacと互換性があります( 「Oracle JDK 17認定システム構成」を参照)。

ファイル・インポート・エージェントをダウンロードしてインストールするには:

Oracle Content Management webインタフェースにログインし、左側のナビゲーション・パネルで「取得」をクリックします(「管理」の下)。このオプションが表示されない場合、必要なアクセス権限がありません。
「プロシージャの取得」ページの「ダウンロード」で、「Oracle Content Captureファイル・インポート・エージェント」をクリックしてローカル・コンピュータにcapture-agent.zipファイルをダウンロードします。
ZIPファイルを解凍します。
<agent directory>\binをPATHに追加する必要があります。エージェント・ディレクトリは、capture-agent.zipが抽出されるフォルダです。また、CAPTURE_HOME環境変数を抽出されたディレクトリに設定し、$CAPTURE_HOME\binをPATHに追加することもできます。
Macの場合:
```
sudo ln -s <agent directory>/bin/capture /usr/local/bin/capture
```
Windowsの場合:

SystemPropertiesAdvanced.exeファイルを実行してから、「環境変数」を編集し、<agent directory>\binをPATH変数に追加します。
CAPTURE_JAVA_HOME変数を、環境変数または<agent directory>/conf/agent.propertiesファイルの有効なJDKのロケーションに設定します。

ファイル・インポート・エージェントへのOracle Content Managementの登録

Oracle Content Managementインスタンスは、Oracle Content Managementインスタンスで構成されたインポート・ジョブを認識し、このインスタンスにファイルをアップロードできるように、取得コマンドライン・ユーティリティに登録する必要があります。

Oracle Content Managementを登録するには:

コンピュータにインストールされていない場合は、ファイル・インポート・エージェントのダウンロードおよびインストール。
Windows、LinuxまたはMacオペレーティング・システムで、これらのコマンドのoneを実行します:
```
$ capture register-server <NAME> --endpoint https://<oracle content management instance name>.oraclecloud.com -u username -p password --domainurl <REST Endpoint (Permanent)>/oauth2/v1/token --clientid sampleid --clientsecret sample-secret --scope https://<server name>:<port number>/urn:opc:cec:all
```
- Oracle Content ManagementインスタンスURL: <oracle content management instance name>.oraclecloud.com
- Oracle Content ManagementインスタンスURLのユーザー名およびパスワード。
  
  ノート:
  潜在的なセキュリティ脅威を軽減するには、必要な手順のコンテンツ取得ロールまたは権限のみを割り当てられたファイル・インポート・エージェント固有のユーザーを作成することを検討してください。
- Oracle Identity ServiceインスタンスURL: <REST Endpoint (Permanent)>/oauth2/v1/token (IDCSアプリケーションの作成の時点でRESTエンドポイント(永続)をコピーしました。または、IDCSストライプをIAMアイデンティティ・ドメインに移行した場合は、その値を「IAMドメイン・アプリケーションを作成しました」時にコピーしました。)
- クライアントID: sampleid (IDCSアプリケーションの作成の時点でその値をコピーしました。または、IDCSストライプをIAMアイデンティティ・ドメインに移行した場合は、その値を「IAMドメイン・アプリケーションを作成しました」時にコピーしました。)
- クライアント・シークレット: sample-secret (IDCSアプリケーションの作成の時点でその値をコピーしました。または、IDCSストライプをIAMアイデンティティ・ドメインに移行した場合は、その値を「IAMドメイン・アプリケーションを作成しました」時にコピーしました。)
- スコープURL: https://<server name>:<port number>/urn:opc:cec:all (IDCSアプリケーションの作成の時点でその値をコピーしました。または、IDCSストライプをIAMアイデンティティ・ドメインに移行した場合は、その値を「IAMドメイン・アプリケーションを作成しました」時にコピーしました。)
IDCSを使用している場合は、かわりにIDCSトークン値を取得します:
```
$ capture register-server <NAME> --endpoint https://<oracle content management instance name>.oraclecloud.com --token <token value>
```
トークン値を取得するには、ブラウザからこのURLを入力 : https://Content Management URL:port/documents/web?IdcService=GET_OAUTH_TOKEN
ノート:
- documents/webコンテキストは、Oracle Identity Cloud Services (IDCS)によって保護されています。ブラウザに有効なIDCSセッションがすでに存在する場合を除き、ユーザーはIDCSにサインインするように求められます。
- OAuthトークンは、JSONレスポンスのtokenValueフィールドに返されます。トークンは7日間有効で、有効期限は秒です。
コマンドを実行してインポート・ジョブをリストすることにより、接続をテストします:
```
$ capture list-import-jobs
```
指定されたOracle Content Managementインスタンスの取得プロシージャで構成されたすべてのフォルダおよびファイル・リスト・インポート・ジョブのリストが表示されます。

Oracle Content Managementを登録し、インポート・ジョブ「フォルダからインポートしたファイルの構成」または「リスト・ファイルのインポートの構成」を構成した後。

キャプチャ・コマンドライン・ユーティリティの使用

captureコマンドライン・ユーティリティを使用すると、エージェントがOracle Content Managementリポジトリにドキュメントをインポートできるようにファイル・インポート・エージェントを構成できます。ファイル・インポート・エージェントを使用および管理するためのコマンドを提供します。

------------------------
capture
------------------------
usage : capture <command> [options]
Run capture <command> -h' to get the detailed help for the command.
Commands:  
capture create-encryption-key <file>     Create an encryption key to encrypt/decrypt password for servers.       [alias:   cek]  
capture register-server <name>           Registers an Oracle Content Management server                           [alias:   rs]  
capture list-servers                     Lists registered servers                                                [alias:   ls]  
capture list-import-jobs                 Lists all Import Jobs from server                                       [alias:  lij]  
capture configure-import-job             Configures import job. Set Import Folder path. Enable or disable.       [alias:  cij]
capture configure-archiver-job           Configures archiver import job to import content from on-premise 
                                         WebCenter Content into Oracle Content Management                        [alias:  caj]
capture trigger-import-job               Forces import job processing.                                           [alias:  tij]
capture refresh-config                   Refresh configuration from server.                                      [alias:   rc]
capture list-procedures                  Displays capture procedures.                                            [alias:   lp]  
capture register-database <name>         Registers external database.                                            [alias:   rd]  
capture deregister-database              Deregister previously registered database.                              [alias:   dd]  
capture list-databases                   Displays registered databases and tables.                               [alias:   ld]  
capture register-table                   Registers tables in a database.                                         [alias:   rt]  
capture deregister-table                 Deregister previously registered table.                                 [alias:   dt]
capture list-table-sync-jobs             Lists all Asset Sync Jobs from server.                                  [alias: ltsj]
capture trigger-table-sync               Force table / asset synchronization.                                    [alias:  tts]
capture start                            Starts import agent                                                     [alias:    s]  
capture stop                             Stops import agent                                                      [alias:    x]  
capture status                           Shows import agent status                                               [alias:   st]  
capture help                             Shows this message                                                      [alias:    h]

-----------------------------
capture create-encryption-key
-----------------------------
usage: create-encryption-key <file> [-h]
Create an encryption key to encrypt/decrypt password for servers and save to <file>.
Options: 
-h,--help   Show help
Example:  
capture create-encryption-key ~/.ceckey                      Create encryption key and save to file ~/.ceckey
------------------------
capture register-server
------------------------
usage: capture register-server <name> -e <endpoint> -u <user> -p <password> [-k <key>] [-d <domainurl] 
[-c <clientid>] [-s <clientsecret>] [-o <scope>] [-t <token>] [-m <timeout>] [-x <proxy>]
Registers an Oracle Content Management server. 
Specify -e <endpoint> for the server URL. 
Specify -u <user> and -p <password> for connecting to the server. 
Optionally specify -k <key> to encrypt the password.
Optionally specify <domainurl>, <clientid>, <clientsecret> and, <scope> for integration with IAM application. 
Optionally specify <token> to use for authorization.

NOTE: -i and --idcsurl have been deprecated. For now they exist for backward compatibility but will be removed in a future release.

Options: 
-e,--endpoint <endpoint>           Server endpoint 
-u,--user <user>                   User name 
-p,--password <password>           Password 
-k,--key <key>                     The key file used to encrypt the password 
-d,--domainurl <domainurl>         Oracle Identity and Access Management Instance URL 
-c,--clientid <clientid>           Client ID 
-s,--clientsecret <clientsecret>   Client secret 
-o,--scope <scope>                 Scope
-t,--token <token>                 OAuth Token to use for authorization. 
-m,--timeout <timeout>             Timeout in millisecond for connections to the server. Defaults to 60 seconds
-x,--proxy <proxy>                 Set proxy host and port
-h,--help                          Show help
Examples:  
capture register-server server1 -e http://server1.com -u user1 -p password1 -d                   
The server is a tenant on Oracle Public cloud  
http://iam.com -c clientid -s clientsecret -o https://primary-audience-and-scope  
capture register-server server1 -e http://server1.com -u user1 -p password1                      
The server is a tenant on Oracle Public cloud  
capture register-server server1 -e http://server1.com -u user1 -p password1 -m 60000             
The timeout is set to 60 seconds  
capture register-server server1 -e http://server1.com -u user1 -p Welcome1 -x my_proxy_host:port 
The proxy is set to my_proxy_host:port
capture register-server server1 -e http://server1.com -u user1 -p Welcome1 -k ~/.mykey           
The password will be encrypted
capture register-server server1 -e http://server1.com -t <token value>                           
The token will be used for authorization
------------------------
capture list-servers
------------------------
usage: capture list-servers [-u <user>] [-f <pattern>] [-h]
Lists registered Oracle Content Management servers. Optionally specify -u <user> 
and -f <pattern> to filter results based on user or server name.
Options: -u,--user <user>         User name 
-f,--pattern <pattern>   String to search in server name 
-h,--help                Show help
Examples:  
capture list-servers                              Lists all registered servers  
capture list-servers -u user1                     Lists all registered servers linked to user 'user1'  
capture list-servers -f demo                      Lists all registered servers whose name contains 'demo'
------------------------
capture list-import-jobs
------------------------
usage: capture list-import-jobs [-f] [-l] [-h]
Lists all Import Jobs from server. Optionally specify -f and -l to show only folder or list file import jobs.
Options: 
-f,--folder     Display only folder import jobs 
-l,--listfile   Display only list file import jobs 
-h,--help       Show help
Examples:  
capture list-import-jobs                                         Lists all import jobs  
capture list-import-jobs -f                                      Lists all folder import jobs  
capture list-import-jobs -l                                      Lists all list file import jobs
-----------------------------
capture configure-import-job
-----------------------------
usage: capture configure-import-job -s <server> [-i <import>] [-p <path>] [-e] [-E] [-d] [-D] [-h]
Configures the import job.  Specify -s <server> -i <importjobid> to select the server and import job. 
Optionally specify -p <path> to set the import folder path. 
Optionally specify -d to disable import job and -e to enable import job
Options: 
-s,--server <server>   Set server name associated with import job 
-i,--import <import>   Set Import Job Id 
-p,--path <path>       Set Local Import Folder Path 
-e,--enable            Enables specific import job 
-E,--enable-all        Enables all import jobs 
-d,--disable           Disables specific import job 
-D,--disable-all       Disables all import job 
-h,--help              Show help
Examples:  
capture configure-import-job -s prod -i import_id -p /Users/user1/data/    Sets the import directory  
capture configure-import-job -s prod -i import_id -e                       Enables a specific import job  
capture configure-import-job -s prod -D                                    Disables all import jobs  
capture configure-import-job -s prod -i import_id -d                       Disables a specific import job
-----------------------------
capture configure-archiver-job
-----------------------------
capture configure-archiver-job -s <server> [-w <procedure>] [-p <path>] [-c <importjob> | -u <importjobid>] [-e | -d] [-h]

Specify -s <server> to select the server, -w <procedure_id> to select the procedure, 
-p <path_to_archiver_export> to select the path, 
-c <import_job_name> / -u <import_job_id> to create or update the import job.

Options:
 -s,--server <server>         Set server name associated with import job
 -w,--procedure <procedure>   Procedure identifier
 -p,--path <path>             Path to archiver output folder
 -c,--create <importjob>      Name of the new import processor Job
 -u,--update <importjobid>    Identifier of the import processor Job
 -e,--enable                  Enables specific import job
 -d,--disable                 Disables specific import job
 -h,--help                    Show help

Examples:
  capture configure-archiver-job -s prod -w procedure_id -c 'Import Job Name' -p /Users/user1/data/    
  Creates the import processor in the procedure and configures the import path
  capture configure-archiver-job -s prod -w procedure_id -u import_job_id -p /Users/user1/data/        
  Updates the import processor in the procedure
  capture configure-archiver-job -s prod -u import_job_id -d       
  Disables a specific import job
  capture configure-archiver-job -s prod -u import_job_id -e      
  Enables a specific import job
------------------------
capture trigger-import-job
------------------------
usage: capture trigger-import-job -s <server> -i <import> [-h] 
Forces import job processing.  
Options: 
-s,--server <server>   Set server name associated with import job 
-i,--import <import>   Set Import Job Id 
-h,--help              Show help 
Examples:  capture trigger-import-job --server production --import xx-job-id-xx       
Forces processing of specified import job
------------------------
capture refresh-config
------------------------
usage: capture refresh-config [-s <server>] [-h] Refresh configuration from server. 
Optionally specify -s to only refresh config for selected server. 
Options: 
-s,--server <server>   Specify the server 
-h,--help              Show help 
Examples:  
capture refresh-config                       Force refresh configuration for all servers  
capture refresh-config -s production         Force refresh configuration from specified server                        
------------------------
capture list-procedures
------------------------
usage: capture list-procedures -s <server> [-h] 
Lists capture procedures. Must specify -s <server> to select a server. 
Options: 
-s,--server <server>   Specify the server 
-h,--help              Show help 
Examples:  capture list-procedures -s ocetest      Lists all capture procedures available for current user
------------------------
capture register-database
------------------------
usage: capture register-database <name> -s <server> -w <procedure> -c <connection> -u <user> -p <password> [-a] [-h] 
Registers on-prem database with Content Capture. Specify -c <connection> for the connection URL, 
-u <user> and -p <password> for connecting to the server. 
Options: 
-s,--server <server>           Specify the server 
-w,--procedure <procedure>     Set procedure to be associated with database 
-c,--connection <connection>   Database connection url 
-u,--user <user>               Database User name 
-p,--password <password>       Database Password 
-a,--attach                    Attach existing database 
-h,--help                      Show help 
Examples:  
capture register-database ebsdb -s server1 -w 1 -c jdbc:oracle:thin:@//host:port/service -u user1 -p pass    
Register ebsdb with server1
------------------------
capture deregister-database
------------------------
usage: capture deregister-database  -s <server> -w <procedure> -d <database> [-e] [-h] 
Deregister previously registered database. Specify -s <server>, -w <procedure> and -d <database> to select the database. 
Options: 
-s,--server <server>         Specify the server 
-w,--procedure <procedure>   Procedure associated with database 
-d,--database <database>     Database to deregister 
-e,--detach                  Only detach 
-h,--help                    Show help 
Examples:  
capture deregister-database -s server1 -w 1 -d ebsdb                   Deregister VENDORS table from ebsdb database  
capture deregister-database -s server1 -w 1 -d ebsdb --detach          Detaches ebsdb database without deregistering it
------------------------
capture list-databases
------------------------
usage: capture list-databases -s <server> [-h] Lists registered databases and tables. Must specify -s <server> to select a server. 
Options: 
-s,--server <server>   Specify the server 
-h,--help              Show help 
Examples:  
capture list-databases -s ocetest     Lists all registered databased linked to server 'ocetest'  
------------------------
capture register-table
------------------------
usage: capture register-table -s <server> -w <procedure> -d <database> -t <table> [-m <schema>] [-h]
Registers table with Content Capture. Specify -s <server>, -w <procedure> and -d <database> to select the database. 
Options: 
-s,--server <server>         Specify the server 
-w,--procedure <procedure>   Specify the procedure 
-d,--database <database>     Specify the database 
-t,--table <table>           Table to sync 
-m,--schema <schema>         Override schema qualifier 
-h,--help                    Show help 
Examples:  
capture register-table -s server1 -w 1 -d ebsdb -t VENDORS   
Register VENDORS table from ebsdb database  
capture register-table -s server1 -w 1 -d ebsdb -t VENDORS -m SVR 
Register VENDORS table from ebsdb database in SVR schema
------------------------
capture deregister-table
------------------------
usage: capture deregister-table -s <server> -w <procedure> -d <database> -t <table> [-m <schema>] [-h] 
Deregister table. Specify table details. 
Options: 
-s,--server <server>         Specify the server 
-w,--procedure <procedure>   Procedure associated with database 
-d,--database <database>     Specify the database 
-t,--table <table>           Table to sync 
-m,--schema <schema>         Override schema qualifier 
-h,--help                    Show help 
Examples:  capture deregister-table -s server1 -w 1 -d ebsdb -t VENDORS 
Deregister VENDORS table from ebsdb database      
------------------------
capture list-table-sync-jobs
------------------------
usage: capture list-table-sync-jobs [-r] [-h] Lists all Asset Sync Jobs from server. 
Options: 
-r,--refresh   Force refresh asset sync jobs from server 
-h,--help      Show help 
Examples:  
capture list-table-sync-jobs               Lists all asset sync jobs  
capture list-table-sync-jobs -r            Refresh asset sync jobs from server and list them
------------------------
capture trigger-table-sync
------------------------
usage: capture trigger-table-sync -s <server> -a <asset> [-h] 
Force table / asset synchronization.  
Options: 
-s,--server <server>   Set server name associated with table sync job 
-a,--asset <asset>     Set Asset Sync Job Id 
-h,--help              Show help 
Examples:  
capture trigger-table-sync -s production -a xx-123-sync-id-xx      
Forces processing of asset synchronization job
------------------------
capture start
------------------------
usage: capture start [-h]
Starts capture agent. 
Options: 
-h,--help   Show help
Examples:  
capture start         Starts capture agent if not running
------------------------
capture stop
------------------------
usage: capture stop [-h]
Stops capture agent. 
Options: 
-h,--help   Show help
Examples:  
capture stop             Stops capture agent if currently running
------------------------
capture status
------------------------
usage: 
capture status [-s <server>] [-i <import>] [-u <user>] [-m <machine>] [-l <limit>] [-d <duration>] [-c | -p] [-h] 
Display capture agent status and activity.  
Options: 
-s,--server <server>       Set Server name 
-i,--import <import>       Set Import Job name 
-u,--user <user>           Set user name. Defaults to current user 
-m,--machine <machine>     Set host name. Defaults to current hostname 
-l,--limit <limit>         Set number of results to return. Defaults to 200 
-d,--duration <duration>   Set duration period in hours 
-c,--completed             Display only completed uploads 
-p,--pending               Display only pending uploads 
-h,--help                  Show help 
Examples:  
capture status                             Display capture agent status  
capture status -u user@example.com         Show upload activity for user : user@example.com  
capture status -i Invoices                 Show upload activity for Invoices import job  
capture status -m myhost.example.com       Show upload activity for a specific host / machine  
capture status -p                          Show uploads pending completion  
capture status -c                          Show completed uploads
------------------------
capture version
------------------------
usage: capture version [-h] 
Displays capture version details. 
Options: 
-h,--help    Show help 
Example:  
capture  version  
Display capture agent version