Developer Toolsのコマンドライン・インタフェース(CLI)の使用

77 Developer Toolsのコマンドライン・インタフェース(CLI)の使用

デプロイメントやその他のリソース移動操作には、Developer ToolsのCLIを使用します。CLIを使用すると、Developer Toolsワークスペースだけでなく、任意のワークスペースを自由に操作できます。コマンドライン・インタフェースにも、インポート機能とエクスポート機能があります。たとえば、CLIでは再利用可能なモジュール(ワークスペース)を作成できます。このようなワークスペースには、任意のサイトにインポートできるリソースが含まれています。

CLIの実行および使用の詳細は、次の項を参照してください。

コマンドライン・インタフェース(CLI)の実行および使用

CLIを実行するには、簡単なステップがいくつか必要です。

コマンドライン・インタフェースを実行するには:

WebCenter Sitesのインストール・ディレクトリ(${Oracle Home}/wcsites/clients)のclientsフォルダにあるdeveloper-tools-command-line-x.y.z.zipファイルを解凍します。
developer-tools-command-line-x.y.z.jarファイルを実行し、次のようにJava EEライブラリ(たとえば、サーブレットAPI実装)をクラスパスに含めます。
```
java -Xbootclasspath/a:lib/servlet-api.jar -jar developer-tools-command-line.jar 
http://<hostname>:<port>/<context-path>/ContentServer username=<username> password=<password>  
cmd=export|import|listcs|listds [options] 
```
プレースホルダのパラメータは、自分の開発環境に関する情報と、実行する必要のあるコマンドに置き換えてください。
- http://<hostname>:<port>/<context-path>: ローカルのWebCenter SitesインスタンスのURLで、ContentServerサーブレットも含まれます(たとえば、http://localhost:8080/cs/ContentServer)
- usernameとpassword: WebCenter Sitesの一般管理者のユーザー名とパスワードです。このユーザーは、RestAdminグループのメンバーである必要があります(たとえば、fwadmin/xceladmin)。
- cmd: 実行するコマンドです。次のコマンドを使用できます。
  - export: WebCenter Sitesからワークスペースにデータをエクスポートします。
  - import: ワークスペースからWebCenter Sitesにデータをインポートします。
  - listcs: WebCenter Sitesのコンテンツをリストします。
  - listds: ワークスペースのコンテンツをリストします
- options: importまたはexportには、次のいずれかを指定します。
  - resources: インポートまたはエクスポートするリソースを、リソース・タイプとリソースIDをセミコロンで区切ったリストで指定します。複数のリソースを指定する場合は、カンマ区切りのリストを使用します。特定のタイプのリソースをすべて指定する場合は、*記号を使用します。リソースを(ワークスペースに)エクスポートするには、そのリソースのローカルIDを指定します。たとえば、resources=Content_C:12345;Product_C:* を使用すると、特定のContent_CアセットとすべてのProduct_Cアセットがエクスポートされます。
    
    リソースを(WebCenter Sitesインスタンスに)インポートする場合は、そのリソースのfw_uidを指定します。リソースのfw_uidを取得するには、listdsオプションを使用します。
    
    すべてのリソース・セレクタを次に示します。
    
    @SITE: サイトを指定します。
    
    @ROLE: ロールを指定します。
    
    @ASSET_TYPE: アセット・タイプを指定します。
    
    @TREETAB: ツリー・タブを指定します。
    
    @STARTMENU: スタート・メニュー・アイテムを指定します。
    
    @ELEMENTCATALOG: ElementCatalogエントリを指定します。
    
    @SITECATALOG: サイト・カタログ・エントリを指定します。
    
    @ALL_NONASSETS: この簡略表記を使用すると、すべての非アセット・リソースが選択されます
    
    @ALL_ASSETS: この簡略表記を使用すると、すべての使用可能なアセットが選択されます
    
    asset type: 特定のタイプのアセットを指定します。
    
    ノート:
    
    インポートまたはエクスポートの前に、セレクタが適切なリソースを選択するかどうかを確認するには、エクスポート操作にlistcsを使用し、インポート操作にlistdsを使用します。これらのコマンドにより、移動されるリソースのリストを表示して、実行前にセレクタを微調整します。
    
    リソースの依存性は自動的にエクスポートおよびインポートされます。ただし、listcsコマンドおよびlistdsコマンドを使用しても、依存性はリストされません。
    
    ブックマークや保存済検索などのユーザー・プリファレンスは、CSDTインポート/エクスポートの一部としてインポート/エクスポートされません。
  - fromSites: 指定したサイトのリソースのみを選択します。
  - toSites: (インポート専用)インポート時に、ナチュラル・サイト・アフィリエーションをサイトのカンマ区切りリストでオーバーライドします。指定するサイトは、ターゲット・システムに存在している必要があります。
  - modifiedSince: (アセット専用)指定した日付以降に変更されたリソースのみを選択します。日付書式は、yyyy-mm-dd hh:MM:ssです。日付は、UTC 0タイムゾーンとして処理されます。
  - datastore: WebCenter Sitesリソースのエクスポート先にするワークスペース、またはWebCenter Sitesリソースのインポート元にするワークスペースを指定します。このパラメータの値の指定を省略すると、メインDeveloper Toolsワークスペースがデフォルトで指定されます。リソースをエクスポートするときに、指定のワークスペースが存在しない場合は、そのワークスペースがCLIにより自動的に作成され、リソースがエクスポートされます。

コマンド例

次に、コマンドライン・インタフェースを使用して実行できるエクスポートとインポートのサンプルのコマンドのリストを示します。

このコマンドは、FirstSiteIIに属しているアセットのうち、指定した日付以降に変更された特定のContent_CアセットとすべてのProduct_Cアセットをエクスポートします。ワークスペースを指定していないため、Developer Toolsワークスペースがデフォルトで使用されます。
```
java -Xbootclasspath/a:lib/servlet-api.jar -jar developer-tools-command-line-x.y.z.jar http://localhost:8080/cs/ContentServer username=bob password=password resources=Content_C:123432123423,11234234212,111234341234;Product_C:* fromSites=FirstSiteII modifiedSince="2016-08-08 19:14:00" cmd=export
```

このコマンドは、ワークスペースに含まれる特定のContent_CアセットとすべてのProduct_CアセットをFirstSiteIIサイトにインポートします(指定した日付以降に変更されています)。ワークスペースを指定していないため、Developer Toolsワークスペースがデフォルトで使用されます。
```
java -Xbootclasspath/a:lib/servlet-api.jar -jar developer-tools-command-line-x.y.z.jar  http://localhost:8080/cs/ContentServer username=bob password=password resources=Content_C:aad618e9-f04e-4ee4-b902-076224bb6f7b;Product_C:* toSites=FirstSiteII modifiedSince="2016-09-17 12:09:00" cmd=import
```

このコマンドは、サイトSecondSiteIIのすべてのリソースをTheOutputという名前のワークスペースにエクスポートします。

java -Xbootclasspath/a:lib/servlet-api.jar -jar developer-tools-command-line-x.y.z.jar  http://localhost:8080/cs/ContentServer username=bob password=password resources=@ALL_ASSETS:*;@ALL_NONASSETS:*  fromSites=SecondSiteII  datastore=TheOutput cmd=export

このコマンドは、TheInputという名前のワークスペースに含まれるすべてのアセットとツリー・タブをサイトMySiteにインポートします。

java -Xbootclasspath/a:lib/servlet-api.jar -jar developer-tools-command-line-x.y.z.jar  http://localhost:8080/cs/ContentServer username=bob password=password resources=@ALL_ASSETS:*;@TREETAB:* toSites=MySite  datastore=TheInput cmd=import

ノート:

modifiedSinceは、export|listcs|importでのみ機能します。

モジュールのインポートについて

モジュールは、WebCenter Sitesインスタンスから特定のワークスペースにエクスポートする関連リソースのセットです。モジュールは再利用できるため、そのコンテンツをCMサイトにインポートできます(サイトがリソースの正規サイト・リストに記載されていない場合でも可能)。

datastoreパラメータを使用すると、WebCenter Sitesリソースのエクスポート先にするワークスペース、またはWebCenter Sitesリソースのインポート元にするワークスペースを指定できます。存在していないワークスペースにWebCenter Sitesリソースをエクスポートすると、そのワークスペースがコマンドライン・インタフェースにより自動的に作成され、リソースがエクスポートされます。

モジュールをCMサイトにインポートするには、importコマンドを実行する必要があります。datastoreパラメータでは、リソースが含まれているワークスペースを指定し、toSitesパラメータでは、それらのリソースをインポートするサイトを指定します。これにより、ワークスペースのコンテンツは、指定したCMサイトにインポートされます。

Developer Toolsのコマンドライン・インタフェース(CLI)から起動される操作のステータス・コード

Developer ToolsのCLIは、起動される操作ごとに次のステータス・コードを戻します。

ステータス・コード	説明
SUCCESS -> 0	Developer Toolsコマンドの正常な起動を表します(export / importなど)。リクエストがクライアント側またはサーバー側でエラーが発生せずに処理され、起動の結果として処理できる少なくとも1つのリソースが存在する場合のみ、このステータスが戻されます。
NO CONTENT -> 1	Developer Toolsコマンドの正常な起動を表します(export / importなど)。リクエストがクライアント側またはサーバー側でエラーが発生せずに処理され、起動の結果として処理できるリソースが存在しない場合のみ、このステータスが戻されます。
IMPROPER SHUTDOWN -> 11	起動したプロセスの予期しない停止によるまれなエラー・コード。
CONSOLE UNAVAILABLE -> 12	クライアント側のエラー・コード。CLIでシステム・コンソール以外のシステムを使用して対話する場合に戻されます。
RUNTIME SANITY CHECK FAILED -> 13	クライアント側のエラー・コード。アプリケーションを実行するために用意された実行時間が十分でない場合(依存性が見つからない場合など)に戻されます。
BAD REQUEST -> 40	クライアント側のエラー・コード。使用方法に違反した場合に戻されます。
UNAUTHORIZED -> 41	クライアント側のエラー・コード。処理を実行する資格証明またはロールが無効または不十分である場合に戻されます。
SERVICE ERROR -> 50	サーバー側のエラー・コード。リクエストの起動時に例外が発生する場合に戻されます。
RESPONSE PARSE ERROR -> 50	サーバー側のエラー・コード。サーバーから送信されたレスポンスがクライアントの予測と一致しない場合に戻されます。このエラー・コードは現在`SERVICE ERROR`と同じですが、今後拡張される可能性があります。