Oracle® Fusion Middleware

WebCenter WLSTコマンド・リファレンス

12c (12.2.1.2.0)

E82752-01(原本部品番号:E77130-01)

2016年10月

このドキュメントでは、WebCenter Portal、WebCenter Content、WebCenter Enterprise CaptureなどのインストールされたOracle Fusion Middlewareコンポーネントを管理するために使用できるカスタムWebLogic Scripting Tool (WLST)コマンドについて説明します。

Oracle Fusion Middleware WebCenter WLSTコマンド・リファレンス, 12c (12.2.1.2.0)

E82752-01

Copyright © 2007, 2016, Oracle and/or its affiliates.  All rights reserved.

原本著者: Sacheth S

原本協力者: Savita Thakur

このソフトウェアおよび関連ドキュメントの使用と開示は、ライセンス契約の制約条件に従うものとし、知的財産に関する法律により保護されています。ライセンス契約で明示的に許諾されている場合もしくは法律によって認められている場合を除き、形式、手段に関係なく、いかなる部分も使用、複写、複製、翻訳、放送、修正、ライセンス供与、送信、配布、発表、実行、公開または表示することはできません。このソフトウェアのリバース・エンジニアリング、逆アセンブル、逆コンパイルは互換性のために法律によって規定されている場合を除き、禁止されています。

ここに記載された情報は予告なしに変更される場合があります。また、誤りが無いことの保証はいたしかねます。誤りを見つけた場合は、オラクル社までご連絡ください。

このソフトウェアまたは関連ドキュメントを、米国政府機関もしくは米国政府機関に代わってこのソフトウェアまたは関連ドキュメントをライセンスされた者に提供する場合は、次の通知が適用されます。

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.No other rights are granted to the U.S. Government.

このソフトウェアもしくはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアもしくはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(redundancy)、その他の対策を講じることは使用者の責任となります。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

OracleおよびJavaはOracle Corporationおよびその関連企業の登録商標です。その他の名称は、それぞれの所有者の商標または登録商標です。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

このソフトウェアまたはハードウェア、そしてドキュメントは、第三者のコンテンツ、製品、サービスへのアクセス、あるいはそれらに関する情報を提供することがあります。適用されるお客様とOracle Corporationとの間の契約に別段の定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスに関して一切の責任を負わず、いかなる保証もいたしません。適用されるお客様とOracle Corporationとの間の契約に定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

目次

タイトルおよび著作権情報

はじめに

- ドキュメントのアクセシビリティについて

- 関連ドキュメント

- 表記規則

1 概要とロードマップ

- 1.1 ドキュメントのスコープと対象読者

- 1.2 このドキュメントの手引き

- 1.3 関連ドキュメント

- 1.4 このガイドの新機能と変更された機能

- 1.4.1 12c リリース(12.2.1.1)の新機能と変更された機能

2 WebCenter PortalカスタムWLSTコマンド

- 2.1 Oracle WebCenter Portal WLSTコマンド・カテゴリの概要

- 2.2 一般

- 2.2.1 deleteConnection

- 2.2.2 setWebCenterServiceFrameworkConfig

- 2.2.3 getWebCenterServiceFrameworkConfig

- 2.2.4 webcenterErrorOccurred

- 2.2.5 getWebCenterConnectionTypes

- 2.3 分析

- 2.3.1 createAnalyticsCollectorConnection

- 2.3.2 setAnalyticsCollectorConnection

- 2.3.3 listAnalyticsCollectorConnections

- 2.3.4 setDefaultAnalyticsCollectorConnection

- 2.3.5 listDefaultAnalyticsCollectorConnection

- 2.3.6 setAnalyticsCollectorConfig

- 2.3.7 listAnalyticsCollectorConfig

- 2.3.8 listAnalyticsEventTypes

- 2.4 アクティビティ・ストリーム

- 2.4.1 archiveASByDate

- 2.4.2 archiveASByDeletedObjects

- 2.4.3 archiveASByClosedSpaces

- 2.4.4 archiveASByInactiveSpaces

- 2.4.5 restoreASByDate

- 2.4.6 truncateASArchive

- 2.4.7 archiveASBySpace

- 2.4.8 archiveASAllSpaces

- 2.4.9 archiveASByUser

- 2.4.10 archiveASAllUsers

- 2.4.11 archiveASByDeletedActors

- 2.4.12 showASStatistics

- 2.5 BPELサーバー接続

- 2.5.1 createBPELConnection

- 2.5.2 setBPELConnection

- 2.5.3 listBPELConnections

- 2.6 コンテンツ・リポジトリ

- 2.6.1 createContentServerConnection

- 2.6.2 setContentServerConnection

- 2.6.3 listContentServerConnections

- 2.6.4 listContentServerProperties

- 2.6.5 setContentServerProperties

- 2.6.6 deleteContentServerProperties

- 2.6.7 deleteContentServerConnection

- 2.6.8 exportFoldersGData

- 2.6.9 migrateFoldersGDataToFrameworkFolders

- 2.7 ディスカッションおよびお知らせ

- 2.7.1 createDiscussionForumConnection

- 2.7.2 setDiscussionForumConnection

- 2.7.3 setDiscussionForumConnectionProperty

- 2.7.4 deleteDiscussionForumConnectionProperty

- 2.7.5 listDefaultDiscussionForumConnection

- 2.7.6 listDiscussionForumConnections

- 2.7.7 setDefaultDiscussionForumConnection

- 2.7.8 setDiscussionForumServiceProperty

- 2.7.9 removeDiscussionForumServiceProperty

- 2.7.10 listDiscussionForumServiceProperties

- 2.7.11 setAnnouncementServiceProperty

- 2.7.12 removeAnnouncementServiceProperty

- 2.7.13 listAnnouncementServiceProperties

- 2.7.14 addDiscussionsServerAdmin

- 2.7.15 addDiscussionsCategoryAdmin

- 2.7.16 setDiscussionsServerProperty

- 2.7.17 getDiscussionsServerProperty

- 2.7.18 removeDiscussionsServerProperty

- 2.8 外部アプリケーション

- 2.8.1 createExtAppConnection

- 2.8.2 setExtAppConnection

- 2.8.3 listExtAppConnections

- 2.8.4 addExtAppField

- 2.8.5 setExtAppField

- 2.8.6 removeExtAppField

- 2.8.7 addExtAppCredential

- 2.8.8 setExtAppCredential

- 2.8.9 removeExtAppCredential

- 2.9 インスタント・メッセージおよびプレゼンス

- 2.9.1 createIMPConnection

- 2.9.2 setIMPConnection

- 2.9.3 setIMPConnectionProperty

- 2.9.4 deleteIMPConnectionProperty

- 2.9.5 listIMPAdapters

- 2.9.6 listIMPConnections

- 2.9.7 listDefaultIMPConnection

- 2.9.8 setDefaultIMPConnection

- 2.9.9 setIMPServiceProperty

- 2.9.10 removeIMPServiceProperty

- 2.9.11 listIMPServiceProperties

- 2.9.12 createIMPExtAppConnection

- 2.10 メール

- 2.10.1 createMailConnection

- 2.10.2 setMailConnection

- 2.10.3 setMailConnectionProperty

- 2.10.4 deleteMailConnectionProperty

- 2.10.5 listMailConnections

- 2.10.6 listDefaultMailConnection

- 2.10.7 setDefaultMailConnection

- 2.10.8 setMailServiceProperty

- 2.10.9 removeMailServiceProperty

- 2.10.10 listMailServiceProperties

- 2.10.11 createMailExtApp

- 2.11 通知

- 2.11.1 setNotificationsConfig

- 2.11.2 getNotificationsConfig

- 2.12 ピープル・コネクション

- 2.12.1 startSyncProfiles

- 2.12.2 stopSyncProfiles

- 2.12.3 isSyncProfilesRunning

- 2.12.4 syncProfile

- 2.12.5 setProfileConfig

- 2.12.6 getProfileConfig

- 2.12.7 listProfileConfig

- 2.12.8 setProfilePhotoSync

- 2.13 個人イベント

- 2.13.1 createPersonalEventConnection

- 2.13.2 setPersonalEventConnection

- 2.13.3 listPersonalEventConnections

- 2.14 ポートレット・プロデューサ

- 2.14.1 registerWSRPProducer

- 2.14.2 setWSRPProducer

- 2.14.3 listWSRPProducers

- 2.14.4 deregisterWSRPProducer

- 2.14.5 listWSRPProducerRegistrationProperties

- 2.14.6 listWSRPProducerUserCategories

- 2.14.7 mapWSRPProducerUserCategory

- 2.14.8 registerPDKJavaProducer

- 2.14.9 setPDKJavaProducer

- 2.14.10 deregisterPDKJavaProducer

- 2.14.11 listPDKJavaProducers

- 2.14.12 registerPageletProducer

- 2.14.13 setPageletProducer

- 2.14.14 listPageletProducers

- 2.14.15 deregisterPageletProducer

- 2.14.16 refreshProducer

- 2.14.17 listPortletClientConfig

- 2.14.18 setPortletClientConfig

- 2.14.19 getPortletClientConfig

- 2.14.20 registerOOTBProducers

- 2.14.21 deregisterOOTBProducers

- 2.14.22 registerSampleProducers

- 2.14.23 deregisterSampleProducers

- 2.15 プロキシ・サーバー

- 2.15.1 getWebCenterProxyConfig

- 2.15.2 setWebCenterProxyConfig

- 2.15.3 unsetWebCenterProxyConfig

- 2.16 検索 - Oracle SES検索

- 2.16.1 createSESConnection

- 2.16.2 setSESConnection

- 2.16.3 listSESConnections

- 2.16.4 setSearchSESConfig

- 2.16.5 listSearchSESConfig

- 2.16.6 createFederationTrustedEntity

- 2.16.7 setSESVersion

- 2.16.8 listSESVersion

- 2.16.9 createDefaultSourceGroup

- 2.17 検索 - Oracle SES検索クローラ

- 2.17.1 createSpacesCrawler

- 2.17.2 createDocumentsCrawler

- 2.17.3 createDiscussionsCrawler

- 2.17.4 listSpacesCrawler

- 2.17.5 listDocumentsCrawler

- 2.17.6 listDiscussionsCrawler

- 2.17.7 startSpacesCrawler

- 2.17.8 startDocumentsCrawler

- 2.17.9 startDiscussionsCrawler

- 2.17.10 stopSpacesCrawler

- 2.17.11 stopDocumentsCrawler

- 2.17.12 stopDiscussionsCrawler

- 2.17.13 deleteSpacesCrawler

- 2.17.14 deleteDocumentsCrawler

- 2.17.15 deleteDiscussionsCrawler

- 2.18 検索 - WebCenter Portal検索

- 2.18.1 setSearchConfig

- 2.18.2 listSearchConfig

- 2.18.3 setSpacesCrawlProperties

- 2.18.4 getSpacesCrawlProperties

- 2.19 WebCenterポータル・アプリケーション

- 2.19.1 getSpacesWorkflowConnectionName

- 2.19.2 setSpacesWorkflowConnectionName

- 2.20 アイデンティティ・ストア

- 2.20.1 setWebCenterIdStoreSearchConfig

- 2.20.2 listWebCenterIdStoreSearchConfig

- 2.21 ライフサイクル

- 2.21.1 deployWebCenterPortal

- 2.21.2 propagateWebCenterPortal

- 2.21.3 exportWebCenterPortals

- 2.21.4 exportWebCenterPortalTemplates

- 2.21.5 importWebCenterPortals

- 2.21.6 listWebCenterPortalArchive

- 2.21.7 exportWebCenterPortalConnections

- 2.21.8 importWebCenterPortalConnections

- 2.21.9 setSpaceState

- 2.21.10 exportWebCenterResource

- 2.21.11 importWebCenterResource

- 2.21.12 importWebCenterTranslations

- 2.21.13 exportWebCenterApplication

- 2.21.14 importWebCenterApplication

- 2.21.15 exportPortletClientMetadata

- 2.21.16 importPortletClientMetadata

- 2.21.17 showProducerImportFailures

- 2.21.18 retryAllFailedProducerImports

- 2.21.19 cloneWebCenterManagedServer

- 2.22 アップグレード

- 2.22.1 upgradeWebCenterPortal

- 2.22.2 listDeprecatedFeaturesUsage

3 Oracle WebCenter ContentカスタムWLSTコマンド

- 3.1 WLST WebCenter Contentコマンド・カテゴリの概要

- 3.2 WLST WebCenter Contentのヘルプ

- 3.3 ゲッター・メソッドとセッター・メソッドの実装

- 3.4 サーバー構成コマンド

- 3.4.1 getUCMHttpServerAddress

- 3.4.2 getUCMServerPort

- 3.4.3 setUCMServerPort

- 3.4.4 getUCMIpAddressFilter

- 3.4.5 setUCMIpAddressFilter

- 3.4.6 getUCMUseSSL

- 3.5 電子メール構成コマンド

- 3.5.1 getUCMMailServer

- 3.5.2 setUCMMailServer

- 3.5.3 getUCMSmtpPort

- 3.5.4 getUCMSysAdminAddress

- 3.5.5 setUCMSysAdminAddress

- 3.6 システム・ステータス・コマンド

- 3.6.1 getUCMCSVersion

- 3.6.2 getUCMServerUptime

- 3.7 一般構成コマンド

- 3.7.1 getUCMOverRideFormat

- 3.7.2 setUCMOverRideFormat

- 3.7.3 getUCMDownloadApplet

- 3.7.4 setUCMDownloadApplet

- 3.7.5 getUCMMultiUpload

- 3.7.6 setUCMMultiUpload

- 3.7.7 getUCMUseAccounts

- 3.7.8 setUCMUseAccounts

- 3.7.9 getUCMIsAutoNumber

- 3.7.10 setUCMIsAutoNumber

- 3.7.11 getUCMAutoNumberPrefix

- 3.7.12 setUCMAutoNumberPrefix

- 3.7.13 getUCMMajorRevLabelSeq

- 3.7.14 setUCMMajorRevLabelSeq

- 3.7.15 getUCMMinorRevLabelSeq

- 3.7.16 setUCMMinorRevLabelSeq

- 3.7.17 getUCMJspServerEnabled

- 3.7.18 setUCMJspServerEnabled

- 3.7.19 getUCMJspEnabledGroups

- 3.7.20 setUCMJspEnabledGroups

- 3.8 コンテンツ・セキュリティ構成コマンド

- 3.8.1 getUCMCopyAccess

- 3.8.2 setUCMCopyAccess

- 3.8.3 getUCMExclusiveCheckout

- 3.8.4 setUCMExclusiveCheckout

- 3.8.5 getUCMAuthorDelete

- 3.8.6 setUCMAuthorDelete

- 3.8.7 getUCMShowOnlyKnownAccounts

- 3.8.8 setUCMShowOnlyKnownAccounts

- 3.9 コンポーネント・マネージャ構成コマンド

- 3.9.1 getUCMComponentStatus

- 3.9.2 setUCMComponentStatus

- 3.9.3 installUCMComponent

- 3.9.4 uninstallUCMComponent

- 3.9.5 downloadUCMComponent

- 3.9.6 getUCMComponentConfig

- 3.9.7 updateUCMComponentConfig

- 3.10 レコード管理構成コマンド

- 3.10.1 getRMLevel

- 3.10.2 getRMConfigurationLevel

- 3.10.3 getRMFeatures

- 3.10.4 getRMDispositionActions

- 3.10.5 rmUpdate

- 3.10.6 addOutgoingProvider

- 3.10.7 registerSource

- 3.11 ユーザー・インタフェース・コマンド

- 3.11.1 displayWccAdfConfig

- 3.11.2 updateWccAdfConfig

- 3.12 ユーザー・インタフェース接続コマンド

- 3.12.1 createRIDCConnection

- 3.12.2 updateRIDCConnection

- 3.12.3 listRIDCConnections

- 3.12.4 deleteRIDCConnection

- 3.12.5 displayRIDCConnection

4 Oracle WebCenter Enterprise CaptureカスタムWLSTコマンド

- 4.1 WLST Oracle WebCenter Enterprise Captureコマンド・カテゴリの概要

- 4.2 構成コマンド

- 4.2.1 listWorkspaces

- 4.2.2 listBatches

- 4.2.3 exportBatch

- 4.2.4 exportWorkspace

- 4.2.5 importWorkspace

- 4.2.6 unlockBatch

- 4.2.7 listLockedBatches

- 4.2.8 listCaptureConfig

- 4.2.9 getCaptureConfig

- 4.2.10 setCaptureConfig

- 4.2.11 scanForClientBundles

- 4.2.12 deleteBundle

- 4.2.13 setObjectProperty

- 4.2.14 getObjectProperty

- 4.2.15 setObjectCredentials

- 4.2.16 updateScript

- 4.2.17 cloneWorkspaceFromID

- 4.2.18 cloneWorkspaceFromFile

- 4.2.19 listImportHATokens

- 4.2.20 deleteImportHAToken

A Captureオブジェクト・プロパティ

- A.1 クライアント・プロファイル・オブジェクト・プロパティ

- A.2 インポート・プロセッサ・ジョブ・オブジェクト・プロパティ

- A.2.1 一般インポート・ジョブ・プロパティ

- A.2.2 フォルダ・インポート・ジョブ固有プロパティ

- A.2.3 リスト・ファイル・インポート・ジョブ固有プロパティ

- A.2.4 電子メール・ジョブ固有プロパティ

- A.3 認識プロセッサ・ジョブ・オブジェクト・プロパティ

- A.3.1 一般認識ジョブ・プロパティ

- A.3.2 BarcodeDefinitionクラス・プロパティ

- A.3.3 DocumentDefinitionクラス・プロパティ

- A.3.4 RecognitionJobFieldクラス・プロパティ

- A.3.5 SeparatorDefinitionクラス・プロパティ

- A.4 コミット・プロファイル・オブジェクト・プロパティ

- A.4.1 一般コミット・プロファイル・プロパティ

- A.4.2 テキスト・ファイル・コミット・プロファイル固有プロパティ

- A.4.3 Webcenterコンテンツ・コミット・プロファイル固有プロパティ

- A.4.4 ContentAttributeMappingInfoクラス・プロパティ

- A.4.5 CaptureToContentFieldMappingクラス・プロパティ

- A.4.6 ContentFieldNameInfoクラス・プロパティ

- A.4.7 Webcenter Imagingコミット・プロファイル固有プロパティ

- A.4.8 PDF検索可能ドキュメント出力固有プロパティ

- A.4.9 DOCSコミット・ドライバ・プロパティ

- A.5 ドキュメント変換ジョブ・オブジェクト・プロパティ

はじめに

このドキュメントでは、WebCenter Portal、WebCenter Content、WebCenter Enterprise CaptureなどのインストールされたOracle Fusion Middlewareコンポーネントを管理するために使用できるカスタムWebLogic Scripting Tool (WLST)コマンドについて説明します。

ドキュメントのアクセシビリティについて

Oracleのアクセシビリティへの取り組みについては、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)にアクセスしてください。

Oracleサポートへのアクセス

サポートを購入したオラクル社のお客様は、My Oracle Supportを介して電子的なサポートにアクセスできます。詳細は、http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info、聴覚に障害があるお客様はhttp://www.oracle.com/pls/topic/lookup?ctx=acc&id=trsを参照してください。

関連ドキュメント

このガイドで言及しているすべての製品の完全なドキュメントは、http://docs.oracle.com/en/middleware/のOracleヘルプ・センターで入手できます。

表記規則

このマニュアルでは次の表記規則を使用します。

表記規則

意味

太字

太字は、操作に関連するGraphical User Interface要素、または本文中で定義されている用語および用語集に記載されている用語を示します。

イタリック

イタリックは、ユーザーが特定の値を指定するプレースホルダ変数を示します。

固定幅フォント

固定幅フォントは、段落内のコマンド、URL、サンプル内のコード、画面に表示されるテキスト、または入力するテキストを示します。

1 概要とロードマップ

この節では、このガイド『WebCenter WLSTコマンド・リファレンス』の内容と構成について説明します。

- ドキュメントのスコープと対象読者

- このドキュメントの手引き

- 関連ドキュメント

- このガイドの新機能と変更された機能

1.1 ドキュメントのスコープと対象読者

このドキュメントでは、WebCenter Portal、WebCenter Content、WebCenter Enterprise CaptureなどのインストールされたOracle Fusion Middlewareコンポーネントを管理するために使用できるカスタムWebLogic Scripting Tool (WLST)コマンドについて説明します。

注意:

コンポーネントは、ORACLE_HOMEディレクトリにインストールされている場合のみ、指定されたOracle Fusion MiddlewareコンポーネントのカスタムWLSTコマンドが使用できます。

このドキュメントは、OracleのJava Platform, Enterprise Edition (Java EE)を使用してJava EEアプリケーションをデプロイする、WebLogic Serverの管理者およびオペレータを対象としています。読者は、Webテクノロジ、およびWebLogic Serverがインストールされているオペレーティング・システムとプラットフォームに精通していることが前提となっています。

1.2 このドキュメントの手引き

このマニュアルの構成は次のとおりです。

- この章「概要とロードマップ」では、このガイドの構成および関連ドキュメントについて説明します。

- 「WebCenter PortalカスタムWLSTコマンド」では、Oracle WebCenter PortalのカスタムWLSTコマンドについて詳細に説明します。

- 「Oracle WebCenter ContentカスタムWLSTコマンド」では、Oracle WebCenter ContentのカスタムWLSTコマンドについて詳細に説明します。

- 「Oracle WebCenter Enterprise CaptureカスタムWLSTコマンド」では、Oracle WebCenter CaptureのカスタムWLSTコマンドについて詳細に説明します。

1.3 関連ドキュメント

WebLogic Scripting Toolの使用方法については、『WebLogic Scripting Toolの理解』を参照してください。

1.4 このガイドの新機能と変更された機能

この項では、WebCenter Content、WebCenter Enterprise CaptureおよびWebCenter Portalの新しいおよび変更されたカスタムWLSTコマンドについて説明します。この項の内容は、次のとおりです。

- 12c リリース(12.2.1.1)の新機能と変更された機能

1.4.1 12c リリース(12.2.1.1)の新機能と変更された機能

Oracle WebCenter Enterprise Capture

- Captureオブジェクトに設定できるDOCSコミット・ドライバ・プロパティのリストを追加しました。

- 一般認識ジョブ・プロパティの項に新規プロパティ・セットを追加しました。

2 WebCenter PortalカスタムWLSTコマンド

この章では、Oracle WebCenter PortalのWebLogic Scripting Tool (WLST)コマンドについて説明します。これらのコマンドを使用すると、コマンド行からWebCenter Portalおよびコンポーネントを構成できます。

注意:

これらのコマンドを使用するには、Oracleホーム(ORACLE_HOME)・ディレクトリからWLSTを起動する必要があります。『Oracle WebCenter Portalでのポータルの構築』のOracle WebLogic Scripting Tool (WLST)コマンドの実行に関する項を参照してください。

これらのWLSTコマンドを使用して行ったほとんどの構成変更は、WebCenter Portalがデプロイされている管理対象サーバーを再起動した後のみ有効になります。例外はいくつかあり、外部アプリケーション、ポートレット・プロデューサ、ライフサイクルのWLSTコマンドなどがこれに含まれます。

Oracle WebCenter Portal構成の詳細は、『Oracle WebCenter Portalの管理』のOracle WebCenter Portalの管理の概要に関する項を参照してください。

次の項では、Oracle WebCenter PortalのカスタムWLSTコマンドについて説明します。

- Oracle WebCenter Portal WLSTコマンド・カテゴリの概要

- 一般

- 分析

- アクティビティ・ストリーム

- BPELサーバー接続

- コンテンツ・リポジトリ

- ディスカッションおよびお知らせ

- 外部アプリケーション

- インスタント・メッセージおよびプレゼンス

- メール

- 通知

- ピープル・コネクション

- 個人イベント

- ポートレット・プロデューサ

- プロキシ・サーバー

- 検索 - Oracle SES検索

- 検索 - Oracle SES検索クローラ

- 検索 - WebCenter Portal検索

- WebCenter Portalアプリケーション

- アイデンティティ・ストア

- ライフサイクル

- アップグレード

2.1 Oracle WebCenter Portal WLSTコマンド・カテゴリの概要

Oracle WebCenter PortalのWLSTコマンドは、いくつかのカテゴリにグループ化されています(表2-1)。

これらのWLSTコマンドを使用して行ったほとんどの構成変更は、WebCenter Portalがデプロイされている管理対象サーバーを再起動した後のみ有効になります。例外は、外部アプリケーション、ポートレット・プロデューサおよびライフサイクルのWLSTコマンドのみです。

表2-1 WLSTコマンド・カテゴリ

コマンド・カテゴリ

説明

一般

WebCenter Portalの接続を管理します。

分析

分析コレクタの接続を管理し、分析コレクタを構成します。

アクティビティ・ストリーム

アクティビティ・ストリーム・データをアーカイブおよびリストアします。

コンテンツ・リポジトリ

コンテンツ・リポジトリの接続を管理し、ドキュメント・サービスを設定します。

ディスカッションおよびお知らせ

ディスカッション・サーバーの接続を管理し、ディスカッションおよびお知らせを構成します。

外部アプリケーション

外部アプリケーションの接続を管理します。

インスタント・メッセージおよびプレゼンス

インスタント・メッセージおよびプレゼンス・サーバーの接続を管理し、インスタント・メッセージおよびプレゼンスを構成します。

メール

メール・サーバーの接続を管理し、メールを構成します。

通知

通知の設定を管理します。

ピープル・コネクション

プロファイル情報を管理します。

個人イベント

個人イベント・サーバーの接続を管理します。

ポートレット・プロデューサ

ポートレット・プロデューサを管理します。

プロキシ・サーバー

RSSおよびアクティビティ・ストリームのプロキシ設定を管理します。

検索 - Oracle SES検索

Oracle Secure Enterprise Search (SES)の接続およびその他の検索関連プロパティを管理します。

検索 - Oracle SES検索クローラ

Oracle Secure Enterprise Search (SES)クローラを管理します。

検索 - WebCenter Portal検索

WebCenter Portalの検索クローラを管理します。

BPELサーバー接続

BPELサーバーの接続を管理します。

WebCenter Portalアプリケーション

WebCenter Portalワークフロー設定およびポータルのメタデータを管理します。

アイデンティティ・ストア

アプリケーションのアイデンティティ・ストアの検索時に使用するオプションを構成します。

ライフサイクル

アプリケーションのメタデータ、個々のポータル、ポータル・テンプレートおよびポートレット・プロデューサのメタデータをエクスポートおよびインポートします。

アップグレード

以前のOracle WebCenter Portalリリースからアップグレードします。

2.2 一般

表2-2に示す一般コマンドを使用して、接続を管理し、その他の一般タスクを実行します。

これらのWLSTコマンドを使用して行った構成変更は、WebCenter Portalがデプロイされている管理対象サーバーを再起動した後のみ有効になります。

表2-2 一般WLSTコマンド

使用するコマンド

目的

WLSTでの使用

deleteConnection

任意の接続を削除します。

オンライン

getWebCenterConnectionTypes

すべての接続タイプを一覧表示します。

オンライン

setWebCenterServiceFrameworkConfig

WebCenter Portalサービス・フレームワーク構成プロパティを設定します。

オンライン

getWebCenterServiceFrameworkConfig

WebCenter Portalフレームワーク構成プロパティを返します。

オンライン

webcenterErrorOccurred

最後に実行したOracle WebCenter Portalコマンドのステータス情報を返します。

オンライン

2.2.1 deleteConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WebCenter Portalに現在構成されている指定された接続を削除します。

deleteConnectionを使用してWSRPまたはPDK-Javaプロデューサ接続(deregisterWSRPProducer またはderegisterPDKJavaProducerではなく)を削除すると、削除が必要になる場合がある、未使用のセカンダリ接続がそのまま残ります。たとえば、WSRPプロデューサの接続を削除すると、それに関連付けられるWebサービス接続がそのまま残り、PDK-Javaプロデューサの接続を削除すると、それに関連付けられるURL接続がそのまま残ります。

構文

deleteConnection(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)用に構成された接続を削除します。

wls:/weblogic/serverConfig> deleteConnection(appName='webcenter', name='MyConnection')

2.2.2 setWebCenterServiceFrameworkConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle WebCenter Portalのサービス・フレームワーク構成プロパティ(リソース・アクション・ハンドラ・クラスやポップアップ表示プロパティなど)を設定します。

構文

setWebCenterServiceFrameworkConfig(appName, [resourceActionHandlerClassName, resourceActionHandlerDisplayInPopup, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

resourceActionHandlerClassName

オプション。サービス・フレームワーク・リソース・アクション・ハンドラによって使用されるクラス。

resourceActionHandlerDisplayInPopup

オプション。リソース・アクション・ハンドラがリソースをポップアップとインラインのどちらで表示するのかを示します。有効なオプションは、1 (true)および0 (false)です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalサービス・フレームワーク・リソース・アクション・ハンドラ・クラスをmy.company.ResourceActionHandlerに設定します。

wls:/wc_domain/domainRuntime> setWebCenterServiceFrameworkConfig(appName='webcenter', resourceActionHandlerClassName='my.company.ResourceActionHandler')

Successfully set the WebCenter Portal service framework configuration.
Resource Action Handler class: my.company.ResourceActionHandler
To effect connection changes, you must restart the managed server on which the
application is deployed.

次の例では、WebCenter Portalサービス・フレームワーク・リソース・アクション・ハンドラのポップアップ表示値を1 (true)に設定します(他のオプションの引数は設定しません)。

wls:/wc_domain/domainRuntime>
setWebCenterServiceFrameworkConfig(appName='webcenter', resourceActionHandlerDisplayInPopup=1)

Successfully set the WebCenter Portal service framework configuration.
Resource Action Handler Display In Popup: true
To effect connection changes, you must restart the managed server on which the application is deployed.

2.2.3 getWebCenterServiceFrameworkConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WebCenter Portalサービス・フレームワーク構成プロパティの設定を次のように返します。

- resourceActionHandlerClassName: WebCenter Portalサービス・フレームワーク・リソース・アクション・ハンドラによって現在使用されているクラス

- resourceActionHandlerDisplayInPopup: リソース・アクション・ハンドラがリソースをポップアップとインラインのどちらで表示するのかを示します。有効なオプションは、1 (true)および0 (false)です。

構文

getWebCenterServiceFrameworkConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)に対して、サービス・フレームワーク・リソース・アクション・ハンドラ・クラスおよびポップアップ表示プロパティを返します。

wls:/weblogic/serverConfig>getWebCenterServiceFrameworkConfig(appName='webcenter')
Resource Action Handler Class: my.company.ResourceActionHandler
Resource Action Handler Display In Popup: true

2.2.4 webcenterErrorOccurred

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

最後に実行されたWebCenter Portalコマンドのステータスを返します。

webcenterErrorOccurredコマンドを使用して、最後に実行されたWebCenter Portalコマンドのステータスを判別します。エラーが発生した場合、このコマンドは1を返し、それ以外の場合は0を返します。

構文

webcenterErrorOccurred ()

例

次の例では、エラーが発生した場合は1を返します。

wls:/mydomain/serverConfig> webcenterErrorOccurred()

2.2.5 getWebCenterConnectionTypes

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

すべてのOracle WebCenter Portal接続タイプを一覧表示します。

構文

getWebCenterConnectionTypes(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)用の接続タイプを返します。

wls:/mydomain/serverConfig>getWebCenterConnectionTypes(appName='webcenter')

2.3 分析

この項には、WebCenter Portal用の分析コレクタ接続を管理して分析コレクタを構成するコマンドが含まれます。

分析コレクタ接続

表2-3に示すコマンドを使用して、WebCenter Portal用の分析コレクタ接続を管理します。OpenUsage APIを使用してこれらのポータル・アプリケーションで発生したイベントを分析コレクタに送信できます。送信したイベントは、分析で使用されます。

これらのOracle WebCenter Portal WLSTコマンドを使用して行った接続構成変更は、アプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

表2-3 分析コレクタ接続WLSTコマンド

使用するコマンド

目的

WLSTでの使用

createAnalyticsCollectorConnection

WebCenter Portal用の分析コレクタへの接続を作成します。

オンライン

setAnalyticsCollectorConnection

既存の分析コレクタ接続を編集します。

オンライン

listAnalyticsCollectorConnections

WebCenter Portalに対して構成されている分析コレクタのすべての接続を一覧表示します。

オンライン

setDefaultAnalyticsCollectorConnection

WebCenter Portal用のデフォルト(またはアクティブ)分析コレクタ接続を指定します。

オンライン

listDefaultAnalyticsCollectorConnection

WebCenter Portalによって使用されている分析コレクタの接続詳細を返します。

オンライン

分析コレクタとクラスタ構成

表2-4に示すコマンドを使用して、WC_Utilities管理対象サーバーにデプロイされている分析コレクタのイベント収集プロパティを構成します。

分析コレクタを再構成するか、クラスタ化を設定する場合、分析コレクタがデプロイされている管理対象サーバー(WC_Utilities)を再起動する必要があります。

表2-4 分析コレクタ構成WLSTコマンド

使用するコマンド

目的

WLSTでの使用

setAnalyticsCollectorConfig

分析コレクタのオプションおよびクラスタのオプション(クラスタ化環境を稼働している場合)を設定します。

オンライン

listAnalyticsCollectorConfig

分析コレクタの設定を返します。

オンライン

listAnalyticsEventTypes

分析コレクタに現在登録されているイベントを一覧表示します。

オンライン

2.3.1 createAnalyticsCollectorConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーション用の分析コレクタへの接続を作成します。

OpenUsage APIを使用してWebCenter Portalで発生したイベントを分析コレクタに送信できます。送信したイベントは、分析で使用されます。

1つのアプリケーションに対して複数の分析コレクタ接続を登録できますが、使用される分析コレクタ接続は1つのみであり、default=1の場合、デフォルト(またはアクティブな)接続が使用されます。

構文

createAnalyticsCollectorConnection(appName, connectionName, [isUnicast, collectorhost, clusterName, collectorPort, isEnabled, timeout, default, server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、名前は常にwebcenterです。

connectionName

接続の名前を示します。名前は、アプリケーション内のすべての接続タイプ間で一意である必要があります。

isUnicast

オプション。クラスタ化された分析コレクタにイベントをマルチキャスト・モードで送信するか、ユニキャスト通信を使用する単一の分析コレクタが必要かを指定します。

有効な値は、1 (true)および0 (false)です。デフォルト値は1 (ユニキャスト)です。

collectorHost

オプション。分析コレクタを実行しているホスト名。デフォルト値はlocalhostです。

ユニキャスト通信である場合、つまりisUnicast=1である場合にのみ必要です。

clusterName

オプション。クラスタ化分析コレクタを実行しているクラスタの名前。

マルチキャスト通信である場合、つまりisUnicast=0である場合にのみ必要です。

collectorPort

オプション。分析コレクタがイベントをリスニングするポート。デフォルト値は31314です。

isEnabled

オプション。OpenUsage APIを使用して発生した分析イベントを分析コレクタに送信するかどうかを指定します。有効な値は、1 (true)および0 (false)です。デフォルト値は0です。

isEnabled=1およびdefault=1である場合、分析イベントは分析コレクタに送信されます。

timeout

オプション。分析コレクタからの応答を待つ時間の長さ(秒単位)。デフォルト値は30です。

マルチキャスト通信である場合、つまりisUnicast=0である場合にのみ必要です。

default

オプション。この接続が、アプリケーション用のデフォルト(またはアクティブ)分析コレクタ接続であるかどうかを示します。

有効な値は、1 (true)および0 (false)です。1に設定した場合、アプリケーションはこの接続上でイベントを送信します。0に設定すると、その接続は使用されません。この引数のデフォルトは0です。

1つのアプリケーションに対して複数の分析コレクタ接続を登録できますが、分析によって使用される接続は1つのみであり、デフォルト(またはアクティブな)接続が使用されます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)用にMyAnalyticsCollectorという名前の接続を作成します。イベントは、ユニキャスト通信を使用する単一の分析コレクタに送信されます。

wls:/weblogic/serverConfig>createAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', isUnicast=1,
collectorHost='myhost.com', collectorPort=31314, isEnabled=1, timeout=30, default=1)

次の例では、WebCenter Portal用にMyAnalyticsCollectorという名前の接続を作成します。イベントは、マルチキャスト・モードでクラスタ化分析コレクタに送信されます

wls:/weblogic/serverConfig>createAnalyticsCollectorConnection(appName='webcenter',
connectionName='MyAnalyticsCollector', isUnicast=0, clusterName='collector-cluster',
ccollectorPort=31314, isEnabled=1, timeout=30, default=1)

2.3.2 setAnalyticsCollectorConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーション用の既存の分析コレクタ接続を編集します。

OpenUsage APIを使用してWebCenter Portalで発生したイベントを分析コレクタに送信できます。送信したイベントは、分析で使用されます。

1つのアプリケーションに対して複数の分析コレクタ接続を登録できますが、使用される分析コレクタ接続は1つのみであり、デフォルト(またはアクティブな)接続が使用されます。

構文

setAnalyticsCollectorConnection(appName, connectionName, [isUnicast, collectorHost, clusterName, collectorPort, isEnabled, timeout, default, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、名前は常にwebcenterです。

connectionName

接続の名前を示します。名前は、アプリケーション内のすべての接続タイプ間で一意である必要があります。

isUnicast

オプション。クラスタ化された分析コレクタにイベントをマルチキャスト・モードで送信するか、ユニキャスト通信を使用する単一の分析コレクタが必要かを指定します。

有効な値は、1 (true)および0 (false)です。デフォルト値は1 (ユニキャスト)です。

collectorHost

オプション。分析コレクタを実行しているホスト名。デフォルト値はlocalhostです。

ユニキャスト通信である場合、つまりisUnicast=1である場合にのみ必要です。

clusterName

オプション。クラスタ化分析コレクタを実行しているクラスタの名前。

マルチキャスト通信である場合、つまりisUnicast=0である場合にのみ必要です。

collectorPort

オプション。分析コレクタがイベントをリスニングするポート。

デフォルト値は31314です。

isEnabled

オプション。OpenUsage APIを使用して発生した分析イベントを分析コレクタに送信するかどうかを指定します。

有効な値は、1 (true)および0 (false)です。デフォルト値はfalseです。

isEnabled=1およびdefault=1である場合、分析イベントは分析コレクタに送信されます。

timeout

オプション。分析コレクタからの応答を待つ時間の長さ(秒単位)。デフォルト値は30です。

マルチキャスト通信である場合、つまりisUnicast=0である場合にのみ必要です。

default

オプション。この接続が、アプリケーション用のデフォルト(またはアクティブ)分析コレクタ接続であるかどうかを示します。

有効な値は、1 (true)および0 (false)です。1に設定した場合、アプリケーションはこの接続上でイベントを送信します。0に設定すると、その接続は使用されません。この引数のデフォルトは0です。

1つのアプリケーションに対して複数の分析コレクタ接続を登録できますが、分析によって使用される接続は1つのみであり、デフォルト(またはアクティブな)接続が使用されます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyAnalyticsCollectorという名前の既存の分析コレクタ接続のホストおよびポートの詳細を編集します。この接続では、イベントは、ユニキャスト・モードで単一の分析コレクタに送信されます。

wls:/weblogic/serverConfig>setAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', collectorHost='myhost.com', collectorPort=31314)

次の例では、MyAnalyticsCollectorという名前の既存の分析コレクタ接続のクラスタ、ポートおよびタイムアウトの詳細を編集します。この接続では、イベントは、マルチキャスト・モードでクラスタ化分析コレクタに送信されます。

wls:/weblogic/serverConfig>setAnalyticsCollectorConnection(appName='webcenter',
connectionName='MyAnalyticsCollector', clusterName='collector-cluster', collectorPort=31314, timeout=60)

2.3.3 listAnalyticsCollectorConnections

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションに対して構成されているすべての分析コレクタ接続の接続名および詳細を一覧表示します。

構文

listAnalyticsCollectorConnections(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、現在、WebCenter Portal (webcenter)に対して構成されているすべての分析コレクタ接続の接続名と詳細を一覧表示します。

wls:/weblogic/serverConfig>listAnalyticsCollectorConnections(appName='webcenter')

------------------
MyAnalyticsCollector
------------------
ClusterName/HostName: localhost
Port: 31314
Timeout: 30
Unicast: 1 (true)
Enabled: 1 (true)

------------------
TestAnalyticsCollector
------------------
ClusterName/HostName: localhost
Port: 32456
Timeout: 456
Unicast: 1 (true)
Enabled: 1 (true)
------------------

2.3.4 setDefaultAnalyticsCollectorConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーション用のデフォルト分析コレクタ接続を指定します。

OpenUsage APIを使用してWebCenter Portalで発生したイベントを分析で使用する分析コレクタに送信するため、デフォルトの分析コレクタ接続が使用されます。

1つのアプリケーションに対して複数の分析コレクタ接続を登録できますが、使用される分析コレクタ接続は1つのみであり、デフォルト(またはアクティブな)接続が使用されます。

構文

setDefaultAnalyticsCollectorConnection(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存の分析コレクタ接続の名前。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)で発生したイベント用にMyAnalyticsCollectorという接続を構成します。

wls:/weblogic/serverConfig> setDefaultAnalyticsCollectorConnection
(appName='webcenter', name='MyAnalyticsCollector')

次の例では、デフォルトの接続名をリセットします。

wls:/weblogic/serverConfig> setDefaultAnalyticsCollectorConnection
(appName='webcenter', name='')

2.3.5 listDefaultAnalyticsCollectorConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションに対して現在構成されている分析コレクタ接続に関する詳細を返します。

1つのアプリケーションに対して複数の分析コレクタ接続を登録できますが、使用される分析コレクタ接続は1つのみであり、デフォルト(またはアクティブな)接続が使用されます。

構文

listDefaultAnalyticsCollectorConnection(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)に対して現在構成されている分析コレクタ接続に関する詳細を返します。

wls:/weblogic/serverConfig>listDefaultAnalyticsCollectorConnection(appName='webcenter')

------------------
MyAnalyticsCollector
------------------
ClusterName/HostName: localhost
Port: 31314
Timeout: 30
Unicast: 1 (true)
Enabled: 1 (true)
------------------

2.3.6 setAnalyticsCollectorConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WC_Utilities管理対象サーバーにデプロイされている分析コレクタを構成します。さらに、クラスタ化環境では、このコマンドを使用してクラスタ設定を設定します。

構文

setAnalyticsCollectorConfig(appName, [collectorHost, defaultPort, maxPort, broadcastType, clusterEnabled, clusterName, heartbeatFrequency, server, applicationVersion])

引数

定義

appName

この操作を実行する分析コレクタ・アプリケーションの名前。これは常にanalytics-collectorです。

collectorHost

オプション。分析コレクタが実行されているホストの名前。

デフォルト値はlocalhostです。

defaultPort

オプション。分析コレクタがリスニングするデフォルト・ポート番号。

デフォルト値は、31314です。

maxPort

オプション。リスナーを割り当てるときに分析コレクタが使用できる最も大きいポート番号。

このプロパティは、多くの場合、複数のコレクタが同じボックス内で実行されているクラスタ化環境で使用されます。各コレクタは、指定されているポート範囲内の空きポートで受信UDPメッセージをリスニングします。範囲は、デフォルト・ポート番号からmaxPort番号までです。

broadcastType

オプション。分析コレクタがハートビートをブロードキャストして自分の場所をイベント・プロデューサに通知する際のネットワーク・チャネルを示します。有効な値は、BroadcastおよびMulticastです。

- Broadcast: 標準ネットワーク・ブロードキャスト・チャネルを使用します。

- Multicast: 特別な固定マルチキャスト・アドレスを使用します。

clusterEnabled

オプション。分析コレクタがクラスタ内にデプロイされているかどうかを示します。有効な値は、1 (true)および0 (false)です。

1に設定されている場合、clusterNameも定義する必要があります。

clusterName

オプション。分析コレクタ・クラスタの名前。

clusterEnabled=1の場合にのみ必要です。

heartbeatFrequency

オプション。'n'秒ごとに分析コレクタ・リスニング情報をブロードキャストします。デフォルトの間隔は10秒です。

分析コレクタは、定期的にハートビートをブロードキャストして自分の場所(hostName)を通知します。クラスタ化環境では、WebCenter Portalは、ハートビートを使用して、どの分析コレクタが使用可能であるのか判別します。

server

オプション。分析コレクタがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、デフォルト・ポートを31315に変更します。

wls:/weblogic/serverConfig>setAnalyticsCollectorConfig(appName='analytics-collector', defaultPort=31315)

2.3.7 listAnalyticsCollectorConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

分析コレクタの設定を返します。

構文

listAnalyticsCollectorConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行する分析コレクタ・アプリケーションの名前。これは常にanalytics-collectorです。

server

オプション。分析コレクタがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次のコマンドは、webcenterという名前のアプリケーションに対して構成されている分析コレクタの現在の設定を一覧表示します。

wls:/weblogic/serverConfig>listAnalyticsCollectorConfig(appName='analytics-collector')

次のものは、スタンドアロン分析コレクタの場合のサンプル出力です。

CollectorHost = localhost
CollectorDefaultPort = 31314
CollectorMaximumPort = 31314
BroadcastType = Multicast
ClusterEnabled =
ClusterName =
ClusterBroadcastFrequency = 55

次のものは、クラスタ化環境における分析コレクタのサンプル出力です。

CollectorHost = localhost
CollectorDefaultPort = 31314
CollectorMaximumPort = 31318
BroadcastType = Multicast
ClusterEnabled = 1
ClusterName = myCluster
ClusterBroadcastFrequency = 55

2.3.8 listAnalyticsEventTypes

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

分析コレクタに現在登録されているすべてのイベントを一覧表示します。

構文

listAnalyticsEventTypes(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次のコマンドは、WebCenter Portal (webcenter)で使用するために、分析コレクタに現在登録されているイベントをすべて一覧表示します。

wls:/weblogic/serverConfig>listAnalyticsEventTypes(appName='webcenter')

出力例:

{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DISCUSSION_ANNOUNCEMENTEDIT
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DISCUSSION_TOPICDELETE
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}PAGEEDIT
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DOCLIB_DOCUMENTCREATE
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}LOGINS
...

2.4 アクティビティ・ストリーム

表2-5に示すコマンドを使用して、WebCenter Portalに対して生成されたアクティビティ・ストリーム・データをアーカイブおよびリストアします。

これらのWLSTコマンドを使用して設定に対して行った変更は、アプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

表2-5 アクティビティ・ストリームWLSTコマンド

使用するコマンド

目的

WLSTでの使用

archiveASByDate

指定された日付よりも古いアクティビティ・ストリーム・データをアーカイブします。

オンライン

archiveASByDeletedObjects

削除されたオブジェクトに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

オンライン

archiveASByClosedSpaces

現在閉じられているポータルに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

オンライン

archiveASByInactiveSpaces

指定された日付以降非アクティブであったポータルに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

オンライン

restoreASByDate

指定された日付以降のアーカイブされたアクティビティ・ストリーム・データを本番表にリストアします。

オンライン

truncateASArchive

アクティビティ・ストリーム・アーカイブ・データを切り捨てます。

オンライン

archiveASBySpace

ポータルに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

オンライン

archiveASAllSpaces

すべてのポータルに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

オンライン

archiveASByUser

ユーザーに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

オンライン

archiveASAllUsers

すべてのユーザーに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

オンライン

archiveASByDeletedActors

削除されたアクターに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

オンライン

showASStatistics

アクティビティ・ストリームの統計を報告します。

オンライン

2.4.1 archiveASByDate

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定された日付よりも古いアクティビティ・ストリーム・データをアーカイブします。

このコマンドは、本番表からアーカイブ表にデータを移動します。例外としては、WC_ACTOR_DETAILおよびWC_OBJECT_DETAILがあり、これらの表のデータは、アーカイブ表に移動ではなくコピーされます。

アクティビティ要素によって使用されていないWC_OBJECT_DETAIL内の行は削除されます。

構文

archiveASByDate(appName, year, month, day, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

year

ここで指定した年より前のアクティビティ・ストリーム・データがアーカイブされます。たとえば、2009です。

month

ここで指定した月より前のアクティビティ・ストリーム・データがアーカイブされます。たとえば、1月なら1、2月なら2のように入力します。

day

ここで指定した日付より前のアクティビティ・ストリーム・データがアーカイブされます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、2015年3月1日より古い、WebCenter Portal (webcenter)のアクティビティ・ストリーム・データをアーカイブします。

wls:/weblogic/serverConfig> archiveASByDate(appName='webcenter', year=2015, month=3, day=1)

2.4.2 archiveASByDeletedObjects

モジュール: Oracle WebCenter Portal

説明

削除されたオブジェクトに関連付けられたアクティビティ・ストリーム・データをアーカイブします。このコマンドは、本番表のデータをアーカイブ表に移動します。ただし、WC_ACTOR_DETAILは除きます。この表のデータは、アーカイブ表に移動されるのではなくコピーされます。

基準(この場合、削除されたオブジェクト)を満たすWC_OBJECT_DETAIL内の行は削除されます。

構文

archiveASByDeletedObjects(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)から削除されたオブジェクトに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

wls:/weblogic/serverConfig> archiveASByDeletedObjects(appName='webcenter')

WLSTでの使用: オンライン

2.4.3 archiveASByClosedSpaces

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

現在閉じられているポータルに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

このコマンドは、本番表のデータをアーカイブ表に移動します。ただし、WC_ACTOR_DETAILは除きます。この表のデータは、アーカイブ表に移動されるのではなくコピーされます。

基準(この場合、閉じられたポータルのアクティビティに関連するオブジェクト)を満たすWC_OBJECT_DETAIL内の行は削除されます。

構文

archiveASByClosedSpaces(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)で現在閉じられているものとしてマークされているポータルに対して、関連付けられているアクティビティ・ストリーム・データをアーカイブします。

wls:/weblogic/serverConfig> archiveASByClosedSpaces(appName='webcenter')

2.4.4 archiveASByInactiveSpaces

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定された日付以降非アクティブであったポータルに関連付けられているアクティビティ・ストリーム・データをアーカイブします。非アクティブ・ポータルとは、指定された日付以降アクティビティがなかった開いているまたは閉じられたポータルです。

このコマンドは、本番表のデータをアーカイブ表に移動します。ただし、WC_ACTOR_DETAILは除きます。この表のデータは、アーカイブ表に移動されるのではなくコピーされます。基準(この場合、指定された日付以降非アクティブであったポータルのアクティビティに関連するオブジェクト)を満たすWC_OBJECT_DETAIL内の行は削除されます。

構文

archiveASByInactiveSpaces(appName, year, month, day, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

year

ポータルが非アクティブになった年。例: 2014。

month

ポータルが非アクティブになった月。たとえば、1月なら1、2月なら2のように入力します。

day

ポータルが非アクティブになった日付。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、2014年10月1日以降、非アクティブであった(オープン・ステータスかクローズ・ステータスかに関係なくアクティビティが発生していない)ポータルと関連付けられているアクティビティ・ストリーム・データをアーカイブします。

wls:/weblogic/serverConfig> archiveASByInactiveSpaces(appName='webcenter', year=2014, month=10, day=1)

2.4.5 restoreASByDate

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定された日付以降のアーカイブされたアクティビティ・ストリーム・データを本番表にリストアします。

このコマンドは、アーカイブ表のデータを本番表に移動します。ただし、WC_ACTOR_DETAILは除きます。この表のデータはリストアされません。アーカイブ・プロセス中にこの表からデータが削除されていないためです。

本番表にすでに存在している行は、リストア・プロセス中に変更されません。

構文

restoreASByDate(appName, year, month, day, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

year

ここで指定した年以降のアクティビティ・ストリーム・データがリストアされます。

例: 2014。

month

ここで指定した月以降のアクティビティ・ストリーム・データがリストアされます。

たとえば、1月なら1、2月なら2のように入力します。

day

ここで指定した日付以降のアクティビティ・ストリーム・データがリストアされます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、2014年10月1日以降にアーカイブされたアクティビティ・ストリーム・データがリストアされます。

wls:/weblogic/serverConfig>restoreASByDate(appName='webcenter', year=2014, month=10, day=1)

2.4.6 truncateASArchive

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

アクティビティ・ストリーム・アーカイブ・データを切り捨てます。

構文

truncateASArchive(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、アクティビティ・ストリーム・アーカイブ・データが切り捨てられます。

wls:/weblogic/serverConfig>truncateASArchive(appName='webcenter')

2.4.7 archiveASBySpace

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたポータルに関連付けられているアクティビティ・ストリーム・データをアーカイブし、一定数のアクティビティのみを保持します。

このコマンドは、本番表からアーカイブ表にデータを移動します。

構文

archiveASBySpace(appName, space, cnt, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

space

データをアーカイブするポータルの名前。たとえば、MySalesPortalなどです。

cnt

本番表で保持するポータル・アクティビティの数。たとえば、2000などです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ポータルMySalesPortalに関連付けられている過去2000件のアクティビティを保持し、残りをアーカイブします。

wls:/weblogic/serverConfig> archiveASBySpace(appName='webcenter', space='MySalesPortal', cnt=2000)

2.4.8 archiveASAllSpaces

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

すべてのポータルのアクティビティ・ストリーム・データをアーカイブし、一定数のアクティビティのみを保持します。

このコマンドは、本番表からアーカイブ表にデータを移動します。

構文

archiveASAllSpaces(appName, cnt, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

cnt

本番表で保持するポータル・アクティビティの数。たとえば、2000などです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、本番表内にある過去2000件のアクティビティをポータルごとに保持し、残りのアクティビティ・ストリーム・データをアーカイブします。

wls:/weblogic/serverConfig> archiveASAllSpaces(appName='webcenter', cnt=2000)

2.4.9 archiveASByUser

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

1人のユーザーに関連付けられているアクティビティ・ストリーム・データをアーカイブし、一定数のアクティビティのみを保持します。

このコマンドは、本番表からアーカイブ表にデータを移動します。

構文

archiveASByUser(appName, actor, cnt, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

actor

データをアーカイブするユーザーの名前。たとえば、Montyなどです。

cnt

本番表で保持するユーザー・アクティビティの数。たとえば、2000などです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ユーザーMontyに関連付けられている過去2000件のアクティビティを保持し、残りをアーカイブします。

wls:/weblogic/serverConfig> archiveASByUser(appName='webcenter', actor='Monty', cnt=2000)

2.4.10 archiveASAllUsers

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

すべてのユーザーのアクティビティ・ストリーム・データをアーカイブし、一定数のアクティビティのみを保持します。

このコマンドは、本番表からアーカイブ表にデータを移動します。

構文

archiveASAllUsers(appName, cnt, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

cnt

本番表で保持するユーザー・アクティビティの数。たとえば、2000などです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、本番表内にあるすべてのユーザーの過去2000件のアクティビティを保持し、残りのアクティビティ・ストリーム・データをアーカイブします。

wls:/weblogic/serverConfig> archiveASAllUsers(appName='webcenter', cnt=2000)

2.4.11 archiveASByDeletedActors

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

削除されたユーザー(アクター)に関連付けられているアクティビティ・ストリーム・データをアーカイブします。

このコマンドは、本番表からアーカイブ表にデータを移動します。基準(この場合、削除されたアクター)を満たすWC_AS_ACTOR_DETAIL内の行は削除されます。

構文

archiveASByDeletedActors(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)の削除されたユーザーに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

wls:/weblogic/serverConfig> archiveASByDeletedActors(appName='webcenter')

2.4.12 showASStatistics

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

様々なアクティビティ・ストリームの統計を報告します。

- アクティビティ数が上位N個のポータルのアクティビティ数。

- アクティビティ数が上位N人のユーザーのアクティビティ数

- 特定の日付の後に発生したアクティビティの数。

- アクティビティ数が上位N個のポータルに対して、特定の日付の後に発生したアクティビティの数。

- アクティビティ数が上位N人のユーザーに対して、特定の日付の後に発生したアクティビティの数。

構文

showASStatistics(appName, year, month, day, cnt, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

year

ここで指定した年以降のアクティビティ・ストリームの統計が報告されます。

例: 2014。

month

ここで指定した月以降のアクティビティ・ストリームの統計が報告されます。

たとえば、1月なら1、2月なら2のように入力します。

day

ここで指定した日以降のアクティビティ・ストリームの統計が報告されます。

cnt

レポートに含めるポータルまたはユーザーの数。たとえば、50などです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)の上位50個のポータルと上位50人のユーザーについて、2014年12月6日以降のアクティビティ・ストリームの統計を報告します。

wls:/weblogic/serverConfig> showASStatistics(appName='webcenter', year=2014, month=7, day=18, cnt=3)

============================================================
Cutoff Date = 7/18/12 12:23 PM
Top Count = 3

1. Portals with most activity count are:
Portal Finance Count =10
Portal Photography Count =9
Portal Sport Count =7

2. Users with most activity count are:
User Monty Count =30
User Karen Count =20
User Dave Count =10

3. Total Activities after 7/18/14 12:23 PM =80

4. Portals with most activity count after specific date, are:
Portal Photography Count =9
Portal Finance Count =6
Portal Sport Count =6

5. Users with most activity count after specific date, are:
User Monty Count =10
User Dave Count =8
User Josie Count =7

2.5 BPELサーバー接続

表2-6に示すコマンドを使用して、BPELサーバー接続を管理してWebCenter Portalのメンバーシップおよび他の通知を管理します。

これらのWLSTコマンドを使用して設定に対して行った変更は、アプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

表2-6 ワークリスト・コマンド

使用するコマンド

目的

WLSTでの使用

createBPELConnection

指定されたアプリケーションのBPELサーバーへの接続を作成します。

オンライン

setBPELConnection

既存のBPELサーバー接続を編集します。

オンライン

listBPELConnections

指定したアプリケーションに対して構成されているすべてのBPELサーバー接続を一覧表示します。

オンライン

2.5.1 createBPELConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのBPELサーバーへの接続を作成します。BPELサーバー接続を使用して、WebCenter Portalのメンバーシップおよび通知を管理できます。WebCenter Portalは、BPELサーバーへの単一の接続のみサポートします。複数のBPELサーバー接続はサポートされていません。

WebCenter Portalがその内部ワークフローのために使用するBPELサーバー接続を指定するには、setSpacesWorkflowConnectionNameコマンドを使用します。「setSpacesWorkflowConnectionName」を参照してください。

構文

createBPELConnection(appName, name, url, [policy, recipientKeyAlias, linkUrl, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

url

BPELサーバーにアクセスするために必要なURLを示します。

protocol://host:portという形式を使用します。

BPELサーバーのURLは、アプリケーション内で一意である必要があります。

policy

オプション。この接続は、認証のために使用するSAMLトークン・ポリシーを示します。任意の有効なポリシーを入力します。有効な値は次のとおりです。

- oracle/wss10_saml_token_client_policy - デフォルトのメッセージ保護されていないポリシーでBPELサーバーにアクセスする場合に使用します。

- oracle/wss10_saml_token_with_message_protection_client_policy - メッセージ保護されたポリシーでBPELサーバーにアクセスする場合に使用します。選択した場合は、アプリケーションとBPELアプリケーションの両方にキーストアを構成する必要があります。

- GPA - グローバル・ポリシー・アタッチメント(GPA)がサポートされている環境の場合に使用します。

この引数を指定しない場合、接続はデフォルトでoracle/wss10_saml_token_client_policyになります。

recipientKeyAlias

オプション。メッセージ保護SAMLポリシー認証に使用される受信者キー別名。BPELサーバー接続が認証用にSAMLトークン・ポリシーを使用しており、アプリケーションのワークリストが複数のBPELサーバー接続を使用している場合にのみ必要です。

デフォルトは、nullです。

Oracle Fusion Middleware Oracle WebCenter Portalの管理のWS-Securityの構成に関する項も参照してください。

linkUrl

オプション。BPELサーバーにリンクするために使用されるURL。url引数と異なる場合にのみ必要です。たとえば、SSOまたはHTTPSが構成されている場合です。

protocol://host:portという形式を使用します。

デフォルトは、nullです。

パフォーマンス上の理由から、HTTPSまたはSSO環境では、linkUrlには、HTTPSまたはSSO Webサーバーを介したBPELワークリスト・アイテムへのユーザー・アクセスを指定し、urlには、HTTPSまたはSSO Webサーバーを介したリダイレクションを使用しないBPEL Webサービスへの直接アクセスを指定します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、デフォルト・セキュリティ・ポリシーを使用するWebCenter Worklistという名前の接続を作成します。

wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter',
name='WebCenter Worklist', url='http://myhost.com:8001',
policy='oracle/wss10_saml_token_client_policy)

次の例では、メッセージ保護されたセキュリティ・ポリシーを使用する接続を作成し、特定のリンクURLを定義します。

wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter',
name='WebCenter Worklist',url='http://myhost.com:8001', policy='oracle/wss10_
saml_token_with_message_protection_client_policy', recipientKeyAlias='myalias', linkUrl='http://mySSO.com:7777')

次の例では、グローバル・ポリシー・アタッチメント(GPA)をサポートする環境で使用される接続を作成します。

wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter',
name='WebCenter Worklist', url='http://myhost.com:8001', policy='GPA')

2.5.2 setBPELConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

既存のBPELサーバー接続を編集します。

WebCenter Portalの内部ワークフローに対して使用されるBPELサーバー接続を指定するには、setSpacesWorkflowConnectionNameコマンドを使用します。「setSpacesWorkflowConnectionName」を参照してください。

構文

setBPELConnection(appName, name, [url, policy, recipientKeyAlias, linkUrl, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のBPELサーバー接続の名前を示します。

url

オプション。BPELサーバーにアクセスするために必要なURLを示します。

使用するフォーマットは、<protocol>://<host>:<port>です。

BPELサーバーのURLは、アプリケーション内で一意である必要があります。

policy

オプション。この接続は、認証のために使用するSAMLトークン・ポリシーを示します。任意の有効なポリシーを入力します。有効な値は次のとおりです。

- oracle/wss10_saml_token_client_policy - デフォルトのメッセージ保護されていないポリシーでBPELサーバーにアクセスする場合に使用します。

- oracle/wss10_saml_token_with_message_protection_client_policy - メッセージ保護されたポリシーでBPELサーバーにアクセスする場合に使用します。選択した場合は、アプリケーションとBPELアプリケーションの両方にキーストアを構成する必要があります。

- GPA - グローバル・ポリシー・アタッチメント(GPA)がサポートされている環境の場合に使用します。

この引数を指定しない場合、接続はデフォルトでoracle/wss10_saml_token_client_policyになります。

recipientKeyAlias

オプション。メッセージ保護SAMLポリシー認証に使用される受信者キー別名。BPELサーバー接続が認証用にSAMLトークン・ポリシーを使用しており、アプリケーションのワークリストが複数のBPELサーバー接続を使用している場合にのみ必要です。

デフォルトは、nullです。

Oracle WebCenter Portalの管理のWS-Securityの構成も参照してください。

linkUrl

オプション。BPELサーバーにリンクするために使用されるURL。url引数と異なる場合にのみ必要です。たとえば、SSOまたはHTTPSが構成されている場合です。protocol://host:portという形式を使用します。

たとえば、http://mySSO.host.com:7777です。

デフォルトは、nullです。

パフォーマンス上の理由から、HTTPSまたはSSO環境では、Link URLには、HTTPSまたはSSO Webサーバーを介したBPELワークリスト・アイテムへのユーザー・アクセスを指定し、BPEL SOAP URLには、HTTPSまたはSSO Webサーバーを介したリダイレクションを使用しないBPEL Webサービスへの直接アクセスを指定します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Worklistという名前の接続のBPELサーバーURL、セキュリティ・ポリシー、受信者キー別名およびリンクURLを更新します。

wls:/weblogic/serverConfig> setBPELConnection(appName='webcenter',
name='WebCenter Worklist',url='http://myhost.com:6666', policy='oracle/wss10_
saml_token_with_message_protection_client_policy', recipientKeyAlias='myalias', linkUrl='http://mySSO.com:7777')

次の例では、グローバル・ポリシー・アタッチメント(GPA)を使用するようにセキュリティ・ポリシーを変更します。

wls:/weblogic/serverConfig> setBPELConnection(appName='webcenter',
name='WebCenter Worklist', policy='GPA')

2.5.3 listBPELConnections

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

このコマンドは、引数を指定せずに使用すると、指定されたアプリケーションに対して構成したすべてのBPEL接続が指定されます。現在、接続を使用していない場合も、すべてのBPEL接続が指定されます。

構文

listBPELConnections(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

verbose

オプション。BPELサーバー接続の詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listBPELConnectionsによって、構成されているすべてのBPELサーバー接続およびそれらの詳細が一覧表示されます。

0に設定した場合、listBPELConnectionsによって、接続名のみ一覧表示されます。この引数のデフォルトは、0です。

この引数を0に設定した場合、name引数を指定しないでください。

name

オプション。既存のBPELサーバー接続の名前を示します。この引数を使用して、特定の接続の詳細情報を表示できます。

すべての接続を表示するには、name引数を省略します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalに対して構成されているすべてのBPELサーバー接続の名前を一覧表示します。

wls:/weblogic/serverConfig> listBPELConnections(appName='webcenter')
------------------
WebCenter Worklist
------------------
------------------
Human Resources Worklist
------------------

次の例では、WebCenter Portalに対して構成されているすべてのBPELサーバー接続の名前および詳細を一覧表示します。

wls:/weblogic/serverConfig> listBPELConnections(appName='webcenter', verbose=1)
------------------
WebCenter Worklist
------------------
Connection Name: WebCenter Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8001
------------------
Human Resources Worklist
------------------
Connection Name: Human Resources Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8888
------------------

2.6 コンテンツ・リポジトリ

表2-7に示すコマンドを使用して、コンテンツ・リポジトリの接続を管理し、WebCenter Portal用のドキュメント・サービスを構成します。

これらのWLSTコマンドを使用して設定に対して行った変更は、アプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle WebCenter Portalの管理』を参照してください。

表2-7 コンテンツ・リポジトリWLSTコマンド

使用するコマンド

目的

WLSTでの使用

createContentServerConnection

Oracle WebCenter Contentリポジトリへの接続を作成します。

オンライン

setContentServerConnection

既存のOracle WebCenter Contentリポジトリ接続を編集します。

オンライン

listContentServerConnections

指定されたアプリケーションに対して構成されている個々またはすべてのOracle WebCenter Contentリポジトリの接続を一覧表示します。

オンライン

listContentServerProperties

WebCenter Portalで使用中のバックエンドのContent Serverのプロパティを一覧表示します。

オンライン

setContentServerProperties

WebCenter Portalで使用されるバックエンドのContent Serverのプロパティを変更します。

オンライン

deleteContentServerProperties

WebCenter Portalで使用されるバックエンドのContent Serverのプロパティを削除します。

オンライン

deleteContentServerConnection

Oracle WebCenter Contentリポジトリへの接続を削除します。

オンライン

exportFoldersGData

Folders_gデータを指定された場所にエクスポートします。

オンライン

migrateFoldersGDataToFrameworkFolders

Folders_gデータをFrameworkFoldersに移行します。

オンライン

2.6.1 createContentServerConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーション用のOracle WebCenter Contentリポジトリへの接続を作成します。

構文

createContentServerConnection(appName, name, socketType, [url, serverHost,
serverPort, keystoreLocation, keystorePassword, privateKeyAlias,
privateKeyPassword, webContextRoot, clientSecurityPolicy, cacheInvalidationInterval, binaryCacheMaxEntrySize,
adminUsername, adminPassword, extAppId, timeout, isPrimary, server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

socketType

Oracle WebCenter ContentのContent Serverが、コンテンツ・サーバー・リスナー・ポートとWebサーバー・フィルタのどちらで接続するか、リスナー・ポートでSSLが有効になっているかどうかを指定します。

有効な値は、socket、web、socketsslおよびjaxws。このオプションは、デフォルト値はありません。

次の中から選択します。

- socket: intradocソケットの接続を使用してContent Serverに接続します。クライアントIPアドレスは、Content Serverで許可されたアドレスのリストに追加する必要があります。この場合、クライアントはOracle WebCenter Portalを実行しているマシンです。

- socketssl - intradocソケットの接続を使用して、SSLプロトコルを使用して保護されたContent Serverに接続します。クライアントの証明書は、接続を許可するサーバーのトラスト・ストア内にインポートする必要があります。これは最もセキュアなオプションであり、WebCenter Portalなどでアイデンティティ伝播が必要な場合の推奨オプションです。

- web - HTTP(S)接続を使用してContent Serverに接続します。WebCenter Portalの場合、このオプションはアクティブな接続(ポータル固有のドキュメントおよびホーム・ポータル・ドキュメントを格納するために使用されているバックエンドのContent Serverリポジトリ)に適していません。それはIDの伝播を許可されていないためです。

- jaxws - Java API for XML Web Services接続を使用してContent Serverに接続します。

url

オプション。コンテンツ・サーバーのURL。socketTypeがwebまたはjaxwsに設定されている場合にのみ必要です。

URLは次の形式で指定する必要があります。

http://hostname:port/web_root/plugin_root

例: http://mycontentserver/cms/idcplg

serverHost

オプション。Content Serverを実行しているマシンのホスト名。socketTypeがsocketまたはsocketsslに設定されている場合に必要になります。

serverPort

オプション。Content Serverがリスニングするポート。socketTypeがsocketまたはsocketsslに設定されている場合に必要になります。

- Socket - サーバー内のincomingプロバイダに対して指定するポート。

- Socket SSL - サーバー内のsslincomingプロバイダに対して指定するポート。

このプロパティは、Content Server構成ファイル内のIntradocServerPort設定に対応しています。これは、デフォルトでポート4444になります。

keystoreLocation

オプション。セキュリティ・アサーションに署名するための秘密鍵を含むキーストアの場所。socketTypeがsocketsslに設定されている場合にのみ必要です。

キーストアの場所は絶対パスであることが必要です。

keystorePassword

オプション。キー・ストアにアクセスするために必要なパスワードを示します。socketTypeがsocketsslに設定されている場合にのみ必要です。

privateKeyAlias

オプション。クライアントのキー・ストア内の秘密鍵別名を示します。このキーを使用すると、サーバーのメッセージに署名することができます。この秘密鍵に対応する公開鍵をサーバーのキーストアにインポートする必要があります。

socketTypeがsocketsslに設定されている場合にのみ必要です。この引数の値は、文字列であり、特殊文字もスペースも含まない必要があります。

privateKeyPassword

オプション。キー・ストア内の秘密鍵別名に使用するパスワードを示します。socketTypeがsocketsslに設定されている場合にのみ必要です。

webContextRoot

オプション。Content ServerのWebサーバー・コンテキスト・ルート。/<context_root>の形式を使用します。たとえば、/csとなります。

webContextRootは、認証にIDENTITY_PROPAGATIONが使用されている場合、つまり、extAppIdが空の文字列に設定されている場合にのみ適用できます。

注意: これらのOracle WebCenter Content機能を完全に有効にするには、Oracle HTTPS Server (OHS)経由でWebCenter Portalにアクセスして、コンテンツ・サーバーとアプリケーションを同じホストとポートで公開する必要があります。アプリケーションとコンテンツ・サーバーの両方で、シングル・サインオンを使用することも必要です。フロントエンドのWebCenter Portalに対するOHSの設定の詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理のコンテンツ・サーバーの構成に関する項を参照してください。

アプリケーションが複数のContent Serverに接続している場合、OHSのリダイレクトが適切に機能するように各Content Serverに一意のWebサーバー・コンテキスト・ルートを設定することをお薦めします。

clientSecurityPolicy

オプション。socketTypeがjaxwsである場合に使用されるクライアント・セキュリティ・ポリシー。例: oracle/wss11_saml_token_with_message_protection_service_policy

グローバル・ポリシー・アタッチメント(GPA)がサポートされている環境の場合は、フィールドを空白のままにします。

cacheInvalidationInterval

オプション。外部Content Serverのコンテンツの変更を確認する間隔(分単位)。WebCenter Portalは、変更されたアイテムをキャッシュから自動的にクリアします。最小の間隔は2分です。

デフォルトでは、キャッシュの無効化は無効(0と指定されている)で、コンテンツ変更に対して定期的なチェックは行われません。

binaryCacheMaxEntrySize

オプション。Content Serverバイナリ・ドキュメントのキャッシュ可能な最大サイズ(バイト単位)。このサイズより大きいドキュメントは、WebCenter Portalによってキャッシュされません。

デフォルトは102400バイト(100K)です。

使用マシンのメモリー構成と、キャッシュされることが期待されるバイナリ・ドキュメントのタイプに基づいて、この値を調整してください。

Content Serverに格納されている大部分のドキュメントは、バイナリ・コンテンツ、つまりイメージ、プレーン・テキスト、Wordドキュメントなどとみなされます。唯一の例外は、仮想コンテンツ・リポジトリ(VCR)のキャッシュ(またはノード・キャッシュ)内のデータ・ファイル(CDFファイル)およびキャッシュに別々に格納されているSite Studioコンテンツです。

adminUsername

この引数は、socketTypeがjaxwsである場合に必要になります。このContent Serverインスタンスの管理権限を持つユーザー名。このユーザーは、プロファイルに基づいてコンテンツ・タイプ情報をフェッチするため、およびキャッシュ無効化の目的でドキュメントの変更を追跡するために使用されます。

デフォルトはsysadminです。

adminPassword

オプション。adminUsernameに指定されているContent Server管理者のパスワード。socketTypeがwebに設定されている場合に必要です。

extAppId

オプション。Content Serverに対してユーザーを認証するために使用される外部アプリケーション。この値は、既存の外部アプリケーション接続の名前と一致する必要があります。「listExtAppConnections」も参照してください。extAppIdを指定しない場合、認証メソッドまたは外部アプリケーションIDを変更しません。

extAppIdに空の文字列を設定すると、認証メソッドとして、IDENTITY_PROPAGATIONを使用します。このメソッドを使用すると、アプリケーションおよびContent Serverでは、同じアイデンティティ・ストアを使用してユーザーが認証されます。socketTypeがwebに設定されている場合は、extAppIDが必須になることに注意してください。

timeout

接続タイムアウト・メッセージが表示されるまでContent Serverへのログインに許容される時間の長さ(ミリ秒単位)、および接続タイプがweb、socketおよびsocketsslのすべてのサービス・リクエストで使用されるRIDCソケット・タイムアウト。

タイムアウト・プロパティが設定されていない場合は、次の値が使用されます。

- ログイン・タイムアウト: oracle.webcenter.contentリソースのデフォルトの同時実行性タイムアウトが使用されます(30秒または30000ミリ秒)。

- RIDCソケット・タイムアウト: 接続タイプがsocket、socketsslまたはwebのすべてのサービス・リクエストに対して、デフォルトのRIDCソケット・タイムアウト(60秒または60000ミリ秒)が使用されます。

timeoutプロパティが設定されており、接続タイプがsocket、socketsslまたはweb,の場合は、RIDCソケット・タイムアウトが短縮され、長時間実行中のリクエストがタイムアウトする可能性が高くなるため、60000ミリ秒未満の値を指定しないことをお薦めします。たとえば、長時間実行中の検索、長時間に及ぶファイルのアップロード、長時間に及ぶコピー操作などでタイムアウトが発生する可能性があります。

isPrimary

オプション。有効な値は、1 (true)および0 (false)。

1の場合、この接続をドキュメント・ツールのプライマリ接続として使用することが指定されます。

この引数のデフォルトは、0です。省略するか0に設定した場合、ドキュメントに使用するプライマリ接続は変更されません。

WebCenter Portalでは、プライマリ接続はポータル固有のコンテンツおよびホーム・ポータル・コンテンツの格納に使用されます。

注意: プライマリとして接続をマークする場合、setContentServerProperties WLSTコマンドを実行して、プライマリWebCenter Content Server接続に必要な特定の追加プロパティを指定する必要があります。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ポート4444のmyhost.comで実行中のOracle WebCenter Contentリポジトリへのソケットベース接続を作成します。認証のために、myExtAppという名前の既存の外部アプリケーションを使用します。「createExtAppConnection」も参照してください。

wls:/weblogic/serverConfig> createContentServerConnection(appName='webcenter',
name='myContentServerConnection', socketType='socket',
serverHost='myhost.com', serverPort=4444, extAppId='myExtApp',
isPrimary=1)

次の例では、Oracle WebCenter ContentリポジトリへのSSLソケットベース接続を作成します。

wls:/weblogic/serverConfig> createContentServerConnection(appName='webcenter',
name='myContentServerConnection', socketType='socketssl',
serverHost='myhost.com', serverPort=4444, keystoreLocation='d:/keys/here', keystorePassword='AlphaSquad7',
privateKeyAlias='enigma', privateKeyPassword='S0larPl3x1s',
extAppId='myExtApp')

次の例では、Oracle WebCenter ContentリポジトリへのJAX-WS (Java API for XML Web Services)接続を作成します。

wls:/weblogic/serverConfig> createContentServerConnection(appName='webcenter'
name='myContentServerConnection', socketType='jaxws', url='http://myhost.com:9044/idcnativews',
adminUsername='weblogic', clientSecurityPolicy='oracle/wss10_saml_token_client_policy')

2.6.2 setContentServerConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

既存のOracle WebCenter Contentリポジトリ接続を編集します。このコマンドを使用すると、appNameとnameの値および1つの追加引数を指定する必要があります。

構文

setContentServerConnection(appName, name, [socketType, url, serverHost,
serverPort, keystoreLocation, keystorePassword, privateKeyAlias,
privateKeyPassword, webContextRoot, clientSecurityPolicy,
cacheInvalidationInterval, binaryCacheMaxEntrySize, adminUsername, adminPassword,
extAppId, timeout, isPrimary, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のOracle WebCenter Contentリポジトリ接続の名前。

socketType

オプション。Oracle WebCenter ContentのContent Serverが、コンテンツ・サーバー・リスナー・ポートとWebサーバー・フィルタのどちらで接続するか、リスナー・ポートでSSLが有効になっているかどうかを指定します。

有効な値は、socket、webおよびsocketsslです。このオプションは、デフォルト値はありません。

次の中から選択します。

- socket: intradocソケットの接続を使用してContent Serverに接続します。クライアントIPアドレスは、Content Serverで許可されたアドレスのリストに追加する必要があります。この場合、クライアントはOracle WebCenter Portalを実行しているマシンです。

- socketssl - intradocソケットの接続を使用して、SSLプロトコルを使用して保護されたContent Serverに接続します。クライアントの証明書は、接続を許可するサーバーのトラスト・ストア内にインポートする必要があります。これは最もセキュアなオプションであり、WebCenter Portalなどでアイデンティティ伝播が必要な場合の推奨オプションです。

- web - HTTP(S)接続を使用してContent Serverに接続します。WebCenter Portalの場合、このオプションはアクティブな接続(ポータル固有のドキュメントおよびホーム・ポータル・ドキュメントを格納するために使用されているバックエンドのContent Serverリポジトリ)に適していません。それはIDの伝播を許可されていないためです。

- jaxws - Java API for XML Web Services接続を使用してContent Serverに接続します。

url

オプション。コンテンツ・サーバーのURL。socketTypeがwebまたはjaxwsに設定されている場合にのみ必要です。

URLは次の形式で指定する必要があります。

http://hostname:port/web_root/plugin_root

例: http://mycontentserver/cms/idcplg

serverHost

オプション。Content Serverを実行しているマシンのホスト名。socketTypeがsocketまたはsocketsslに設定されている場合に必要になります。

serverPort

オプション。Content Serverがリスニングするポート。socketTypeがsocketまたはsocketsslに設定されている場合に必要になります。

- Socket - サーバー内のincomingプロバイダに対して指定するポート。

- Socket SSL - サーバー内のsslincomingプロバイダに対して指定するポート。

例, 4444

keystoreLocation

オプション。セキュリティ・アサーションに署名するための秘密鍵を含むキーストアの場所。socketTypeがsocketsslに設定されている場合にのみ必要です。

キーストアの場所は絶対パスであることが必要です。

keystorePassword

オプション。キー・ストアにアクセスするために必要なパスワードを示します。socketTypeがsocketsslに設定されている場合にのみ必要です。

privateKeyAlias

オプション。クライアントのキー・ストア内の秘密鍵別名を示します。socketTypeがsocketsslに設定されている場合にのみ必要です。

この引数の値は、文字列であり、特殊文字もスペースも含まない必要があります。

privateKeyPassword

オプション。キー・ストア内の秘密鍵別名に使用するパスワードを示します。socketTypeがsocketsslに設定されている場合にのみ必要です。

webContextRoot

オプション。コンテンツ・サーバーのフロントエンドがOracle HTTP Server (OHS)である場合のコンテンツ・サーバーのWebサーバー・コンテキスト・ルート。/<context_root>の形式を使用します。たとえば、/csとなります。

コンテンツ・プレゼンタを使用してSite Studioコンテンツを作成または編集する場合は、Oracle HTTP Server (OHS)を介してWebCenter Portalにアクセスにすることをお薦めします。Oracle HTTP Server (およびWebContextRoot構成)がなくても、コンテンツ・プレゼンタ内からSite Studioコンテンツの作成や編集を行えますが、作成および編集アクションは、コンテンツ・プレゼンタ・タスク・フロー内で開かれるのではなく、新しいブラウザ・ウィンドウ(またはタブ)が起動されます。

注意: これらの機能を完全に有効にするには、Oracle HTTPS Server (OHS)経由でWebCenter Portalにアクセスして、コンテンツ・サーバーとアプリケーションを同じホストとポートで公開する必要があります。さらに、アプリケーションとコンテンツ・サーバーの両方で、シングル・サインオンを使用することも必要です。フロントエンドのWebCenter Portalに対するOHSの設定の詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理のWebCenter PortalのOracle HTTP Serverの構成に関する項を参照してください。

webContextRootは、認証にIDENTITY_PROPAGATIONが使用されている場合、つまり、extAppIdが空の文字列に設定されている場合にのみ適用できます。

clientSecurityPolicy

オプション。socketTypeがjaxwsである場合に使用されるクライアント・セキュリティ・ポリシー。例: oracle/wss11_saml_token_with_message_protection_service_policy

グローバル・ポリシー・アタッチメント(GPA)がサポートされている環境の場合は、フィールドを空白のままにします。

cacheInvalidationInterval

オプション。外部Content Serverのコンテンツの変更を確認する間隔(分単位)。WebCenter Portalは、変更されたアイテムをキャッシュから自動的にクリアします。最小の間隔は2分です。

デフォルトでは、キャッシュの無効化は無効(0と指定されている)で、コンテンツ変更に対して定期的なチェックは行われません。

binaryCacheMaxEntrySize

オプション。Content Serverバイナリ・ドキュメントのキャッシュ可能な最大サイズ(バイト単位)。このサイズより大きいドキュメントは、WebCenter Portalによってキャッシュされません。デフォルトは102400バイト(100K)です。

使用マシンのメモリー構成と、キャッシュされることが期待されるバイナリ・ドキュメントのタイプに基づいて、この値を調整してください。

adminUsername

オプション。このContent Serverインスタンスの管理権限を持つユーザー名。このユーザーは、プロファイルに基づいてコンテンツ・タイプ情報をフェッチするため、およびキャッシュ無効化の目的でドキュメントの変更を追跡するために使用されます。

デフォルトはsysadminです。

adminPassword

オプション。adminUsernameに指定されているContent Server管理者のパスワード。socketTypeがwebに設定されている場合に必要です。

extAppId

オプション。Content Serverに対してユーザーを認証するために使用される外部アプリケーション。この値は、既存の外部アプリケーション接続の名前と一致する必要があります。「listExtAppConnections」も参照してください。extAppIdを指定しない場合、認証メソッドまたは外部アプリケーションIDを変更しません。

extAppIdに空の文字列を設定すると、認証メソッドとして、IDENTITY_PROPAGATIONを使用します。このメソッドを使用すると、アプリケーションおよびContent Serverでは、同じアイデンティティ・ストアを使用してユーザーが認証されます。

timeout

接続タイムアウト・メッセージが表示されるまでContent Serverへのログインに許容される時間の長さ(ミリ秒単位)、および接続タイプがweb、socketおよびsocketsslのすべてのサービス・リクエストで使用されるRIDCソケット・タイムアウト。

タイムアウト・プロパティが設定されていない場合は、次の値が使用されます。

- ログイン・タイムアウト: oracle.webcenter.contentリソースのデフォルトの同時実行性タイムアウトが使用されます(30秒または30000ミリ秒)。詳細は、『パフォーマンスのチューニング』の同時実行性管理の構成に関する項を参照してください。

- RIDCソケット・タイムアウト: 接続タイプがsocket、socketsslまたはwebのすべてのサービス・リクエストに対して、デフォルトのRIDCソケット・タイムアウト(60秒または60000ミリ秒)が使用されます。

timeoutプロパティが設定されており、接続タイプがsocket、socketsslまたはweb,の場合は、RIDCソケット・タイムアウトが短縮され、長時間実行中のリクエストがタイムアウトする可能性が高くなるため、60000ミリ秒未満の値を指定しないことをお薦めします。たとえば、長時間実行中の検索、長時間に及ぶファイルのアップロード、長時間に及ぶコピー操作などでタイムアウトが発生する可能性があります。

isPrimary

オプション。有効な値は、1 (true)および0 (false)。

1の場合、この接続をアプリケーション内のドキュメント・サービスでプライマリ接続として使用することが指定されます。

この引数のデフォルトは、0です。省略するか0に設定した場合、ドキュメントに使用するプライマリ接続は変更されません。

WebCenter Portalでは、プライマリ接続はポータル固有のコンテンツおよびホーム・ポータル・コンテンツの格納に使用されます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Oracle WebCenter Contentリポジトリへのソケットベース接続を編集します。

wls:/weblogic/serverConfig>setContentServerConnection(appName='webcenter',
name='myContentServerConnection', socketType='socket',
serverHost='myhost.com',  serverPort=4444,
extAppId='myExtApp', isPrimary=1)

次の例では、Oracle WebCenter ContentリポジトリへのSSLソケットベース接続を編集します。

wls:/weblogic/serverConfig>setContentServerConnection(appName='webcenter',
name='myContentServerConnection', socketType='socketssl',
serverHost='myhost.com', serverPort=8443,
keystoreLocation='d:/keys/here', keystorePassword='T0PS3CR3T',
privateKeyAlias='TekJansen', privateKeyPassword='LadyNocturne',
extAppId='myExtApp', isPrimary=1)

次の例では、Oracle WebCenter ContentリポジトリへのJAX-WS (Java API for XML Web Services)接続を編集します。

wls:/weblogic/serverConfig> setContentServerConnection(appName='webcenter',
socketType='jaxws', url='http://myhost.com:9044/idcnativews', adminUsername='weblogic',
clientSecurityPolicy='oracle/wss10_saml_token_client_policy')

2.6.3 listContentServerConnections

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

引数を指定せずに、このコマンドを使用すると、指定されたアプリケーションに対して構成されているすべてのOracle WebCenter Contentリポジトリの接続が一覧表示されます。

構文

listContentServerConnections(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

verbose

オプション。コンテンツ・リポジトリ接続の詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listJCRContentServerConnectionsによって、指定されたアプリケーションに対して構成されているすべてのOracle WebCenter Contentリポジトリの接続およびその詳細が一覧表示されます。

0に設定すると、接続名のみが一覧表示されます。

この引数のデフォルトは、0です。

name

オプション。既存のOracle WebCenter Contentリポジトリ接続の名前。

指定した場合、特定のOracle WebCenter Contentリポジトリの接続に関する詳細を表示できます。nameの値を指定すると、verboseの値を指定する必要があります。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)に対して構成されているOracle WebCenter Contentリポジトリの接続を一覧表示します。

wls:/weblogic/serverConfig> listContentServerConnections(appName='webcenter')

次の例では、myContentServerConnection1という名前のOracle WebCenter Contentリポジトリの接続のすべてのプロパティを一覧表示します。myContentServerConnection1という名前の接続が存在し、それがOracle WebCenter Contentリポジトリ接続である必要があります。

wls:/weblogic/serverConfig>listContentServerConnections(appName='webcenter',
verbose=1, name='myContentServerConnection1')

2.6.4 listContentServerProperties

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ポータル固有ドキュメントおよびホーム・ポータル・ドキュメントを格納するためにWebCenter Portalによって使用されているバックエンドOracle WebCenter Contentリポジトリのプロパティを一覧表示します。このコマンドは、WebCenter Portalに対してのみ有効です。

構文

listContentServerProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ポータル固有ドキュメントおよびホーム・ポータル・ドキュメントを格納するためにWebCenter Portalインスタンス(webcenter)によって使用されているバックエンドOracle WebCenter Contentリポジトリのプロパティを一覧表示します。

wls:/weblogic/serverConfig> listContentServerProperties(appName='webcenter')

The Documents Portal Server identifier is "/EnterpriseLibraries"
The Documents repository administrator is "sysadmin"
The Documents security group is "/WebCenter1109"
The Documents primary connection is "myContentServerConnection"

2.6.5 setContentServerProperties

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ポータル関連データを格納するためにWebCenter Portalによって使用されている、バックエンドOracle WebCenter Contentリポジトリのプロパティを変更します。

構文

setContentServerProperties(appName, [portalServerIdentifier, adminUserName, securityGroup, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

portalServerIdentifier

オプション。WebCenter Portalコンテンツが格納されているルート・フォルダを示します。この引数の値は、/folderNameの形式を使用する必要があります。

たとえば、/WebCenterまたは/WCPMain。

portalServerIdentifierを/(ルート自体)にすることはできません。また、アプリケーションの間にユニークである必要があります。指定したフォルダは存在しない場合、そのフォルダが作成されます。

注意: この引数の値を変更した場合、adminUserNameおよびsecurityGroup引数の値も指定する必要があります。

adminUserName

オプション。コンテンツ・リポジトリ管理者のユーザー名を示します。たとえば、sysadminです。このユーザーは、WebCenter Portalコンテンツのフォルダの作成と維持や、コンテンツ・アクセス権限の管理に使用されます。

WebCenter Portalユーザーにかわって操作を実行するには、この接続に対する管理権限が必要です。WebCenter Portalユーザーにかわって操作を実行するには、この接続に対する管理権限が必要です。

securityGroup

オプション。WebCenter Portalで作成されるコンテンツ・サーバーのファイルに割り当てられるセキュリティ・グループの値として使用する一意の識別子。この名前を使用して、複数のWebCenter Portalインスタンスの間に共有で使用しているWebCenter Contentインスタンスのデータを分離されます。この名前は、WebCenter Portalインスタンスの間で一意である必要があります。

この引数の値は、文字で始まる必要があります。文字の後に英数字またはアンダースコアを続けます。文字列には、30次の文字を入力ことができます。

注意: この引数の値を変更する場合、portalServerIdentifierおよびadminUserName引数の値も変更する必要があります。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ポータル関連ドキュメントを格納するためにWebCenter Portalによって使用されている、バックエンドOracle WebCenter Contentリポジトリの接続プロパティを変更します。

wls:/weblogic/serverConfig> setContentServerProperties(appName='webcenter',
portalServerIdentifier='/AccountingSpaces', adminUserName='admin',  securityGroup='WCAccounting')

次の例では、ポータル関連ドキュメントを格納するためにWebCenter Portalによって使用されている、バックエンドOracle WebCenter Contentリポジトリの管理者のユーザー名を変更します。

wls:/weblogic/serverConfig> setContentServerProperties(appName='webcenter', adminUserName='sysadmin')

2.6.6 deleteContentServerProperties

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WebCenter Portalによって使用されているバックエンドOracle WebCenter ContentリポジトリのadminUserName、applicationNameおよび spacesRootのプロパティを削除します。

構文

deleteContentServerProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalによって使用されているバックエンドOracle WebCenter Contentリポジトリの接続プロパティ(adminUserName、applicationName、spacesRoot)を削除します。

wls:/weblogic/serverConfig> deleteContentServerProperties(appName='webcenter')

2.6.7 deleteContentServerConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたOracle WebCenter Contentリポジトリ接続を削除します。

構文

deleteContentServerConnection(appName, name)

引数

定義

appName

この操作を実行するアプリケーションの名前。WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

削除する既存のOracle WebCenter Contentリポジトリ接続の名前。

例

次の例では、MyContentServerConnectionという名前のOracle WebCenter Contentリポジトリの接続を削除します。

wls:/weblogic/serverConfig> deleteContentServerConnection(appName='webcenter' name='MyContentServerConnection')

2.6.8 exportFoldersGData

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WLSTコマンドmigrateFoldersGToFrameworkFoldersを使用してデータをFrameworkFoldersに移行できるように、Folders_gデータを指定された場所にエクスポートします。Folders_gデータをFrameworkFoldersに移行した後、エクスポートされたFolders_gデータから比較レポートを生成して、すべてのファイルとフォルダがFrameworkFoldersに移行されたことを検証できます。

構文

exportFoldersGData(appName,server,[connectionName,directoryPath,applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

注意: アプリケーションが同じコンテンツ・サーバー接続を共有するクラスタ環境では(つまり、アプリケーションが同じコンテンツ・サーバーに接続し、同じルート・フォルダとセキュリティ・グループを共有)、このコマンドは1台の管理対象サーバーに対してのみ実行してください。

connectionName

オプション。コンテンツ・サーバーの接続名。デフォルトでないコンテンツ・サーバー接続でFolders_gデータをエクスポートする場合にのみ必要です。

この引数が指定されない場合、デフォルトのコンテンツ・サーバー接続、つまり、isPrimary=1であるコンテンツ・サーバー接続が使用されます。

directoryPath

オプション。移行するFolders_gデータの宛先ディレクトリ。

この引数が指定されない場合、Folders_gデータは、WCP_ORACLE_HOME/common/wlstの下にあるFRAMEWORK_FOLDER_MIGRATIONという名前のフォルダにエクスポートされます。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WC_Portal管理対象サーバーにデプロイされたWebCenter PortalアプリケーションのFolders_gデータをエクスポートします。WebCenter Portalのデフォルト・コンテンツ・サーバー接続の詳細を使用して、Folders_gデータが、デフォルトの場所、(WCP_ORACLE_HOME/common/wlst/FRAMEWORK_FOLDER_MIGRATIONディレクトリ)にエクスポートされます。

exportFoldersGData(appName='webcenter',server='WC_Portal')

次の例では、WC_Portal管理対象サーバーにデプロイされたWebCenter PortalアプリケーションのFolders_gデータをエクスポートします。MyContentServerConnectionというContent Server接続が使用され、Folders_gデータが/scratch/myTemp_Dirディレクトリにエクスポートされます。

exportFoldersGData(appName='webcenter',server='WC_Portal',connectionName='MyContentServerConnection',directoryPath='/scratch/myTemp_Dir/')

2.6.9 migrateFoldersGDataToFrameworkFolders

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Folders_gデータをFrameworkFoldersに移行して、移行されたデータの整合性を検証します。

構文

migrateFoldersGDataToFrameworkFolders(appName,server,contentDbConnectionUrl,contentDbUserName,[connectionName,directoryPath,reportMode,applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

注意: アプリケーションが同じコンテンツ・サーバー接続を共有するクラスタ環境では(つまり、同じコンテンツ・サーバーに接続し、同じルート・フォルダとセキュリティ・グループを共有)、このコマンドは1台のみの管理対象サーバーに対して実行してください。

contentDbConnectionUrl

WebCenter Contentスキーマ(名前付きOCS)があるデータベースの接続URL。

接続URL形式host:port:sidを使用します。

contentDbUserName

移行するWebCenter Contentスキーマ(名前付きOCS)のユーザー名。

connectionName

オプション。コンテンツ・サーバーの接続名。

デフォルトでないコンテンツ・サーバー接続でFolders_gデータを移行する場合にのみ必要です。

指定しない場合、デフォルトのコンテンツ・サーバー接続、つまり、isPrimary=1であるコンテンツ・サーバー接続が使用されます。

directoryPath

オプション。移行するFolders_gデータを含んでいるディレクトリ。

指定しない場合、Folders_gデータはWCP_ORACLE_HOME/common/wlst/FRAMEWORK_FOLDER_MIGRATIONディレクトリから移行されます。これは、WLSTコマンドexportFoldersGDataを使用してエクスポートされるFolders_gデータのデフォルトの場所です。

reportMode

オプション。移行時に発生することを記述して、実際のデータを移行する前に検討できるレポートを作成するかどうかを示します。

有効な値は、trueおよびfalseです。

true - Folders_gデータがFrameworkFoldersに移行されるときに行われるすべてのメタデータの変更を記述するレポートを作成します。実際のデータの移動は行われません。

false - 移行前レポートは要求されません。Folders_gデータは、FrameworkFoldersに移行されます。

デフォルト値はfalseです。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、Folders_gデータを、デフォルト・ディレクトリ(WCP_ORACLE_HOME/common/wlst/FRAMEWORK_FOLDER_MIGRATION)から、WC_Portal管理対象サーバーにデプロイされたWebCenter PortalアプリケーションのFrameworkFoldersに移行し、移行されたデータを検証します。移行は、デフォルトContent Server接続の詳細と、指定されたWebCenter Contentデータベース接続およびユーザー名を使用して実行されます。

migrateFoldersGDataToFrameworkFolders(appName='webcenter',server='WC_Portal',contentDbConnectionUrl='wccdbhost.example.com:wccdbport:wccdbsid', contentDbUserName='SCHEMA_PREFIX_OCS')

次の例では、Folders_gデータを/scratch/myTemp_DirディレクトリからFrameworkFoldersに移行し、WC_Portal管理対象サーバーにデプロイされたWebCenter Portalアプリケーションの移行済データを検証します。MyContentServerConnectionという名前のContent Server接続と指定したWebCenter Contentデータベース接続およびユーザー名を使用して、移行が実行されます。

migrateFoldersGDataToFrameworkFolders(appName='webcenter',server='WC_Portal',contentDbConnectionUrl='wccdbhost.example.com:wccdbport:wccdbsid', contentDbUserName='SCHEMA_PREFIX_OCS',connectionName='MyContentServerConnection',directoryPath='/scratch/myTemp_Dir/)

次の例は、Folders_gデータがどのように、WC_PortalにデプロイされたWebCenter PortalアプリケーションのFrameworkFoldersに移行されるかをレポートします。MyContentServerConnection接続の詳細と、指定されたWebCenter Contentデータベース接続およびユーザー名を使用して移行レポートが作成され、Folders_gデータ(/scratch/myTemp_Dir)と同じ場所に保存されます。

migrateFoldersGDataToFrameworkFolders(appName='webcenter',server='WC_Portal',contentDbConnectionUrl='wccdbhost.example.com:wccdbport:wccdbsid', contentDbUserName='SCHEMA_PREFIX_OCS',connectionName='MyContentServerConnection',directoryPath='/scratch/myTemp_Dir/', reportMode='true')

2.7 ディスカッションおよびお知らせ

表2-8に示すコマンドを使用して、WebCenter Portalのディスカッション・サーバー接続を管理します。

これらのWLSTコマンドを使用して設定に対して行った変更は、アプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

表2-8 ディスカッションおよび通知WLSTコマンド

使用するコマンド

目的

WLSTでの使用

createDiscussionForumConnection

指定されたアプリケーションの新しいディスカッション・サーバー接続を作成します。

オンライン

setDiscussionForumConnection

既存のディスカッション・サーバー接続を編集します。

オンライン

setDefaultDiscussionForumConnection

ディスカッションおよびお知らせのデフォルト接続を指定します。

オンライン

listDiscussionForumConnections

指定されたアプリケーションに対して設定したディスカッション・サーバーのすべての接続を表示します。

オンライン

listDefaultDiscussionForumConnection

指定されたアプリケーションのデフォルト・ディスカッション・サーバー接続を一覧表示します。

オンライン

setDiscussionForumConnectionProperty

追加のディスカッション・サーバー接続プロパティを設定します。

オンライン

deleteDiscussionForumConnectionProperty

ディスカッション・サーバー接続プロパティを削除します。

オンライン

setDiscussionForumServiceProperty

ディスカッションのデフォルトを指定します。

オンライン

removeDiscussionForumServiceProperty

ディスカッションのデフォルトを削除します。

オンライン

listDiscussionForumServiceProperties

ディスカッションの設定を一覧表示します。

オンライン

setAnnouncementServiceProperty

お知らせのデフォルトを指定します。

オンライン

removeAnnouncementServiceProperty

お知らせのデフォルトを削除します。

オンライン

listAnnouncementServiceProperties

お知らせの設定を一覧表示します。

オンライン

addDiscussionsServerAdmin

ユーザーまたはグループにディスカッション・サーバーのシステム管理者パーミッションを付与します。

オンライン

addDiscussionsCategoryAdmin

ユーザーまたはグループにディスカッション・サーバーのカテゴリ管理者権限を付与します。

オンライン

setDiscussionsServerProperty

ディスカッション・サーバーのプロパティを設定します。

オンライン

getDiscussionsServerProperty

ディスカッション・サーバーのプロパティ値を返します。

オンライン

removeDiscussionsServerProperty

現在のディスカッション・サーバーのプロパティ値を削除します。

オンライン

2.7.1 createDiscussionForumConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションの新しいディスカッション・サーバー接続を作成します。

ディスカッションおよびお知らせの両方の場合は、ディスカッション・サーバーの接続が必要です。ディスカッションおよびお知らせの両方で、同じディスカッション・サーバーの接続が使用されます。

1つのアプリケーションに対して複数のディスカッション・サーバー接続を登録できますが、ディスカッション・サービスおよびお知らせサービスに対して使用される接続は1つのみであり、デフォルト(またはアクティブ)接続が使用されます。

構文

createDiscussionForumConnection(appName, name, url, adminUser,
[timeout, default, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

url

ディスカッション・フォーラムおよび通知をホストしているディスカッション・サーバーのURLを示します。例: http://myhost:8888/owc_discussions。

adminUser

ディスカッション・サーバー管理者の名前を示します。ディスカッションおよびお知らせは、WebCenter Portalユーザーにかわってこのアカウントを使用して管理操作を実行します。

このアカウントは、多くの場合、WebCenter Portalにおいてディスカッションとお知らせを管理するために使用されます。このユーザーは、super adminである必要はありません。ただし、ユーザーがWebCenter Portalの現在のアプリケーション・ルート・カテゴリ(つまり、すべてのポータル関連のディスカッションとお知らせが格納されているディスカッション・サーバー上のカテゴリ)に関する管理特権を持つ必要があります。

policyURIForAuthAccess

オプション。ディスカッション・サーバーWebサービスへの認証アクセスに必要なSAMLトークン・ベース・ポリシーへのURI。

指定するクライアント・ポリシーには、ディスカッション・サーバーでOWCDiscussionsServiceAuthenticatedエンドポイント用に構成されているサービス・ポリシーとの互換性が必要です。初期の設定では、デフォルト・サービス・ポリシーはWSS 1.0 SAMLトークン・サービス・ポリシー(oracle/wss10_saml_token_service_policy)です。

有効なクライアント・ポリシー値には次のようなものがあります。

- oracle/wss10_saml_token_client_policy (WSS 1.0 SAMLトークン・クライアント・ポリシー)

- oracle/wss11_saml_token_with_message_protection_client_policy (メッセージ保護クライアント・ポリシー付きWSS 1.1 SAMLトークン)

- GPA (グローバル・ポリシー・アタッチメント) - グローバル・ポリシー・アタッチメントがサポートされている環境の場合には、GPAを使用します。さらに、WLSTコマンドdetachWebServicePolicyまたはEnterprise Managerを使用して、デフォルト・ポリシーがディスカッション・サーバーのOWCDiscussionsServiceAuthenticatedエンドポイントからデタッチされていることを確認します。

『Oracle WebCenter Portalの管理』のお知らせとディスカッションの管理に関する項も参照してください。

policyURIForPublicAccess

オプション。ディスカッション・サーバーWebサービスへのパブリック・アクセスに対して、メッセージ・セキュリティおよび整合性を強制するために必要なポリシーへのURI。

デフォルト値は、oracle/no_authentication_client_policyです。

指定するクライアント・ポリシーには、ディスカッション・サーバーでOWCDiscussionsServicePublicエンドポイント用に構成されているサービス・ポリシーとの互換性が必要です。初期の設定では、サービス・ポリシーは、パブリック・アクセス(oracle/no_authentication_client_policy)用に構成されていません。

有効なクライアント・ポリシー値には次のようなものがあります。

- oracle/no_authentication_client_policy (なし)

- oracle/wss11_with_message_protection_client_policy (WSS 1.1メッセージ保護クライアント・ポリシー)

- GPA (グローバル・ポリシー・アタッチメント) - グローバル・ポリシー・アタッチメントがサポートされている環境の場合には、GPAを使用します。さらに、ディスカッション・サーバーにおけるOWCDiscussionsServicePublicエンドポイントにアタッチされているデフォルト・ポリシーが、oracle/no_authentication_service_policyに設定されていることも確認する必要があります。

recipientKeyAlias

オプション。メッセージ保護ポリシーに使用される受信者キー別名(OWCDiscussionsServicePublicおよびOWCDiscussionsServiceAuthenticatedエンドポイントに適用可能)。これは、構成されたキーストアにある、ディスカッション・サーバーの公開鍵を含む証明書の別名です。デフォルトは、nullです。

Oracle WebCenter Portalの管理のWS-Securityの構成も参照してください。

timeout

オプション。接続タイムアウト・メッセージを出す前にディスカッション・サーバーからの応答を受信する間のディスカッションの待機時間(秒単位)の長さを示します。

この引数のデフォルトは、-1です。-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、ディスカッションおよびお知らせのデフォルト接続であることを示します。

有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、ディスカッションもお知らせもこの接続を使用します。

0に設定すると、その接続は使用されません。デフォルトは0です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalのディスカッション・サーバー接続を作成します。

wls:/weblogic/serverConfig>createDiscussionForumConnection(appName='webcenter',
name='MyDiscussionServer', url='http://myhost.com:8888/owc_discussions',
adminUser='admin', policyURIForAuthAccess='oracle/wss10_saml_token_client_policy', default=0)

2.7.2 setDiscussionForumConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

既存のディスカッション・サーバー接続を編集します。このコマンドを使用して、接続の属性を更新します。

createDiscussionForumConnectionコマンドを使用して、接続が作成されます。

構文

setDiscussionForumConnection(appName, name, [url, adminUser, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias, timeout, default, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のディスカッション・サーバー接続の名前を示します。

url

オプション。ディスカッション・サーバーへのURLを示します。

adminUser

オプション。ディスカッション・サーバー管理者の名前を示します。ディスカッションでは、このアカウントを使用して、WebCenter Portalユーザーの代理として管理操作が行われます。

このアカウントは、多くの場合、WebCenter Portalにおいてディスカッションとお知らせを管理するために使用されます。このユーザーは、super adminである必要はありません。ただし、ユーザーがWebCenter Portalの現在のアプリケーション・ルート・カテゴリ(つまり、すべてのポータル関連のディスカッションとお知らせが格納されているディスカッション・サーバー上のカテゴリ)に関する管理特権を持つ必要があります。

policyURIForAuthAccess

オプション。ディスカッション・サーバーWebサービスへの認証アクセスに必要なSAMLトークン・ベース・ポリシーへのURI。

指定するクライアント・ポリシーには、ディスカッション・サーバーでOWCDiscussionsServiceAuthenticatedエンドポイント用に構成されているサービス・ポリシーとの互換性が必要です。初期の設定では、デフォルト・サービス・ポリシーはWSS 1.0 SAMLトークン・サービス・ポリシー(oracle/wss10_saml_token_service_policy)です。

有効なクライアント・ポリシー値には次のようなものがあります。

- oracle/wss10_saml_token_client_policy (WSS 1.0 SAMLトークン・クライアント・ポリシー)

- oracle/wss11_saml_token_with_message_protection_client_policy (メッセージ保護クライアント・ポリシー付きWSS 1.1 SAMLトークン)

- GPA (グローバル・ポリシー・アタッチメント) - グローバル・ポリシー・アタッチメントがサポートされている環境の場合には、GPAを使用します。さらに、WLSTコマンドdetachWebServicePolicyまたはEnterprise Managerを使用して、デフォルト・ポリシーがディスカッション・サーバーのOWCDiscussionsServiceAuthenticatedエンドポイントからデタッチされていることを確認します。

『Oracle WebCenter Portalの管理』のお知らせとディスカッションの管理に関する項も参照してください。

policyURIForPublicAccess

オプション。ディスカッション・サーバーWebサービスへのパブリック・アクセスに対して、メッセージ・セキュリティおよび整合性を強制するために必要なポリシーへのURI。

デフォルト値は、oracle/no_authentication_client_policyです。

指定するクライアント・ポリシーには、ディスカッション・サーバーでOWCDiscussionsServicePublicエンドポイント用に構成されているサービス・ポリシーとの互換性が必要です。初期の設定では、サービス・ポリシーは、パブリック・アクセス(oracle/no_authentication_client_policy)用に構成されていません。

有効なクライアント値は次のとおりです:

- oracle/no_authentication_client_policy (なし)

- oracle/wss11_with_message_protection_client_policy (WSS 1.1メッセージ保護クライアント・ポリシー)

- GPA (グローバル・ポリシー・アタッチメント) - グローバル・ポリシー・アタッチメントがサポートされている環境の場合には、GPAを使用します。さらに、ディスカッション・サーバーにおけるOWCDiscussionsServicePublicエンドポイントにアタッチされているデフォルト・ポリシーが、oracle/no_authentication_service_policyに設定されていることも確認する必要があります。

recipientKeyAlias

オプション。メッセージ保護ポリシーに使用される受信者キー別名(OWCDiscussionsServicePublicおよびOWCDiscussionsServiceAuthenticatedエンドポイントに適用可能)。これは、構成されたキーストアにある、ディスカッション・サーバーの公開鍵を含む証明書の別名です。デフォルトは、nullです。

Oracle WebCenter Portalの管理のWS-Securityの構成も参照してください。

timeout

オプション。接続タイムアウト・メッセージを出す前に ディスカッション・サーバーからの応答を受信する間のディスカッションおよびお知らせの待機時間(秒単位)の長さを示します。この引数のデフォルトは、-1です。-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、ディスカッションおよびお知らせのデフォルト接続であることを示します。1つまたは複数の接続が定義されている場合のみ必要です。

有効なオプションは、1 (true)および0 (false)です。1に設定した場合、ディスカッションおよびお知らせはこの接続を使用します。0に設定すると、その接続は使用されません。デフォルトは0です。

ディスカッションとお知らせでこの接続を使用することを指定するには、値を0から1に変更します。

この接続を無効に設定するには、removeDiscussionForumServicePropertyコマンドを使用します。

removeDiscussionForumServiceProperty('appName='webcenter', property='selected.connection')

注意: 1つのアプリケーションに対して複数のディスカッション・サーバー接続を登録できますが、ディスカッションおよびお知らせに対してデフォルト接続またはアクティブ接続のみ使用できます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyDiscussionsServerという名前のセキュアなディスカッション・サーバー接続の属性を更新します。

wls:/weblogic/serverConfig> setDiscussionForumConnection(appName='webcenter',
name='MyDiscussionServer', url='http://myhost.com:7786/owc_discussions',
adminUser='admin', policyURIForAuthAccess='oracle/wss10_saml_token_client_policy', default=1)

2.7.3 setDiscussionForumConnectionProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ディスカッション・サーバー接続プロパティを設定します。使用しているディスカッション・サーバーに接続するために追加のパラメータを使用する必要がある場合、このコマンドを使用します。

このコマンドは、キーおよび値を使用して任意の接続プロパティを追加する拡張可能な方法を提供します。(createDiscussionForumConnectionおよびsetDiscussionForumConnection に指定した接続プロパティを必ず使用しなければならないというわけではありません。)

注意:

createDiscussionForumConnectionまたはsetDiscussionForumConnection を使用して、利用可能な接続プロパティを設定するためにsetDiscussionForumConnectionPropertyを使用しないでください。それを試みても、効果はありません。

すべての既知の追加接続プロパティを表2-9に示します。

表2-9 追加のディスカッション・サーバー接続プロパティ

追加の接続プロパティ

説明

application.root.category.id

すべてのディスカッション・フォーラムが格納されているディスカッション・サーバー上のアプリケーション・ルート・カテゴリIDを示します。たとえば、3に設定すると、すべてのフォーラムがID 3のカテゴリに格納されます。

linkURL

ユーザーをディスカッション・サーバーの管理コンソールにリンクするために使用するURL。createDiscussionForumConnectionまたはsetDiscussionForumConnection コマンドを使用して指定されたurl引数と異なる場合のみ必要です。たとえば、SSOまたはHTTPSが構成されている場合です。

別のパブリック外部URLを指定する場合は、次の形式を使用します。protocol://host:port

例: http://example.com:7777

構文

setDiscussionForumConnectionProperty(appName, name, key, value, [secure, server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のディスカッション・サーバー接続の名前を示します。

key

接続プロパティの名前を示します。表2-9も参照してください。

value

プロパティの値を示します。キーおよび値を持つ接続上の任意のプロパティを変更できます。

secure

オプション。暗号化を使用してプロパティの値を安全に格納するかどうかを示します。有効なオプションは、1 (true)および0 (false)です。1の場合、値が暗号化されます。デフォルト・オプションは0です。

パスワードを格納する場合は、1に設定します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyDiscussionServerという名前のディスカッション・サーバー接続のディスカッション・フォーラムの格納に使用するカテゴリを構成します。

wls:/weblogic/serverConfig>setDiscussionForumConnectionProperty
(appName='webcenter', name='MyDiscussionServer', key='application.root.category.id', value='3')

次の例では、別のパブリック外部URLを構成し、ユーザーがディスカッション・サーバーの管理コンソールにアクセスできるようにします。

wls:/weblogic/serverConfig>setDiscussionForumConnectionProperty
(appName='webcenter', name='MyDiscussionServer', key='linkURL', value='http://example.com:7777')

次の例は、myProperty1というカスタム・ディスカッション・サーバー接続プロパティをpropertyValue1の値を付けて追加します。

wls:/weblogic/serverConfig>setDiscussionForumConnectionProperty
(appName='webcenter', name='MyDiscussionServer', key='myProperty1', value='propertyValue1')

次の例では、値secureValueを指定してsecuredPropertyというセキュアなディスカッション・サーバー接続プロパティを追加します。

wls:/weblogic/serverConfig>setDiscussionForumConnectionProperty
(appName='webcenter', name='MyDiscussionServer', key='securedProperty', value='secureValue', secure=1)

2.7.4 deleteDiscussionForumConnectionProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ディスカッション・サーバー接続プロパティを削除します。接続プロパティを削除した結果、設定が無効になる場合、希望したとおりに接続されない可能性があるので、接続プロパティを削除するときに注意してください。

このコマンドを使用すると、setDiscussionForumConnectionPropertyコマンドを使用して追加したadditional接続プロパティのみ削除できます。

構文

deleteDiscussionForumConnectionProperty(appName, name, key, [server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のディスカッション・サーバー接続の名前を示します。

key

削除する接続プロパティの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、myProperty1という名前のディスカッション・サーバー接続プロパティを削除します。

wls:/weblogic/serverConfig> deleteDiscussionForumConnectionProperty
(appName='webcenter', name='MyDiscussionServer', key='myProperty1')

2.7.5 listDefaultDiscussionForumConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションで、ディスカッション・サービスとお知らせサービスが使用するディスカッション・サーバー接続の名前を示します。1つのアプリケーションに対して複数のディスカッション・サーバー接続を登録できますが、ディスカッションおよびお知らせでは、デフォルト(またはアクティブ)という接続のみ使用されます。

構文

listDefaultDiscussionForumConnection(appName, [verbose, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

verbose

オプション。有効なオプションは、1 (true)および0 (false)です。

1に設定すると、ディスカッション・サーバー接続の名前および詳細が一覧表示されます。

0に設定すると、接続の名前のみ表示されます。この引数のデフォルトは、0です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalでディスカッションおよびお知らせが使用しているディスカッション・サーバー接続の名前を示します。

wls:/weblogic/serverConfig>listDefaultDiscussionForumConnection(appName='webcenter')

次の例では、WebCenter Portalでディスカッションおよびお知らせが使用しているディスカッション・サーバー接続の名前と詳細を一覧表示します。

wls:/weblogic/serverConfig> listDefaultDiscussionForumConnection(appName='webcenter', verbose=1)

2.7.6 listDiscussionForumConnections

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションに対して設定したディスカッション・サーバーのすべての接続を一覧表示します。

構文

listDiscussionForumConnections(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

verbose

オプション。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listDiscussionForumConnectionsによって、アプリケーションに対して構成されているすべてのディスカッション・サーバー接続およびそれらの詳細が一覧表示されます。

0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

name

オプション。既存のディスカッション・サーバー接続の名前を示します。この引数を使用して、特定のディスカッション・サーバーの接続に関する詳細情報を表示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、現在、WebCenter Portalに対して設定したディスカッション・サーバーのすべての接続の名前を表示します。

wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter')

次の例は、現在、WebCenter Portalに対して設定したディスカッション・サーバーのすべての接続の名前とその詳細情報を表示します。

wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter',
verbose=1)

この例は、myDiscussionsServerという名前のディスカッション・サーバーの接続に関する詳細情報を表示します。

wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter',
name='myDiscussionsServer')

2.7.7 setDefaultDiscussionForumConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションにおけるディスカッションおよびお知らせのデフォルト・ディスカッション・サーバー接続を指定します。

1つのアプリケーションに対して複数のディスカッション・サーバー接続を登録できますが、ディスカッションとお知らせに対して使用される接続は、デフォルト(またはアクティブ)接続と呼ばれる1つのみです。

構文

setDefaultDiscussionForumConnection(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のディスカッション・サーバー接続の名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalにおけるディスカッションおよびお知らせのmyDiscussionServerという名前のデフォルト(またはアクティブ)接続を作成します。

wls:/weblogic/serverConfig> setDefaultDiscussionForumConnection
(appName='webcenter', name='myDiscussionServer')

2.7.8 setDiscussionForumServiceProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのディスカッションに使用するデフォルト値を指定します。

ディスカッションの構成可能なプロパティを表2-10に示します。

表2-10 ディスカッション - 構成可能なプロパティ

構成プロパティ

説明

topics.fetch.size

ディスカッションによって検索してトピック・ビューに表示されるトピックの最大数を示します。

forums.fetch.size

ディスカッションによって検索してフォーラム・ビューに表示されるフォーラムの最大数を示します。

recentTopics.fetch.size

ディスカッションによって検索して最新トピック・ビューに表示されるトピックの最大数を示します。

watchedTopics.fetch.size

ディスカッションによって検索して表示済トピック・ビューに表示されるトピックの最大数を示します。

watchedForums.fetch.size

ディスカッションによって検索して表示済フォーラム・ビューに表示されるフォーラムの最大数を示します。

application.root.category.id

すべてのディスカッション・フォーラムが格納されているディスカッション・サーバー上のアプリケーション・ルート・カテゴリIDを示します。たとえば、3に設定すると、すべてのフォーラムがカテゴリ3内に格納されます。

ForumGatewayManager.AUTO_START

メール配信リストによる通信は、ディスカッション・フォーラム投稿として公開できます。このパラメータはこの通信のゲートウェイを起動または停止します。

WebCenter Portalの場合、デフォルト値は1であり、その場合、管理を介してメール・サーバー設定を構成するとただちにゲートウェイが起動します。ゲートウェイを停止してこの機能を無効化するには、これを0に設定し、管理対象サーバーを再起動します。

構文

setDiscussionForumServiceProperty(appName, property, value, [server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

property

構成プロパティの名前を示します。

value

プロパティの値を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、トピック・ビューに表示されるトピックのデフォルト数を変更します。

wls:/weblogic/serverConfig>setDiscussionForumServiceProperty
(appName='webcenter', property='topics.fetch.size', value='30')

2.7.9 removeDiscussionForumServiceProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ディスカッション・プロパティに設定されている現在の値を削除します。このコマンドを使用して、表2-10に一覧表示されている任意のプロパティを削除します。

これらのプロパティの値を削除すると予期しない動作を引き起こす可能性があるので、このコマンドを使用するときは注意してください。

注意:

このコマンド構文を使用して、現在、ディスカッション・サービスおよびお知らせサービスのために使用している接続を無効に設定します。

removeDiscussionForumServiceProperty('appName='webcenter', property='selected.connection')

このコマンドを使用すると、default接続引数が0に設定されます。「setDiscussionForumConnection」も参照してください。

構文

removeDiscussionForumServiceProperty(appName, property, [server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

property

構成プロパティの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalにおけるディスカッションの現在のtopics.fetch.sizeプロパティをクリアします。

wls:/weblogic/serverConfig> removeDiscussionForumServiceProperty
(appName='webcenter', property='topics.fetch.size')

2.7.10 listDiscussionForumServiceProperties

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ディスカッションのすべての構成可能なプロパティを表示します。

構文

listDiscussionForumServiceProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalにおけるディスカッションの構成プロパティを一覧表示します。

wls:/weblogic/serverConfig> listDiscussionForumServiceProperties(appName='webcenter')

2.7.11 setAnnouncementServiceProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのお知らせに使用するデフォルト値を指定します。

お知らせの構成可能なプロパティを表2-11に示します。

表2-11 お知らせ - 構成可能なプロパティ

構成プロパティ

説明

miniview.page_size

お知らせの小型ビューに表示されるお知らせの最大数を示します。

mainview.page_size

お知らせのメイン・ビューに表示されるお知らせの最大数を示します。

linksview.page_size

お知らせのリンク・ビューに表示されるお知らせの最大数を示します。

announcements.expiration.days

通知の有効期限を示します。

構文

setAnnouncementServiceProperty(appName, property, value, [server, applicationVersion})

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

property

構成プロパティの名前を示します。

value

プロパティ値。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalでお知らせを表示するデフォルト日数を変更します。

wls:/weblogic/serverConfig>setAnnouncementServiceProperty(appName='webcenter',
property='announcements.expiration.days', value='21')

2.7.12 removeAnnouncementServiceProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

お知らせプロパティに設定されている現在の値を削除します。このコマンドを使用して、表2-11に一覧表示されている任意のプロパティを削除します。

これらのプロパティの値を削除すると予期しない動作を引き起こす可能性があるので、このコマンドを使用するときは注意してください。

構文

removeAnnouncementServiceProperty(appName, property, [server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

property

構成プロパティの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalにおけるお知らせのannouncements.expiration.daysプロパティをクリアします。

wls:/weblogic/serverConfig>removeAnnouncementServiceProperty
(appName='webcenter', property='announcements.expiration.days')

2.7.13 listAnnouncementServiceProperties

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーション内のお知らせを対象とする、すべての構成可能なプロパティを一覧表示します。

構文

listAnnouncementServiceProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalにおけるお知らせの構成プロパティを一覧表示します。

wls:/weblogic/serverConfig>listAnnouncementServiceProperties(appName='webcenter')

2.7.14 addDiscussionsServerAdmin

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ユーザーまたはグループにディスカッション・サーバーのシステム管理者パーミッションを付与します。このコマンドは、現在の管理者のいずれも含まない新しいアイデンティティ・ストアにディスカッション・サーバーを接続する際に役立ちます。

構文

addDiscussionsServerAdmin(appName, name, [type, server, applicationVersion])

引数

定義

appName

この操作を実行するディスカッション・サーバー・アプリケーションの名前。たとえば、owc_discussionsです。

name

ディスカッション・サーバーの管理者として追加するユーザーまたはグループの名前。

type

オプション。アイデンティティのタイプを識別します。有効な値は、USERおよびGROUPです。

デフォルト値はUSERです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Collaborationです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ユーザーweblogicにディスカッション・サーバーのシステム管理者パーミッションを付与します。

addDiscussionsServerAdmin(appName='owc_discussions', name='weblogic', type='USER')

次の例では、Administratorsユーザー・グループのすべてのユーザーにディスカッション・サーバーのシステム管理者パーミッションを付与します。

addDiscussionsServerAdmin(appName='owc_discussions', name='Administrators', type='GROUP')

2.7.15 addDiscussionsCategoryAdmin

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

特定のカテゴリIDのユーザーまたはグループにディスカッション・サーバーのカテゴリ管理者権限を付与します。

構文

addDiscussionsCategoryAdmin(appName, categoryId, name, [type, server, applicationVersion])

引数

定義

appName

この操作を実行するディスカッション・サーバー・アプリケーションの名前。たとえば、owc_discussionsです。

categoryId

ディスカッション・サーバーのカテゴリのID(数値)。

name

ディスカッション・サーバーのカテゴリの管理者として追加するユーザーまたはグループの名前。

type

オプション。アイデンティティのタイプを識別します。有効な値は、USERおよびGROUPです。

デフォルト値はUSERです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Collaborationです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ユーザーweblogicにディスカッション・サーバーのカテゴリ(ID=2)に対するカテゴリ管理者権限を付与します。

addDiscussionsCategoryAdmin(appName='owc_discussions', categoryId=2, name='weblogic', type='USER')

次の例では、Salesユーザー・グループに含まれるすべてのユーザーに、ディスカッション・サーバーのカテゴリ(ID=2)に対するカテゴリ管理者権限を付与します。

addDiscussionsCategoryAdmin(appName='owc_discussions', categoryId=2, name='Sales', type='GROUP')

2.7.16 setDiscussionsServerProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ディスカッション・サーバー・プロパティを設定します。このコマンドを使用して、ディスカッション・サーバーのシステム・プロパティを設定します。

注意:

setDiscussionsServerPropertyなどのディスカッション・サーバーWLSTコマンドを実行するには、管理サーバーの接続に使用するユーザーがディスカッション・サーバーの管理権限も持っている必要があります。

構文

setDiscussionsServerProperty(appName, key, value, [server, applicationVersion])

引数

定義

appName

この操作を実行するディスカッション・サーバー・アプリケーションの名前。たとえば、owc_discussionsです。

key

ディスカッション・サーバー・プロパティの名前。

たとえば、owc_discussions.sso.mode, AuthFactory.className, UserManager.className, and GroupManager.classNameなどです。

value

ディスカッション・サーバー・プロパティの値。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Collaborationです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、SSOのディスカッション・サーバーを構成するプロパティを設定します。example.com:8890/owc_discussionsはディスカッション・サーバーがデプロイされるWeb層のベースURLです。

wls:/weblogic/serverConfig>setDiscussionsServerProperty(appName='owc_discussions', key='owc_discussions.sso.mode', value='true')

wls:/weblogic/serverConfig>setDiscussionsServerProperty(appName='owc_discussions', key='jiveURL', value='example.com:8890/owc_discussions')

2.7.17 getDiscussionsServerProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ディスカッション・サーバー・プロパティの現在の値を返します。

注意:

getDiscussionsServerPropertyなどのディスカッション・サーバーWLSTコマンドを実行するには、管理サーバーに接続するために使用するユーザーがディスカッション・サーバーの管理権限も持っている必要があります。

構文

getDiscussionsServerProperty(appName, key, [server, applicationVersion])

引数

定義

appName

この操作を実行するディスカッション・サーバー・アプリケーションの名前。たとえば、owc_discussionsです。

key

ディスカッション・サーバー・プロパティの名前。

たとえば、owc_discussions.sso.mode, AuthFactory.className, UserManager.className,およびGroupManager.classNameなどです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Collaborationです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、いくつかの主要なディスカッション・サーバー・プロパティの現在の値を返します。

wls:/weblogic/serverConfig>getDiscussionsServerProperty(appName='owc_discussions', key='AuthFactory.className')

wls:/weblogic/serverConfig>getDiscussionsServerProperty(appName='owc_discussions', key='UserManager.className')

wls:/weblogic/serverConfig>getDiscussionsServerProperty(appName='owc_discussions', key='GroupManager.className')

2.7.18 removeDiscussionsServerProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ディスカッション・サーバー・プロパティに設定されている現在の値を削除します。

注意:

removeDiscussionsServerPropertyなどのディスカッション・サーバーWLSTコマンドを実行するには、管理サーバーに接続するために使用するユーザーがディスカッション・サーバーの管理権限も持っている必要があります。

構文

removeDiscussionsServerProperty(appName, key, [server, applicationVersion])

引数

定義

appName

この操作を実行するディスカッション・サーバー・アプリケーションの名前。たとえば、owc_discussionsです。

key

ディスカッション・サーバー・プロパティの名前。

たとえば、owc_discussions.sso.mode, AuthFactory.className, UserManager.classNameおよびGroupManager.classNameなどです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Collaborationです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ディスカッション・サーバーの'SSO mode'プロパティの現在の値を削除します。

wls:/weblogic/serverConfig>removeDiscussionsServerProperty(appName='owc_discussions', key='owc_discussions.sso.mode')

2.8 外部アプリケーション

表2-12に示すコマンドを使用して、WebCenter Portalの外部アプリケーション接続を管理します。

これらのWLSTコマンドを使用して行った構成変更は、アプリケーションでただちに使用可能になります。つまり、管理対象サーバーを再起動する必要はありません。

表2-12 外部アプリケーションWLSTコマンド

使用するコマンド

目的

WLSTでの使用

createExtAppConnection

指定したアプリケーションの外部アプリケーション接続を作成します。

オンライン

setExtAppConnection

既存の外部アプリケーション接続を編集します。

オンライン

listExtAppConnections

指定されたアプリケーションに対して構成されている個々またはすべての外部アプリケーションを一覧表示します。

オンライン

addExtAppField

特定の外部アプリケーション接続の別のログイン・フィールドを追加します。

オンライン

setExtAppField

特定の外部アプリケーション・ログイン・フィールドの値およびdisplay-to-user設定を編集します。

オンライン

removeExtAppField

外部アプリケーション・ログイン・フィールドを削除します。

オンライン

addExtAppCredential

外部アプリケーションの共有資格証明またはパブリック資格証明を指定します。

オンライン

setExtAppCredential

外部アプリケーションの共有資格証明またはパブリック資格証明を編集します。

オンライン

removeExtAppCredential

現在、外部アプリケーションに対して設定されている共有資格証明またはパブリック資格証明を削除します。

オンライン

2.8.1 createExtAppConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションの外部アプリケーション接続を作成します。

構文

createExtAppConnection(appName, name, [displayName, url, authMethod,
userFieldName, pwdFieldName, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。この名前は、WebCenter Portalのすべての接続タイプにおいて一意である必要があります。

displayName

オプション。外部アプリケーション表示名を示します。外部アプリケーションの、WebCenter Portalユーザーにとってわかりやすいユーザー・フレンドリな名前を示します。表示名は、WebCenter Portal内のすべての外部アプリケーション間で一意である必要があります。

url

オプション。外部アプリケーションのログインURLを示します。

アプリケーションのURLを確定するには、アプリケーションのログイン・ページに移動して、そのページのURLを記録します。

例: http://login.yahoo.com/config/login

authMethod

オプション。外部アプリケーションで使用される認証メソッドを示します。有効なオプションは、GET、POSTおよびBASIC。

この引数のデフォルトは、POSTです。

userFieldName

オプション。外部アプリケーション・ログイン・フォーム上のユーザー名フィールドまたはユーザーIDフィールドを識別する名前を示します。この名前を探すには、ログイン・ページのHTMLソースを参照します。この引数は、ユーザー資格証明を指定しません。

自動化されたADF外部アプリケーション・ログインを作成する場合は必須です。

pwdFieldName

オプション。外部アプリケーション・ログイン・フォーム上のパスワード・フィールドを識別する名前を示します。この名前を探すには、ログイン・ページのHTMLソースを参照します。この引数は、ユーザー資格証明を指定しません。

自動化されたADF外部アプリケーション・ログインを作成する場合は必須です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)にMy Yahoo!という名前の外部アプリケーションの接続を作成します。

wls:/weblogic/serverConfig> createExtAppConnection(appName='webcenter',
name='yahoo', displayName='My Yahoo!', url='http://login.yahoo.com/config/login',
authMethod='POST', userFieldName='login', pwdFieldName='password')

2.8.2 setExtAppConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

既存の外部アプリケーション接続を編集します。

構文

setExtAppConnection(appName, name, [displayName, url, authMethod,
userFieldName, pwdFieldName, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存の外部アプリケーション接続の名前を示します。

displayName

オプション。外部アプリケーション表示名を示します。外部アプリケーションの、WebCenter Portalユーザーにとってわかりやすいユーザー・フレンドリな名前を示します。

表示名は、WebCenter Portal内のすべての外部アプリケーション間で一意である必要があります。

url

オプション。外部アプリケーションのログインURLを示します。アプリケーションのURLを確定するには、アプリケーションのログイン・ページに移動して、そのページのURLを記録します。

authMethod

オプション。外部アプリケーションで使用される認証メソッドを示します。

有効なオプションは、GET、POSTおよびBASIC。この引数のデフォルトは、POSTです。

userFieldName

オプション。外部アプリケーション・ログイン・フォーム上のユーザー名フィールドまたはユーザーIDフィールドを識別する名前を示します。この名前を探すには、ログイン・ページのHTMLソースを参照します。この引数は、ユーザー資格証明を指定しません。

authMethodがGETまたはPOSTであり、ログインURLが指定されている場合は必須ですが、BASIC認証メソッドを選択した場合、空のままにできます。

pwdFieldName

オプション。外部アプリケーション・ログイン・フォーム上のパスワード・フィールドを識別する名前を示します。この名前を探すには、ログイン・ページのHTMLソースを参照します。この引数は、ユーザー資格証明を指定しません。

authMethodは、GETまたはPOSTの場合、この引数を指定する必要があります。ただし、BASIC認証メソッドを選択した場合、空に設定できます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、yahooという名前の外部アプリケーションの表示名属性を更新します。

wls:/weblogic/serverConfig> setExtAppConnection(appName='webcenter',
name='yahoo', displayName='My Favorite Yahoo!')

2.8.3 listExtAppConnections

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

appName引数のみを指定して、このコマンドを使用すると、現在、指定されたWebCenter Portalアプリケーションに対して設定したすべての外部アプリケーションの名前が表示されます。

構文

listExtAppConnections(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

verbose

オプション。外部アプリケーションの詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listExtAppConnectionsによって、WebCenter Portalに対して構成されているすべての外部アプリケーションおよびその詳細が一覧表示されます。

0に設定した場合、listExtAppConnectionsによって、外部アプリケーションの名前のみが一覧表示されます。この引数のデフォルトは、0です。

この引数を0に設定した場合、name引数を指定しないでください。

name

オプション。既存の外部アプリケーション接続の名前を示します。この引数を使用して、特定の接続の詳細情報を表示できます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)で現在使用されているすべての外部アプリケーションの名前を一覧表示します。

wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter')
app1
app2
app3

次の例は、外部アプリケーションのapp1、app2およびapp3の詳細情報を表示します。

wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter', verbose=1)
----
app1
----
Name: app1
Display Name: Application1
Login URL: http://app1
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Shared Credential: Disabled
Public Credential: Disabled
----
app2
----
Name: app2
Display Name: Application2
Login URL: http://app2
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Additional Fields: {Account1:1, Accout2:DefVal:0}
Shared Credential: Disabled
Public Credential: Enabled
----
app3
----
Name: app3
Display Name: Application3
Authentication Method: POST
Shared Credential: Enabled
Public Credential: Enabled

次の例は、外部アプリケーションapp1のみの詳細情報を表示します。

wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter', verbose=1, name='app1')
----
app1
----
Name: app1
Display Name: Application1
Login URL: http://app1
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Shared Credential: Disabled
Public Credential: Disabled

2.8.4 addExtAppField

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

特定の外部アプリケーション接続の別のログイン・フィールドを追加します。たとえば、外部アプリケーションでは、ユーザー名およびパスワードの他に、HostおよびMailAddressなどその他のログイン条件も入力する必要がある場合があります。

オプションで、ユーザーが追加ログイン・フィールを指定できるように外部アプリケーションのログインに表示されます。

別のログイン・フィールドを追加し、かつ外部アプリケーションで共有またはパブリック資格証明を使用する場合、WLSTコマンドaddExtAppCredentialおよびsetExtAppCredentialを使用して、共有またはパブリック資格証明を更新できます「addExtAppCredential」および「setExtAppCredential」を参照してください。

構文

addExtAppField(appName, name, fieldName, [fieldValue, displayToUser, server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存の外部アプリケーション接続の名前を示します。

fieldName

ログイン・フィールド名を示します。HTMLログイン・フォーム上のフィールドを識別する名前を示します。アプリケーションでは、認証メソッドとしてBASICを使用している場合、このフィールドを該当しません。

fieldValue

オプション。ログイン・フィールド値を示します。ログイン・フィールドにデフォルト値を入力するか、または、ユーザーが値を入力できるようにフィールドを空に設定します。デフォルトで、この引数は空です。

displayToUser

オプション。外部アプリケーションのログイン画面にログイン・フィールドが表示されるかどうかを指定します。

有効なオプションは、1 (true)および0 (false)です。この引数のデフォルトは、0です。

この引数を0に設定した場合、fieldValueを指定する必要があります。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

この例は、ABCという外部アプリケーションにusername.default.exampleのデフォルト値でAccountという名前の追加フィールドを作成します。このフィールドは、ABCのログイン・ページに表示されます。

wls:/weblogic/serverConfig> addExtAppField(appName='webcenter', name='ABC',
fieldName='Account', fieldValue='username.default.example', displayToUser=1)

2.8.5 setExtAppField

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

現在、外部アプリケーションに対して設定されている1つまたは複数のログイン・フィールドのフィールド値およびdisplay-to-user設定を変更します。外部アプリケーションの名前およびログイン・フィールド名とともにfieldValueまたはdisplayToUserを指定する必要があります。fieldValueおよびdisplayToUser引数は、オプションです。

このコマンドを使用すると、この外部アプリケーションに対して作成された共有資格証明またはパブリック資格証明を使用する必要があります。displayToUserを1に変更すると、場合によっては、既存の共有ユーザー資格証明またはパブリック・ユーザー資格証明を更新することも必要です。「setExtAppCredential」も参照してください。

構文

setExtAppField(appName, name, fieldName, [fieldValue, displayToUser, server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存の外部アプリケーション接続の名前を示します。

fieldName

既存のログイン・フィールドの名前を示します。

fieldValue

オプション。新しいまたは変更したログイン・フィールド値を示します。

ログイン・フィールドにデフォルト値を入力するか、または、ユーザーが値を入力できるようにフィールドを空に設定します。デフォルトで、この引数は空です。

displayToUser

オプション。外部アプリケーションのログイン画面にログイン・フィールドが表示されるかどうかを指定します。有効なオプションは、1 (true)および0 (false)です。

0に設定した場合、fieldValueを指定する必要があります。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Accountというログイン・フィールドのデフォルト値を指定し、外部アプリケーションの資格証明配信画面にそのフィールドを表示します。

wls:/weblogic/serverConfig> setExtAppField(appName='webcenter', name='ABC',
fieldName='Account', fieldValue='admin', displayToUser=1)

2.8.6 removeExtAppField

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

外部アプリケーション接続からログイン・フィールドを削除します。

このコマンドを使用すると、この外部アプリケーションに対して作成された任意の共有資格証明またはパブリック資格証明の使用を考慮する必要があります。つまり、共有ユーザー資格証明またはパブリック・ユーザー資格証明からログイン・フィールドを削除する必要があります。

必要に応じて、setExtAppCredentialコマンドを使用して、ログイン・フィールドを削除できます。たとえば、外部アプリケーションのmyAppには、Accountという追加フィールドがあり、次のコマンドを使用してパブリック資格証明が前に指定されています。

addExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC',
username='admin', password='mypublic.password', field='Account:admin@myhost.com')

Accountフィールドを削除すると、次のコマンドを実行して、資格証明を変更できます。

setExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC',
username='admin', password='mypublic.password')

setExtAppCredentialの使用に関する詳細情報については、「setExtAppCredential」を参照してください。

構文

removeExtAppField(appName, name, fieldName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。

fieldName

削除するログイン・フィールドを示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、ABCという外部アプリケーションからAccountという名前の追加ログイン・フィールドを削除します。

wls:/weblogic/serverConfig> removeExtAppField(appName='webcenter, name='ABC',
fieldName='Account')

2.8.7 addExtAppCredential

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

特定の外部アプリケーションの共有ユーザー資格証明またはパブリック・ユーザー資格証明を設定します。

共有資格証明を指定すると、ここで定義したユーザー名およびパスワードを使用して、WebCenter Portalにアクセスするすべてのユーザーが認証されます。WebCenter Portalユーザーには、ログイン・フォームは表示されません。

WebCenter Portalを使用してこの外部アプリケーションにアクセスするパブリック・ユーザーは、ここで定義したパブリック資格証明を使用してログインします。

すでに資格証明が存在する場合は、setExtAppCredentialコマンドを使用する必要があることを示す報告メッセージが表示されます。

構文

addExtAppCredential(appName, name, type, username, password, [field, server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存の外部アプリケーション接続の名前を示します。

type

資格証明のタイプを示します。有効な値は、SHAREDおよびPUBLICです。

username

共有ユーザーまたはパブリック・ユーザーの名前を示します。

password

共有ユーザーまたはパブリック・ユーザーのパスワードを示します。

field

オプション。追加のログイン・フィールドの値を示します。形式として、FieldName:FieldValueを使用します。ここで、FieldNameは、displayToUser=1で構成した追加ログイン・フィールドの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、外部アプリケーションABCのパブリック資格証明を指定します。パブリック・ユーザー名は、mypublic.usernameで、パスワードは、mypublic.passwordであり、Accountという追加フィールド名が存在します。

wls:/weblogic/serverConfig> addExtAppCredential(appName='webcenter', name='ABC',
type='PUBLIC', username='mypublic.username', password='mypublic.password',
field='Account:username.example')

2.8.8 setExtAppCredential

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

現在、外部アプリケーションに対して設定した共有ユーザー資格証明またはパブリック・ユーザー資格証明を変更します。すでに資格証明が指定されていない場合は、addExtAppCredentialを使用する必要があることを示す報告メッセージが表示されます。「addExtAppCredential」を参照してください。

setExtAppCredentialは、既存の資格証明のみ計算するので、usernameおよびpasswordの引数をオプションです。パラメータusername、passwordまたはfieldの少なくとも1つを指定する必要があります。

数日当たりにパスワードを変更する必要があるシステムのパスワードを更新するには、setExtAppCredentialコマンドを使用できます。

構文

setExtAppCredential(appName, name, type, [username, password, field,
server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存の外部アプリケーション接続の名前を示します。

type

資格証明のタイプを示します。有効な値は、SHAREDおよびPUBLICです。

username

オプション。共有ユーザーまたはパブリック・ユーザーのユーザー名を示します。

password

オプション。共有ユーザーまたはパブリック・ユーザーのパスワードを示します。

field

オプション。追加のログイン・フィールドの値を示します。形式として、FieldName:FieldValueを使用します。ここで、FieldNameは、displayToUser=1で構成した追加ログイン・フィールドの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、外部アプリケーションABCのパブリック・ユーザーのログイン資格証明を変更します。

wls:/weblogic/serverConfig> setExtAppCredential(appName='webcenter',name='ABC',
type='PUBLIC', username='username.example', password='password.example',
field='Account:username.example')

2.8.9 removeExtAppCredential

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

現在、外部アプリケーションに対して設定した共有ユーザー資格証明またはパブリック・ユーザー資格証明を削除します。

資格証明が存在しない場合、エラーが表示されます。

構文

removeExtAppCredential(appName, name, type, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存の外部アプリケーション接続の名前を示します。

type

資格証明のタイプを示します。有効な値は、SHAREDおよびPUBLICです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、外部アプリケーションABCに対して指定した共有資格証明を削除します。

wls:/weblogic/serverConfig> removeExtAppCredential(appName='webcenter', name='ABC', type='SHARED')

2.9 インスタント・メッセージおよびプレゼンス

表2-13に指定されているコマンドを使用して、インスタント・メッセージおよびプレゼンス・サーバー接続を管理します。

これらのWLSTコマンドを使用して行った構成変更は、WebCenter Portalがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

表2-13 インスタント・メッセージおよびプレゼンスWLSTコマンド

使用するコマンド

目的

WLSTでの使用

createIMPConnection

指定されたアプリケーションの新しいインスタント・メッセージおよびプレゼンス・サーバー接続を作成します。

オンライン

setIMPConnection

既存のインスタント・メッセージおよびプレゼンス・サーバー接続を編集します。

オンライン

setIMPConnectionProperty

インスタント・メッセージおよびプレゼンス・サーバー接続を変更します。

オンライン

deleteIMPConnectionProperty

インスタント・メッセージおよびプレゼンス・サーバー接続プロパティを削除します。

オンライン

listIMPAdapters

指定されたアプリケーションでサポートされるプレゼンス・サーバーを一覧表示します。

オンライン

listIMPConnections

指定されたアプリケーションに対して構成したすべてのインスタント・メッセージおよびプレゼンス・サーバー接続を一覧表示します。

オンライン

listDefaultIMPConnection

指定されたアプリケーションに対して構成したデフォルト・インスタント・メッセージおよびプレゼンス・サーバー接続を一覧表示します。

オンライン

setDefaultIMPConnection

指定した接続をデフォルト・インスタント・メッセージおよびプレゼンス・サーバー接続として設定します。

オンライン

setIMPServiceProperty

インスタント・メッセージおよびプレゼンスのデフォルトを指定します。

オンライン

removeIMPServiceProperty

インスタント・メッセージおよびプレゼンスのデフォルトを削除します。

オンライン

listIMPServiceProperties

インスタント・メッセージおよびプレゼンスのプロパティを一覧表示します。

オンライン

createIMPExtAppConnection

インスタント・メッセージおよびプレゼンス・サーバー接続に適した外部アプリケーションを作成します。

オンライン

2.9.1 createIMPConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのインスタント・メッセージおよびプレゼンス・サーバー接続を作成します。

サポートされているインスタント・メッセージおよびプレゼンス・サーバーのタイプを探すには、listIMPAdapters コマンドを使用します。初期の設定では、WebCenter PortalはMicrosoft Office Communications Server 2007 SP1 (OCS)およびMicrosoft Lync 2010をサポートしています。

WebCenter Portalには複数のプレゼンス・サーバー接続を登録できますが、インスタント・メッセージおよびプレゼンス・サービスにより使用されるのは、1つの接続、つまりデフォルト(アクティブ)接続のみです。

構文

createIMPConnection(appName, name, adapter, url, [appId, poolName,
userDomain, timeout, default, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

adapter

アダプタ名。インスタント・メッセージおよびプレゼンス・サーバーに一致するアダプタを指定します。有効な値はOCS2007です。

Microsoft Office Communications Server 2007およびMicrosoft Lyncの場合、OCS2007を選択します。

url

インスタント・メッセージおよびプレゼンス・サービスをホストしているサーバーのURLを示します。

例: http://myocshost.com:8888

domain

非推奨。

setIMPServicePropertyコマンドを使用して、IMアドレスを解決します。

appId

オプション。プレゼンス・サーバー接続に関連付けられる外部アプリケーションを示します。

指定した場合、OCSまたはLyncサーバーに対してユーザーの認証を行うために外部アプリケーション資格証明情報が使用されます。OCSおよびLyncサーバー接続の場合は、この引数は必須です。

インスタント・メッセージおよびプレゼンス・サービスに対して構成する外部アプリケーションでは、authMethod=POSTを使用して、fieldName='Account'およびdisplaytoUser=1で追加フィールドを指定する必要があります。外部アプリケーションがまだ存在していない場合、WLSTコマンドcreateIMPExtAppConnectionを使用して、必要な追加フィールドすべてを自動的に持つ外部アプリケーションを作成します。

「addExtAppField」および「setExtAppField」も参照してください。

poolName

オプション。OCSまたはLync接続を作成するために必要なプール名。プール名の詳細は、Microsoft Office Communications ServerまたはMicrosoft Lync Serverに関するドキュメントを参照してください。

OCSおよびLyncサーバー接続の場合は、この引数は必須です。

userDomain

OCSまたはLyncサーバー上のActive Directoryドメイン。

OCSまたはLyncサーバー接続の場合、この引数は必須です。

timeout

オプション。接続タイムアウト・メッセージを出す前にプレゼンス・サーバーからの応答を受信する間のインスタント・メッセージおよびプレゼンスの待機時間(秒単位)の長さを示します。この引数のデフォルトは、-1です。

-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、インスタント・メッセージおよびプレゼンス・サービスのデフォルト接続であるかどうかを示します。

有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myOCSPresenceServerという名前のMicrosoft Office Communications Serverへのインスタント・メッセージおよびプレゼンス・サーバー接続を作成します。

wls:/weblogic/serverConfig>createIMPConnection(appName='webcenter',
name='myOCSPresenceServer', adapter='OCS2007', url='http://myocshost.com/owc/ocs',
appId='OCSExtApp', userDomain='OCS', poolName='pool01.myocshost.com', timeout=60, default=1)

次の例では、myLyncServerという名前のMicrosoft Lync Serverへのインスタント・メッセージおよびプレゼンス・サーバー接続を作成します。

wls:/weblogic/serverConfig>createIMPConnection(appName='webcenter',
name='myLyncServer', adapter='OCS2007',
url='http://mylynchost.com:8888' appId='LyncExtApp', userDomain='LYNC', poolName='pool05.mylynchost.com', timeout=60, default=1))

2.9.2 setIMPConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

既存のインスタント・メッセージおよびプレゼンス・サーバーの接続を編集します。このコマンドを使用して、接続の属性を更新します。

createIMPConnection コマンドを使用して、接続が作成されます。

構文

setIMPConnection(appName, name, [adapter, url, appId, poolName,
userDomain, timeout, default, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のプレゼンス・サーバー接続の名前を示します。

adapter

オプション。アダプタ名。インスタント・メッセージおよびプレゼンス・サーバーに一致するアダプタを指定します。有効な値はOCS2007です。

Microsoft Office Communications ServerおよびMicrosoft Lync Serverの場合、OCS2007を選択します。

url

オプション。インスタント・メッセージおよびプレゼンス・サービスをホストしているサーバーのURLを示します。

domain

非推奨。

setIMPServicePropertyコマンドを使用して、IMアドレスを解決します。

appId

プレゼンス・サーバー接続に関連付けられる外部アプリケーションを示します。

指定した場合、OCSまたはLyncサーバーに対してユーザーの認証を行うために外部アプリケーション資格証明情報が使用されます。OCSおよびLyncサーバー接続の場合は、この引数は必須です。

インスタント・メッセージおよびプレゼンス・サービスに対して構成する外部アプリケーションでは、authMethod=POSTを使用して、fieldName='Account'およびdisplaytoUser=1で追加フィールドを指定する必要があります。外部アプリケーションがまだ存在していない場合、WLSTコマンドcreateIMPExtAppConnectionを使用して、必要な追加フィールドすべてを自動的に持つ外部アプリケーションを作成します。

「addExtAppField」および「setExtAppField」も参照してください。

poolName

OCSまたはLync接続を作成するために必要なプール名。プール名の詳細は、Microsoft Office Communications ServerまたはMicrosoft Lync Serverに関するドキュメントを参照してください。

OCSおよびLyncサーバー接続の場合は、この引数は必須です。

userDomain

OCSサーバー上のActive Directoryドメイン。

OCSまたはLyncサーバー接続の場合、この引数は必須です。

timeout

オプション。接続タイムアウト・メッセージを出す前にプレゼンス・サーバーからの応答を受信する間のインスタント・メッセージおよびプレゼンスの待機時間(秒単位)の長さを示します。

この引数のデフォルトは、-1です。-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、インスタント・メッセージおよびプレゼンス・サービスのデフォルト接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

インスタント・メッセージおよびプレゼンスで、この接続を使用することを指定するには、値を0から1に変更します。

この接続を無効に設定するには、removeIMPServicePropertyコマンドを使用します。

removeIMPServiceProperty('appName='webcenter', property='selected.connection')

1つのアプリケーションに対して複数のプレゼンス・サーバー接続を登録できますが、インスタント・メッセージおよびプレゼンス・サービスに対して使用される接続は1つのみであり、デフォルト(またはアクティブ)接続が使用されます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、既存のインスタント・メッセージおよびプレゼンス・サーバー接続の属性を設定します。

wls:/weblogic/serverConfig>setIMPConnection(appName='webcenter',
name='myOCSPresenceServer', adapter='OCS2007', url='http://myocshost.com/owc/ocs',
timeout=120, default=1)

2.9.3 setIMPConnectionProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンス・サーバー接続プロパティを設定します。使用しているプレゼンス・サーバーに接続するために追加のパラメータを使用する必要がある場合、このコマンドを使用します。これは、キーおよび値を使用して任意の接続プロパティを追加する拡張可能な方法です。(createIMPConnection およびsetIMPConnection に指定した接続プロパティを必ず使用しなければならないというわけではありません。)

すべての既知の追加接続プロパティを表2-14に示します。

表2-14 追加のインスタント・メッセージおよびプレゼンス接続プロパティ

追加の接続プロパティ

説明

presence.url

プレゼンス・サーバーへのURLを示します。プレゼンスを別のサーバーにデプロイした場合に指定する必要があります。

contacts.url

接続管理サービスへのURLを示します。コンテンツ管理サービスを別のサーバーにデプロイした場合に指定する必要があります。

call.url

サード・パーティ・コール・サーバーのURLを示します。値を指定しなかった場合、base.connection.urlと同じ値が使用されます。

call.method

値sipおよびpstnがサポートされます。

sipに設定した場合、IMPサービスによって、ユーザーのSIPアドレスがサード・パーティ・コール・サービスに転送されます。サード・パーティ・コール・サービスでは、コールのルーティングを決定する必要があります。

pstnに設定した場合、ユーザーの電話番号はそのユーザーのプロファイル属性(BUSINESS_PHONE)に基づいて決定されます。接続プロパティcall.number.attributeを使用すると、このデフォルトのプロファイル属性(BUSINESS_PHONE)を、他の任意の属性に変更できます。

call.domain

pstnゲートウェイのドメイン名を示します。ドメイン名を指定しなかった場合、接続の作成時に指定したドメイン値が使用されます。ドメイン名は、call.methodをpstnに設定した場合のみ指定します。

contact.number.attribute

ユーザー・プロファイルからユーザーの電話番号を読み取るために使用する属性を示します。デフォルトはBUSINESS_PHONEです。この属性値は、call.methodをpstnに設定した場合のみ指定します。

primary.domain

WebCenterユーザー・アイデンティティをドメインで修飾し(john.doe@oracle.comなど)、プレゼンス・サーバーのドメインがそれと異なる(john.doe@example.comなど)場合、プライマリ・ドメインoracle.comを指定します。

ユーザー・アイデンティティをドメインで修飾し、プレゼンス・サーバーに同じoracle.comドメインを使用する場合、primary.domainを指定する必要はありません。

注意:

setIMPConnectionPropertyを使用して、createIMPConnection またはsetIMPConnection の利用可能なプロパティを設定しないでください。それを試みても、効果はありません。

構文

setIMPConnectionProperty(appName, name, key, value, [secure, server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のプレゼンス・サーバー接続の名前を示します。

key

接続プロパティの名前を示します。表2-14を参照してください。

value

プロパティの値を示します。キーおよび値を持つ接続上の任意のプロパティを変更できます。

secure

オプション。暗号化を使用してプロパティの値を安全に格納するかどうかを示します。有効なオプションは、1 (true)および0 (false)です。1の場合、値が暗号化されます。デフォルト・オプションは0です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、デフォルト値のadminでadmin.userというカスタム・インスタント・メッセージおよびプレゼンス・サーバー接続プロパティを追加します。

wls:/weblogic/serverConfig>setIMPConnectionProperty(appName='webcenter',
name='MyLCSPresenceServer', key='admin.user', value='admin')

2.9.4 deleteIMPConnectionProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンス・サーバー接続プロパティを削除します。接続プロパティを削除した結果、設定が無効になる場合、希望したとおりに接続されない可能性があるので、接続プロパティを削除するときに注意してください。

このコマンドを使用すると、setIMPConnectionPropertyコマンドを使用して追加したadditional接続プロパティのみ削除できます。

構文

deleteIMPConnectionProperty(appName, name, key, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のプレゼンス・サーバー接続の名前を示します。

key

削除する接続プロパティの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、admin.userという名前のインスタント・メッセージおよびプレゼンス・サーバー接続プロパティを削除します。

wls:/weblogic/serverConfig>deleteIMPConnectionProperty(appName='webcenter',
name='MyOCSPresenceServer', key='admin.user')

2.9.5 listIMPAdapters

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle WebCenter Portalでサポートされるインスタント・メッセージおよびプレゼンス・サーバーのタイプを一覧表示します。初期の設定では、WebCenter PortalはMicrosoft Office Communications Server 2007 SP1 (OCS)およびMicrosoft Lync 2010をサポートしています。

構文

listIMPAdapters()

例

次の例では、サポートされるプレゼンス・サーバーを一覧表示します。

wls:/weblogic/serverConfig>listIMPAdapters()

2.9.6 listIMPConnections

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションに対して構成したすべてのインスタント・メッセージおよびプレゼンス・サーバー接続を一覧表示します。

構文

listIMPConnections(appName,[verbose, name, server, applicationVersion)

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

verbose

オプション。プレゼンス・サーバー接続の詳細情報を冗長モードで表示します。有効な値は、1 (true)および0 (false)です。

1に設定した場合、listIMPConnectionsによって、指定されたアプリケーションに対して構成されているすべてのプレゼンス・サーバー接続およびそれらの詳細が一覧表示されます。0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

name

オプション。既存のプレゼンス・サーバー接続の名前を示します。この引数を使用して、特定のプレゼンス・サーバーの接続に関する詳細情報を表示します。

verbose引数を1に設定したとき、name引数を使用すると、verbose引数が無視されることに注意します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)に対して構成したすべてのインスタント・メッセージおよびプレゼンス・サーバー接続を一覧表示します。

wls:/weblogic/serverConfig>listIMPConnections(appName='webcenter')

次の例では、WebCenter Portalに対して構成したすべてのインスタント・メッセージおよびプレゼンス・サーバー接続を冗長モードで一覧表示します。

wls:/weblogic/serverConfig>listIMPConnections(appName='webcenter', verbose=1)

次の例は、impConnection1という名前のインスタント・メッセージおよびプレゼンス・サーバーの接続に関する詳細情報を指定します。

wls:/weblogic/serverConfig> listIMPConnections(appName='webcenter', name='impConnection1')

2.9.7 listDefaultIMPConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションでインスタント・メッセージおよびプレゼンスによって使用される接続を一覧表示します。WebCenter Portalに対して複数のプレゼンス・サーバー接続を登録できますが、インスタント・メッセージおよびプレゼンスに対して使用される接続は、デフォルト(またはアクティブ)接続の1つのみです。

利用可能なプレゼンス・サーバー接続が、1つのみ存在する場合は、その接続がデフォルト接続と想定されます。

構文

listDefaultIMPConnection(appName, verbose, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

verbose

オプション。利用可能であれば、デフォルト・プレゼンス・サーバー接続が冗長モードで表示されます。

有効なオプションは、1 (true)および0 (false)です。1に設定すると、プレゼンス・サーバー接続の名前および詳細が一覧表示されます。

0に設定すると、接続の名前のみ表示されます。この引数のデフォルトは、0です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)でインスタント・メッセージおよびプレゼンスによって使用される接続の名前および詳細情報を一覧表示します。

wls:/weblogic/serverConfig>listDefaultIMPConnection(appName='webcenter', verbose=1)

2.9.8 setDefaultIMPConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーション内のインスタント・メッセージおよびプレゼンスのデフォルト接続を指定します。1つのアプリケーションに対して複数のプレゼンス・サーバー接続を登録できますが、インスタント・メッセージおよびプレゼンスに対して使用される接続は、デフォルト(またはアクティブ)接続の1つのみです。

利用可能なプレゼンス・サーバー接続が、1つのみ存在する場合は、その接続がデフォルト接続と想定されます。

構文

setDefaultIMPConnection(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のインスタント・メッセージおよびプレゼンス接続の名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)におけるインスタント・メッセージおよびプレゼンスのmyPresenceServerという名前のデフォルト(またはアクティブ)接続を作成します。

wls:/weblogic/serverConfig>setDefaultIMPConnection(appName='webcenter', name='myPresenceServer')

2.9.9 setIMPServiceProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンスのデフォルト値を指定します。

インスタント・メッセージおよびプレゼンスの構成可能なプロパティを表2-15に示します。

表2-15 インスタント・メッセージおよびプレゼンス - 構成可能なプロパティ

構成プロパティ

説明

selected.connection

インスタント・メッセージおよびプレゼンスによって使用される接続を示します。

rtc.cache.time

インスタント・メッセージおよびプレゼンス・データのキャッシュ・タイムアウトを示します。デフォルトでは60秒です。

resolve.display.name.from.user.profile

ユーザー表示名は、欠落している場合、表示する項目を確定します。0に設定しており、表示名情報が利用不可能な場合、アプリケーション内にユーザー名のみ表示されます。1に設定しており、表示名情報が利用不可能な場合、表示名がユーザー・プロファイル・データから読み込まれます。このオプションを1に設定すると、パフォーマンスに影響があります。デフォルト設定は0です。

表示名は、プレゼンス・データでは必須でありません。WebCenter Portalで表示名がデフォルトで提供されないことがあり、なおかつその情報が重要と思われる場合、表示名が常に表示されるように、resolve.display.name.from.user.profileを1に設定します。

im.address.resolver.class

ユーザー名をIMアドレスに、IMアドレスをユーザー名にマップするために使用されるリゾルバの実装。

デフォルト設定は、oracle.webcenter.collab.rtc.IMPAddressResolverImplです。この実装では、次の場所で、指定された順序でIMアドレスが検索されます。

- ユーザー・プリファレンス

- ユーザー資格証明

- ユーザー・プロファイル

im.address.profile.attribute

ユーザーのIMアドレスを決定するために使用されるユーザー・プロファイル属性。デフォルト設定は、BUSINESS_EMAILです。

構文

setIMPServiceProperty(appName, property, value, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

property

構成プロパティの名前を示します。

value

プロパティの値を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)内のインスタント・メッセージおよびプレゼンス・データのデフォルト・キャッシュ・タイムアウトを変更します。

wls:/weblogic/serverConfig>setIMPServiceProperty(appName='webcenter',
property='rtc.cache.time', value='30')

2.9.10 removeIMPServiceProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンス・プロパティに設定されている現在の値を削除します。このコマンドを使用して、表2-15に一覧表示されている任意のプロパティを削除します。

これらのプロパティの値を削除すると予期しない動作を引き起こす可能性があるので、このコマンドを使用するときは注意してください。

注意:

このコマンドの構文を使用して、現在、インスタント・メッセージおよびプレゼンスによって使用されている接続を無効にします。

removeIMPServiceProperty('appName='webcenter', property='selected.connection')

このコマンドを使用すると、default接続引数が0に設定されます。「setIMPConnection」も参照してください。

構文

removeIMPServiceProperty(appName, property, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

property

構成プロパティの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal内のインスタント・メッセージおよびプレゼンスのキャッシュ有効期限値をクリアします。

wls:/weblogic/serverConfig>removeIMPServiceProperty(appName='webcenter',
property='rtc.cache.time')

2.9.11 listIMPServiceProperties

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンスのすべての構成可能なプロパティを一覧表示します。

構文

listIMPServiceProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)内のインスタント・メッセージおよびプレゼンスの構成可能なプロパティを一覧表示します。

wls:/weblogic/serverConfig>listIMPServiceProperties(appName='webcenter')

2.9.12 createIMPExtAppConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンス・サーバー接続に適した外部アプリケーションを作成します。外部アプリケーションは、必須の追加プロパティauthMethod=POST、および追加フィールドfieldName='Account'とdisplaytoUser=1で構成されます。

構文

createIMPExtAppConnection(appName, name, [displayName, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

displayName

オプション。外部アプリケーション表示名を示します。アプリケーションのユーザーが識別するユーザー・フレンドリな名前。

表示名は、アプリケーション内のすべての外部アプリケーション間で一意である必要があります。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、インスタント・メッセージおよびプレゼンス・サーバー接続に適したIMPxAppという名前の外部アプリケーションを作成します。

wls:/weblogic/serverConfig>createIMPExtAppConnection(appName='webcenter',
name='IMPxApp', displayName='IMP Ext App')

2.10 メール

表2-16に示すコマンドを使用して、指定されたアプリケーションのメール・サーバー接続を管理します。

WebCenter Portalでは、複数のメール接続がサポートされています。default=1を使用して設定したメール接続は、WebCenter Portal内のメール・サービスのデフォルト接続です。追加のすべての接続が代理接続として提供されます。WebCenter Portalでは、ユーザーがユーザー・プリファレンスを使用して利用する接続を選択できます。

これらのWLSTコマンドを使用して設定に対して行った変更は、アプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

表2-16 メールWLSTコマンド

使用するコマンド

目的

WLSTでの使用

createMailConnection

指定されたアプリケーションのメール・サーバー接続を作成します。

オンライン

setMailConnection

既存のメール・サーバー接続を編集します。

オンライン

setMailConnectionProperty

メール・サーバー接続プロパティを設定します。

オンライン

deleteMailConnectionProperty

メール・サーバー接続プロパティを削除します。

オンライン

listMailConnections

指定したアプリケーションに対して構成されているすべてのメール・サーバー接続を一覧表示します。

オンライン

listDefaultMailConnection

指定したアプリケーションに対して構成されているデフォルトのメール・サーバー接続を一覧表示します。

オンライン

setDefaultMailConnection

指定した接続をデフォルト・メール・サーバー接続として設定します。

オンライン

setMailServiceProperty

メールのデフォルトを指定します。

オンライン

removeMailServiceProperty

メールのデフォルトを削除します。

オンライン

listMailServiceProperties

メールのプロパティを一覧表示します。

オンライン

createMailExtApp

メール接続に適した外部アプリケーションを作成します。

オンライン

2.10.1 createMailConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのメール・サーバー接続を作成します。

WebCenter Portalでは、Microsoft Exchange Serverや、IMAP4およびSMTPをサポートするすべてのメール・サーバーをサポートしています。メール・サーバー接続の重要な属性として、imapHost、imapPort、imapSecured、smtpHost、smtpPortおよびsmtpSecuredがあります。

複数のメール・サーバー接続に登録できます。WebCenter Portalでは、複数のメール接続がサポートされています。default=1を使用して設定したメール接続は、WebCenter Portal内のメール・サービスのデフォルト接続です。追加のすべての接続が代理接続として提供されます。WebCenter Portalでは、ユーザーがユーザー・プリファレンスを使用して利用する接続を選択できます。

構文

createMailConnection(appName, name, [imapHost, imapPort, smtpHost, smtpPort,
imapSecured, smtpSecured, appId, timeout, default, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

imapHost

オプション。IMAPサービスが実行しているマシンのホスト名を示します。

imapPort

オプション。IMAPサービスのリスン先ポートを示します。

smtpHost

オプション。SMTPサービスが実行しているマシンのホスト名を示します。

smtpPort

オプション。SMTPサービスのリスン先ポートを示します。

imapSecured

オプション。IMAPサーバーに接続したメール・サーバーでSSLが有効になっているかどうかを示します。

有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

smtpSecured

オプション。SMTPサーバーが保護されているかどうかを指定します。

有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

appId

メール・サーバー接続に関連付けられる外部アプリケーションを示します。

外部アプリケーション資格証明情報を使用して、IMAPおよびSMTPサーバーに対応するユーザーが認証されます。同じ資格証明を指定して、IMAPおよびSMTPサーバーの両方のサーバー上のユーザーが認証されます。

メールに対して構成する外部アプリケーションでは、authMethod=POSTを使用し、いくつかの追加ログイン・フィールドを指定する必要があります。

fieldName='Email Address'およびdisplaytoUser=1

fieldName='Your Name'およびdisplaytoUser=1

fieldName='Reply-To Address'およびdisplaytoUser=1

外部アプリケーションがまだ存在していない場合、WLSTコマンドcreateMailExtAppを使用して、必要な追加フィールドすべてを自動的に持つ外部アプリケーションを作成します。

「createExtAppConnection」も参照してください。

timeout

オプション。終了するまでのメールの待機時間(秒単位)の長さを示します。

この引数のデフォルトは、-1です。-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、メールのデフォルト接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは、0です。

WebCenter Portalでは、複数のメール接続がサポートされています。default=1を使用して設定したメール接続は、WebCenter Portal内のメール・サービスのデフォルト接続です。default=0で構成した追加の接続が代理接続として提供されます。WebCenter Portalはユーザー・プリファレンスを使用して利用する接続を選択できます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、メール・サーバー接続に適した外部アプリケーションを作成し、次に、WebCenter Portal (webcenter)用のmyMailConnectionという名前のメール・サーバー接続を作成します。

wls:/weblogic/serverConfig>createMailExtApp(appName='webcenter', name='extApp_Mail', displayName='Mail Ext App')

wls:/weblogic/serverConfig> reateMailConnection(appName='webcenter' , name='myMailConnection' , imapHost='myimaphost.com', imapPort=143 ,
smtpHost='mysmtphost.com' , smtpPort=25 , imapSecured=0, smtpSecured=0,
appId='extApp_Mail', timeout=60, default=1)

2.10.2 setMailConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

既存のメール接続を編集します。このコマンドを使用して、接続の属性を更新します。

createMailConnectionコマンドを使用して、接続が作成されます。

このコマンドを使用すると、createMailConnectionを使用して設定できない追加および任意のLDAPサーバーの属性を設定できます。LDAPの詳細が定義されている場合、メールがWebCenter Portalのポータル配信リストを作成、編集および削除します。ポータル配信リストは、それらのポータルにちなんで名付けられ(非Java識別子は除く)、ドメインが割り当てられます(@mycompany.comなど、domain属性から導出されます)。LDAPの詳細情報を提供しない場合、ポータル配信リストが作成および保持されません。メール・サーバーとしてMicrosoft Exchange Serverを指定する必要があります。

構文

setMailConnection(appName, name, [imapHost, imapPort, smtpHost, smtpPort,
imapSecured, smtpSecured, appId, default, ldapHost, ldapPort, ldapBaseDN,
ldapAdminUser, ldapAdminPassword, ldapSecured, domain, defaultUser, timeout,
server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のメール・サーバー接続の名前を示します。

imapHost

オプション。IMAPサービスが実行しているマシンのホスト名を示します。

imapPort

オプション。IMAPサービスのリスン先ポートを示します。

smtpHost

オプション。SMTPサービスが実行しているマシンのホスト名を示します。

smtpPort

オプション。SMTPサービスのリスン先ポートを示します。

imapSecured

オプション。IMAPサーバーへの接続は、SSLが有効になっているかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

smtpSecured

オプション。SMTPサーバーへの接続は、SSLが有効になっているかどうかを示します。

有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

appId

オプション。メール・サーバー接続に関連付けられる外部アプリケーションを示します。

外部アプリケーション資格証明情報を使用して、IMAPおよびSMTPサーバーに対応するユーザーが認証されます。同じ資格証明を指定して、IMAPおよびSMTPサーバーの両方のサーバー上のユーザーが認証されます。

メールに対して構成する外部アプリケーションでは、authMethod=POSTを使用し、いくつかの追加ログイン・フィールドを指定する必要があります。

fieldName='Email Address'およびdisplaytoUser=1

fieldName='Your Name'およびdisplaytoUser=1

fieldName='Reply-To Address'およびdisplaytoUser=1

外部アプリケーションがまだ存在していない場合、WLSTコマンドcreateMailExtAppを使用して、必要な追加フィールドすべてを自動的に持つ外部アプリケーションを作成します。

「createExtAppConnection」も参照してください。

ldapHost

オプション。LDAPディレクトリ・サーバーが実行中であるマシンのホスト名を示します。

ldapPort

オプション。LDAPディレクトリ・サーバーのリスン先ポートを示します。

ldapBaseDN

オプション。LDAPスキーマのベースによって識別した名前を示します。例: CN=Users,DC=oracle,DC=com。

ldapAdminUser

オプション。LDAPディレクトリ・サーバー管理者のユーザー名を示します。LDAPスキーマに値を入力する権限を持つ有効な管理者を示します。

ldapAdminPassword

オプション。LDAPディレクトリ・サーバー管理者のパスワードを示します。このパスワードは、保護したストアに保存されます。

ldapSecured

オプション。LDAPサーバーへの接続は、SSLが有効になっているかどうかを示します。

有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。すべてのLDAP通信でSSLを使用するには、これを1に設定します。

domain

オプション。ポータル配信リストに追加したドメイン名を示します。

たとえば、ドメイン属性をmycompany.comに設定すると、Finance Projectポータルでは、FinanceProject@mycompany.comという名前の配信リストが保持されます。

defaultUser

オプション。管理に関する機能を付与する必要があるユーザーのカンマ区切りのリストを示します。これらのユーザーは、作成されるすべてのポータル配信リストのメンバーになります。指定したユーザーは、ベースLDAPスキーマ(ldapBaseDN引数に指定した)に存在する必要があります。

timeout

オプション。終了するまでのメールの待機時間(秒単位)の長さを示します。

この引数のデフォルトは、-1です。-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、メールのデフォルト(またはアクティブ)接続であるかどうかを示します。

有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。1を設定すると、この接続は、メールのデフォルト接続であることを示します。

WebCenter Portalでは、複数のメール接続がサポートされています。default=1を使用して設定したメール接続は、WebCenter Portal内のメール・サービスのデフォルト接続です。default=0で構成した追加の接続が代理接続として提供されます。WebCenter Portalユーザーはユーザー・プリファレンスを使用して利用する接続を選択できます。

default値を0から1に変更すると、接続はメールのデフォルト接続になります。

デフォルト接続を使用しないようにするには、次に示すようにremoveMailServicePropertyコマンドを使用します。

removeMailServiceProperty('appName='webcenter', property='selected.connection')

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)用に構成されたメール・サーバー接続の個々の属性を設定します。

wls:/weblogic/serverConfig>setMailConnection(appName='webcenter',
name='myMailConnection', imapHost='myimaphost.com', imapPort=143,
smtpHost='mysmtphost.com' , smtpPort=25 , imapSecured=0, smtpSecured=0,
appId='extApp_Mail', timeout=60, default=1)

次の例では、メール・サーバーに接続する個別の属性を設定します。

wls:/weblogic/serverConfig>setMailConnection(appName='webcenter',
name='myMailConnection', imapPort=993, imapSecured=1, smtpPort=465 ,
smtpSecured=1)

次の例では、メール・サーバーに接続するLDAPの属性を設定します。

wls:/weblogic/serverConfig>setMailConnection(appName='webcenter',
name='myMailConnection', domain='mycompany.com', defaultUser='admin',
imapHost='myimaphost.com', imapPort=143, smtpHost='mysmtphost.com',
imapSecured=0, smtpSecured=0, smtpPort=25, appId='extApp_Mail',
default=1, ldapHost='myldaphost.com', ldapPort=389,
ldapBaseDN='CN=Users,DC=exchange,DC=uk,DC=com', ldapAdminUser='administrator',
ldapAdminPassword='adminpswd', ldapSecured=0, timeout=60)

2.10.3 setMailConnectionProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

メール・サーバー接続プロパティを設定します。使用しているメール・サーバーに接続するために追加のパラメータを使用する必要がある場合、このコマンドを使用します。これは、キーおよび値を使用して任意の接続プロパティを追加する拡張可能な方法です。(createMailConnectionおよびsetMailConnection に指定した接続プロパティを必ず使用しなければならないというわけではありません。)

構文

setMailConnectionProperty(appName, name, key, value, [secure, server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のメール・サーバー接続の名前を示します。

key

接続プロパティの名前を示します。

value

プロパティの値を示します。キーおよび値を持つ接続上の任意のプロパティを変更できます。

secure

オプション。暗号化を使用してプロパティの値を安全に格納するかどうかを示します。有効なオプションは、1 (true)および0 (false)です。1の場合、値が暗号化されます。デフォルト・オプションは0です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、デフォルト値propertyValue1でmyProperty1というカスタム・メール・サーバー接続プロパティを追加します。

wls:/weblogic/serverConfig> setMailConnectionProperty(appName='webcenter',
name='myMailServer', key='myProperty1', value='propertyValue1')

2.10.4 deleteMailConnectionProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

メール・サーバー接続プロパティを削除します。接続プロパティを削除した結果、設定が無効になる場合、希望したとおりに接続されない可能性があるので、接続プロパティを削除するときに注意してください。

このコマンドを使用すると、setMailConnectionPropertyコマンドを使用して追加したadditional接続プロパティのみ削除できます。

構文

deleteMailConnectionProperty(appName, name, key, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のメール・サーバー接続の名前を示します。

key

削除する接続プロパティの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、mailProperty1という名前のメール・サーバー接続プロパティを削除します。

wls:/weblogic/serverConfig>deleteMailConnectionProperty(appName='webcenter',
name='myMailServer', key='mailProperty1')

2.10.5 listMailConnections

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定したアプリケーションに対して構成されているすべてのメール・サーバー接続を一覧表示します。

構文

listMailConnection(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

verbose

オプション。メール・サーバー接続の詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listMailConnectionsによって、アプリケーションに対して構成されているすべてのメール・サーバー接続およびそれらの詳細が一覧表示されます。

0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

name

オプション。既存のメール・サーバー接続の名前を示します。この引数を使用して、特定のメール・サーバーの接続に関する詳細情報を表示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalに対して現在構成されているメール・サーバー接続の名前を表示します。

wls:/weblogic/serverConfig>listMailConnections(appName='webcenter')

次の例では、現在、WebCenter Portalに対して構成されているメール・サーバーのすべての接続の名前とその詳細情報を表示します。

wls:/weblogic/serverConfig>listMailConnections(appName='webcenter', verbose=1)

この例は、mailConnection1という名前のメール・サーバー接続の詳細情報を表示します。

wls:/weblogic/serverConfig>listMailConnections(appName='webcenter', name='mailConnection1')

2.10.6 listDefaultMailConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションでメールによって使用されているデフォルト・メール・サーバー接続を表示します。

複数メール・サーバーを登録できますが、デフォルト接続は、1つのみ存在します。default=1を使用して設定したメール接続は、WebCenter Portal内のメール・サービスのデフォルト接続です。追加のすべての接続が代理接続として提供されます。WebCenter Portalでは、ユーザーがユーザー・プリファレンスを使用して利用する接続を選択できます。

構文

listDefaultMailConnection(appName,[verbose, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

verbose

オプション。利用可能であれば、デフォルト・メール・サーバー接続が冗長モードで表示されます。有効なオプションは、1 (true)および0 (false)です。

1に設定すると、メール・サーバー接続の名前および詳細が一覧表示されます。

0に設定すると、接続の名前のみ表示されます。この引数のデフォルトは、0です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalでメールが使用しているメール・サーバー接続の名前と詳細を一覧表示します。

wls:/weblogic/serverConfig>listDefaultMailConnection(appName='webcenter', verbose=1)

2.10.7 setDefaultMailConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションにおけるメールのデフォルト・メール・サーバー接続を指定します。

複数メール・サーバーを登録できますが、デフォルト接続は、1つのみ存在します。default=1を使用して設定したメール接続は、WebCenter Portal内のメール・サービスのデフォルト接続です。追加のすべての接続が代理接続として提供されます。WebCenter Portalでは、ユーザーがユーザー・プリファレンスを使用して利用する接続を選択できます。

構文

setDefaultMailConnection(appName, name, [server, applicationVersion])

引数

説明

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のメール接続の名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalのデフォルト接続に、myMailServerという名前の接続を使用するようメールを構成します。

wls:/weblogic/serverConfig>setDefaultMailConnection(appName='webcenter', name='myMailServer')

2.10.8 setMailServiceProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

メールのデフォルト値を指定します。

メールの構成可能なプロパティを表2-17に示します。

表2-17 メール - 構成可能なプロパティ

構成プロパティ

説明

address.delimiter

複数のメール・アドレスを区切るために使用するデミリタを定義します。デフォルトではカンマが使用されます。

いくつかのメール・サーバーでは、lastname, firstnameの形式のメール・アドレスを必要とします。その場合、セミコロンが必要です。

mail.emailgateway.polling.frequency

新しい受信電子メールについて、ポータル配信リストを確認する頻度(秒単位)。デフォルトは1800秒(30分)です。

ポータル配信リストによる電子メール通信は、ディスカッション・サーバー上でディスカッション・フォーラム投稿として公開できます。詳細は、『Oracle WebCenter Portalでのポータルの構築』の"ディスカッション・フォーラムでのポータル・メールの公開に関する項"を参照してください。

mail.messages.fetch.size

メールの受信トレーに表示されるメッセージの最大数を示します。

resolve.email.address.to.name

LDAPが構成されている場合に、ユーザー電子メール・アドレスがWebCenter Portalユーザー名に解決されるかどうかを決定します。有効な値は、1 (true)および0 (false)です。デフォルト値は0です。

1に設定すると、メール・タスク・フローに電子メール・アドレスのかわりにWebCenter Portalユーザー名が表示されます。

メールが電子メール・アドレスを提供するときにプレゼンス情報を取得できないため、インスタント・メッセージおよびプレゼンスがプレゼンス・ステータスを取得するためにユーザー名を必要とする場合は、このプロパティを1に設定します。この値を1に設定すると、アプリケーションのパフォーマンスに影響与えます。したがって、このプロパティを設定する場合はそれを考慮する必要があります。

mail.recipient.limit

メッセージの受信者の数を制限します。たとえば、この値を「500」に設定すると、受信者数が500に制限されます。

構文

setMailServiceProperty(appName, property, value, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

property

構成プロパティの名前を示します

value

プロパティの値を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)でメールの受信トレーに表示されるメッセージのデフォルト数を100個に増加します。

wls:/weblogic/serverConfig>setMailServiceProperty(appName='webcenter',
property='mail.messages.fetch.size', value='100')

2.10.9 removeMailServiceProperty

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

メール・プロパティに設定されている現在の値を削除します。このコマンドを使用して、表2-17に一覧表示されている任意のプロパティを削除します。

これらのプロパティの値を削除すると予期しない動作を引き起こす可能性があるので、このコマンドを使用するときは注意してください。

注意:

このコマンド構文を使用すると、メールで現在のデフォルト接続を使用できなくなります。

removeMailServiceProperty('appName='webcenter', property='selected.connection')

このコマンドを使用すると、default接続引数が0に設定されます。「setMailConnection」も参照してください。

構文

removeMailServiceProperty(appName, property, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

property

構成プロパティの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalにおけるメールの現在のmail.messages.fetch.sizeの設定をクリアします。

wls:/weblogic/serverConfig>removeMailServiceProperty(appName='webcenter', property='mail.messages.fetch.size')

2.10.10 listMailServiceProperties

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

メールのすべての構成可能なプロパティを表示します。

構文

listMailServiceProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalにおけるメールの構成可能なプロパティを一覧表示します。

wls:/weblogic/serverConfig>listMailServiceProperties(appName='webcenter')

2.10.11 createMailExtApp

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

メール・サーバー接続に適した外部アプリケーションを作成します。外部アプリケーションは、必須の追加プロパティauthMethod=POSTおよび次のいくつかの追加ログイン・フィールドで構成されます。

fieldName='Email Address'およびdisplaytoUser=1

fieldName='Your Name'およびdisplaytoUser=1

fieldName='Reply-To Address'およびdisplaytoUser=1

構文

createMailExtAppConnection(appName, name, [displayName, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

displayName

オプション。外部アプリケーション表示名を示します。外部アプリケーションの、ポータル・ユーザーにとってわかりやすいユーザー・フレンドリな名前を示します。表示名は、アプリケーション内のすべての外部アプリケーション間で一意である必要があります。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、メール・サーバー接続に適したMailxAppという名前の外部アプリケーションを作成します。

wls:/weblogic/serverConfig>createMailExtAppConnection(appName='webcenter', name='MailxApp', displayName='Mail Ext App')

2.11 通知

表2-18に示すコマンドを使用して、指定されたアプリケーションにおける通知の設定を管理します。

これらのWLSTコマンドを使用して設定に対して行った変更は、アプリケーションがデプロイされている管理対象サーバーを再起動した後有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

表2-18 通知WLSTコマンド

使用するコマンド

目的

WLSTでの使用

setNotificationsConfig

指定されたアプリケーションで発生した通知のルーティングに使用する接続を指定します。

オンライン

getNotificationsConfig

指定されたアプリケーションで発生した通知の送信に使用する接続に関する詳細を返します。

オンライン

2.11.1 setNotificationsConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションで発生した通知のルーティングに使用する接続を指定します。

既存のメール・サーバーまたはBPELサーバー接続を使用します。アプリケーションをBPELサーバーに接続している場合は、メール、SMSなど複数メッセージング・チャネルを通じた通知のルーティングにOracle User Messaging Service (UMS)を使用できます。通知でBPELサーバー接続を使用するように構成すると、使用可能な各メッセージング・チャネルに対して送信者の'From'アドレスを指定できます。つまり、送信者メール・アドレスとSMSアドレスを指定できます。

または、メール・サーバーを介して通知メッセージをルーティングすることもできます。通知がメール・サーバー接続を使用するように構成する場合、メール・サーバー接続に関連付けられている外部アプリケーションに共有資格証明が含まれている必要があります。共有資格証明は、アプリケーション全体の通知をルーティングするために必要です。

構文

setNotificationsConfig(appName, type, name, [senderMailAddress, senderSMSAddress, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

type

通知の送信に使用する接続のタイプ。有効な値は、MAILおよびBPELです。

name

既存の接続の名前。

次の点を考慮してください。

- メール・サーバー接続 - メール・サーバー接続に関連付けられている外部アプリケーションに共有資格証明が含まれている必要があります。

- BPELサーバー接続 - Oracle User Messaging Service (UMS)がBPELサーバー上で使用可能である必要があります。

senderMailAddress

オプション。すべてのメール通知の送信元となるメール・アドレス。

次の形式を使用します。

<email_alias><<email_address>>または<email address>。

たとえば、WebCenter Notification<notifications@webcenter.com>またはnotifications@webcenter.comです。

この引数は、BPELサーバーを介してルーティングされる通知に適用されます。BPELサーバーが使用されており、UMSが複数の電子メール・ドライバで構成されている場合は、このアドレスは適切な電子メール・ドライバを識別するためにも使用されます。

メール・サーバーが使用される場合、送信者アドレスは、関連付けられている外部アプリケーションの共有資格証明に対して指定されているものと同じユーザーです。

senderSMSAddress

オプション。すべてのSMS通知の送信元となるSMS番号。

通常、SMSアドレスの形式は、4-6桁の数字(-、空白または他の文字を含まない)です。例: 28734。

この引数は、BPELサーバーを介してルーティングされる通知に適用されます。BPELサーバーが使用されており、UMSが複数のSMSドライバで構成されている場合は、このアドレスは適切なSMSドライバを識別するためにも使用されます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)の通知でWebCenter-SMSという名前のBPELサーバー接続が使用されることを指定し、さらにすべての通知の送信元となるメール・アドレスおよびSMSアドレスを定義します。

wls:/weblogic/serverConfig>setNotificationsConfig(appName='webcenter', type='BPEL',
name='WebCenter-SMS', senderMailAddress='WebCenter Notification<notifications@webcenter.com>',
senderSMSAddress='28734')

2.11.2 getNotificationsConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションで発生した通知の送信に使用する接続に関する詳細を返します。

構文

getNotificationsConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalで通知サービスによって使用される接続に関する詳細を返します。

wls:/weblogic/serverConfig>getNotificationsConfig(appName='webcenter')

ConnectionType:    BPEL
ConnectionName:    WebCenter-SMS
SenderMailAddress: notifications@webcenter.com
SenderSMSAddress:  28776

2.12 ピープル・コネクション

表2-19に示すコマンドを使用して、WebCenter Portal内のユーザー・プロファイル情報を管理します。

これらのWLSTコマンドを使用して行った構成変更は、WebCenter Portalがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

表2-19 ピープル・コネクションWLSTコマンド

使用するコマンド

目的

WLSTでの使用

startSyncProfiles

LDAPストア内のプロファイル情報を、WebCenter Portalデータベース・スキーマと同期します。

オンライン

syncProfile

特定のユーザーのプロファイル情報を同期します。

オンライン

stopSyncProfiles

プロファイル同期プロセスを停止します。

オンライン

isSyncProfilesRunning

プロファイルの同期が進行中かどうかを確認します。

オンライン

setProfileConfig

プロファイルのプロパティを設定します。

オンライン

getProfileConfig

現在のプロファイルのプロパティを返します。

オンライン

listProfileConfig

現在のプロファイルのプロパティを一覧表示します。

オンライン

setProfilePhotoSync

LDAPサーバーからWebCenterスキーマのユーザー・プロファイル写真を同期するかどうかを指定します。

オンライン

2.12.1 startSyncProfiles

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

LDAPストア内のプロファイル情報を、WebCenter Portalデータベース・スキーマと同期します。

構文

startSyncProfiles(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalのユーザー・プロファイルを同期します。

wls:/weblogic/serverConfig>startSyncProfiles(appName='webcenter')

2.12.2 stopSyncProfiles

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

プロファイル同期プロセスが現在進行中の場合は、それを停止します。

構文

stopSyncProfiles(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalのプロファイル同期プロセスを停止します。

wls:/weblogic/serverConfig>stopSyncProfiles(appName='webcenter')

2.12.3 isSyncProfilesRunning

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

プロファイルの同期が進行中かどうかを確認します。

構文

isSyncProfilesRunning(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalに対して、プロファイル同期が進行中かどうかを確認します。

wls:/weblogic/serverConfig>isSyncProfilesRunning(appName='webcenter')

2.12.4 syncProfile

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

LDAPストア内の特定のユーザーのプロファイル情報を、WebCenter Portalスキーマと同期します。

構文

syncProfile(appName, userName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

userName

プロファイル情報を同期するユーザーの名前。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、chadという名前のユーザーのプロファイル情報を同期します。

wls:/weblogic/serverConfig>syncProfile(appName='webcenter', userName='chad')

2.12.5 setProfileConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのプロファイルのプロパティを設定します。パラメータを省略した場合、対応する構成は変更されません。

構文

setProfileConfig(appName, ProfilePageVersion, ProfileSyncHourOfDay, ProfileSyncFrequencyInDays, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

ProfilePageVersion

オプション。使用するプロファイル・ページのバージョンを指定します。

ProfilePageVersionの有効な値は、次のとおりです。

v1 - 古いスタイルのプロファイル・ページを使用します

v2 - 新しいプロファイル・ページ形式を使用します

デフォルト値はv2です。

ProfileSyncHourOfDay

オプション。プロファイルの同期をいつ開始するか(時間単位)を指定します。

0から23までの任意の値。デフォルト値は午後11時を示す23です。

ProfileSyncFrequencyInDays

オプション。プロファイルの同期が発生する頻度(日単位)を指定します。

0より大きい任意の値。デフォルト値は7です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ProfilePageVersionおよびProfileSyncHourOfDay構成設定に新しい値を設定します。

他のすべての設定は変更されません。

wls:/weblogic/serverConfig>setProfileConfig(appName='webcenter',ProfilePageVersion=v2, ProfileSyncHourOfDay=12)

2.12.6 getProfileConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションの現在のプロファイル設定を返します。

構文

getProfileConfig(appName, key, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

key

プロファイル・プロパティの名前。有効な値は次のとおりです。

- ProfilePageVersion

- ProfileSyncHourofDay

- ProfileSyncFrequencyInDays

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、様々なプロファイル・プロパティの現在の設定を返します。

wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfilePageVersion')
wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfileSyncHourOfDay')
wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfileSyncFrequencyInDays')

2.12.7 listProfileConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションの現在のプロファイル設定を一覧表示します。

構文

listProfileConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)用の現在のプロファイル設定を一覧表示します。

wls:/weblogic/serverConfig>listProfileConfig(appName='webcenter')

2.12.8 setProfilePhotoSync

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

LDAPの最新のユーザー・プロファイル写真をWebCenter Portalのプロファイル・キャッシュと同期するかどうかを指定します。同期を有効にすると、プロファイル・キャッシュが失効したときにプロファイル写真が同期されます。同期を無効にすると、プロファイル写真はWebCenter Portalのプロファイル・キャッシュと同期されません。

構文

setProfilePhotoSync(appName, enablePhotoSync, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

enablePhotoSync

LDAPのユーザー・プロファイル写真を定期的に同期するかどうかを指定します。有効な値は1および0です。

- 1: ユーザー・プロファイル写真を定期的に同期します(WebCenter Portalのプロファイル・キャッシュが失効した後)。

- 0: LDAPのプロファイル写真をWebCenter Portalのプロファイル・キャッシュと自動的に同期しません。WebCenter Portalユーザーは、プロファイル・ページから新しい写真を手動でアップロードする必要があります。

デフォルト値は1です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalにおけるプロファイル写真の同期を有効にします。

wls:/weblogic/serverConfig>setProfilePhotoSync(appName='webcenter', enablePhotoSync=1)

2.13 個人イベント

表2-20に示すコマンドを使用して、指定されたアプリケーションの個人イベント・サーバー接続を管理します。

これらのWLSTコマンドを使用して設定に対して行った変更は、アプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

表2-20 個人イベントWLSTコマンド

使用するコマンド

目的

WLSTでの使用

createPersonalEventConnection

指定されたアプリケーションの個人イベント・サーバー接続を作成します。

オンライン

setPersonalEventConnection

既存の個人イベント・サーバー接続を編集します。

オンライン

listPersonalEventConnections

指定したアプリケーションに対して構成されているすべての個人イベント・サーバー接続を一覧表示します

オンライン

2.13.1 createPersonalEventConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションの個人イベント・サーバー接続を作成します。

個人イベントは、Microsoft Exchange Server 2007、Microsoft Exchange Server 2010およびMicrosoft Exchange Server 2013への接続をサポートします。WebCenter Portalに対して複数の個人イベント接続を登録できますが、個人イベント・サービスに対して使用される接続は1つのみであり、デフォルト(またはアクティブ)接続が使用されます。

構文

createPersonalEventConnection(appName, name, webServiceUrl, adapterName, appId, [default, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

webServiceUrl

イベント・アプリケーションを公開するWebサービスのURL。

次の形式を使用します。

protocol://host:port/appWebServiceInterface/WSName

adapterName

個人イベント・サーバーに一致するアダプタを指定します。有効な値は、MSEx2007、MSEx2010およびMSEx2013です。Microsoft Exchange Server 2007の場合はMSEx2007を、Microsoft Exchange Server 2010の場合はMSEx2010を、Microsoft Exchange Server 2013の場合はMSEx2013を選択します。

各アダプタは、認証およびデータ交換のための独自のメカニズムを備えています

appId

個人イベント・サービスを提供するMicrosoft Exchange Serverに関連付けられている外部アプリケーション。指定した場合、Microsoft Exchange Serverに対してユーザーの認証を行うために外部アプリケーション資格証明情報が使用されます。

default

オプション。この接続が、個人イベント・サービスのデフォルト接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

個人イベントでこの接続を使用することを指定するには、値を1に設定します。

WebCenter Portalに対して複数の接続を登録できますが、個人イベント・サービスに対して使用される接続は1つのみであり、デフォルト(またはアクティブ)接続が使用されます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)用にMyPEConnectionという名前の接続を作成します。この接続は、Microsoft Exchange Server 2007を指し、個人イベント・サービスのデフォルト接続として指定されています。

wls:/weblogic/serverConfig>createPersonalEventConnection(appName='webcenter',
name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl',
adapterName='MSEx2007', appId='ExtPEApp', default=1)

次の例では、WebCenter Portalに対してMyPEConnectionという名前の接続を作成します。この接続は、Microsoft Exchange Server 2007を指します。

wls:/weblogic/serverConfig>createPersonalEventConnection(appName='webcenter',
name='MyPEConnection', webServiceUrl='http://myexchange.com/ExchangeWS/PersonalEventsWebService.asmx', adapterName='MSEx2007',  appId='ExtPEApp')

2.13.2 setPersonalEventConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定したアプリケーションに対して構成された、既存の個人イベント・サーバー接続を編集します。

構文

setPersonalEventConnection(appName, name, [webServiceUrl, adapterName, appId, default, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存の個人イベント・サーバー接続の名前。

webServiceUrl

イベント・アプリケーションを公開するWebサービスのURL。

次の形式を使用します。

protocol://host:port/appWebServiceInterface/WSName

adapterName

オプション。個人イベント・サーバーに一致するアダプタを指定します。有効な値は、MSEx2007、MSEx2010およびMSEx2013です。Microsoft Exchange Server 2007の場合はMSEx2007を、Microsoft Exchange Server 2010の場合はMSEx2010を、Microsoft Exchange Server 2013の場合はMSEx2013を選択します。

各アダプタは、認証およびデータ交換のための独自のメカニズムを備えています

appId

オプション。個人イベント・サービスを提供するMicrosoft Exchange Serverに関連付けられている外部アプリケーション。指定した場合、Microsoft Exchange Serverに対してユーザーの認証を行うために外部アプリケーション資格証明情報が使用されます。

default

オプション。この接続が、個人イベントのデフォルト接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

個人イベントでこの接続を使用することを指定するには、値を1に設定します。

WebCenter Portalに対して複数の接続を登録できますが、個人イベント・サービスに対して使用される接続は1つのみであり、デフォルト(またはアクティブ)接続が使用されます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyPEConnectionという名前の接続のWebサービスURLを更新します。

wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl')

次の例では、MyPEConnectionという名前の接続を、WebCenter Portalの個人イベント・サービスのデフォルト接続にします。

wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', default=1)

2.13.3 listPersonalEventConnections

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定したアプリケーションに対して構成されているすべての個人イベント・サーバー接続を一覧表示します。

構文

listPersonalEventConnections(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

verbose

オプション。冗長モードの個人イベントの接続詳細を表示します。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listPersonalEventConnectionsによって、指定したアプリケーションに対して構成されているすべての個人イベント・サーバー接続およびそれらの詳細が一覧表示されます。

0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

0に設定した場合、name引数を指定しないでください。

name

オプション。既存の個人イベント接続の名前。この引数を使用して、特定の個人イベント・サーバーに関する接続詳細を表示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、現在、WebCenter Portal (webcenter)に対して構成した個人イベント・サーバーのすべての接続の名前とその詳細情報を表示します。

wls:/weblogic/serverConfig>listPersonalEventConnections(appName='webcenter', verbose=1)

次の例では、MyPEConnectionという名前の個人イベント・サーバー接続の接続詳細を表示します。

wls:/weblogic/serverConfig>listPersonalEventConnections(appName='webcenter', verbose=1, name='MyPEConnection')

2.14 ポートレット・プロデューサ

表2-21に示すコマンドを使用して、WebCenter Portalで使用されるポートレット・プロデューサを管理します。

これらのWLSTコマンドを使用して行ったすべての構成変更は、アプリケーションでただちに有効になります。

表2-21 ポートレット・プロデューサWLSTコマンド

使用するコマンド

目的

WLSTでの使用

registerWSRPProducer

WSRPプロデューサを作成し登録します。

オンライン

setWSRPProducer

WSRPプロデューサの登録に関する詳細情報を編集します。

オンライン

listWSRPProducers

WSRPプロデューサの登録に関する詳細情報を表示します。

オンライン

deregisterWSRPProducer

WSRPプロデューサを登録解除し、関連付けられるWSRPおよびWebサービス接続を削除します。

オンライン

listWSRPProducerRegistrationProperties

WSRPプロデューサによってサポートされる登録プロパティを表示します。

オンライン

listWSRPProducerUserCategories

WSRPプロデューサでサポートされる可能性がある任意のユーザー・カテゴリを表示します。

オンライン

mapWSRPProducerUserCategory

WSRPプロデューサによってサポートされるユーザー・カテゴリに、指定したアプリケーションで定義されているロールをマップします。

オンライン

registerPDKJavaProducer

Oracle PDK-Javaプロデューサを作成し登録します。

オンライン

setPDKJavaProducer

PDK-Javaプロデューサの登録に関する詳細情報を編集します。

オンライン

listPDKJavaProducers

登録済のOracle PDK-Javaプロデューサを表示します。

オンライン

deregisterPDKJavaProducer

Oracle PDK-Javaプロデューサを登録解除し、関連付けられる接続を削除します。

オンライン

registerPageletProducer

ページレット・プロデューサを作成し登録します。

オンライン

setPageletProducer

ページレット・プロデューサの登録に関する詳細を編集します。

オンライン

listPageletProducers

ページレット・プロデューサの登録に関する詳細を一覧表示します。

オンライン

deregisterPageletProducer

ページレット・プロデューサを登録解除し、関連付けられている接続を削除します。

オンライン

refreshProducer

現在、名前付きのプロデューサによって提供されたポートレットが反映されるようにそのプロデューサに対して格納したメタデータを最新の状態にします。

オンライン

listPortletClientConfig

指定されたアプリケーションのポートレット・クライアントの構成を一覧表示します。

オンライン

setPortletClientConfig

ポートレット・クライアントの構成設定を編集します。

オンライン

getPortletClientConfig

ポートレット・クライアントの構成設定を返します。

オンライン

registerOOTBProducers

Oracle WebCenter Portalの初期状態のプロデューサを登録します。

オンライン

deregisterOOTBProducers

Oracle WebCenter Portalの初期状態のプロデューサを登録解除します。

オンライン

registerSampleProducers

Oracle WebCenter Portalのサンプル・プロデューサを登録します。

オンライン

deregisterSampleProducers

サンプル・プロデューサを登録解除します。

オンライン

2.14.1 registerWSRPProducer

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WSRPポートレット・プロデューサへの接続を作成し、WRSPプロデューサを指定されたアプリケーションに登録します。WSRPプロデューサ接続を作成すると、<name>-wsconnという名前のWebサービス接続も作成されます。ここで、<name>は、name引数に対して指定した値を示します。

構文

registerWSRPProducer(appName, name, url, [proxyHost], [proxyPort],
[timeout],[externalApp],[registrationProperties],[tokenType],[issuer],[defUser],
[keyStorePath],[keyStorePswd],[sigKeyAlias],[sigKeyPswd],[encKeyAlias],
[encKeyPswd],[recptAlias], [enforcePolicyURI], [server],[applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

ここで指定した名前は、Composer (Portletsフォルダの下)に表示されます。

url

プロデューサWSDL URL。構文は、WSRPの実装によって異なります。例:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL(WSRP 1.0: 後方互換性のため)

説明:

- host_nameは、プロデューサがデプロイされているサーバーを示します

- port_numberは、HTTPリスナー・ポート番号を示します

- context_rootは、Webアプリケーションのコンテキスト・ルートを示します

- portlets[/wsrp(1|2)]?WSDLは、静的テキストを示します。ここに入力するテキストは、プロデューサがデプロイされている方法によって異なります。

次に例を示します。

http://myhost.com:7778/MyPortletApp/portlets/wsrp2?WSDL

proxyHost

オプション。プロキシ・サーバーのホスト名またはIPアドレスを示します。

プロキシは、アプリケーションとリモート・ポートレット・プロデューサがファイアウォールで隔てられている場合には、必要です。HTTPプロキシは、プロデューサと通信するために必要です。

proxyPort

オプション。プロキシ・サーバーのリスン先のポート番号を示します。

timeout

オプション。プロデューサと通信するために秒の単位で指定するタイムアウトを示します。たとえば、プロデューサによってポータル・ページ上にポートレットを登録、登録解除および表示するために必要な最大時間です。この引数のデフォルトは、30です。

個々のポートレットは、その自体のタイムアウト時間を定義する場合があります。このタイムアウト値は、ここで指定されている値よりも優先されます。

registrationProperties

オプション。登録プロパティとその値のリストを示します。有効な登録プロパティを指定する場合、カンマ区切りのフォーマットを使用する必要があります。各プロパティの後には、等号および値が続きます。例: name=Producer,key=123。プロデューサの登録プロパティは、listWSRPProducerRegistrationPropertiesを使用して表示できます。「listWSRPProducerRegistrationProperties」を参照してください。

tokenType

オプション。このWSRPプロデューサで認証するために使用するトークン・プロファイルのタイプを示します。

引数がenforcePolicyURI=1である場合、有効な値は次のとおりです:

- USERNAME_WITHOUT_PASSWORD (oracle/wss10_username_id_propagation_with_msg_protection_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージ保護(整合性と機密性)およびIDの伝播を提供します。資格証明(user nameのみ)は、WS-Security UsernameTokenヘッダーを介してアウトバウンドSOAPリクエスト・メッセージに組み込まれています。パスワードは組み込まれません。
非対称の主要技術のWS-Security 1.0 Basic128スイートを使用することでメッセージ保護を提供します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

- USERNAME_WITH_PASSWORD (oracle/wss10_username_token_with_message_protection_client_policy) - このポリシーは、WS-Security v1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージ保護(整合性と機密性)および認証を提供します。プレーン・テキストとダイジェストの両方のメカニズムがサポートされます。
このポリシーは、非対称鍵テクノロジのWS-SecurityのBasic128スイートを使用します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

WSRPプロデューサには、別のIDストアがある場合、このトークン・プロファイルを使用します。プロデューサに関連する外部アプリケーションを定義し、その外部アプリケーションをこのプロデューサと関連付ける必要があります。

- SAML_TOKEN_WITH_MSG_INTEGRITY (wss10_saml_token_with_message_integrity_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの整合性保護およびSAMLベースの認証を提供します。SOAPメッセージに組み込まれているSAMLトークンは、送信者保証確認付きSAMLベース認証で使用されます。
このポリシーは、WS-Securityの非対称鍵テクノロジのBasic 128スイートおよびメッセージの整合性のためにはSHA-1ハッシュ・アルゴリズムを使用します。

このポリシーを選択する場合は、受信者キー別名(recptAlias)を無効に設定する必要があります。

- SAML_TOKEN_WITH_MSG_PROTECTION (oracle/wss10_saml_token_with_message_protection_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの保護(整合性と機密性)およびSAMLベースの認証を提供します。Webサービス・コンシューマによって、SOAPヘッダーにSAMLトークンが組み込まれ、確認タイプはsender-vouchesです。
このポリシーは、非対称鍵テクノロジのWS-SecurityのBasic128スイートを使用します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

- WSS11_SAML_TOKEN_WITH_MSG_PROTECTION (oracle/wss11_saml_token_with_message_protection_client_policy) - このポリシーは、WS-Security 1.1標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの保護(整合性と機密性)およびSAMLトークンの移入を提供します。SOAPメッセージに組み込まれているSAMLトークンは、送信者保証確認付きSAMLベース認証で使用されます。このポリシーは、署名および暗号化のために対称鍵テクノロジを、署名の承認のために非対称鍵テクノロジのWS-SecurityのBasic 128スイートを使用します。

- WSS10_SAML_TOKEN_ONLY (oracle/wss10_saml_token_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエスト・メッセージに対するSAMLベースの認証を提供します。このポリシーでは、ユーザーのアイデンティティが伝播されます。通常、これはメッセージ保護および整合性チェックが不要な内部部門でのデプロイメントに使用されます。
このポリシーでは、キーストアの構成は不要です。

引数がenforcePolicyURI=0である場合、tokenType引数には、任意の有効な Oracle Web Services Manager (OWSM)ポリシーURIを指定できます。

issuer

オプション。トークンの発行者の名前を示します。発行者名は、テーマの検証を保証する要素です。たとえば、www.oracle.comです。

この引数は、トークン・タイプがSAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS10_SAML_TOKEN_ONLY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTIONである場合にのみ適用されます。

defUser

オプション。ポータル・アプリケーションでユーザーが認証されていない場合、リモート・プロデューサにアサートするユーザー名。

認証されていない場合、アイデンティティanonymousがアプリケーション・ユーザーに関連付けられます。場合によっては、値anonymousはリモート・プロデューサに対して不適切であるため、かわりのアイデンティティをここで指定する必要があります。ただし、この場合、アプリケーションによってそのユーザーは認証されていないため、指定したデフォルト・ユーザーは、リモート・プロデューサにおいて権限が低いユーザーであることに注意してください。そのユーザーがアプリケーションに対して認証済である場合、デフォルト・ユーザーではなく、そのユーザーのアイデンティティがアサートされます。

この引数は、トークン・タイプがUSERNAME_WITHOUT_PASSWORD、SAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS10_SAML_TOKEN_ONLY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTIONである場合にのみ適用されます。

extApp

オプション。この引数は、tokenTypeがUSERNAME_WITH_PASSWORDの場合、適用できます。このプロデューサは、外部アプリケーションによって認証用ユーザー資格証明を格納および提供する場合、この引数を使用して、関連付けられる外部アプリケーションの名前を指定します。

keyStorePath

オプション。SOAPメッセージのセキュリティ・トークンおよびSOAPメッセージの本体など一部にサインするために使用される秘密鍵および証明書を含むキー・ストアへの絶対パスを示します。選択したファイルは、Javaキー・ツールを使用して作成したキー・ストアである必要があります。

keyStorePswd

オプション。キー・ストアの作成時に設定されていたキー・ストアのパスワードを示します。

sigKeyAlias

オプション。サインするために使用した秘密鍵に関連付けられる証明書の識別子を示します。

sigKeyPswd

オプション。sigKeyAlias引数を使用して指定した別名によって識別したキーにアクセスするパスワードを示します。

encKeyAlias

オプション。暗号化のために使用されるキー別名を示します。有効な値は、指定したキー・ストアにあるキー別名の1つです。

encKeyPswd

オプション。暗号化キーにアクセスするパスワードを示します。

recptAlias

オプション。プロデューサの証明者に関連付けられるキー・ストア別名を示します。この証明者を使用して、プロデューサへのメッセージを暗号化します。

tokenTypeは、SAML_TOKEN_WITH_MSG_INTEGRITYの場合、受信者キー別名を指定しません。

enforcePolicyURI

オプション。有効な値は、1 (true)および0 (false)です。1に設定した場合、ユーザーは、tokenType引数に次のトークン・プロファイルのうちの1つを指定する必要があります。USERNAME_WITHOUT_PASSWORD、USERNAME_WITH_PASSWORD、SAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTION、WSS10_SAML_TOKEN_ONLY

0に設定した場合、ユーザーは、任意のOracle Web Services Manager (OWSM)ポリシーURIを指定できます。ユーザーは、指定したOWSMポリシーが有効であることを確認する必要があります。

デフォルト値は1です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)にWSRPSamplesという名前のWSRPプロデューサを登録します。

wls:/weblogic/serverConfig> registerWSRPProducer(appName='webcenter',
name='WSRPSamples', url='http://myhost.com:9999/
portletapp/portlets/wsrp2?WSDL')

次の例では、保護されたWSRPプロデューサを登録します。

wls:/weblogic/serverConfig> registerWSRPProducer(appName='webcenter',
name='WSRPSamples2', url='http://myhost.com:8899/portletapp/portlets/wsrp2?WSDL',
tokenType='WSS11_SAML_TOKEN_WITH_MSG_PROTECTION', issuer='www.oracle.com',  defUser='anonymous', keyStorePath='/keys/mykeystore.jks', keyStorePswd='Test1',
sigKeyAlias='mysigalias',sigKeyPswd='mysigpswd', encKeyAlias='myencalias',
encKeyPswd='myencpswd', recptAlias='myrcptalias')

2.14.2 setWSRPProducer

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

既存のWSRPプロデューサの登録に関する詳細情報を編集します。

構文

setWSRPProducer(appName, name, [url], [proxyHost], [proxyPort], [timeout],
[externalApp], [tokenType],[issuer], [defUser], [keyStorePath], [keyStorePswd]
[sigKeyAlias], [sigKeyPswd], [encKeyAlias], [encKeyPswd], [recptAlias],
[enforcePolicyURI], [server], [applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のWSRPプロデューサの名前を示します。

url

オプション。WSRPプロデューサURL。構文は、WSRPの実装によって異なります。例:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL(WSRP 1.0: 後方互換性のため)

説明:

- host_nameは、プロデューサがデプロイされているサーバーを示します

- port_numberは、HTTPリスナー・ポート番号を示します

- context_rootは、Webアプリケーションのコンテキスト・ルートを示します

- portlets[/wsrp(1|2)]?WSDLは、静的テキストを示します。ここに入力するテキストは、プロデューサがデプロイされている方法によって異なります。

次に例を示します。

http://myhost:7778/MyPortletApp/portlets/wsrp2?WSDL

proxyHost

オプション。プロキシ・サーバーのホスト名またはIPアドレスを示します。

プロキシは、アプリケーションとリモート・ポートレット・プロデューサがファイアウォールで隔てられている場合には、必要です。HTTPプロキシは、プロデューサと通信するために必要です。

proxyPort

オプション。プロキシ・サーバーのリスン先のポート番号を示します。

timeout

オプション。プロデューサと通信するために秒の単位で指定するタイムアウトを示します。たとえば、プロデューサによってポータル・ページ上にポートレットを登録、登録解除および表示するために必要な最大時間です。

この引数のデフォルトは、30です。

個々のポートレットは、その自体のタイムアウト時間を定義する場合があります。このタイムアウト値は、ここで指定されている値よりも優先されます。

extApp

オプション。この引数は、tokenTypeがUSERNAME_WITH_PASSWORDの場合、適用できます。このプロデューサは、外部アプリケーションによって認証用ユーザー資格証明を格納および提供する場合、この引数を使用して、関連付けられる外部アプリケーションの名前を指定します。

tokenType

オプション。このWSRPプロデューサで認証するために使用するトークン・プロファイルのタイプを示します。

引数がenforcePolicyURI=1である場合、有効な値は次のとおりです:

- USERNAME_WITHOUT_PASSWORD
(oracle/wss10_username_id_propagation_with_msg_protection_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージ保護(整合性と機密性)およびアイデンティティの伝播を提供します。資格証明(user nameのみ)は、WS-Security UsernameTokenヘッダーを介してアウトバウンドSOAPリクエスト・メッセージに組み込まれています。パスワードは組み込まれません。

非対称鍵テクノロジのWS-Security 1.0 Basic 128スイートを使用することでメッセージ保護を提供します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

- USERNAME_WITH_PASSWORD
(oracle/wss10_username_token_with_message_protection_client_policy) - このポリシーは、WS-Security v1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージ保護(整合性と機密性)および認証を提供します。プレーン・テキストとダイジェストの両方のメカニズムがサポートされます。

このポリシーは、非対称鍵テクノロジのWS-SecurityのBasic128スイートを使用します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

WSRPプロデューサには、別のIDストアがある場合、このトークン・プロファイルを使用します。プロデューサに関連する外部アプリケーションを定義し、その外部アプリケーションをこのプロデューサと関連付ける必要があります。

- SAML_TOKEN_WITH_MSG_INTEGRITY
(wss10_saml_token_with_message_integrity_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの整合性およびSAMLベースの認証を提供します。SOAPメッセージに組み込まれているSAMLトークンは、送信者保証確認付きSAMLベース認証で使用されます。

このポリシーは、WS-Securityの非対称鍵テクノロジのBasic 128スイートおよびメッセージの整合性のためにはSHA-1ハッシュ・アルゴリズムを使用します。

このポリシーを選択する場合は、受信者キー別名(recptAlias)を無効に設定する必要があります。

- SAML_TOKEN_WITH_MSG_PROTECTION
(oracle/wss10_saml_token_with_message_protection_client_policy) - このポリシーは、WS-Security v1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの保護(整合性と機密性)およびSAMLベースの認証を提供します。Webサービス・コンシューマによって、SOAPヘッダーにSAMLトークンが組み込まれ、確認タイプはsender-vouchesです。

このポリシーは、非対称鍵テクノロジのWS-SecurityのBasic128スイートを使用します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

tokenType
continued...

- WSS11_SAML_TOKEN_WITH_MSG_PROTECTION
(oracle/wss11_saml_token_with_message_protection_client_policy) - このポリシーは、WS-Security 1.1標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの保護(整合性と機密性)およびSAMLトークンの移入を有効化します。SOAPメッセージに組み込まれているSAMLトークンは、送信者保証確認付きSAMLベース認証で使用されます。このポリシーは、署名および暗号化のために対称鍵テクノロジを、署名の承認のために非対称鍵テクノロジのWS-SecurityのBasic 128スイートを使用します。

- WSS10_SAML_TOKEN_ONLY
(oracle/wss10_saml_token_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエスト・メッセージにSAMLトークンを組み込みます。このポリシーでは、ユーザーのアイデンティティが伝播されます。通常、これはメッセージ保護および整合性チェックが不要な内部部門でのデプロイメントに使用されます。

このポリシーでは、キーストアの構成は不要です。

引数がenforcePolicyURI=0である場合、tokenType引数には、任意の有効な Oracle Web Services Manager (OWSM)ポリシーURIを指定できます。

issuer

オプション。トークンの発行者の名前を示します。発行者名は、テーマの検証を保証する要素です。たとえば、www.oracle.comです。

この引数は、トークン・タイプがSAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS10_SAML_TOKEN_ONLY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTIONである場合にのみ適用されます。

defUser

オプション。アプリケーションでユーザーが認証されていない場合、リモート・プロデューサをアサートするユーザー名を示します。

認証されていない場合は、anonymousというアイデンティティがアプリケーション・ユーザーに関連付けられます。場合によっては、値anonymousはリモート・プロデューサに対して不適切であるため、かわりのアイデンティティをここで指定する必要があります。ただし、この場合、アプリケーションによってそのユーザーは認証されていないため、指定したデフォルト・ユーザーは、リモート・プロデューサにおいて権限が低いユーザーであることに注意してください。そのユーザーがアプリケーションに対して認証済である場合、デフォルト・ユーザーではなく、そのユーザーのアイデンティティがアサートされます。

この引数は、トークン・タイプがUSERNAME_WITHOUT_PASSWORD、SAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS10_SAML_TOKEN_ONLY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTIONである場合にのみ適用されます。

keyStorePath

オプション。SOAPメッセージのセキュリティ・トークンおよびSOAPメッセージの本体など一部にサインするために使用される秘密鍵および証明書を含むキー・ストアへの絶対パスを示します。選択したファイルは、Javaキー・ツールを使用して作成したキー・ストアである必要があります。

keyStorePswd

オプション。キー・ストアの作成時に設定されていたキー・ストアのパスワードを示します。

sigKeyAlias

オプション。サインするために使用した秘密鍵に関連付けられる証明書の識別子を示します。

sigKeyPswd

オプション。sigKeyAlias引数を使用して指定した別名によって識別したキーにアクセスするパスワードを示します。

encKeyAlias

オプション。戻りメッセージを暗号化するためにプロデューサによって使用されるキーの別名。有効な値は、指定したキー・ストアにあるキー別名の1つです。指定しない場合、プロデューサでは、戻りメッセージの暗号化のために署名鍵を使用します。

encKeyPswd

オプション。暗号化キーにアクセスするパスワードを示します。

recptAlias

オプション。プロデューサの証明者に関連付けられるキー・ストア別名を示します。この証明書を使用して、プロデューサへのアウトバウンド・メッセージを暗号化します。

tokenTypeは、SAML_TOKEN_WITH_MSG_INTEGRITYの場合、受信者キー別名を指定しません。

enforcePolicyURI

オプション。有効な値は、1 (true)および0 (false)です。1に設定した場合、ユーザーは、tokenType引数に次のトークン・プロファイルのうちの1つを指定する必要があります。USERNAME_WITHOUT_PASSWORD、USERNAME_WITH_PASSWORD、SAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTION、WSS10_SAML_TOKEN_ONLY

0に設定した場合、ユーザーは、任意のOracle Web Services Manager (OWSM)ポリシーURIを指定できます。ユーザーは、指定したOWSMポリシーが有効であることを確認する必要があります。

デフォルト値は1です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

この例では、WSRPSamplesのプロデューサのタイムアウトを60秒に増加します。

wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter', name='WSRPSamples', timeout=60)

この例は、保護されたWSRPプロデューサ上のセキュリティ・プロパティを更新します。

wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter',
name='WSRPSamples2', tokenType='WSS11_SAML_TOKEN_WITH_MSG_PROTECTION', issuer='www.oracle.com',  defUser='anonymous',
keyStorePath='/keys/mykeystore.jks', keyStorePswd='Test1',
sigKeyAlias='mysigalias', sigKeyPswd='mysigpswd',encKeyAlias='myencalias',
encKeyPswd='myencpswd', recptAlias='myrcptalias')

この例は、保護されたWSRPプロデューサ上に設定したセキュリティ・プロパティをすべて削除します。

wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter',
name='WSRPSamples2', tokenType='')

2.14.3 listWSRPProducers

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのWSRPプロデューサの登録に関する詳細情報を一覧表示します。

構文

listWSRPProducers(appName, [name, verbose, server, [applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

オプション。既存のWSRPプロデューサの名前を示します。指定しない場合、このアプリケーションに対して構成したWSRPプロデューサの接続に関する詳細情報が表示されます。

verbose

オプション。WSRPプロデューサの接続に関する詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listWSRPProducersによって、すべての接続プロパティが一覧表示されます。

0に設定した場合、listWSRPProducersによって、接続名のみ一覧表示されます。この引数のデフォルトは、1です。

この引数を0に設定した場合、names引数を指定しないでください。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalに登録されているWSRPプロデューサをすべて一覧表示します。

wls:/weblogic/serverConfig> listWSRPProducers(appName='webcenter', verbose=0)

----------------------
WSRPSamples-connection
----------------------

次の例では、WebCenter Portalに、WSRPSamples-connectionとして登録されているWSRPプロデューサの詳細な接続情報を一覧表示します。

wls:/weblogic/serverConfig> listWSRPProducers(appName='webcenter', name='WSRPSamples-connection', verbose=1)

----------------------
WSRPSamples-connection
----------------------
Connection Name: WSRPSamples-connection
Web Service Connection Name: WSRPSamples-connection-wsconn
Proxy Host: None
Proxy Port: None
Timeout: 0
WSDL URL: http://example.com:7777/portletapp/portlets/wsrp2?WSDL

2.14.4 deregisterWSRPProducer

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WSRPプロデューサを登録解除し、関連付けられるWSRPおよびWebサービス接続を削除します。

構文

deregisterWSRPProducer(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のWSRPプロデューサの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、WebCenter Portal (webcenter)内のWSRPSamplesプロデューサを登録解除します。

wls:/weblogic/serverConfig> deregisterWSRPProducer(appName='webcenter', name='WSRPSamples')

2.14.5 listWSRPProducerRegistrationProperties

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WSRPポートレット・プロデューサによってサポートされる登録プロパティを表示します。

構文

listWSRPProducerRegistrationProperties(appName, url, [proxyHost, proxyPort, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

url

WSRPプロデューサURL。構文は、WSRPの実装によって異なります。例:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL(WSRP 1.0: 後方互換性のため)

説明:

- host_nameは、プロデューサがデプロイされているサーバーを示します

- port_numberは、HTTPリスナー・ポート番号を示します

- context_rootは、Webアプリケーションのコンテキスト・ルートを示します

- portlets[/wsrp(1|2)]?WSDLは、静的テキストを示します。ここに入力するテキストは、プロデューサがデプロイされている方法によって異なります。

次に例を示します。

http://myhost:7778/MyPortletApp/portlets/wsrp2?WSDL

proxyHost

オプション。プロキシ・サーバーのホスト名またはIPアドレスを示します。

プロキシは、アプリケーションとリモート・ポートレット・プロデューサがファイアウォールで隔てられている場合には、必要です。HTTPプロキシは、プロデューサと通信するために必要です。

proxyPort

オプション。プロキシ・サーバーのリスン先のポート番号を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、WSRPプロデューサの有効な登録プロパティおよび指定したWSDL URLを表示します。

wls:/weblogic/serverConfig> listWSRPProducerRegistrationProperties
(appName='webcenter', url='http://myhost:9999/portletapp/portlets/wsrp2?WSDL')

Registration Property hint : hint text
Registration Property label : label text
Registration Property language : en
Registration Property name : {urn:xyz:wlp:prop:reg:registration}consumerRole
Registration Property value : None

2.14.6 listWSRPProducerUserCategories

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WSRPプロデューサでサポートされる可能性がある任意のユーザー・カテゴリを表示します。WebCenter Portalユーザーは、WLSTコマンドのmapWSRPProducerUserCategoryを使用して、アプリケーションのロールをプロデューサのユーザー・カテゴリにマップできます。

構文

listWSRPProducerUserCategories(appName, name, [server, [pplicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のWSRPプロデューサの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、WSRPSamplesという名前のWSRPプロデューサに関連付けられるカテゴリを表示します。

wls:/weblogic/serverConfig> listWSRPProducerUserCategories(appName='webcenter',
name='WSRPSamples')

User Category Name : categoryTwo
User Category Description : Custom role two.
User Category Mapped Local Roles : None

User Category Name : categoryOne
User Category Description : Custom role one.
User Category Mapped Local Roles : None

2.14.7 mapWSRPProducerUserCategory

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WSRPプロデューサによってサポートされるユーザー・カテゴリに対して指定したアプリケーションに定義したロールをマップします。listWSRPProducerUserCategoriesを使用して、ユーザー・カテゴリを検索可能です。

構文

mapWSRPProducerUserCategory(appName, name, localRole, producerUserCategory, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のWSRPプロデューサの名前を示します。

localRole

アプリケーションのマップするロールの名前を示します。

producerUserCategory

WebCenter PortalロールをマップするWSRPプロデューサのユーザー・カテゴリ。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、アプリケーション・ロールadminをWSRPユーザー・カテゴリwrsp-adminにマップします。

wls:/weblogic/serverConfig> mapWSRPProducerUserCategory(appName='webcenter',
name='WSRPProducer1', localRole='admin', producerUserCategory='wsrp-admin')

2.14.8 registerPDKJavaProducer

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle PDK-Javaポートレット・プロデューサへの接続を作成し、Oracle PDK-Javaプロデューサを指定されたアプリケーションに登録します。

構文

registerPDKJavaProducer(appName, name, url, [serviceId, proxyHost, proxyPort,
subscriberId, sharedKey, timeout, establishSession, externalApp, mapUser,
server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

url

Oracle PDK-JavaプロデューサのURLを示します。次の構文を使用します。

http://host_name:port_number/context_root/providers

説明:

- host_nameは、プロデューサがデプロイされているサーバーを示します

- port_numberは、HTTPリスナー・ポート番号を示します

- context_rootは、Webアプリケーションのコンテキスト・ルートを示します。

- providersは、静的テキストを示します。ここに入力するテキストは、プロデューサがデプロイされている方法によって異なります。

次に例を示します。

http://myHost:7778/myEnterprisePortlets/providers

serviceId

オプション。プロデューサのサービスIDを示します。

PDK-Javaでは、1つのアダプタ・サーブレットの下に複数のプロデューサをデプロイできます。プロデューサは、それらのユニークなサービスIDで識別されます。サービスIDがURLのエンド・ポイントに追加されていないときにのみ、指定する必要があります。

たとえば、次のURLのエンドポイントには、サービスIDとしてsampleを指定する必要があります。

http://domain.example.com:7778/axyz/providers

ただし、次のURLのエンドポイントには、サービスIDを指定する必要はありません。

http://domain.example.com:7778/axyz/providers/sample

サービスIDを使用して、<service_id>.propertiesというファイルを参照できます。このファイルには、プロデューサのテスト・ページを表示するかどうかなど、プロデューサの特性が定義されています。任意の値を使用してサービスIDを作成します。

proxyHost

オプション。プロキシ・サーバーのホスト名またはIPアドレスを示します。

プロキシは、アプリケーションとリモート・ポートレット・プロデューサがファイアウォールで隔てられている場合には、必要です。HTTPプロキシは、プロデューサと通信するために必要です。

proxyPort

オプション。プロキシ・サーバーのリスン先のポート番号を示します。この引数のデフォルトは、80です。

sharedKey

オプション。リモート・プロデューサのメッセージを認証するために使用する共有キーを示します。メッセージを認証すると、受信メッセージが共有キーを持つホストから送信されます。この引数のデフォルトは、nullです。

共有キーは、10文字から20文字までの英数字を含むことができます。

subscriberId

オプション。必要に応じて、コンシューマの識別子を示します。

アプリケーションにプロデューサを登録すると、プロデューサに呼出しが行われます。コール中、コンシューマが(このインスタンスの場合は、WebCenter Portal)サブスクライバIDの値をプロデューサに渡します。サブスクライバIDを使用するためにプロデューサがコード化される可能性があります。

timeout

オプション。プロデューサと通信するために秒の単位で指定するタイムアウトを示します。たとえば、プロデューサによってポータル・ページ上にポートレットを登録、登録解除および表示するために必要な最大時間です。

この引数のデフォルトは、30です。

個々のポートレットは、その自体のタイムアウト時間を定義する場合があります。このタイムアウト値は、ここで指定されている値よりも優先されます。

establishSession

オプション。このプロデューサからポートレットを実行するときには、ユーザー・セッションを有効にします。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

セッションを有効に(1に設定)すると、サーバーでは、ユーザー名などセッション固有の情報が保持されます。セッションを使用してメッセージを認証するので、共有キーが指定されている場合、このオプションも有効に設定する必要があります。プロデューサとサーバーの間でセッションレス通信を行う場合は、0を指定します。

externalApp

オプション。プロデューサに関連付けられるために使用する外部アプリケーションの名前を示します。プロデューサのポートレットの1つを認証する必要がある場合、必須です。

mapUser

オプション。外部アプリケーションからマップしたユーザー名をプロデューサに渡す必要があるかどうかを示すフラグ。

有効な値は、1 (true)および0 (false)です。この引数のデフォルトは、1です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、WebCenter Portal (webcenter)のJPDKSamplesという名前のOracle PDK-Javaプロデューサを作成し登録します。

wls:/weblogic/serverConfig> registerPDKJavaProducer(appName='webcenter',
name='JPDKSamples', url='http://myhost:9999/jpdk/providers/sample')

2.14.9 setPDKJavaProducer

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

既存のPDK-Javaプロデューサの登録に関する詳細情報を編集します。

構文

setPDKJavaProducer(appName, name, url, [serviceId, proxyHost, proxyPort,
subscriberId, sharedKey, timeout, establishSession, externalApp, mapUser,
server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のPDK-Javaプロデューサの名前を示します。

url

Oracle PDK-JavaプロデューサのURLを示します。次の構文を使用します。

http://host_name:port_number/context_root/providers

説明:

- host_nameは、プロデューサがデプロイされているサーバーを示します

- port_numberは、HTTPリスナー・ポート番号を示します

- context_rootは、Webアプリケーションのコンテキスト・ルートを示します。

- providersは、静的テキストを示します。ここに入力するテキストは、プロデューサがデプロイされている方法によって異なります。

次に例を示します。

http://myHost:7778/myEnterprisePortlets/providers

serviceId

オプション。プロデューサのサービスIDを示します。

PDK-Javaでは、1つのアダプタ・サーブレットの下に複数のプロデューサをデプロイできます。プロデューサは、それらのユニークなサービスIDで識別されます。サービスIDがURLのエンド・ポイントに追加されていないときにのみ、指定する必要があります。

たとえば、次のURLのエンドポイントには、サービスIDとしてsampleを指定する必要があります。

http://domain.example.com:7778/axyz/providers

ただし、次のURLのエンドポイントには、サービスIDを指定する必要はありません。

http://domain.example.com:7778/axyz/providers/sample

サービスIDを使用して、<service_id>.propertiesというファイルを参照できます。このファイルには、プロデューサのテスト・ページを表示するかどうかなど、プロデューサの特性が定義されています。任意の値を使用してサービスIDを作成します。

proxyHost

オプション。プロキシ・サーバーのホスト名またはIPアドレスを示します。

プロキシは、アプリケーションとリモート・ポートレット・プロデューサがファイアウォールで隔てられている場合には、必要です。HTTPプロキシは、プロデューサと通信するために必要です。

proxyPort

オプション。プロキシ・サーバーのリスン先のポート番号を示します。

subscriberId

オプション。必要に応じて、コンシューマの識別子を示します。

アプリケーションにプロデューサを登録すると、プロデューサに呼出しが行われます。呼び出し中に、コンシューマ(このインスタンスではWebCenter Portal)は、プロデューサにサブスクライバIDの値を渡します。プロデューサは、サブスクライバIDの希望する値を表示しない場合、登録の呼出しを拒否する可能性があります。

sharedKey

オプション。共有キーを使用して、リモート・プロデューサのメッセージを認証します。メッセージを認証すると、受信メッセージが共有キーを持つホストから送信されます。sharedKey引数およびestablishSession引数を使用してセッションを有効にする必要があります。

timeout

オプション。プロデューサと通信するために秒の単位で指定するタイムアウトを示します。たとえば、プロデューサによってポータル・ページ上にポートレットを登録、登録解除および表示するために必要な最大時間です。

個々のポートレットは、その自体のタイムアウト時間を定義する場合があります。このタイムアウト値は、ここで指定されている値よりも優先されます。

establishSession

オプション。このプロデューサからポートレットを実行するときには、ユーザー・セッションを有効にします。有効な値は、1 (true)および0 (false)です。establishSession引数およびsharedKey引数を使用してセッションを有効にする必要があります。

セッションを有効に(1に設定)すると、サーバーでは、ユーザー名などセッション固有の情報が保持されます。セッションを使用してメッセージを認証するので、共有キーが指定されている場合、このオプションも有効に設定する必要があります。プロデューサとサーバーの間でセッションレス通信を行う場合は、0に設定します。

externalApp

オプション。このプロデューサに関連付けられる外部アプリケーションの名前を示します。

mapUser

オプション。外部アプリケーションからマップしたユーザー名をプロデューサに渡す必要があるかどうかを示すフラグ。有効な値は、1 (true)および0 (false)です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、プロキシ・サーバーを使用するためにMyAppに登録されたPDK-Javaプロデューサを変更します。

wls:/weblogic/serverConfig> setPDKJavaProducer(appName='MyApp',name='MyProducer',
url='http://myhost.com/jpdk/providers/sample', proxyHost='myproxy.com', proxyPort=80)

2.14.10 deregisterPDKJavaProducer

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle PDK-Javaプロデューサを登録解除し、指定されたアプリケーションに関連付けられる接続を削除します。

構文

deregisterPDKJavaProducer(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のPDK-Javaプロデューサの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、wc-OmniPortletプロデューサを登録解除し、関連付けられる接続を削除します。

wls:/weblogic/serverConfig> deregisterPDKJavaProducer(appName='webcenter',
name='wc-OmniPortlet')

Already in Domain Runtime Tree
Producer wc-OmniPortlet has been deregistered.
Already in Domain Runtime Tree
"wc-OmniPortlet" successfully deleted
Already in Domain Runtime Tree
"wc-OmniPortlet-urlconn" successfully deleted

2.14.11 listPDKJavaProducers

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションに登録された1つまたは複数のOracle PDK-Javaプロデューサの詳細情報を表示します。

構文

listPDKJavaProducers(appName, [name, verbose, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

オプション。既存のPDK-Javaポートレット・プロデューサの名前を示します。指定しない場合、このアプリケーションに対して構成したすべてのPDK-Javaプロデューサの接続に関する詳細情報が表示されます。

verbose

オプション。PDK-Javaプロデューサの接続に関する詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listPDKJavaProducersによって、すべての接続プロパティが表示されます。

0に設定した場合、listPDKJavaProducersによって、接続名のみが一覧表示されます。この引数のデフォルトは、1です。

この引数を0に設定した場合、name引数を指定しないでください。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、JPDKSamplesプロデューサのすべての接続プロパティ(冗長モード)を表示します。

wls:/weblogic/serverConfig> listPDKJavaProducers(appName='webcenter',
name='JPDKSamples', verbose=1)

----------------------
wc-OmniPortlet
----------------------
Service Id: None
Shared Key: None
External Application Id: None
Subscriber Id: None
URL: http://myhost:9999/portalTools/omniPortlet/providers/omniPortlet

2.14.12 registerPageletProducer

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定したアプリケーションに、ページレット・プロデューサを登録します。

構文

registerPageletProducer(appName, name, url, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

ここで指定する名前は、デフォルトではComposer (Mash-ups >Pagelet Producersフォルダの下)に表示されます。

url

ページレット・プロデューサがデプロイされているサーバーへのアクセスに必要なURL。次の構文を使用します:

protocol://host.domain:port_number/pagelets

URLには、完全修飾ドメイン名を含める必要があります。次に例を示します。

http://myhost.example.com:7778/pagelets

ページレットがセキュアなデータを伝送する場合、登録されるURLはhttpsプロトコルを使用する必要があります。次に例を示します。

https://myhost.com:7779/pagelets

注意: WebCenter Portalでは、ページレット・プロデューサURLがOracle Access Manager (OAM)によって保護されている場合、ページレット・カタログのURLを除外する(アクセス制御を使用しないで直接マップする)必要があります。そのようにしない場合、RESTを使用したときにカタログが空で表示されます。ページレット・カタログのURLは、次のとおりです。

http://proxy_host:proxy_port/api/v2/ensemble/pagelets

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)にページレット・プロデューサを登録します。

wls:/weblogic/serverConfig> registerPageletProducer(appName='webcenter',
name='MyPageletProducer', url='http://myhost.com:7001/pagelets')

2.14.13 setPageletProducer

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

既存のページレット・プロデューサの接続詳細を編集します。

構文

setPageletProducer(appName, name, [url, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のページレット・プロデューサ接続の名前。

url

オプション。ページレット・プロデューサがデプロイされているサーバーへのアクセスに必要なURL。次の構文を使用します:

protocol://host.domain:port_number/pagelets

URLには、完全修飾ドメイン名を含める必要があります。次に例を示します。

http://myhost.example.com:7778/pagelets

注意: WebCenter Portalでは、ページレット・プロデューサURLがOracle Access Manager (OAM)によって保護されている場合、ページレット・カタログのURLを除外する(アクセス制御を使用しないで直接マップする)必要があります。そのようにしない場合、RESTを使用したときにカタログが空で表示されます。ページレット・カタログのURLは、次のとおりです。

http://proxy_host:proxy_port/api/v2/ensemble/pagelets

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyPageletProducerという名前の既存のページレット・プロデューサ接続の管理者ユーザー名およびパスワード詳細を更新します。

wls:/weblogic/serverConfig> setPageletProducer(appName='webcenter',
name='MyPageletProducer', url='http://mypagelethost.com:7778/pagelets')

2.14.14 listPageletProducers

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定したアプリケーションに登録されている1つまたはすべてのページレット・プロデューサの接続詳細を一覧表示します。

構文

listPageletProducers(appName, [name, verbose, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

オプション。既存のページレット・プロデューサ接続の名前。この引数を使用して、特定のページレット・プロデューサの接続詳細を表示します。

指定しない場合、このアプリケーションに対して構成したページレット・プロデューサの接続に関する詳細情報が表示されます。

verbose

オプション。ページレット・プロデューサの接続詳細を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listPageletProducersによって、すべての接続プロパティが一覧表示されます。

0に設定した場合、listPageletProducersによって、接続名のみが一覧表示されます。この引数のデフォルトは、1です。

この引数を0に設定した場合、name引数を指定しないでください。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalに対して登録されているすべてのページレット・プロデューサの接続名および詳細を一覧表示します。

wls:/weblogic/serverConfig> listPageletProducers(appName='webcenter', verbose=1)

----------------------
MyPageletProducer
----------------------
URL: http://myhost.com:7001/pagelets
----------------------
TestPageletProducer
----------------------
URL: http://testhost.com:7002/pagelets
----------------------

次の例では、MyPageletProducerという名前の1つのページレット・プロデューサ接続の詳細を表示します。

wls:/weblogic/serverConfig> listPageletProducers(appName='webcenter',
name='MyPageletProducer', verbose=1)
----------------------
MyPageletProducer
----------------------
URL: http://myhost.com:7001/pagelets

2.14.15 deregisterPageletProducer

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定したアプリケーションに現在登録されているページレット・プロデューサを登録解除します。

構文

deregisterPageletProducer(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のページレット・プロデューサ接続の名前。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalに対して現在構成されているMyPageletProducerという名前のページレット・プロデューサ接続を登録解除します。

wls:/weblogic/serverConfig> deregisterPageletProducer(appName='webcenter',
name='MyPageletProducer')

2.14.16 refreshProducer

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

名前付きのプロデューサによって提供されたポートレットが反映されるようにそのプロデューサに対して格納したメタデータを最新の状態にします。

構文

refreshProducer(appName, producerName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

producerName

既存のプロデューサの名前を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、WebCenter Portal (webcenter)内のWSRPSamplesプロデューサを最新の状態にします。

wls:/weblogic/serverConfig> refreshProducer(appName='webcenter', producerName='WSRPSamples')

Producer WSRPSamples has been refreshed.

2.14.17 listPortletClientConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのポートレット・クライアントの構成を一覧表示します。

構文

listPortletClientConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalのポートレット・クライアント構成を一覧表示します。

wls:/weblogic/serverConfig> listPortletClientConfig(appName='webcenter')

-------------------------------------
Portlet Client Configuration Settings
-------------------------------------
Application Striping: 0
Content Cache Enabled: 0
Maximum Content Cache Objects: 2000
Maximum Content Cache Size: 10000000
Default Timeout: 30
Maximum IFrame Querystring Length: 0
Maximum Resource URL Length: 1500
Maximum Timeout: 60
Minimum Timeout: 2
Parallel Pool Size: 20
Parallel Queue Size: 40
Maximum Rendition Cache Objects: 1000
Resource Proxy Path: /resource-proxy
Supported Locales: en, de, fr

2.14.18 setPortletClientConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのポートレット・クライアントの構成を編集します。パラメータを省略した場合、対応する構成設定は変更されません。

注意:

このWLSTコマンドを使用して行った構成変更は、アプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

構文

setPortletClientConfig(appName, [applicationStriping, contentCacheEnabled,
contentCacheMaxObjects, contentCacheMaxSize, defaultTimeout,
maximumIframeQueryStringLength, maximumResourceUrlLength, maximumTimeout,
minimumTimeout, parallelPoolSize, parallelQueueSize,
renditionCacheMaxObjects, resourceProxyPath, supportedLocales, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

applicationStriping

オプション。アプリケーションのストライプ化を有効にするかどうかを指定します。有効な値は、1 (true)および0 (false)です。

デフォルト値は0 (false)です。

contentCacheEnabled

オプション。ポートレット・クライアントのコンテンツ・キャッシュを有効にするかどうかを指定します。有効な値は、1 (true)および0 (false)です。

デフォルト値は1 (true)です。

contentCacheMaxObjects

オプション。ポートレット・クライアントのコンテンツ・キャッシュに格納するオブジェクトの最大数。

デフォルト値は0 (無制限)です。

contentCacheMaxSize

オプション。ポートレット・クライアントのコンテンツ・キャッシュの最大サイズ(バイト単位)。

デフォルト値は0 (無制限)です。

defaultTimeout

オプション。プロデューサに対するリクエストのデフォルトのタイムアウト期間(秒単位)。

デフォルト値は10です。

maximumIframeQueryStringLength

オプション。URL短縮が適用されるまでのポートレット・インライン・フレームURLの最大長。

デフォルト値は0 (常にURLを短縮)です。

maximumResourceUrlLength

オプション。ポートレット・リソースURLの最大長。

デフォルト値は1500です。

maximumTimeout

オプション。プロデューサに対するリクエストの最大タイムアウト期間(秒単位)。

デフォルト値は300です。

minimumTimeout

オプション。プロデューサに対するリクエストの最小タイムアウト期間(秒単位)。

デフォルト値は1です。

parallelPoolSize

オプション。タスクのパラレル実行に使用するスレッドの数。

デフォルト値は10です。

parallelQueueSize

オプション。パラレル実行でキューに入れることができるタスクの数。

デフォルト値は20です。

renditionCacheMaxObjects

オプション。ポートレットをインライン・フレームにレンダリングするときに使用するポートレット・レンディションを格納するために、ポートレット・クライアントによって使用されるキャッシュ内のオブジェクトの最大数。

デフォルト値は25です。

resourceProxyPath

オプション。アプリケーションのコンテキスト・ルートからの相対位置で示した、ポートレット・リソース・プロキシ・サーブレットのベース・パス。

デフォルト値は/resourceproxyです。

supportedLocales

オプション。ポートレット・クライアントによってサポートされる1つ以上のロケールを指定します。デフォルト値はen (英語)です。複数のロケールをカンマで区切ります。

たとえば、supportedLocales='en,fr,de'などです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ContentCacheEnabled、MinimumTimeout、MaximumTimeoutおよびParallelQueueSize構成設定の新しい値を設定します。他のすべての設定は変更されません。

wls:/weblogic/serverConfig> setPortletClientConfig(appName='webcenter',
contentCacheEnabled=0, minimumTimeout=10, maximumTimeout=120,
parallelQueueSize=25)

次の例では、SupportedLocales構成設定の値を英語、フランス語およびスペイン語に設定します。他のすべての設定は変更されません。

wls:/weblogic/serverConfig> setPortletClientConfig(appName='webcenter',
supportedLocales='en, fr, es')

2.14.19 getPortletClientConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

特定のポートレット・クライアントの構成設定値、または指定されたアプリケーションのすべての設定値を返します。

構文

getPortletClientConfig(appName, [configSetting, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

configSetting

オプション。返すポートレット・クライアント構成設定の名前。次のいずれかの値になる。

ApplicationStriping

ContentCacheEnabled

ContentCacheMaxObjects

ContentCacheMaxSize

DefaultTimeout

MaximumIframeQueryStringLength

MaximumResourceUrlLength

MaximumTimeout

MinimumTimeout

ParallelPoolSize

ParallelQueueSize

RenditionCacheMaxObjects

ResourceProxyPath

SupportedLocales

注意: 値では大文字と小文字が区別されます。

すべての設定の名前と値を返す場合は、このパラメータを省略します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalに対するDefaultTimeout構成設定の値を返します。

wls:/weblogic/serverConfig> defaultTimeout =
getPortletClientConfig(appName='webcenter', configSetting='DefaultTimeout')

次の例では、WebCenter Portalのすべてのポートレット・クライアント構成設定の名前および値を返します。

wls:/weblogic/serverConfig> settingsDict =
getPortletClientConfig(appName='webcenter')

2.14.20 registerOOTBProducers

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WebCenter Portalにいくつかの即時利用可能なプロデューサ(OmniPortletおよびWSRP Tools)を登録します

構文

registerOOTBProducers(producerHost, producerPort, appName, [server,
applicationVersion])

引数

定義

producerHost

初期状態のプロデューサをホストするサーバーのホスト名およびIPアドレスを示します。

ロード・バランサによってフロント処理されるクラスタでは、そのロード・バランサのホスト名を入力します。

producerPort

初期状態のプロデューサをホストするサーバーのポート番号を示します。

ロード・バランサによってフロント処理されるクラスタでは、そのロード・バランサのポート番号を入力します。

appName

初期状態のプロデューサを登録するアプリケーションの名前を示します。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalに即時利用可能なプロデューサを登録します。

wls:/weblogic/serverConfig> registerOOTBProducers(producerHost='myhost.com',
producerPort=9999, appName='webcenter')

Registering Out-of-the-Box Producers
Registering producers at http://myhost.com:9999

Registering Omniportlet
Created connection wc-OmniPortlet-urlconn
Created connection wc-OmniPortlet
Producer connection wc-OmniPortlet has been registered.

Registering WSRP Tools
Created connection wc-WSRPTools-wsconn
Created connection wc-WSRPTools
Producer connection wc-WSRPTools has been registered.

2.14.21 deregisterOOTBProducers

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

組込みプロデューサ(OmniPortletおよびWSRPツール)をWebCenter Portalから登録解除します

構文

deregisterOOTBProducers(appName, [server, applicationVersion])

引数

定義

appName

現在、初期状態のプロデューサが登録されているアプリケーションの名前を示します。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、初期状態のプロデューサを登録解除し、WebCenter Portal内のそれらに関連付けられている接続を削除します。

wls:/weblogic/serverConfig> deregisterOOTBProducers(appName='webcenter')

Deregistering Out-of-the-Box Producers

Deregistering Omniportlet
Producer wc-OmniPortlet has been deregistered.
wc-OmniPortlet successfully deleted
wc-OmniPortlet-urlconn successfully deleted

Deregistering WSRP Tools
Producer wc-WSRPTools has been deregistered.
wc-WSRPTools successfully deleted
wc-WSRPTools-wsconn successfully deleted

2.14.22 registerSampleProducers

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle WebCenter Portalで提供されているサンプル・プロデューサを、指定したアプリケーションに登録します。WSRPサンプルおよびJPDKサンプルの2つのサンプル・プロデューサがあります。

構文

registerSampleProducers(producerHost, producerPort, appName, [server,
applicationVersion])

引数

定義

producerHost

サンプル・プロデューサをホストするサーバーのホスト名およびIPアドレスを示します。

producerPort

サンプル・プロデューサをホストするサーバーのポート番号を示します。

appName

サンプル・プロデューサを登録するアプリケーションの名前を示します。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalにサンプル・プロデューサを登録します。

wls:/weblogic/serverConfig> registerSampleProducers(producerHost='myhost.com',
producerPort=9999, appName='webcenter')

2.14.23 deregisterSampleProducers

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle WebCenterのサンプル・プロデューサ(WSRPサンプルおよびJPDKサンプル)を指定されたアプリケーションから登録解除します。

構文

deregisterSampleProducers(appName, [server, applicationVersion])

引数

定義

appName

現在、サンプル・プロデューサが登録されているアプリケーションの名前を示します。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

値を指定しない場合、この引数のデフォルトは、webcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalからサンプル・プロデューサを登録解除します。

wls:/weblogic/serverConfig> deregisterSampleProducers(appName='webcenter')

2.15 プロキシ・サーバー

表2-22に示すコマンドを使用して、指定されたアプリケーション内のツールおよびサービスによって使用されるプロキシ・サーバー設定を管理します。

これらのWLSTコマンドを使用して設定に対して行った変更は、アプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

表2-22 RSS WLSTコマンド

使用するコマンド

目的

WLSTでの使用

getWebCenterProxyConfig

ツールおよびサービスによって使用されるプロキシ・ホストとプロキシ・ポートを返します。

オンライン

setWebCenterProxyConfig

ツールおよびサービスによって使用されるプロキシ・ホストとプロキシ・ポートを指定します。

オンライン

unsetWebCenterProxyConfig

プロキシ・ホストおよびプロキシ・ポート設定を削除します。

オンライン

2.15.1 getWebCenterProxyConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーション内のRSSニュース・フィードおよびアクティビティ・ストリームによって使用されるプロキシ・ホストとプロキシ・ポートを返します。ネットワーク構成によっては、ご使用のアプリケーションでアクティビティ・ストリームの外部RSSニュース・フィードおよび外部リンクを表示するために、プロキシ詳細が必要な場合があります。

構文

getWebCenterProxyConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)内のツールおよびサービスによって使用されるプロキシ・ホストおよびプロキシ・ポートを返します。

wls:/weblogic/serverConfig> getWebCenterProxyConfig(appName='webcenter')

2.15.2 setWebCenterProxyConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーション内のRSSニュース・フィードおよびアクティビティ・ストリームによって使用されるプロキシ・ホストとプロキシ・ポートを指定します。ネットワーク構成によっては、ご使用のアプリケーションでアクティビティ・ストリームの外部RSSニュース・フィードおよび外部リンクを表示するために、プロキシ詳細が必要な場合があります。

構文

setWebCenterProxyConfig(appName, proxyHost, proxyPort, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

proxyHost

プロキシ・サーバーのホスト名を示します。

proxyPort

プロキシ・サーバーが実行しているポートを示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)内のツールおよびサービスによって使用されるプロキシ・ホストおよびプロキシ・ポートを設定します。

wls:/weblogic/serverConfig> setWebCenterProxyConfig(appName='webcenter',
proxyHost='www-proxy.example.com', proxyPort='80')

2.15.3 unsetWebCenterProxyConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定したアプリケーションに対して構成された現在のプロキシ・ホストおよびプロキシ・ポート設定を削除します。

構文

unsetWebCenterProxyConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)に対して構成されたプロキシ・ホストおよびプロキシ・ポート設定を削除します。

wls:/weblogic/serverConfig> unsetWebCenterProxyConfig(appName='webcenter')

2.16 検索 - Oracle SES検索

表2-23に示すコマンドを使用して、WebCenter PortalのためのOracle Secure Enterprise Search (SES)接続および他のOracle SES検索関連プロパティを管理します。

これらのWLSTコマンドを使用して設定に対して行った変更は、アプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

表2-23 検索 - Oracle SES WLSTコマンド

使用するコマンド

目的

WLSTでの使用

createSESConnection

指定されたアプリケーション用のOracle SESインスタンスへの接続を作成します。

オンライン

setSESConnection

既存のOracle SES検索接続を編集します。

オンライン

listSESConnections

指定したアプリケーションに対して構成されている個々またはすべてのOracle SES検索接続を一覧表示します。

オンライン

setSearchSESConfig

既存のOracle SES検索接続の検索設定を構成します。

オンライン

listSearchSESConfig

指定されたアプリケーションのOracle SESプロパティを一覧表示します。

オンライン

createFederationTrustedEntity

Oracle (SES)インスタンス上にフェデレーション・トラステッド・エンティティを作成します。

オンライン

setSESVersion

指定したアプリケーションに対して現在構成されているOracle SESインスタンスのバージョン情報を取得および格納します。

オンライン

listSESVersion

指定したアプリケーションに対して構成されているOracle SESインスタンスのバージョン情報を返します。

オンライン

createDefaultSourceGroup

デフォルトのドキュメント、ディスカッションおよびお知らせソースを使用して、Oracle SESインスタンス内にソース・グループを作成します。

オンライン

2.16.1 createSESConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのOracle Secure Enterprise Search (SES)インスタンスへの接続を作成します。

構文

createSESConnection(appName, name, url, appUser, appPassword,[default, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

接続の名前を示します。名前は、アプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

url

Oracle Secure Enterprise Searchによって検索の要求を有効にするために公開されたWebサービスのURLを示します。

次の形式を使用します。

http://host:port/search/query/OracleSearch

appUser

WebCenter Portalユーザーのかわりに検索を実行できるよう、Oracle Secure Enterprise Searchに対して信頼されるアプリケーションとして自身を認証するために、アプリケーションで使用するユーザー名。

指定したユーザーは、アプリケーションに対して構成したOracle Identity ManagementサーバーおよびOracle SESに対して構成したOracle Identity Managementサーバーの両方に存在する必要があります。

appPassword

指定したユーザーのパスワードを示します。

default

オプション。検索接続を積極的に使用するために検索を構成します。有効なオプションは、1 (true)および0 (false)です。

1に設定すると、使用されているその他の検索接続が置き換えられます。

0に設定すると、現在の検索構成は変更されません。

この引数のデフォルトは、0です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Oracle SESインスタンスhttp://myhost.com:7777/search/query/OracleSearchを指す新しい検索接続を作成し、この接続を、WebCenter PortalのアクティブなSES検索接続として設定します。

wls:/weblogic/serverConfig>createSESConnection(appName='webcenter', name='SESConn1',
url='http://myhost.com:7777/search/query/OracleSearch', appUser='wpadmin',
appPassword='password', default=1)

2.16.2 setSESConnection

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションの既存のOracle Secure Enterprise Search (SES)検索接続を編集します。

構文

setSESConnection(appName, name, [url, appUser, appPassword, default, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存の検索接続の名前を示します。

url

オプション。Oracle Secure Enterprise Searchによって検索の要求を有効にするために公開されたWebサービスのURLを示します。

次の形式を使用します。

http://host:port/search/query/OracleSearch

appUser

オプション。ポータル・ユーザーのかわりに検索を実行できるよう、アプリケーションでOracle Secure Enterprise Searchにログインするために使用するユーザー名。

appPassword

オプション。ポータル・ユーザーのかわりに検索を実行できるよう、アプリケーションでOracle Secure Enterprise Searchにログインするために使用するパスワード。

default

オプション。検索接続を積極的に使用するために検索を構成します。有効なオプションは、1 (true)および0 (false)です。

1に設定すると、使用されているその他の検索接続が置き換えられます。

0に設定すると、現在の検索構成は変更されません。

この引数のデフォルトは、0です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、SESConn1という名前の検索接続のURLを変更し、この接続をWebCenter PortalのアクティブなOracle SES検索接続として設定します。

wls:/weblogic/serverConfig> etSESConnection(appName='webcenter', name='SESConn1',
url='http://myhost.com:7777/search/query/OracleSearch', appUser='wpadmin',
appPassword='password', default=1)

2.16.3 listSESConnections

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定したアプリケーションに対して構成されているすべてのOracle Secure Enterprise Search (SES)検索接続の名前を一覧表示します。

構文

listSESConnections(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

verbose

オプション。検索接続に関する詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listSESConnectionsによって、アプリケーションに対して構成されているすべてのSES検索接続およびその詳細が一覧表示されます。

0に設定した場合、listSESConnectionsによって、接続名のみ一覧表示されます。

この引数のデフォルトは、0です。

この引数を0に設定した場合、name引数を指定しないでください。

name

オプション。既存の検索接続の名前を示します。この引数を使用して、特定の接続の詳細情報を表示できます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalに対して構成されているすべてのOracle SES検索接続の接続詳細を表示します。

wls:/weblogic/serverConfig>listSESConnections(appName='webcenter', verbose=1)

次の例では、SESConn1という名前のOracle SES検索接続の接続詳細を表示します。

wls:/weblogic/serverConfig>listSESConnections(appName='webcenter', verbose=1, name='SESConn1')

2.16.4 setSearchSESConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

既存のOracle Secure Enterprise Search (SES)検索接続の検索設定を設定します。パラメータを指定しない場合、検索設定が変更されません。

構文

setSearchSESConfig(appName,[connectionName, dataGroup, topNRows, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

connectionName

オプション。検索に使用する接続の名前。

dataGroup

オプション。検索を行うSecure Enterpriseの検索データ・グループの名前を指定します。値を指定しない場合、Oracle Secure Enterprise Searchインスタンス中のすべての項目が検索されます。

topNRows

オプション。調整されたデータを収集するために検索結果の一番上のN行数を示します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、検索でSESConn1という名前のSES検索接続を使用してgroup2という名前のデータ・グループを検索することを指定します。

wls:/weblogic/serverConfig>setSearchSESConfig(appName='webcenter',connectionName='SESConn1', dataGroup='group2', topNRows=200);

次の例では、検索により返される結果の最大数を変更します。この例では、接続の名前が指定されていないので、構成に関する変更が現在のデフォルト(またはアクティブ)接続に適用されます。

wls:/weblogic/serverConfig>setSearchSESConfig(appName='webcenter', topNRows=500);
Already in Domain Runtime Tree
Restart is needed for the service connection changes to take effect.

2.16.5 listSearchSESConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのOracle SES検索設定を一覧表示します。

構文

listSearchSESConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)のOracle SES検索構成情報を表示します。

wls:/weblogic/serverConfig>listSearchSESConfig(appName='webcenter')
Already in Domain Runtime Tree
-----------------
Search SES Config
-----------------
connectionName:  SESConn1
dataGroup:  group2
topNRows:  200

2.16.6 createFederationTrustedEntity

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたエンティティ名およびパスワードに対するフェデレーション・トラステッド・エンティティをOracle Secure Enterprise Search (SES)インスタンス上に作成します。

構文

createFederationTrustedEntity(appName, sesUrl, sesPassword, entityName, entityPassword, desc,  [sesSchema, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。

次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

entityName

エンティティ名。

entityPassword

エンティティ・パスワード。

desc

エンティティの簡単な説明。

または、空の文字列''を指定します。

sesSchema

Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myEntityという名前のフェデレーション・トラステッド・エンティティをOracle SESインスタンスhttp://myseshost.com:7777/search/query/OracleSearch上に作成します。

wls:/weblogic/serverConfig>
createFederationTrustedEntity(appName='webcenter',
sesUrl='http://myseshost.com:7777/search/api/admin/AdminService',
sesSchema='eqsys', sesPassword='password', entityName='myEntity',
entityPassword='password', desc='This is a my sample entity')

2.16.7 setSESVersion

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定したアプリケーションに対して構成されているOracle Secure Enterprise Search (SES)インスタンスのバージョン情報を取得し、そのバージョンを後から検索問合せに使用するために格納します。

バージョン情報は、Oracle SES接続が検索問合せのデフォルト接続として設定されている場合に使用されます。

構文

setSESVersion(appName, sesUrl, sesSchema, sesPassword, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。

次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesSchema

Oracle SES管理ユーザーのユーザー名。たとえば、searchsysなどです。

sesPassword

Oracle SES管理ユーザーのパスワード。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Oracle SESインスタンスhttp://myhost.com:7777/search/query/OracleSearchのバージョン情報を取得し、その情報をWebCenter Portalで使用できるようにします。

wls:/weblogic/serverConfig>setSESVersion(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='searchsys', sesPassword='password')

2.16.8 listSESVersion

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションによって使用されているOracle Secure Enterprise Search (SES)インスタンスのバージョン番号を返します。

構文

listSESVersion(appName, sesUrl, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。

次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesUrl

Oracle SES管理APIのWebサービスURL。

次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesSchema

Oracle SES管理ユーザーのユーザー名。たとえば、searchsysなどです。

sesPassword

Oracle SES管理ユーザーのパスワード。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Oracle SESインスタンスhttp://myhost.com:7777/search/query/OracleSearchのバージョン情報を返し、そのバージョン情報がWebCenter Portal内に保存されていることを確認します。

wls:/weblogic/serverConfig>listSESVersion(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService')

-----------------
SES Version Config
-----------------
url:  http://myhost.com:7777/search/api/admin/AdminService
version:  11.1.2.2.0

2.16.9 createDefaultSourceGroup

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

特定のホスト、ポート、アプリケーション名、共有ドキュメント、ディスカッション・ソースおよびお知らせソースに対するデフォルト名のソース・グループをOracle Secure Enterprise Search (SES)インスタンス内に作成します。

構文

createDefaultSourceGroup(appName, sesUrl, sesPassword, host, port, defaultHost, defaultPort, [sesSchema, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。

次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザーのパスワード。

host

アプリケーションを実行しているマシンのホスト名。

ポート

アプリケーションにアクセスするために使用されるポート番号。

defaulthost

デフォルト・ソースが構成されているマシンのホスト名。

defaultport

デフォルト・ソースの構成先で使用されているポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://webhost:8888/webcenterにあるWebCenter Portalに対するデフォルト・ソース・グループを、Oracle SESインスタンスhttp://myhost.com:7777/search/query/OracleSearch内に作成します

デフォルト・ソース・グループには、http://mydefaultHost:8989にあるドキュメントおよびディスカッション・ソースも含まれます。

wls:/weblogic/serverConfig>createDefaultSourceGroup(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService',
sesSchema='eqsys', sesPassword='password', host='webhost', port='8888', defaultHost='mydefaultHost', defaultPort='8989')

2.17 検索 - Oracle SES検索クローラ

表2-24に示すコマンドを使用して、WebCenter PortalのOracle Secure Enterprise Search (SES)クローラを管理します。

Oracle SESクローラWLSTコマンドを実行した後に、アプリケーションを再起動する必要はありません。

表2-24 検索 - Oracle SESクローラWLSTコマンド

使用するコマンド

目的

WLSTでの使用

createSpacesCrawler

Oracle SESインスタンス上にWebCenter Portalオブジェクトのクローラを作成します。

オンライン

createDocumentsCrawler

指定されたアプリケーション用のドキュメント・クローラをOracle SESインスタンス上に作成します。

オンライン

createDiscussionsCrawler

指定されたアプリケーション用のディスカッション・クローラとお知らせクローラをOracle SESインスタンス上に作成します。

オンライン

listSpacesCrawler

Oracle SESインスタンス上でWebCenter Portalに対して構成されているSpacesクローラを返します。

オンライン

listDocumentsCrawler

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているドキュメント・クローラを返します。

オンライン

listDiscussionsCrawler

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを返します。

オンライン

startSpacesCrawler

Oracle SESインスタンス上でWebCenter Portalに対して構成されているSpacesクローラを起動します。

オンライン

startDocumentsCrawler

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているドキュメント・クローラを起動します。

オンライン

startDiscussionsCrawler

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを起動します。

オンライン

stopSpacesCrawler

Oracle SESインスタンス上でWebCenter Portalに対して構成されているSpacesクローラを停止します。

オンライン

stopDocumentsCrawler

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているドキュメント・クローラを停止します。

オンライン

stopDiscussionsCrawler

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを停止します。

オンライン

deleteSpacesCrawler

Oracle SESインスタンス上でWebCenter Portalに対して構成されているSpacesクローラを削除します。

オンライン

deleteDocumentsCrawler

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているドキュメント・クローラを削除します。

オンライン

deleteDiscussionsCrawler

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを削除します。

オンライン

2.17.1 createSpacesCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上にWebCenter Portalオブジェクトのクローラを作成します。このコマンドは、WebCenter Portalデータソースを作成し、WebCenter Portalオブジェクト(ポータル、リスト、ページ、ピープルなど)をクロールするためのスケジュールを指定します。

構文

createSpacesCrawler(appName,  host, port, sesUrl, sesPassword, crawlUser,
crawlPassword, scratchDir, authUserIdFormat, crawlingMode, recrawlPolicy,
freqType, startHour, hoursBetweenLaunches, startDayOfWeek, startDayOfMonth,
daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches, [server,
applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

host

WebCenter Portalを実行しているマシンのホスト名。

ポート

WebCenter Portalにアクセスするために使用されるポート番号。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

crawlUser

WebCenter Portalのクロール管理ユーザー。

このユーザーは、WebCenter Portalとバックエンドのアイデンティティ管理サーバーに存在する必要があり、適切な権限とロールが付与されている必要があります。たとえば、mycrawladminです

crawlPassword

crawlUser引数で指定されているWebCenter Portalユーザーのパスワード。

scratchDir

Oracle SESが一時ステータス・ログを書き込めるローカル・ディレクトリ。このディレクトリは、Oracle SESがインストールされているシステム上に存在する必要があります。

authUserIdFormat

アクティブ・アイデンティティ・プラグインのユーザーIDの形式。たとえば、ユーザー名、電子メール、ニックネーム、user_name。

crawlingMode

ソース内のURLをクロールするためのモード。デフォルト・モードは、ACCEPT_ALLです。有効な値は、ACCEPT_ALL、INDEX_ONLY、EXAMINE_URLです。

ACCEPT_ALL: 索引付けのためにすべてのURLを自動的に受け入れます。ソース内のすべてのURLをクロールおよび索引付けします。それらのURL内で見つかったすべてのリンクの抽出および索引付けも行います。前にクロールされたURLは、それらが変更されていた場合にのみ再索引付けされます。

EXAMINE_URL: 索引付けする前にURLを確認します。ソース内のすべてのURLをクロールしますが、索引付けは行いません。それらのURL内で見つかったすべてのリンクのクロールも行います。

INDEX_ONLY: 索引付けのみ行います。ソース内のすべてのURLをクロールし、索引付けします。それらのURL内で見つかったどのリンクも抽出しません。このオプションは、前にEXAMINE_URLを使用してクロールされたソースに対して選択します。

recrawlPolicy

すべてのドキュメントをクロールするか、変更されたドキュメントのみクロールするのかを指定します。有効な値は、PROCESS_ALLおよびPROCESS_CHANGEDです。

PROCESS_ALL - すぺてのドキュメントがクロールされます。このオプションは、フル・クロールを強制するために使用します。

PROCESS_CHANGED - 前回のクロール以降に変更されたドキュメントのみクロールします。この設定で、クローリング・プロセスを大幅に高速化できます。

freqType

スケジュール済クロールの頻度。有効な値は、MANUAL、MONTHLY、WEEKLY、DAILY、HOURLYです。

クロールをMONTHLY、WEEKLY、DAILYまたはHOURLYにスケジュールするには、追加の引数を次のように指定します。

MONTHLY: startHour、startDayOfTheMonth、monthsBetweenLaunches

WEEKLY: startHour、startDayOfTheWeek、weeksBetweenLaunches

DAILY: startHour、daysBetweenLaunches

HOURLY: hoursBetweenLaunches

定期的なクロールが不要な場合は、MANUALを選択し、startSpacesCrawlerコマンドを使用して、クロールを手動で開始します。

startHour

クロールを開始する時刻。1と24の間の任意の数字。

たとえば、2:00amであれば2、2:00pmであれば14を入力します。

hoursBetweenLaunches

クロール間の時間数。

freqType='HOURLY'の場合にのみ有効です。

startDayOfWeek

週ごとのクロールを開始する曜日。たとえば、MONDAY、TUESDAYなどです。

freqType='WEEKLY'の場合にのみ有効です。

startDayOfMonth

月ごとのクロールを開始する日。たとえば、1日の場合は1、2日の場合は2のように入力します。

freqType='MONTHLY'の場合にのみ有効です。

daysBetweenLaunches

クロール間の日数。

freqType='DAILY'の場合にのみ有効です。

weeksBetweenLaunches

クロール間の週数。

freqType='WEEKLY'の場合にのみ有効です。

monthsBetweenLaunches

クロール間の月数。

freqType='MONTHLY'の場合にのみ有効です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portal (webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上にSpacesクローラを作成します。

createSpacesCrawler(appName='webcenter', host='myhost.com', port='8888',
sesUrl='http://myseshost.com:7777/search/api/admin/AdminService',
sesPassword='sespassword', crawlUser='mycrawladmin', crawlPassword='password',
scratchDir'/tmp', authUserIdFormat='username', crawlingMode='ACCEPT_ALL',
recrawlPolicy= 'PROCESS_ALL', freqType='MANUAL', startHour=1,
hoursBetweenLaunches=1, startDayOfWeek='MONDAY', startDayOfMonth=1, daysBetweenLaunches =1, weeksBetweenLaunches=1, monthsBetweenLaunches=1)

2.17.2 createDocumentsCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーション用のドキュメント・クローラをOracle SESインスタンス上に作成します。

このコマンドは、Oracle WebCenter Contentリポジトリ・データソースを作成し、Oracle WebCenter Contentリポジトリ内のドキュメントをクロールするスケジュールを指定します。

構文

createDocumentsCrawler(appName,  host, port, sesUrl, sesPassword, configUrl,
user, password, scratchDir, httpEndpoint, displayUrl, realm, authUserIdFormat,
pipelineName, crawlingMode, recrawlPolicy, freqType, startHour,
hoursBetweenLaunches, startDayOfWeek, startDayOfMonth,
daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches,
[server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

host

アプリケーションを実行しているマシンのホスト名。

ポート

アプリケーションにアクセスするために使用されるポート番号。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

configUrl

データ・フィード・タイプ、場所、セキュリティ属性など、ソースの詳細を提供するXML構成ファイルのURL。次のURL形式を使用します。

http://host:port/cs/idcplg?IdcService=SES_CRAWLER_DOWNLOAD_CONFIG&source=sourcename

user

Oracle WebCenter ContentのContent Serverの管理ユーザー。例, sysadmin。

認証タイプがOracle SSOである場合、Oracle SSOによってフロント処理されているアイデンティティ管理サーバーにユーザーのユーザーID(およびパスワード)を入力します。このユーザーには、sysadminと同じパーミッションを付与する必要があります。それらのパーミッションを付与できない場合は、Content Serverでこのユーザーに対応するリモート・ユーザーを削除し、Content Serverにそのユーザー(同じ名前)のローカル・バージョンを作成します。

password

指定した管理ユーザーのパスワード。

scratchDir

Oracle SESが一時ステータス・ログを書き込めるローカル・ディレクトリ。このディレクトリは、Oracle SESがインストールされているシステム上に存在する必要があります。

httpEndpoint

Content Server認可のためのHTTPエンドポイント。次に例を示します。

http://host:port/idc/idcplg

displayUrl

相対アクセスURLの前に付けて完全な表示URLを形成するHTTPホスト情報文字列。次に例を示します。

http://host:port/idc

realm

制御およびデータ・フィードを提供するアプリケーションのレルム。このパラメータは、フィードにHTTPを介してアクセスしている場合に適しており、認証タイプがBASICである場合に必須です。

たとえば、jazn.comです

authUserIdFormat

Content Server認可APIによって使用される(アクティブ・アイデンティティ・プラグイン内の)ユーザーIDの形式。たとえば、ユーザー名、電子メール、ニックネーム、user_name。

pipelineName

Oracle SES内で、このソースに対して作成されるドキュメント・サービス・パイプライン。

crawlingMode

ソース内のURLをクロールするためのモード。デフォルト・モードは、ACCEPT_ALLです。有効な値は、ACCEPT_ALL、INDEX_ONLY、EXAMINE_URLです。

ACCEPT_ALL: 索引付けのためにすべてのURLを自動的に受け入れます。ソース内のすべてのURLをクロールおよび索引付けします。それらのURL内で見つかったすべてのリンクの抽出および索引付けも行います。前にクロールされたURLは、それらが変更されていた場合にのみ再索引付けされます。

EXAMINE_URL: 索引付けする前にURLを確認します。ソース内のすべてのURLをクロールしますが、索引付けは行いません。それらのURL内で見つかったすべてのリンクのクロールも行います。

INDEX_ONLY: 索引付けのみ行います。ソース内のすべてのURLをクロールし、索引付けします。それらのURL内で見つかったどのリンクも抽出しません。このオプションは、前にEXAMINE_URLを使用してクロールされたソースに対して選択します。

recrawlPolicy

すべてのドキュメントをクロールするか、変更されたドキュメントのみクロールするのかを指定します。有効な値は、PROCESS_ALLおよびPROCESS_CHANGEDです。

PROCESS_ALL - すぺてのドキュメントがクロールされます。このオプションは、フル・クロールを強制するために使用します。

PROCESS_CHANGED - 前回のクロール以降に変更されたドキュメントのみクロールします。この設定で、クローリング・プロセスを大幅に高速化できます。

freqType

スケジュール済クロールの頻度。有効な値は、MANUAL、MONTHLY、WEEKLY、DAILY、HOURLYです。

クロールをMONTHLY、WEEKLY、DAILYまたはHOURLYにスケジュールするには、追加の引数を次のように指定します。

MONTHLY: startHour、startDayOfTheMonth、monthsBetweenLaunches

WEEKLY: startHour、startDayOfTheWeek、weeksBetweenLaunches

DAILY: startHour、daysBetweenLaunches

HOURLY: hoursBetweenLaunches

定期的なクロールが不要な場合は、MANUALを選択し、startDocumentsCrawlerコマンドを使用して、クロールを手動で開始します。

startHour

クロールを開始する時刻。1と24の間の任意の数字。

たとえば、2:00amであれば2、2:00pmであれば14を入力します。

hoursBetweenLaunches

クロール間の時間数。

freqType='HOURLY'の場合にのみ有効です。

startDayOfWeek

週ごとのクロールを開始する曜日。たとえば、MONDAY、TUESDAYなどです。

freqType='WEEKLY'の場合にのみ有効です。

startDayOfMonth

月ごとのクロールを開始する日。たとえば、1日の場合は1、2日の場合は2のように入力します。

freqType='MONTHLY'の場合にのみ有効です。

daysBetweenLaunches

クロール間の日数。

freqType='DAILY'の場合にのみ有効です。

weeksBetweenLaunches

クロール間の週数。

freqType='WEEKLY'の場合にのみ有効です。

monthsBetweenLaunches

クロール間の月数。

freqType='MONTHLY'の場合にのみ有効です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portal (webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上にドキュメント・クローラを作成します。

createDocumentsCrawler(appName='webcenter', host='myhost.com', port='8888',
sesUrl='http://myseshost.com:7777/search/api/admin/AdminService',
sesPaswword='password',
configUrl='http://myucmhost.com:9044/cs/idcplg?IdcService=SES_CRAWLER_DOWNLOAD_ CONFIG&source=mysource',
user='adminuser', password='password', scratchDir='/scratch',
httpEndpoint='http://myucmhost.com:9044/cs/idcplg',
displayUrl='http://myucmhost:9044/cs', realm='jazn.com', authUserIdFormat='username',
pipelineName='My UCM Pipeline', crawlingMode='ACCEPT_ALL',
recrawlPolicy='PROCESS_ALL', freqType='MANUAL', startHour=1,
hoursBetweenLaunches=1, startDayOfWeek='MONDAY', startDayOfMonth=1,
daysBetweenLaunches=1, weeksBetweenLaunches=1, monthsBetweenLaunches=1)

2.17.3 createDiscussionsCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle Secure Enterprise Search (SES)インスタンス上で、指定されたアプリケーションに対してディスカッション・フォーラム・クローラおよびお知らせクローラを作成します。

このコマンドは、2つのOracle SESデータベース・ソース(ディスカッション・フォーラム用に1つと、お知らせ用に1つ)を作成し、クロール・スケジュールを指定します。ディスカッション・フォーラム・ソースは、<appname_host_port>_forumsという名前で、FORUMCRAWLER_VWというビューがあり、お知らせソースは<appname_host_port>_announcementsという名前で、ANNOUNCEMENTS_VWというビューがあります。

構文

createDiscussionsCrawler(appName,  host, port, sesUrl, sesPassword,
dbConnString, user, password, authUserIdFormat, crawlingMode,
recrawlPolicy, freqType, startHour, hoursBetweenLaunches, startDayOfWeek,
startDayOfMonth, daysBetweenLaunches, weeksBetweenLaunches,
monthsBetweenLaunches, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

host

アプリケーションを実行しているマシンのホスト名。

ポート

アプリケーションにアクセスするために使用されるポート番号。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

dbConnString

ディスカッション・サーバーがインストールされているデータベースの接続URL。次の形式を使用します。

Oracle: jdbc:oracle:thin:@<host>:<port>/<oracle-sid>

IBM DB2: jdbc:db2://<host>:<port>/<database_name>

Microsoft SQL Server: jdbc:sqlserver://<host_or_IP_address>:<port>/<database_name>

user

ディスカッション・サーバーがインストールされているデータベースの管理ユーザー。

Oracle: ユーザーMyPrefix_DISCUSSIONS_CRAWLERがインストール中に作成されます。

IBM DB2: ユーザーMyPrefix_DCがインストール中に作成されます(MyPrefixは5文字)。

Microsoft SQL Server: ユーザーMyPrefix_DISCUSSIONS_CRAWLERがインストール中に作成されます。

password

指定したディスカッション・サーバー管理ユーザーのパスワード。

authUserIdFormat

ディスカッション・サーバー認可APIによって使用される(アクティブ・アイデンティティ・プラグイン内の)ユーザーIDの形式。たとえば、ユーザー名、電子メール、ニックネーム、user_name。

crawlingMode

ソース内のURLをクロールするためのモード。デフォルト・モードは、ACCEPT_ALLです。有効な値は、ACCEPT_ALL、INDEX_ONLY、EXAMINE_URLです。

ACCEPT_ALL: 索引付けのためにすべてのURLを自動的に受け入れます。ソース内のすべてのURLをクロールおよび索引付けします。それらのURL内で見つかったすべてのリンクの抽出および索引付けも行います。前にクロールされたURLは、それらが変更されていた場合にのみ再索引付けされます。

EXAMINE_URL: 索引付けする前にURLを確認します。ソース内のすべてのURLをクロールしますが、索引付けは行いません。それらのURL内で見つかったすべてのリンクのクロールも行います。

INDEX_ONLY: 索引付けのみ行います。ソース内のすべてのURLをクロールし、索引付けします。それらのURL内で見つかったどのリンクも抽出しません。このオプションは、前にEXAMINE_URLを使用してクロールされたソースに対して選択します。

recrawlPolicy

すべてのドキュメントをクロールするか、変更されたドキュメントのみクロールするのかを指定します。有効な値は、PROCESS_ALLおよびPROCESS_CHANGEDです。

PROCESS_ALL - すぺてのドキュメントがクロールされます。このオプションは、フル・クロールを強制するために使用します。

PROCESS_CHANGED - 前回のクロール以降に変更されたドキュメントのみクロールします。この設定で、クローリング・プロセスを大幅に高速化できます。

freqType

スケジュール済クロールの頻度。有効な値は、MANUAL、MONTHLY、WEEKLY、DAILY、HOURLYです。

クロールをMONTHLY、WEEKLY、DAILYまたはHOURLYにスケジュールするには、追加の引数を次のように指定します。

MONTHLY: startHour、startDayOfTheMonth、monthsBetweenLaunches

WEEKLY: startHour、startDayOfTheWeek、weeksBetweenLaunches

DAILY: startHour、daysBetweenLaunches

HOURLY: hoursBetweenLaunches

定期的なクロールが不要な場合は、MANUALを選択し、startDiscussionsCrawlerコマンドを使用して、クロールを手動で開始します。

startHour

クロールを開始する時刻。1と24の間の任意の数字。

たとえば、2:00amであれば2、2:00pmであれば14を入力します。

hoursBetweenLaunches

クロール間の時間数。

freqType='HOURLY'の場合にのみ有効です。

startDayOfWeek

週ごとのクロールを開始する曜日。たとえば、MONDAY、TUESDAYなどです。

freqType='WEEKLY'の場合にのみ有効です。

startDayOfMonth

月ごとのクロールを開始する日。たとえば、1日の場合は1、2日の場合は2のように入力します。

freqType='MONTHLY'の場合にのみ有効です。

daysBetweenLaunches

クロール間の日数。

freqType='DAILY'の場合にのみ有効です。

weeksBetweenLaunches

クロール間の週数。

freqType='WEEKLY'の場合にのみ有効です。

monthsBetweenLaunches

クロール間の月数。

freqType='MONTHLY'の場合にのみ有効です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portal (webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上にディスカッション・フォーラム・クローラおよびお知らせクローラを作成します。

createDiscussionsCrawler(appName='webcenter', host='myhost.com', port='8888',
sesUrl='http://myseshost.com:7777/search/api/admin/AdminService',
sesPaswword='password', dbConnString='jdbc:oracle:thin:@myjivedbhost.com:1521/mysid',
user='app_discussions_crawler', password='password',
authUserIdFormat='nickname', crawlingMode='ACCEPT_ALL',
recrawlPolicy='PROCESS_ALL', freqType='MANUAL', startHour=1,
hoursBetweenLaunches=1,startDayOfWeek='MONDAY',
startDayOfMonth=1, daysBetweenLaunches=1,
weeksBetweenLaunches=1, monthsBetweenLaunches=1)

2.17.4 listSpacesCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalに対して構成されているSpacesクローラを返します。

構文

listSpacesCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, verbose,
server, applicationVersion]

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalを実行しているマシンのホスト名。

ポート

WebCenter Portalにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

verbose

オプション。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listSpacesCrawlerによって、Oracle SESでWebCenter Portalに対して構成されているSpacesクローラおよび詳細が返されます。

0に設定すると、ソース名のみが一覧表示されます。この引数のデフォルトは、0です。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portalに対してOracle SESインスタンスhttp://myseshost.com:7777内で構成されているSpacesクローラを返します。

listSpacesCrawler(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword'password', host='myhost.com', port='8888')

Already in Domain Runtime Tree
-----------------
Spaces Crawlers
-----------------
webcenter_myhost.com_8888_portal

2.17.5 listDocumentsCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているドキュメント・クローラを返します。

構文

listDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, verbose, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

アプリケーションを実行しているマシンのホスト名。

ポート

アプリケーションにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

verbose

オプション。有効なオプションは、1 (true)および0 (false)です。

1に設定した場合、listDocumentsCrawlerによって、Oracle SESでアプリケーションに対して構成されているドキュメント・クローラおよび詳細が返されます。

0に設定すると、ソース名のみが一覧表示されます。この引数のデフォルトは、0です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portal (webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777内で構成されているドキュメント・クローラを返します。

listDocumentsCrawler(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword'password', host='myhost.com', port='8888')

Already in Domain Runtime Tree
-----------------
Documents Crawlers
-----------------
webcenter_myhost.com_8888_documents

2.17.6 listDiscussionsCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを返します。

構文

listDiscussionsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, verbose,  server, applicationVersion]

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

アプリケーションを実行しているマシンのホスト名。

ポート

アプリケーションにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

verbose

オプション。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listDiscussionsCrawlerによって、Oracle SESでアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラ、およびそれらの詳細が返されます。0に設定すると、ソース名のみが一覧表示されます。この引数のデフォルトは、0です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portalに対してOracle SESインスタンスhttp://myseshost.com:7777内で構成されているディスカッション・クローラとお知らせクローラを返します。

listDiscussionsCrawler(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')

Already in Domain Runtime Tree
-----------------
Discussions Crawler
-----------------
webcenter_myhost.com_8888_forums
webcenter_myhost.com_8888_announcements

2.17.7 startSpacesCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalに対して構成されているSpacesクローラを起動します。

構文

startSpacesCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalを実行しているマシンのホスト名。

ポート

WebCenter Portalにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portal (webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているSpacesクローラを起動します。

startSpacesCrawler(appName='webcenter',
sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')

2.17.8 startDocumentsCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているドキュメント・クローラを起動します。

構文

startDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion]

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

アプリケーションを実行しているマシンのホスト名。

ポート

アプリケーションにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portal (webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているドキュメント・クローラを起動します。

startDocumentsCrawler(appName='webcenter',
sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')

2.17.9 startDiscussionsCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle Secure Enterprise Search (SES)インスタンス上で指定したアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを起動します。

構文

startDiscussionsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

アプリケーションを実行しているマシンのホスト名。

ポート

アプリケーションにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portal (webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているディスカッション・クローラとお知らせクローラを起動します。

startDiscussionsCrawler(appName='webcenter',
sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')

2.17.10 stopSpacesCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalに対して構成されているSpacesクローラを停止します。

構文

stopSpacesCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalを実行しているマシンのホスト名。

ポート

WebCenter Portalにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portalに対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているSpacesクローラを停止します。

stopSpacesCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')

2.17.11 stopDocumentsCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているドキュメント・クローラを停止します。

構文

stopDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

アプリケーションを実行しているマシンのホスト名。

ポート

アプリケーションにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portalに対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているドキュメント・クローラを停止します。

stopDocumentsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')

2.17.12 stopDiscussionsCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを停止します。

構文

stopDiscussionsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

アプリケーションを実行しているマシンのホスト名。

ポート

アプリケーションにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portalに対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているディスカッション・クローラとお知らせクローラを停止します。

stopDiscussionsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')

2.17.13 deleteSpacesCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalに対して構成されているSpacesクローラを削除します。

構文

deleteSpacesCrawler(appName, sesUrl, sesPassword, host, port,[sesSchema, server,applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalを実行しているマシンのホスト名。

ポート

WebCenter Portalにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるwebcenterというWebCenter Portalに対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているSpacesクローラを削除します。

deleteSpacesCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService',  sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')

2.17.14 deleteDocumentsCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているドキュメント・クローラを削除します。

構文

deleteDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

アプリケーションを実行しているマシンのホスト名。

ポート

アプリケーションにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portalに対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているドキュメント・クローラを削除します。

deleteDocumentsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')

2.17.15 deleteDiscussionsCrawler

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上で指定したアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを削除します。

構文

deleteDiscussionsCrawler(appName, sesUrl, sesPassword, host, port,  [server],
[applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。次の形式を使用します。

http://host:port/search/api/admin/AdminService

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

アプリケーションを実行しているマシンのホスト名。

ポート

アプリケーションにアクセスするために使用されるポート番号。

sesSchema

オプション。Oracle SES管理ユーザーのユーザー名。デフォルト値はeqsysです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/portalにあるWebCenter Portalに対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているディスカッション・クローラとお知らせクローラを削除します。

deleteDiscussionsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')

2.18 検索 - WebCenter Portal検索

表2-25に示すコマンドを使用して、WebCenter Portal用の検索設定とクロール・オプションを管理します。

これらのWLSTコマンドを使用して行った構成変更は、ただちに有効になります。再起動は不要です。

表2-25 WebCenter Portal検索WLSTコマンド

使用するコマンド

目的

WLSTでの使用

setSearchConfig

指定されたアプリケーションの検索設定を変更します。

オンライン

listSearchConfig

指定されたアプリケーションの検索プロパティを一覧表示します。

オンライン

setSpacesCrawlProperties

指定されたアプリケーションのクロール・プロパティを指定します。

オンライン

getSpacesCrawlProperties

指定されたアプリケーションの現在のクロール設定を返します。

オンライン

2.18.1 setSearchConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションの検索設定を変更します。パラメータを指定しない場合、検索設定は変更されません。

構文

setSearchConfig(appName,[numSavedSearches, numResultsRegion, numResultsMain, executionTimeout, prepareTimeout, showAllExecutionTimeout, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

numSavedSearches

オプション。保存済検索項目のドロップ・ダウン(メイン検索ページ)に表示する保存済検索項目数を示します。

numResultsRegion

オプション。保存済検索タスク・フローに表示される保存済検索項目数を示します。

numResultsMain

オプション。メイン検索ページから提出された検索項目に対して、ツールまたはサービスごとに表示される検索結果の数を示します。

executionTimeout

オプション。ツールまたはサービスで検索を許可されている最大時間(ミリ秒単位)を示します。この引数の値は、有効な値である必要があります。

prepareTimeout

オプション。ツールまたはサービスで検索の初期化を許可されている最大時間(ミリ秒単位)を示します。この引数の値は、有効な値である必要があります。

showAllExecutionTimeout

オプション。ツールまたはサービスで検索結果の表示を許可されている最大時間(ミリ秒単位)を示します。この引数の値は、有効な値である必要があります。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、保存済の検索には、ツールまたはサービスごとに5個の検索結果が表示されることを示します。また、検索を行うために必要なタイムアウト時間は、7秒です。

wls:/weblogic/serverConfig>setSearchConfig(appName='webcenter',
numResultsRegion=5, executionTimeout=7000);

次の例では、保存済検索ドロップダウン・リストの保存済検索の数値を8に増やします。

wls:/weblogic/serverConfig>setSearchConfig(appName='webcenter', numSavedSearches=8);

次の例は、検索を実行するタイムアウトを5秒に設定し、各ツールまたはサービスで、タイムアウト前に15秒まで検索結果を表示できます。

wls:/weblogic/serverConfig>setSearchConfig(appName='webcenter', executionTimeout=5000, showAllExecutionTimeout=15000);

2.18.2 listSearchConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションの検索設定を一覧表示します。

構文

listSearchConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalの検索構成情報を表示します。

wls:/weblogic/serverConfig>listSearchConfig(appName='webcenter')

2.18.3 setSpacesCrawlProperties

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WebCenter PortalのOracle SESクロール・プロパティを指定します。

WebCenter PortalをOracle SESがクロールすることにより、WebCenter Portalオブジェクト(具体的にはポータル、リスト、ページ、ピープル(プロファイル)、Wiki、ブログ、ドキュメント、ディスカッションおよびお知らせ)にわたる、より高度に統合された、より高速な検索エクスペリエンスを実現できます。これは、次の3種類のクローラによって可能になります。

- Spacesクローラ(ポータル、リスト、ページおよびピープル用)

- ドキュメント・クローラ(ドキュメント、Wiki、ブログ用)

- ディスカッション・クローラ(ディスカッションとお知らせ用)

このコマンドを使用して、WebCenter PortalのOracle SESクローラを有効化または無効化します。Oracle SESクローラを使用するには、3つのすべてのクローラを有効にする必要があります。

このコマンドを使用して、Spacesクローラに対してフル・クロールを実行する間隔を指定することもできます。フル・クロール中に、Spacesクローラのコンテンツがすべて再読取りされます。初期の設定では、Spacesクローラのフル・クロールは7日間ごとに実行されますが、ご使用のインストールに合せて異なる頻度を指定できます。

3種類のすべてのクローラにおいて、増分クロールは、Oracle SESから実行されるスケジューラ主導になります。これらの増分クロール中は、前回のクロール以降に追加または更新されたコンテンツのみが処理されます。

構文

setSpacesCrawlProperties(appName, [fullCrawlIntervalInHours, spacesCrawlEnabled, documentCrawlEnabled, discussionsCrawlEnabled, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

fullCrawlIntervalInHours

オプション。フル・クロール間の時間数。デフォルトは168時間、つまり7日間です。

spacesCrawlEnabled

オプション。SpacesクローラをOracle SESで有効化するかどうかを指定します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは、0です。

0に設定した場合、Oracle WebCenter Portalの内部検索アダプタが検索結果を返します。

documentCrawlEnabled

オプション。ドキュメント・クローラをOracle SESで有効にするかどうかを指定します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは、0です。

0に設定した場合、Oracle WebCenter Portalの内部検索アダプタが検索結果を返します。

discussionsCrawlEnabled

オプション。ディスカッション・クローラとお知らせクローラをOracle SESで有効にするかどうかを指定します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは、0です。

0に設定した場合、Oracle WebCenter Portalの内部検索アダプタが検索結果を返します。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter PortalにおけるOracle SESクローラを有効にし、WebCenter PortalがSpacesクローラを使用したフル・クロールを8日ごとに実行するように指定します。

wls:/weblogic/serverConfig>setSpacesCrawlProperties(appName='webcenter', fullCrawlIntervalInHours=192, spacesCrawlEnabled=1, documentCrawlEnabled=1, discussionsCrawlEnabled=1)

2.18.4 getSpacesCrawlProperties

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

フル・クロール間の時間数(Spacesクローラ)、Oracle SESクローラが有効かどうかなど、指定されたアプリケーションの現在のクロール設定を返します。

構文

getSpacesCrawlProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)の現在のクロール設定を返します。

wls:/weblogic/serverConfig>getSpacesCrawlProperties(appName='webcenter')

Spaces Crawl Properties:
-----------------
fullCrawlIntervalInHours: 124
spacesCrawlEnabled:       1
documentCrawlEnabled:     1
discussionsCrawlEnabled:  1

2.19 WebCenter Portalアプリケーション

表2-26に示すコマンドを使用して、WebCenter Portalに対するワークフロー設定およびメタデータを管理します。

表2-26 WebCenter PortalアプリケーションのWLSTコマンド

使用するコマンド

目的

WLSTでの使用

getSpacesWorkflowConnectionName

WebCenter Portalが内部ワークフローに対して使用しているBPELサーバー接続の名前を返します。

オンライン

setSpacesWorkflowConnectionName

WebCenter Portalワークフローに対して使用されるBPELサーバー接続を指定します。

オンライン

2.19.1 getSpacesWorkflowConnectionName

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WebCenter Portalが内部ワークフロー(ポータル・メンバーシップの通知、ポータル・サブスクリプションの要求など)に対して使用しているBPELサーバー接続の名前を返します。

構文

getSpacesWorkflowConnectionName(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalが内部ワークフローに対して現在使用しているBPELサーバー接続の名前を示します。

wls:/weblogic/serverConfig> getSpacesWorkflowConnectionName(appName='webcenter')
WorkflowConfigConnectionName: WebCenter-Worklist

2.19.2 setSpacesWorkflowConnectionName

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WebCenter Portalが内部ワークフローに対して使用しているBPELサーバー接続を指定します。WebCenter Portalでは、内部ワークフロー(ポータル・メンバーシップの通知、ポータル・サブスクリプションの要求など)をホストするためにOracle SOAスイートに含まれているBPELサーバーが使用されます。ここで指定された接続の名前は、有効なBPELサーバー接続である必要があります。

注意:

このWLSTコマンドを使用して行った構成変更は、WebCenter Portalがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理を参照してください。

構文

setSpacesWorkflowConnectionName(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

name

既存のBPELサーバー接続の名前を示します。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalが、その内部ワークフローのためにWebCenter-Worklistという名前のBPELサーバー接続を使用することを指定します。

wls:/weblogic/serverConfig>setSpacesWorkflowConnectionName(appName='webcenter',
name='WebCenter-Worklist')

2.20 アイデンティティ・ストア

表2-27に示すコマンドを使用して、アプリケーションのアイデンティティ・ストアを検索するためのオプションを構成します。

表2-27 WebCenter Portalアイデンティティ・ストアWLSTコマンド

使用するコマンド

目的

WLSTでの使用

setWebCenterIdStoreSearchConfig

指定されたアプリケーションのアイデンティティ・ストアを検索するための構成オプションを変更します。

オンライン

listWebCenterIdStoreSearchConfig

指定されたアプリケーションのアイデンティティ・ストアを検索するための現在の構成オプションを一覧表示します。

オンライン

2.20.1 setWebCenterIdStoreSearchConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションのアイデンティティ・ストアを検索するための構成オプションを変更します。これらの設定を使用して、WebCenter Portalでのアイデンティティ・ストアの(ユーザーおよびロールの)検索を最適化します。

アイデンティティ・ストアの検索パラメータはadf-config.xmlに格納されています。検索パラメータを指定しない場合、それは変更されません。

構文

setWebCenterIdStoreSearchConfig(appName,[narrowSearchTimeout, broadSearchTimeout, maxSearchFilters, maxFetchRecords, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

narrowSearchTimeout

オプション。アイデンティティ・ストアから単一のユーザーをフェッチするなど、小さい単純な検索に対して許容される最大時間(ミリ秒単位)。

初期状態でのデフォルトは30000ミリ秒です。

broadSearchTimeout

オプション。名前パターンに一致するユーザーおよびロールを返すなど、大きな結果セットを返すために許容される最大時間(ミリ秒単位)。

初期状態でのデフォルトは60000です。

maxSearchFilters

オプション。アプリケーションのアイデンティティ・ストアに許容される検索フィルタの数。初期状態では最大許容数は100です。

いくつかのアイデンティティ・ストアの検索は、LDAP検索コールに変換される検索フィルタを使用して実行されます。関連付けられているLDAPサーバーによって検索条件が制限される場合は、そのLDAPサーバー設定に一致するようにmaxSearchFiltersプロパティを設定できます。

maxFetchRecords

オプション。各検索問合せから返されるレコードの最大数。初期状態でのデフォルトは100です。

この設定の値は、LDAPサーバーのパフォーマンスに影響を与えるため、この検索結果制限を増やす場合はそれを考慮してください。

LDAPサーバーではそれ自体の検索結果制限が適用されるため、実際に使用される制限は、2つの値のうち、より小さい方になります。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、両方のアイデンティティ・ストア検索タイムアウトを増やします。

wls:/weblogic/serverConfig>setWebCenterIdStoreSearchConfig(appName='webcenter', narrowSearchTimeout=60000, broadSearchTimeout=100000);

次の例では、返されるレコードの最大数を100に制限します。

wls:/weblogic/serverConfig>setWebCenterIdStoreSearchConfig(appName='webcenter', maxFetchRecords=100);

2.20.2 listWebCenterIdStoreSearchConfig

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーション(WebCenter Portal)のアイデンティティ・ストアを検索するための現在の構成オプションを一覧表示します。

アイデンティティ・ストアの検索パラメータはadf-config.xmlに格納されています。

構文

listWebCenterIdStoreSearchConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)に対するアイデンティティ・ストア検索の構成情報を表示します。

wls:/weblogic/serverConfig>listWebCenterIdStoreSearchConfig(appName='webcenter');

-----------------
User role search configuration parameters
-----------------
Narrow search timeout    : 30000
Broad search timeout     : 60000
Maximum search filters   : 100
Maximum records to fetch : 200

2.21 ライフサイクル

表2-28に示すコマンドを使用して、WebCenter Portal用のライフサイクル操作を実行します。

表2-28 ライフサイクルWLSTコマンド

使用するコマンド

目的

WLSTでの使用

deployWebCenterPortal

ステージ環境から本番環境にポータルをデプロイします。

オンライン

propagateWebCenterPortal

指定されたポータルのメタデータを、ステージ環境から本番環境に伝播します。

オンライン

exportWebCenterPortals

指定された1つ以上のポータルをポータル・アーカイブ(.parファイル)にエクスポートします。

オンライン

exportWebCenterPortalTemplates

指定された1つ以上のポータル・テンプレートをポータル・アーカイブ(.parファイル)にエクスポートします。

オンライン

importWebCenterPortals

1つ以上のポータルまたはポータル・テンプレートをポータル・アーカイブ(.parファイル)からインポートします。

オンライン

listWebCenterPortalArchive

ポータル・アーカイブの内容を一覧表示し、そのポータル・アーカイブを指定された場所に抽出します。

オンラインまたはオフライン

exportWebCenterPortalConnections

接続構成情報をソースのWebCenter Portal環境から指定されたファイルにエクスポートします。

オンライン

importWebCenterPortalConnections

新しいWebCenter Portal接続を、指定された接続プロパティ・ファイルからインポートします。

オンライン

setSpaceState

ポータルをオフラインにするか、ポータルをオンラインにします。

オンライン

exportWebCenterResource

ポータル・アセットをエクスポート・アーカイブ(.aarファイル)にエクスポートします。

オンライン

importWebCenterResource

ポータル・アセットをエクスポート・アーカイブ(.aar)からインポートします

オンライン

importWebCenterTranslations

WebCenter Portalの変換をインポートします。

オンライン

exportWebCenterApplication

WebCenter Portalアプリケーションをエクスポート・アーカイブ(.parファイル)にエクスポートします。

オンライン

importWebCenterApplication

WebCenter Portalアプリケーションをエクスポート・アーカイブ(.parファイル)からインポートします。

オンライン

exportPortletClientMetadata

エクスポート・アーカイブにポートレット・クライアント・メタデータおよびプロデューサのカスタマイズとパーソナライズをエクスポートします。

オンライン

importPortletClientMetadata

エクスポート・アーカイブからポートレット・クライアント・メタデータおよびプロデューサのカスタマイズとパーソナライズをインポートします。

オンライン

showProducerImportFailures

メタデータのインポートが失敗したプロデューサの名前およびそれらの失敗の理由を表示します。

オンライン

retryAllFailedProducerImports

残りのプロデューサ・メタデータのインポートを試行します

オンライン

cloneWebCenterManagedServer

WebCenter Portalで使用される管理対象サーバーをクローニングします。

オンライン

2.21.1 deployWebCenterPortal

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ステージ環境から本番環境にポータルをデプロイします。

注意:

- 管理対象サーバーの名前は、ステージ環境と本番環境の両方で一致している必要があります。

- 本番環境への接続は、ステージ・インスタンスで定義されている必要があります。

- 少なくともWebLogicの「監視」ロールとWebCenter Portalの権限であるPortals - Manage Security and Configurationを持っている必要があります。

構文

deployWebCenterPortal(appName, portalName, targetConnectionName,
[deployCustomizations, deployPortalContent, deploySecurity, deployData,
deployActivities, deploySharedAssets, deployConnections, overwrite, savePortal, deployLog, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

portalName

デプロイするポータルの名前。たとえば、portalName='myPortal'などです。

注意: ここにポータルの表示名を入力しないでください。ポータルのURL内で使用されているポータル名を入力する必要があります。不明な場合は、ポータル名を「ポータルについて」ダイアログで確認します。

targetConnectionName

ターゲット本番インスタンスへの接続方法を指定する、ソース・ステージ・インスタンス上の接続名。

注意: 接続が存在しない場合は、Enterprise ManagerまたはWLSTコマンドadf_createHttpUrlConnectionを使用して接続を構成します。

deployCustomizations

オプション。この属性は非推奨です。

deployPortalContent

オプション。ポータルのコンテンツ・フォルダをターゲット・サーバーにデプロイするかどうかを指定します。有効な値は1および0です。

- 1 - ポータルのコンテンツ・フォルダをデプロイします。

- 0 - ポータル・コンテンツを除外します。

この引数のデフォルトは、0です。

deploySecurity

オプション。この属性は非推奨です。

deployData

オプション。この属性は非推奨です。

deployActivities

オプション。アクティビティ・ストリーム・メッセージをターゲットにデプロイするかどうかを示します。このオプションはdeployData=1の場合のみ適用できます。

有効な値は1および0です。

- 1 - ソース・ポータルからのアクティビティ・ストリーム・メッセージがターゲットにデプロイされます。

- 0 - ソース・ポータルからのアクティビティ・ストリーム・メッセージはターゲットにデプロイされません。ターゲット上のアクティビティ(存在する場合)は保持されます。このオプションは、ステージ環境と本番環境の間を移行する場合や、テスト・データが不要になった場合に便利です。

この引数のデフォルトは、1です。

deploySharedAssets

オプション。非シード共有アセットをターゲットにデプロイするかどうかを示します。有効な値は1および0です。

- 1 - 共有アセットをデプロイします。

- 0 - 共有アセットをデプロイしません。

この引数のデフォルトは、0です。

deployConnections

オプション。ポータルに関連付けられている接続をターゲットにデプロイするかどうかを示します。有効な値は1および0です。

- 1 - 接続をデプロイします。

- 0 - 接続をデプロイしません。

この引数のデフォルトは、1です。

overwrite

オプション。ポータルがターゲット内にすでに存在する場合に、そのポータルを再デプロイするかどうかを指定します。有効な値は1および0です。

- 1 - ポータルを再デプロイします。

- 0 - ポータルが存在する場合は再デプロイしません。

この引数のデフォルトは、0です。

savePortal

オプション。ポータルを再デプロイする前に、ターゲット・インスタンス上のポータルをバックアップするかどうかを指定します。

有効な値は1および0です。

- 1 - ポータルを再デプロイする前にバックアップします。バックアップ・アーカイブは、ターゲット・マシン上の一時ディレクトリに保存されます。

- 0 - デプロイ前にポータルのバックアップを実行しません。

デフォルト値は0です。

deployLog

オプション。デプロイ操作の詳細情報を含むローカル・ログ・ファイルの名前と場所。

指定しない場合、PortalDeploy_timestamp.logという名前のデプロイ・ログ・ファイルが一時ディレクトリ内に生成されます。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、コンテンツ・フォルダなしでmyPortalという名前のポータルをデプロイします。

wls:/weblogic/serverConfig> deployWebCenterPortal(appName='webcenter',
portalName='myPortal', targetConnectionName='MyProductionConnection')

注意:

adf_createHttpUrlConnection WLSTコマンドを使用すると、MyProductionConnectionを作成できます。次に例を示します。

adf_createHttpURLConnection(appName='webcenter', name='MyProductionConnection', url='http://example.com:7777', user='myuser', password='mypassword', realm='ProductionRealm')

次の例では、myPortalという名前のポータルを、それに関連付けられたコンテンツすべてとともにデプロイし、デプロイ・ログ・ファイルの名前と場所を指定します。

wls:/weblogic/serverConfig> deployWebCenterPortal(appName='webcenter',
portalName='myPortal', targetConnectionName='MyProductionConnection',
deployPortalContent=1, deployLog='/mydeploylogs/myPortal_deploy.log')

次の例では、ポータルおよびすべての関連付けられたコンテンツを再デプロイする前にターゲットでmyPortalをバックアップします。

wls:/weblogic/serverConfig> deployWebCenterPortal(appName='webcenter',
portalName='myPortal', targetConnectionName='MyProductionConnection',
deployPortalContent=1, savePortal=1, overwrite=1)

2.21.2 propagateWebCenterPortal

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたポータルのメタデータ変更を、ステージ環境から本番環境に伝播します。

次のメタデータの変更が伝播されます。

- 含める:

- ポータル・ページ、システム・ページ、ポートレット、アセットおよびタスク・フローに関するポータル・レベルのカスタマイズ(メタデータの変更)

- ポータル・ページ、ポートレットおよびタスク・フロー・インスタンスに関するユーザー・レベルのカスタマイズ(メタデータの変更)

- 対象外: セキュリティ、コンテンツとデータに対するすべての変更およびポータルの状態(オンライン/オフライン)

注意:

伝播できるのは、以前にdeployWebCenterPortalコマンドを使用して(ステージ環境から本番環境に)デプロイされたポータルのみです。

その他の変更を移行するには、exportWebCenterPortalsとimportWebCenterPortals,またはdeployWebCenterPortalの使用を検討してください。

注意:

- 管理対象サーバーの名前は、ステージ環境と本番環境の両方で一致している必要があります。

- 本番環境への接続は、ステージ・インスタンスで定義されている必要があります。

- 少なくともWebLogicの「監視」ロールとWebCenter Portalの権限であるPortals - Manage Security and Configurationを持っている必要があります。

構文

propagateWebCenterPortal(appName, portalName, targetConnectionName, [savePortal, propagateLog, propagateSharedAssets, propagatePortalContent, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

portalName

伝播するポータルの名前。たとえば、portalName='myPortal'などです。

注意: ここにポータルの表示名を入力しないでください。ポータルのURL内で使用されているポータル名を入力する必要があります。不明な場合は、ポータル名を「ポータルについて」ダイアログで確認します。

targetConnectionName

ターゲット本番インスタンスへの接続方法を指定する、ソース・ステージ・インスタンス上の接続名。

注意: 接続が存在しない場合は、Enterprise ManagerまたはWLSTコマンドadf_createHttpUrlConnectionを使用して接続を構成します。

savePortal

オプション。ポータルの変更を伝播する前に、ターゲット・インスタンス上のポータルをアーカイブにバックアップするかどうかを指定します。

有効な値は1および0です。

- 1 - 伝播する前にターゲット・ポータルをアーカイブにバックアップします。作成されたバックアップ・アーカイブは、ターゲット・マシン上の/tmpディレクトリに保存されます。

- 0 - 変更を伝播する前に、ターゲット・ポータルをバックアップしません。

デフォルト値は0です。

propagateLog

オプション。伝播操作の詳細情報を含むローカル・ログ・ファイルの名前と場所。

指定しない場合、PortalPropagation_timestamp.logという名前の伝播ログ・ファイルが一時ディレクトリ内に生成されます。

propagateSharedAssets

オプション。非シード共有アセットのメタデータ変更をターゲットに伝播するかどうかを指定します。

有効な値は1および0です。

- 1 - 共有アセット変更を含めます。

- 0 - 共有アセット変更を含めません。

デフォルト値は0です。

propagatePortalContent

オプション。ポータルに関連付けられているコンテンツの変更をターゲット・インスタンスに伝播するかどうかを指定します。

有効な値は1および0です。

- 1 -ポータル・コンテンツを伝播します。

- 0 - ポータル・コンテンツを除外します。

デフォルト値は0です。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myPortalという名前のポータルのメタデータに対する変更を伝播します。

wls:/weblogic/serverConfig> propagateWebCenterPortal(appName='webcenter', portalName='myPortal', targetConnectionName='MyProductionConnection')

注意:

adf_createHttpUrlConnection WLSTコマンドを使用すると、MyProductionConnectionを作成できます。次に例を示します。

adf_createHttpURLConnection(appName='webcenter', name='MyProductionConnection', url='http://example.com:7777', user='myuser', password='mypassword', realm='ProductionRealm')

次の例では、すべての関連付けられたコンテンツとともにmyPortalという名前のポータルをバックアップし、そのポータルのメタデータ変更を伝播します。

wls:/weblogic/serverConfig> propagateWebCenterPortal(appName='webcenter', portalName='myPortal', targetConnectionName='MyProductionConnection', savePortal=1)

次の例では、myPortalという名前のポータルのメタデータに対する変更を伝播し、その伝播ログ・ファイルの名前と場所を指定します。

wls:/weblogic/serverConfig> propagateWebCenterPortal(appName='webcenter',
portalName='myPortal', targetConnectionName='MyProductionConnection',
propagateLog='/mypropagationlogs/myPortal_propagation.log')

2.21.3 exportWebCenterPortals

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたファイル名を使用して、1つ以上の指定されたポータルをポータル・アーカイブ(.parファイル)にエクスポートします。

ポータル・アーカイブ・ファイルには、1つ以上のポータル・データ・アーカイブ(.pdrファイル)が含まれます。このアーカイブは、エクスポートするポータルごとに1つ存在します。

いずれかのポータルを適切にエクスポートできなかった場合は、エクスポート操作が続行されます。指定されたポータルごとに、エクスポート操作が成功または失敗したことを示すステータス・メッセージがWLSTコンソールに表示されます。エクスポートできなかったポータルは、.parファイルから除外されます。

注意:

このコマンドを実行するには、少なくともWebLogicの「監視」ロールとWebCenter Portalの権限であるPortals - Manage Security and Configurationを持っている必要があります。

ポータルが2GBより大きい場合、exportWebCenterPortalsコマンドにexportConnections = 0を設定します。exportWebCenterPortalConnectionsコマンドを使用して、接続を移行します。

構文

exportWebCenterPortals(appName, fileName, [names, offlineDuringExport, exportPortalContent, exportConnections, exportSharedAssets, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

fileName

エクスポート・アーカイブ(.parファイル)の名前と場所。たとえば、/myExports/myPortalExport.parなどです。

場所を指定しなかった場合、アーカイブはWLSTコマンドを実行したディレクトリ内に作成されます。

names

オプション。エクスポートする1つ以上のポータルの名前。複数のポータル名をカンマで区切ります。たとえば、names='sales,finance'などです。

注意: ここにポータルの表示名を入力しないでください。ポータルのURL内で指定されている名前を入力する必要があります。ポータル名は、「ポータルについて」ダイアログで確認できます。

names引数を空白のままにした場合、すべてのポータル(最大10個のポータル)がエクスポートされます。インスタンスに10個を超えるポータルが含まれる場合は、names引数を使用して、各ポータルに個別に名前を付ける必要があります。

offlineDuringExport

オプション。エクスポート・プロセスを開始する前に、エクスポートするポータルをオフラインにする必要があるかどうかを示します。ユーザーによるポータルへのアクセスが許可されている場合、エクスポートの開始後に発生した変更はエクスポートされません。

有効な値は1および0です。

- 1 - エクスポート・プロセスを開始する前にオンライン・ポータル(存在する場合)をオフラインにし、エクスポート・プロセスの最後に、それらのポータルを元のオンライン状態に戻します。
エクスポート・プロセス中にデータが失われないように、offlineDuringExport=1に設定することをお薦めします。

- 0 - ポータルを現在の状態でエクスポートします。

デフォルト値は0です。

exportPortalContent

オプション。WebCenter Content Server上にある各ポータルのコンテンツ・フォルダをエクスポートするかどうかを指定します。

コンテンツ・フォルダは、ドキュメント・サービスを使用してポータル・ドキュメント(ファイル、フォルダ、Wikiおよびブログ)を作成、管理および格納するすべてのポータルに対して、自動的にContent Server上に作成されます。ポータルとともにエクスポートできるのは、このフォルダに格納されたコンテンツのみです。たとえば、Content Presenterを通じて表示されるWebコンテンツまたはページは、その情報がポータルのコンテンツ・フォルダに格納されないため、エクスポート対象に含まれません。

有効な値は1および0です。

- 1 - ポータルのコンテンツ・フォルダをエクスポートします。

- 0 - ポータル・コンテンツを除外します。

デフォルト値は0です。

exportConnections

オプション。WebCenter Portal接続をconnection.propertiesという名前のファイルにエクスポートし、それをポータル・アーカイブ(.parファイル)に含めるかどうかを指定します。

また、connection.propertiesのコピーは、同じ場所にあるアーカイブの外部、つまりfileNameオプションを使用して指定された場所に格納されます。

有効な値は1および0です。

- 1 - WebCenter Portal接続をエクスポートします。

- 0 - WebCenter Portal接続をエクスポートしません。

デフォルト値は0です。

『Oracle WebCenter Portalの管理』の接続プロパティ・ファイルの理解に関する項も参照してください。

exportSharedAssets

オプション。非シード共有アセットをエクスポートしてポータル・アーカイブ(.par)に含めるかどうかを指定します。有効な値は1および0です。

- 1 - 共有アセットをエクスポートします。

- 0 - 共有アセットをエクスポートしません。

デフォルト値は0です。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myPortal1とmyPortal2をmyPortalExport.parにエクスポートします。

wls:/weblogic/serverConfig> exportWebCenterPortals(appName='webcenter', fileName='myPortalExport.par', names='myPortal1, myPortal2')

次の例では、myPortal1をmyPortalExport.parにエクスポートします。エクスポート操作の発生時にmyPortal1がオフラインになるように、offlineDuringExportを1に設定しています。

wls:/weblogic/serverConfig> exportWebCenterPortals(appName='webcenter', fileName=myPortalOfflineExport.par', names='myPortal1', offlineDuringExport=1)

次の例では、ポータルのコンテンツ・フォルダを含むすべてのポータルをexportAllMyPortals.parにエクスポートします。

wls:/weblogic/serverConfig> exportWebCenterPortals(appName='webcenter', fileName='exportAllMyPortals.par', exportPortalContent=1)

2.21.4 exportWebCenterPortalTemplates

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたファイル名を使用して、1つ以上の指定されたポータル・テンプレートをポータル・アーカイブ(.parファイル)にエクスポートします。ポータル・アーカイブ・ファイルには、エクスポートする各ポータル・テンプレートに対応した、ポータル・データ・アーカイブ(.pdrファイル)が含まれます。

各ポータル・データ・アーカイブには、テンプレート固有のデータ(ページ、ディスカッションおよびリスト)、カスタマイズ、セキュリティ情報およびオプションでポータル・テンプレートのコンテンツが含まれます。

いずれかのポータル・テンプレートを適切にエクスポートできなかった場合、エクスポート操作が続行されます。指定されたポータルごとに、エクスポート操作が成功または失敗したことを示すステータス・メッセージがWLSTコンソールに表示されます。エクスポートできなかったポータル・テンプレートは、.parファイルから除外されます。

注意:

このコマンドを実行するには、少なくともWebLogicの「監視」ロールとWebCenter Portalの権限であるポータル・テンプレート - すべて管理を持っている必要があります。

構文

exportWebCenterPortalTemplates(appName, fileName, [names, exportPortalTemplateContent, exportConnections, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

fileName

エクスポート・アーカイブ(.parファイル)の名前と場所。たとえば、/myExports/myPortalTemplateExport.parなどです。

場所を指定しなかった場合、アーカイブはWLSTコマンドを実行したディレクトリ内に作成されます。

names

オプション。エクスポートする1つ以上のポータル・テンプレートの名前。複数のテンプレート名をカンマで区切ります。たとえば、names='mySalesTemplate,myHRTemplate'などです。

注意: ここにポータル・テンプレートの表示名を入力しないでください。ポータル・テンプレートのURL内で指定されている名前を入力する必要があります。ポータル名は、「ポータル・テンプレートについて」ダイアログで確認できます。

names引数を空白のままにした場合、すべてのテンプレート(最大10個のテンプレート)がエクスポートされます。インスタンスに10個を超えるポータル・テンプレートが含まれる場合は、names引数を使用して、各テンプレートに個別に名前を付ける必要があります。

exportPortalTemplateContent

オプション。WebCenter Content Server上にある各テンプレートのコンテンツ・フォルダをエクスポートするかどうかを指定します。

コンテンツ・フォルダは、ドキュメント・サービスを使用してテンプレート・ドキュメント(ファイル、フォルダ、Wikiおよびブログ)を作成、管理および格納するすべてのテンプレートに対して、自動的にContent Server上に作成されます。ポータル・テンプレートとともにエクスポートできるのは、このフォルダに格納されたコンテンツのみです。たとえば、Content Presenterを通じて表示されるWebコンテンツまたはページは、その情報がポータル・テンプレートのコンテンツ・フォルダに格納されないため、エクスポート対象に含まれません。

有効な値は1および0です。

- 1 - ポータル・テンプレートのコンテンツ・フォルダをエクスポートします。

- 0 - ポータル・テンプレートのコンテンツを除外します。

デフォルト値は0です。

exportConnections

オプション。WebCenter Portal接続をconnection.propertiesという名前のファイルに抽出し、それをポータル・アーカイブ(.par)に含めるかどうかを指定します。有効な値は1および0です。

有効な値は1および0です。

- 1 - WebCenter Portal接続を抽出します。

- 0 - WebCenter Portal接続を抽出しません。

デフォルト値は1です。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myPortalTemplate1とmyPortalTemplate2をmyPortalTemplateExport.parにエクスポートします。

wls:/weblogic/serverConfig> exportWebCenterPortalTemplates(appName='webcenter', fileName='myPortalTemplateExport.par', names='myPortalTemplate1, myPortalTemplate2')

次の例では、ポータル・テンプレートのコンテンツを含むすべてのポータル・テンプレートをexportAllMyPortalTemplates.parにエクスポートします。

wls:/weblogic/serverConfig> exportWebCenterPortalTemplates(appName='webcenter', fileName='exportAllMyPortalTemplates.par', exportPortalTemplateContent=1)

2.21.5 importWebCenterPortals

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

1つ以上のポータルまたはポータル・テンプレートをポータル・アーカイブ(.parファイル)からインポートします。

注意:

このコマンドを実行するには、少なくともWebLogicの「監視」ロールとWebCenter Portalの権限であるPortals - Portals - Manage Security and Configurationまたはポータル・テンプレート - すべて管理を持っている必要があります。

構文

importWebCenterPortals(appName, fileName, [names, parentPortal, importCustomizations, importPortalContent, importSecurity, importData,
importActivities, overwrite, savePortals, forceOffline, importLog,  importConnections, connPropertiesFile, importSharedAssets, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

fileName

インポートするポータルまたはポータル・テンプレートを含むポータル・アーカイブ(.parファイル)の名前。たとえば、mySalesPortal.parなどです。

names

オプション。インポートする1つ以上のポータルまたはポータル・テンプレートの名前。たとえば、names='sales'などです。

複数の名前をカンマで区切ります。たとえば、names='sales,finance'などです。

注意:ここに表示名を入力しないてください。ポータルまたはポータル・テンプレートのURL内で指定されている名前を入力する必要があります。

- ポータル名は、「ポータルについて」ダイアログで確認できます。

- ポータル・テンプレート名は、「ポータル・テンプレートについて」ダイアログで確認できます。

注意: .parファイルに複数のポータルがある場合、namesを使用して選択的にポータルをインポートします。つまり、このパラメータに対して指定されたポータル名がインポートされます。これを省略した場合、.parファイル内のすべてのポータルがインポートされます。  単一のポータルが含まれる.parファイルの場合、このパラメータは無視できます。

parentPortal

オプション。アーカイブに含まれるポータルの配置先となる親ポータルの名前。指定した場合、インポートされたポータルは、その親ポータルのサブポータルになります。

この引数のデフォルトは、nullです。親を指定しなかった場合、アーカイブ済ポータルはルート・ポータルとしてインポートされます。

注意: アーカイブにポータル・テンプレートが含まれている場合、この引数は無視されます。

importCustomizations

オプション。この属性は非推奨です。

importPortalContent

オプション。インスタンスのポータルに関連付けられているコンテンツをインポートするかどうかを指定します。有効な値は1および0です。

有効な値は1および0です。

- 1 - ポータル・コンテンツをインポートします。

- 0 - ポータル・コンテンツを除外します。このオプションは、ステージ環境と本番環境の間を移行する場合や、テスト・コンテンツが不要になった場合に便利です。

この引数のデフォルトは、0です。

注意: 大きいコンテンツ・フォルダを含むポータル・アーカイブは、ファイルの最大アップロード・サイズを超える場合があります(デフォルトでは2GB)。必要に応じて、この設定値を増やすことができます。詳細は、Oracle Fusion Middleware Oracle WebCenter Portalの管理のファイルの最大アップロード・サイズの変更に関する項を参照してください。

importSecurity

オプション。この属性は非推奨です。

importData

オプション。この属性は非推奨です。

importActivities

オプション。エクスポート・アーカイブからアクティビティ・メッセージをインポートするかどうかを示します。有効な値は1および0です。

- 1 - ポータル・アーカイブに格納されたアクティビティ・メッセージがインポートされます。

- 0 - アクティビティ・メッセージはインポートされません。

この引数のデフォルトは、1です。

注意: アーカイブにポータル・テンプレートが含まれている場合、この引数は無視されます。

overwrite

オプション。ターゲット内に存在するポータルまたはポータル・テンプレートを上書きするかどうかを指定します。

有効な値は1および0です。

- 1 - ポータルを上書きします。

- 0 - ポータルが存在する場合はインポートを回避します。新しいポータル(またはポータル・テンプレート)のみをインポートします。

デフォルトは0です。

savePortals

オプション。インポート操作を開始する前に、既存のポータルをアーカイブに保存するかどうかを指定します。

有効な値は1および0です。

- 1 - インポート前に、ターゲットに存在する指定されたポータルをアーカイブに保存します。作成されたアーカイブは、ターゲット・マシン上の/tmpディレクトリにコピーされます。

- 0 - インポート操作前に既存のポータルを保存しません。

デフォルト値は0です。

forceOffline

オプション。インポート・プロセスを開始する前に、既存のポータルをオフラインにするかどうかを指定します。

有効な値は1および0です。

- 1 - インポート・プロセスを開始する前に、ポータルをオフラインにします。

- 0 - ポータルのインポートを試みます。1つ以上のポータルが現在オンラインの場合、それらのポータルをオフラインにするよう求められます。

デフォルト値は0です。

注意: アーカイブにポータル・テンプレートが含まれている場合、この引数は無視されます。

importLog

オプション。インポート操作の詳細情報を含むローカル・ログ・ファイルの名前を指定します。

指定しない場合、PortalImport_ timestamp.logという名前のログ・ファイルが一時ディレクトリ内に生成されます。

importConnections

オプション。インスタンスのポータルに関連付けられている接続をインポートするかどうかを指定します。有効な値は1および0です。

有効な値は1および0です。

- 1 - ポータルで使用される接続をインポートします。

- 0 - 接続を除外します。

デフォルトは1です。

connPropertiesFile

オプション。接続プロパティ・ファイルの名前と場所を指定します。例: /myConnections/connection.properties

WebサービスおよびURL接続は、指定された接続プロパティ・ファイルからインポートされます。ターゲット上に存在しない接続がインポートされます。ターゲット上に存在する接続は無視されます。

注意: importConnectionsが0に設定されている場合、この引数は無視されます。

importSharedAssets

オプション。ポータル(.par)とともに非シード共有アセットをインポートするかどうかを指定します。共有アセット・ディレクトリはアーカイブに存在する必要があります。有効な値は1および0です。

有効な値は1および0です。

- 1 - 共有アセットをインポートします。

- 0 - 共有アセットをインポートしません。

デフォルトは0です。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myPortalExport.parにアーカイブされたsalesポータルの新しいバージョンをインポートし、そのインポート・ログ・ファイルの名前と場所を指定します。インポート操作の発生時に既存のsalesポータルがオフラインになるように、forceOfflineを1に設定しています。

wls:/weblogic/serverConfig> importWebCenterPortals(appName='webcenter', fileName='myPortalExport.par', names='sales', forceOffline=1, importLog='sales_import.log')

次の例では、myPortalExport.parからsalesポータルの新しいバージョンを再インポートする前に、salesポータルのコピーを保存します。

wls:/weblogic/serverConfig> importWebCenterPortals(appName='webcenter', fileName='myPortalExport.par', names='sales', savePortals=1)

次の例では、myPortalTemplateExport.parにアーカイブされたnewHireポータル・テンプレートをインポートし、そのインポート・ログ・ファイルの名前と場所を指定します。

wls:/weblogic/serverConfig> importWebCenterPortals(appName='webcenter', fileName='myPortalTemplateExport.par', names='newHire', importLog='newHire.log')

2.21.6 listWebCenterPortalArchive

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンラインまたはオフライン

説明

ポータル・アーカイブの内容を一覧表示し、オプションでそのポータル・アーカイブを指定された場所に抽出します。

構文

listWebCenterPortalArchive(appName, fileName, [extractDir, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

fileName

ポータル・アーカイブの名前と場所。

extractDir

オプション。ポータル・アーカイブのコンテンツの抽出先となるディレクトリ。ディレクトリを指定した場合、ポータル・アーカイブはその場所に抽出されます。

指定しない場合、アーカイブ・コンテンツは一覧表示されますが、抽出されません。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myPortal.parのコンテンツを一覧表示し、アーカイブ・コンテンツをディレクトリ/myPortalArchives/myPortalContentに抽出します。

wls:/weblogic/serverConfig> listWebCenterPortalArchive(appName='webcenter', fileName='/myPortalArchives/myPortal.par', extractDir='/myPortalArchives/myPortalContent')

2.21.7 exportWebCenterPortalConnections

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

接続構成情報をソースのWebCenter Portal環境から指定されたファイルにエクスポートします。

次の接続がエクスポートされます。

- 分析コレクタ接続

- コンテンツ・リポジトリ接続(Oracle WebCenter Content)

- ディスカッション・サーバー接続

- イベント・サーバー接続

- 外部アプリケーション接続

- メール・サーバー接続

- Oracle Secure Enterprise Search接続

- ポートレット・プロデューサ接続(WSRPおよびPDK-Java)

- ページレット・プロデューサ接続

- プレゼンス・サーバー接続

- URL接続

- Webサービス接続(データ・コントロールによって使用されます)

- BPELサーバー接続

注意:

exportWebCenterPortalConnectionsコマンドを実行するには、少なくともWebLogicの「管理」ロールを持っている必要があります。

構文

exportWebCenterPortalConnections(appName, fileName, [connectionType, [connectionName,] logFile, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

fileName

接続プロパティ・ファイルの名前と場所を指定します。場所を指定しない場合、ファイルは現在のディレクトリ内に保存されます。

connectionType

オプション。エクスポートする接続のタイプ。複数の接続タイプをカンマで区切ります。次に例を示します。

connectionType='wsrpProducerConnection, webServiceConnection'

空白のままにした場合、すべての接続タイプがエクスポートされます。

有効な接続タイプは、次のとおりです。

- analyticsCollectorConnection (分析コレクタ)

- webcenterContentServerConnection (Oracle WebCenter Content)

- discussionConnection (ディスカッション・サーバー)

- personalEventConnection (プレゼンス・サーバー)

- externalAppConnection (外部アプリケーション)

- mailConnection (メール・サーバー)

- sesConnection (Oracle Secure Enterprise Search)

- wsrpProducerConnection (WSRPポートレット・プロデューサ)

- jpdkProducerConnection (PDK-Javaポートレット・プロデューサ)

- pageletProducerConnection (ページレット・プロデューサ)

- impConnection (プレゼンス・サーバー)

- urlConnection (URL)

- webServiceConnection (Webサービス)

- bpelConnection ( BPELサーバー)

- restConnection

注意: connectionNameを指定した場合、この引数は必須です。

connectionName

オプション。単一のconnectionTypeに対してエクスポートする特定の接続に名前を付けます。複数の接続名をカンマで区切ります。

たとえば、connectionType='wsrpProducerConnection'の場合、このタイプの1つ以上の接続をconnectionName='myWSRPProducer1,myWSRPProducer2'のように指定してエクスポートできます。

connectionNameの値を指定する場合、connectionType引数も指定する必要があります。例: exportWebCenterPortalConnections(appName='webcenter', fileName='/scratch/conn.properties', connectionType='wsrpProducerConnection', connectionName='MyWSRPConn')

注意: 名前を指定しない場合、指定されたconnectionType.に対するすべての接続がエクスポートされます。

logFile

エクスポート接続操作の詳細情報を含むローカル・ログ・ファイルの名前を指定します。

指定しない場合、ConnectionExport_< timestamp>.logという名前のログ・ファイルが一時ディレクトリ内に生成されます。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、すべてのWSRPプロデューサおよびWebサービス接続の接続構成情報を、/myConnectionsにあるconnection.propertiesという名前のファイルにエクスポートします。

wls:/weblogic/serverConfig> exportWebCenterPortalConnections(appName='webcenter',
fileName='/myConnections/connection.properties', connectionType='wsrpProducerConnection,webServiceConnection')

次の例では、myWSRP1およびmyWSRP2という2つのWSRPプロデューサ接続の接続構成情報を、/myConnectionsにあるconnection.propertiesという名前のファイルにエクスポートします。

wls:/weblogic/serverConfig> exportWebCenterPortalConnections(appName='webcenter',
fileName='/myConnections/connection.properties', connectionType='wsrpProducerConnection', connectionName='myWSRP1,myWSRP2')

次の例では、すべての接続構成情報を、/myConnectionsにあるconnection.propertiesという名前のファイルにエクスポートします。

wls:/weblogic/serverConfig> exportWebCenterPortalConnections(appName='webcenter',
fileName='/myConnections/connection.properties')

次の例では、接続構成情報を、\myConnectionsにあるconnection.propertiesという名前のファイルにエクスポートします。エクスポート操作の詳細情報は、/myExportLogsにあるexportConnections.logにも記録されます。

wls:/weblogic/serverConfig> exportWebCenterPortalConnections(appName='webcenter',
fileName='/myConnections/connection.properties', logFile='/myExportLogs/exportConnections.log')

2.21.8 importWebCenterPortalConnections

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

新しいWebCenter Portal接続を、指定された接続プロパティ・ファイルからインポートします。ターゲット上に存在しない接続がインポートされます。ターゲット上に存在する接続は無視されます。

次の接続をエクスポートできます。

- 分析コレクタ接続

- コンテンツ・リポジトリ接続(Oracle WebCenter Content)

- ディスカッション・サーバー接続

- イベント・サーバー接続

- 外部アプリケーション接続

- メール・サーバー接続

- Oracle Secure Enterprise Search接続

- ポートレット・プロデューサ接続(WSRPおよびPDK-Java)

- ページレット・プロデューサ接続

- プレゼンス・サーバー接続

- URL接続

- Webサービス接続(データ・コントロールによって使用されます)

- BPELサーバー接続

注意:

- importWebCenterPortalConnectionsコマンドを実行するには、少なくともWebLogicの「管理」ロールを持っている必要があります。

- インポートできるのは、以前にexportWebCenterPortalConnectionsコマンドを使用してエクスポートされた接続情報のみです。

- 新しくインポートされたポートレット・プロデューサ、外部アプリケーション、URLおよびWebサービス接続は、ターゲット内でただちに使用可能になります。他の接続タイプの場合、新しい接続を使用可能にするために、WebCenter Portalがデプロイされた管理対象サーバーを再起動するよう求められます。

構文

importWebCenterPortalConnections(appName, fileName, [promptForPassword, logFile, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

fileName

接続プロパティ・ファイルの名前と場所を指定します。

promptForPassword

オプション。インポート操作中、新しい接続を作成するために資格証明が必要になった場合、ユーザーにパスワードを要求するかどうかを指定します。たとえば、新しいOracle-Secure Enterprise Search (SES)接続を作成するには、パスワードを入力する必要があります。

有効な値は1および0です。

- 1 - パスワードが必要な場合、ユーザーに資格証明の入力を要求します。

- 0 - 新しい接続を作成するためにパスワードが必要な場合、ユーザーにその入力を要求しません。スクリプト内でこのコマンドを実行する場合、この引数を常に0に設定してください。

デフォルトは1です。

logFile

オプション。インポート接続操作の詳細情報を記録するローカル・ログ・ファイルの名前を指定します。

値を指定しない場合、ConnectionImport_< timestamp>.logという名前のログ・ファイルが一時ディレクトリ内に生成されます。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、/myConnectionsにあるconnection.propertiesという名前のファイル内で定義されている接続をインポートします。

wls:/weblogic/serverConfig> importWebCenterPortalConnections(appName='webcenter',
fileName='/myConnections/connection.properties')

次の例では、\myConnectionsにあるconnection.propertiesという名前のファイル内で定義されている接続をインポートします。インポート操作の詳細情報は、importConnection.logにも記録されます。

wls:/weblogic/serverConfig> importWebCenterPortalConnections(appName='webcenter',
fileName='/myConnections/connection.properties', logFile='importConnection.log')

次の例では、\myConnectionsにあるconnection.propertiesという名前のファイル内で定義されている接続をインポートします。ユーザーに資格情報の入力(必要な場合)を要求しません。

wls:/weblogic/serverConfig> importWebCenterPortalConnections(appName='webcenter',
fileName='/myConnections/connection.properties', promptForPassword=1)

2.21.9 setSpaceState

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

ポータルをオフラインにするか、ポータルをオンラインにします。

構文

setSpaceState(appName, spaceName, offline, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、名前は常にwebcenterです。

spaceName

オフラインまたはオンラインにするポータルの名前。

offline

ポータルをオフラインにするか、オンラインに戻すかを指定します。有効な値は1および0です。

- 1はポータルをオフラインにします

- 0はポータルをオンラインにします

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyPortalをオフラインにします。

wls:/weblogic/serverConfig> setSpaceState(appName='webcenter', spaceName='MyPortal', offline=1)

2.21.10 exportWebCenterResource

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたファイル名を使用して、単一のアセット、デバイスまたはデバイス・グループをエクスポート・アーカイブ(.aarファイル)にエクスポートします。

アセットをエクスポートする場合、resourceGUIDまたはresourceNameを指定できます。

デバイスまたはデバイス・グループをエクスポートする場合は、resourceNameのみを指定できます。

注意:

- このコマンドを実行するには、少なくともWebLogicの「監視」ロールと、エクスポートするアセット、デバイスまたはデバイス・グループのタイプに対する適切な「作成」、「編集」または「削除」権限を持っている必要があります。
詳細は、『Oracle WebCenter Portalの管理』のWebCenter Portalライフサイクル操作を実行するために必要な権限に関する項を参照してください。

- 初期状態のアセット、デバイスまたはデバイス・グループはエクスポートできません。

構文

exportWebCenterResource(appName, fileName, resourceType, [resourceGUID, resourceName, spaceName, exportContentDirectory, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、名前は常にwebcenterです。

fileName

エクスポートを書き込むローカル・ファイルの名前を示します。

resourceType

エクスポートするリソースのタイプ(アセット、デバイスまたはデバイス・グループ)。

有効な値は、pageTemplate、contentPresenter、pageStyle、resourceCatalog、skin、layout,taskFlow、dataControl、device、deviceGroup、dataSource、sqlDataSource、appIntgVisualization、visualizationTemplateです。

説明:

- pageTemplate - ページ・テンプレート

- contentPresenter - コンテンツ・プレゼンタの表示テンプレート

- pageStyle - ページ・スタイル

- resourceCatalog - リソース・カタログ

- skin - スキン

- taskFlow - タスク・フロー

- taskflowStyle - タスク・フロー・スタイル

- dataControl - データ・コントロール

- device - デバイス

- deviceGroup - デバイス・グループ

- dataSource - データ・ソース

- sqlDataSource - SQLデータ・ソース

- appIntgVisualization - アプリケーション統合の視覚化

- visualizationTemplate - 視覚化テンプレート

初期状態のアセット、デバイスまたはデバイス・グループはエクスポートまたはインポートできません。

注意: このリリースでは、taskFlowStyleによってmashupStyleが置き換えられます。mashupStyleオプションは非推奨になりますが、下位互換性を維持するために、このリリースでも動作します。

resourceGUID

オプション。エクスポートするアセットの一意のID (GUID)。

内部IDは、アセットの「バージョン情報」ダイアログで確認できます。

resourceTypeがdeviceまたはdeviceGroupに設定されている場合、この引数は使用されません。

resourceName

オプション。エクスポートするアセット、デバイスまたはデバイス・グループの表示名。

アセットの表示名は、アセットの「バージョン情報」ダイアログで確認できます。

デバイスまたはデバイス・グループ名は、デバイスまたはデバイス・グループの「編集」ダイアログで確認できます。

注意: 初期状態のアセット、デバイスまたはデバイス・グループはエクスポートできません。

spaceName

オプション。エクスポートするアセットを含むポータルの名前。この引数は、ポータル・アセット、つまり特定のポータルによって所有されているアセットをエクスポートするために使用します。

WebCenter Portalの共有アセットをエクスポートする場合は、この引数を省略します。この引数のデフォルトは、nullです(共有アセットがエクスポートされます)。

resourceTypeがdeviceまたはdeviceGroupに設定されている場合、この引数は使用されません。

exportContentDirectory

非推奨。

アセットに関連付けられたMDSコンテンツをエクスポート・アーカイブに含めることはできなくなりました。レガシーMDSコンテンツを移行する必要がある場合は、標準のMDS WLSTコマンドexportMetadataを使用してください。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyPortalという名前のポータル(WebCenter Portal内)によって所有されているページ・テンプレートを、myPageTemplateExport.aarというローカル・ファイルにエクスポートします。

wls:/weblogic/serverConfig> exportWebCenterResource(appName='webcenter',
fileName='myPageTemplateExport.aar', resourceType='pageTemplate',
resourceGUID='gsr47d9a5ac_7398_439a_97d2_8b54ce905f7e, spaceName='MyPortal')

次の例では、MyPortalという名前のポータルによって所有されている同じページ・テンプレートをエクスポートしますが、GUIDではなくテンプレートの表示名を指定します。

wls:/weblogic/serverConfig> exportWebCenterResource(appName='webcenter',
fileName='myPageTemplateExport.aar', resourceType='pageTemplate',
resourceName='MyPageTemplate, spaceName='MyPortal')

次の例では、MyMobileDeviceという名前のデバイスをWebCenter Portalからエクスポートします。

wls:/weblogic/serverConfig> exportWebCenterResource(appName='webcenter',
fileName='myDeviceExport.aar', resourceType='device', resourceName='MyMobileDevice')

2.21.11 importWebCenterResource

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

単一のアセット、デバイスまたはデバイス・グループをアセット・エクスポート・アーカイブ(.aarファイル)からインポートします。

注意:

- このコマンドを実行するには、少なくともWebLogicの「監視」ロールと、インポートするアセット、デバイスまたはデバイス・グループのタイプに対する適切な「作成」、「編集」または「削除」権限を持っている必要があります。
詳細は、『Oracle WebCenter Portalの管理』のWebCenter Portalライフサイクル操作を実行するために必要な権限に関する項を参照してください。

- 初期状態のアセット、デバイスまたはデバイス・グループはエクスポートまたはインポートできません。

構文

importWebCenterResource(appName, fileName, [resourceType, spaceName, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、名前は常にwebcenterです。

fileName

インポートするアーカイブ・ファイルの名前。

resourceType

オプション。インポートするリソースのタイプ(アセット、デバイスまたはデバイス・グループ)。

有効な値は、pageTemplate、contentPresenter、pageStyle、navigation、resourceCatalog、skin、taskFlow、mashupStyle、dataControl、deviceおよびdeviceGroupです。

説明:

- pageTemplate - ページ・テンプレート

- contentPresenter - コンテンツ・プレゼンタの表示テンプレート

- pageStyle - ページ・スタイル

- navigation - ナビゲーション・モデル

- resourceCatalog - リソース・カタログ

- skin - スキン

- taskFlow - タスク・フロー

- taskflowStyle - タスク・フロー・スタイル

- dataControl - データ・コントロール

- device - デバイス

- deviceGroup - デバイス・グループ

アーカイブ(.aarファイル)に1つ以上のデバイスまたはデバイス・グループが含まれている場合、この引数は必須です。

- resourceType='device'の場合、アーカイブに含まれているすべてのデバイスがインポートされます。

- resourceType='deviceGroup'の場合、アーカイブに含まれているすべてのデバイス・グループと、それらに関連付けられたデバイスがインポートされます。

注意: このリリースでは、taskFlowStyleによってmashupStyleが置き換えられます。mashupStyleオプションは非推奨になりますが、下位互換性を維持するために、このリリースでも動作します。

spaceName

オプション。アセットのインポート先となるポータルの名前。

WebCenter Portalに共有アセットをインポートする場合は、この引数を省略します。

この引数のデフォルトは、nullです(共有アセットがインポートされます)。

resourceTypeがdeviceまたはdeviceGroupに設定されている場合、この引数は使用されません。

overwriteContentDirectory

非推奨。

アセットに関連付けられたMDSコンテンツをエクスポート・アーカイブに含めることはできなくなりました。レガシーMDSコンテンツを移行する必要がある場合は、標準のMDS WLSTコマンドimportMetadataを使用してください。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myPageTemplateExport.aarという名前のアーカイブから、WebCenter Portal内のMyPortalにページ・テンプレートをインポートします。

wls:/weblogic/serverConfig> importWebCenterResource(appName='webcenter',fileName='myPageTemplateExport.aar', spaceName='MyPortal', resourceType='pageTemplate')

次の例では、myDeviceExport.aarという名前のアーカイブから、WebCenter Portalにデバイスをインポートします。

wls:/weblogic/serverConfig> importWebCenterResource(appName='webcenter',fileName='myDeviceExport.aar', resourceType='device')

2.21.12 importWebCenterTranslations

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalで使用するための変換済コンテンツ(XLFファイル)をMDSおよびWebCenter Portalリポジトリにインポートします。

構文

importWebCenterTranslations(appName, server, mdsRootDir, [applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、名前は常にwebcenterです。

server

WebCenter Portalのデプロイ先となるターゲット管理対象サーバーの名前。たとえば、WC_Portalなどになります。

mdsRootDir

変換済XLFファイルが含まれるファイル・システム上のMDSルート・ディレクトリ。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ディレクトリ/scratch/shared/newmd内の 変換済コンテンツをMDSおよびWebCenter Portalリポジトリにインポートします。

wls:/weblogic/serverConfig> importWebCenterTranslations(appName='webcenter',
server='WC_Portal, mdsRootDir='/scratch/shared/newmd')

2.21.13 exportWebCenterApplication

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたファイル名を使用して、WebCenter Portalアプリケーション全体をエクスポート・アーカイブ(.parファイル)にエクスポートします。

構文

exportWebCenterApplication(appName, fileName, [connectionFileName, exportCustomizations, exportData, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、名前は常にwebcenterです。

fileName

エクスポートの書込み先となるエクスポート・アーカイブ(.parファイル)の名前。

connectionFileName

オプション。接続のエクスポートが実行される接続ファイルの名前。

exportCustomizations

オプション。この属性は非推奨です。

exportData

オプション。この属性は非推奨です。

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter PortalをmyAppExport.parという名前のファイルにエクスポートし、接続をconnection.propertiesファイルにエクスポートします。

wls:/weblogic/serverConfig>exportWebCenterApplication(appName='webcenter', fileName='myAppExport.par', connectionFileName='connection.properties')

次の例では、テストWebCenter Portalインスタンスをexport.parという名前のファイルにエクスポートします。この場合、テスト時に作成したデータ(リスト、イベント、リンク、タグなど)はエクスポートされません。

wls:/weblogic/serverConfig>exportWebCenterApplication(appName='webcenter', fileName='export.par')

2.21.14 importWebCenterApplication

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーション全体をエクスポート・アーカイブ・ファイルから管理対象サーバーにインポートします。

WebCenter Portalのインポート後、アプリケーションのデプロイ先である管理対象サーバーを再起動する必要があります。

構文

importWebCenterApplication(appName, fileName, [connectionFileName, importConnections, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

fileName

インポートする必要があるエクスポート・アーカイブの名前。

connectionFileName

オプション。接続のインポートが実行される接続ファイルの名前。

importConnections

オプション。connectionFileNameパラメータまたはエクスポート・アーカイブから接続をインポートするかどうかを指定します。

有効な値は1および0です。デフォルト値は1です。

1 - 接続をインポートします

0 - 接続をインポートしません

server

オプション。WebCenter Portalのデプロイ先の管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、エクスポート・アーカイブmyAppExport.parからWebCenter Portalをインポートします。

wls:/weblogic/serverConfig> importWebCenterApplication(appName='webcenter',
fileName='myAppExport.par')

2.21.15 exportPortletClientMetadata

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

WebCenter Portalのポートレット・クライアント・メタデータおよびプロデューサのカスタマイズとパーソナライズをエクスポートします。このコマンドは、指定したエクスポート・アーカイブ(.earファイル)に、すべてのアプリケーションのプロデューサに関するメタデータをエクスポートします。特定のプロデューサのメタデータをエクスポートすることはできません。

構文

exportPortletClientMetadata(appName, fileName, [exportPersonalizations, server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、名前は常にwebcenterです。

fileName

エクスポートの書込み先となるエクスポート・アーカイブ(.earファイル)の名前。

exportPersonalizations

オプション。有効な値は、1 (true)および0 (false)です。

- 1 - すべてのプロデューサのパーソナライズがエクスポートされます。

- 0 - パーソナライズはエクスポートされません。

この引数のデフォルトは、1です。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myExport.earという名前のエクスポート・アーカイブにポートレット・クライアント・メタデータおよびプロデューサのカスタマイズをエクスポートします。パーソナライズはエクスポートされません。

wls:/weblogic/serverConfig> exportPortletClientMetadata(appName='myApp', fileName='myExport.ear', exportPersonalizations=0)

次の例では、サーバーWC_CustomPortal1にデプロイされたバージョン番号V2.0のアプリケーションのポートレット・クライアント・メタデータをエクスポートします。

wls:/weblogic/serverConfig> exportPortletClientMetadata(appName='myApp', fileName='myExport.ear', server='WC_CustomPortal1', applicationVersion='V2.0')

2.21.16 importPortletClientMetadata

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定したエクスポート・アーカイブからポートレット・クライアント・メタデータおよびプロデューサのカスタマイズとパーソナライズをインポートします。

プロデューサのパーソナライズをエクスポートするかどうかはオプションです。指定されたエクスポート・アーカイブにパーソナライズが含まれている場合には、プロデューサのパーソナライズもインポートされます。

構文

importPortletClientMetadata(appName, fileName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、名前は常にwebcenterです。

fileName

インポートする必要があるエクスポート・アーカイブの名前。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Portalなどになります。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myExport.earという名前のエクスポート・アーカイブから、ポートレット・クライアント・メタデータおよびプロデューサのカスタマイズとパーソナライズをインポートします。

wls:/weblogic/serverConfig> importPortletClientMetadata(appName='myApp', fileName='myExport.ear')

2.21.17 showProducerImportFailures

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたアプリケーションの残りのプロデューサ・インポートを一覧表示します。

デプロイメントまたはインポート操作後に初めてアプリケーションを起動したときに、そのアプリケーションによって使用されるプロデューサを使用できない場合、プロデューサのインポートは失敗します。

構文

showProducerImportFailures(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、名前は常にwebcenterです。

server

アプリケーションがデプロイされている管理対象サーバーの名前。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)に対するプロデューサのインポートの失敗を表示します。

wls:/weblogic/serverConfig> showProducerImportFailures(appName='webcenter')

2.21.18 retryAllFailedProducerImports

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

残りのプロデューサ・メタデータをインポートします。

デプロイメントまたはインポート操作後に初めてアプリケーションを起動したときに、そのアプリケーションによって使用されるプロデューサを使用できない場合、プロデューサのインポートは失敗することがあります。このコマンドを使用して、前にメタデータのインポートが失敗したプロデューサのメタデータをインポートします。

構文

retryAllFailedProducerImports(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、名前は常にwebcenterです。

server

アプリケーションがデプロイされている管理対象サーバーの名前。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal (webcenter)の欠落しているプロデューサ・メタデータをインポートします。

wls:/weblogic/serverConfig> retryAllFailedProducerImports(appName='webcenter')

Importing metadata from the following producers failed for application webcenter.
Producer Description : Serialised stack trace:
[[
oracle.portlet.client.container.PortletHttpException: HTTP <unknown method> request to URL...
...
Failure Id : /oracle/adf/portlet/producerImportFailures/producerImportFailure2
Producer Id : /oracle/adf/portlet/JSR286FilePref
Producer Name : JSR286FilePref

Tried to re-import producer metadata for application webcenter.
Attempt to re-import producer metadata succeeded.

注意:

以前にプロデューサのインポートを試みたときに発生したエラーと例外が表示されるため、このコマンドでどの失敗済のプロデューサを再インポートしようとしているかを確認できます。

2.21.19 cloneWebCenterManagedServer

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

指定されたベース管理対象サーバーと同じリソースを使用して、新しい管理対象サーバーを作成します。

構文

cloneWebCenterManagedServer(baseManagedServer, newManagedServer, newManagedServerPort, [verbose])

引数

定義

baseManagedServer

ベース管理対象サーバーの名前。

newManagedServer

新しいクローニングされた管理対象サーバーの名前。

newManagedServerPort

新しい管理対象サーバーのポート番号。

verbose

オプション。管理対象サーバーを冗長モードで作成します。有効な値は1および0です。

1に設定すると、作成プロセス中に、診断に役立つ追加の進捗情報が表示されます。

デフォルトは0です。

例

次の例では、WC_Portal管理対象サーバーのクローンを作成します。新しい管理対象サーバーの名前は、WC_Portal2になります。

wls:/weblogic/serverConfig> cloneWebCenterManagedServer(baseManagedServer='WC_Portal', newManagedServer='WC_Portal2', newManagedServerPort=1234)

2.22 アップグレード

表2-29に示すコマンドを使用して、前のOracle WebCenter Portalリリースからアップグレードします。

表2-29 Oracle WebCenter PortalのアップグレードWLSTコマンド

使用するコマンド

目的

WLSTでの使用

upgradeWebCenterPortal

WebCenter Portalをアップグレードします。

オンライン

listDeprecatedFeaturesUsage

アップグレードされたWebCenter Portalアプリケーションで使用された非推奨の接続、タスクフローおよびポートレットをリストします。

オンライン

2.22.1 upgradeWebCenterPortal

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

リリース11gからリリース12cにWebCenter Portalをアップグレードします。

Oracle WebCenter Portalは、Content ServerのFrameworkFolderフォルダ・サービスをサポートします。既存のOracle WebCenter PortalインスタンスがFolders_gを使用するよう構成されている場合、このコマンドはWebCenter PortalおよびWebCenter Content ServerをFrameworkFoldersに移行し、WebCenter Portalをリリース12cにアップグレードします。

アップグレードの詳細は、Oracle WebCenterのアップグレードのOracle WebCenter Portalのアップグレードに関する項を参照してください。

注意:
upgradeWebCenterPortalコマンドを実行する前に、ノード・マネージャが稼働していることを確認します。

構文

upgradeWebCenterPortal(appName, server, migrationDirectory, [contentServerName, contentDbConnectionUrl, contentDbUserName, includeFolders, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Spacesです。

アプリケーションが同じコンテンツ・サーバー接続を共有するクラスタ環境では(つまり、アプリケーションが同じコンテンツ・サーバーに接続し、同じルート・フォルダとセキュリティ・グループを共有)、このコマンドは1台の管理対象サーバーに対してのみ実行してください。

migrationDirectory

アップグレード・ログが書き込まれる(書込み権限がある)絶対ディレクトリ・パス。

WebCenter PortalがFolders_gベースのContent Serverを使用するよう構成されている場合、このディレクトリにはFolders_gからFrameworkFoldersへの移行に関連するデータが含まれます。

マルチノード設定の場合、これはすべてのノードからアクセスおよび書込みが可能な共有ディレクトリである必要があります。また、ディレクトリはすべてのノードから同じパスを使用してアクセス可能である必要があります。

contentServerName

オプション。WebCenter Content Serverのデプロイ先の管理対象サーバーの名前。たとえば、UCM_server1などです。

WebCenter PortalがContent Serverを使用するよう構成されている場合、この引数を指定します。

contentDbConnectionUrl

オプション。

WebCenter Contentスキーマ(名前付きOCS)があるデータベースの接続URL。接続URL形式host:port:sidを使用します。

contentDbUserName

オプション。

注意: contentDbConnectionUrlを指定する場合は必須です。

移行するWebCenter Contentスキーマ(名前付きOCS)のユーザー名。

includeFolders

オプション。Folders_gからFrameworkFoldersへの移行に含めるフォルダのカンマ区切りのリスト。PersonalSpacesフォルダとWebCenter Portalルート・フォルダはデフォルトで移行されます。

たとえば、Contribution FoldersとCommon Templatesを移行する場合、includeFolders='Contribution Folders,Common Templates'を指定します。移行後、Contribution Foldersは/Enterprise Libraries/Contribution Foldersとして移行され、Common Templatesは/Enterprise Libraries/Common Templatesとして移行されます。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WC_Spaces管理対象サーバーにデプロイされるWebCenter Portalをアップグレードします。アップグレード・ログは、ディレクトリ/tmp/upgradeに書き込まれます。

wls:/weblogic/serverConfig> upgradeWebCenterPortal(appName='webcenter', server='WC_Spaces', migrationDirectory='/tmp/upgrade');

次の例では、WebCenter PortalおよびWebCenter Content ServerをFrameworkFoldersにアップグレードし、WC_Spaces管理対象サーバーにデプロイされるWebCenter Portalをアップグレードします。アップグレード・ログは、ディレクトリ/tmp/upgradeに書き込まれます。デフォルト・フォルダの他に、Contribution Foldersも移行されます。

wls:/weblogic/serverConfig> upgradeWebCenterPortal(appName='webcenter', server='WC_Spaces', migrationDirectory='/tmp/upgrade',
contentServerName='UCM_server1', contentDbConnectionUrl='wccdbhost.example.com:wccdbport:wccdbsid', contentDbUserName='SCHEMA_PREFIX_OCS', includeFolders='Contribution Folders');

注意:
upgradeWebCenterPermissions WLSTコマンドを実行すると、権限がすでに存在する特定のエラー・メッセージが表示されます。次に例を示します。

Already in Domain Runtime Tree

Command FAILED, Reason: JPS-04201: Cannot grant permission(s). Grant already
exists for grantee [GranteeEntry: codeSource=null principals=[[AppRole:
appID=webcenter name=webcenter#-#defaultadministrator displayName=null
description=null category=null
uniquename=cn=webcenter\#-\#defaultadministrator,cn=Roles,cn=webcenter,cn=wc_d
omain,cn=JPSContext,cn=jpsRoot guid=66FBB210983411E49F671B16134D61DE
members=[] classname=oracle.security.jps.service.policystore.ApplicationRole
type=JPS_APPLICATION_ROLE]]].

そのようなエラー・メッセージによる機能への影響はありません。エラー・メッセージを無視しても問題なく、WebCenter Portalインスタンスのアップグレードを続行できます。

2.22.2 listDeprecatedFeaturesUsage

モジュール: Oracle WebCenter Portal

WLSTでの使用: オンライン

説明

アップグレードされたWebCenter Portalアプリケーションで使用された非推奨の接続、タスクフローおよびポートレットをリストします。このコマンドを実行して、単一のポータル、複数のポータルまたはアプリケーション全体の非推奨の使用状況をリストできます。このコマンドによって、詳細なレポートも生成されます。詳細は、Oracle WebCenterのアップグレードのOracle WebCenter Portalのアップグレードに関する項を参照してください。

構文

listDeprecatedFeaturesUsage(appName, server, reportDirectory, [portal, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。

WebCenter Portalの場合、アプリケーション名は常にwebcenterです。

server

アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Spacesです。

アプリケーションが同じコンテンツ・サーバー接続を共有するクラスタ環境では(つまり、アプリケーションが同じコンテンツ・サーバーに接続し、同じルート・フォルダとセキュリティ・グループを共有)、このコマンドは1台の管理対象サーバーに対してのみ実行してください。

reportDirectory

レポートが書き込まれる絶対ディレクトリ・パス(書込み権限を持つ)。

portal

オプション。レポートを生成する必要があるカンマ区切りのポータル名。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WC_Spaces管理対象サーバーにデプロイされるWebCenter Portalで使用された非推奨の接続、タスクフローおよびポートレットをリストします。レポートはディレクトリ/tmp/reportに書き込まれます。

wls:/weblogic/serverConfig>listDeprecatedFeaturesUsage(appName='webcenter', server='WC_Portal', reportDirectory='/tmp/report')

次の例では、WC_Portal管理対象サーバーにデプロイされるHRPortalおよびFinancePortalで使用された非推奨の接続、タスクフローおよびポートレットをリストします。レポートはディレクトリ/tmp/reportに書き込まれます。

wls:/weblogic/serverConfig>listDeprecatedFeaturesUsage(appName='webcenter', server='WC_Portal', reportDirectory='/tmp/report', portal='HRPortal,FinancePortal')

3 Oracle WebCenter ContentカスタムWLSTコマンド

この章では、Oracle WebCenter Content用のカスタムWLSTコマンド、およびそのコマンド構文、引数、コマンド例を詳細に説明します。

次の項では、Oracle WebCenter ContentのWLSTカスタム・コマンドについて説明します。これらのコマンドを使用して、Oracle WebCenter Content ServerおよびOracle WebCenter Content Serverインスタンスをコマンド・ラインから構成および監視できます。内容は次のとおりです。

- WLST WebCenter Contentコマンド・カテゴリの概要

- WLST WebCenter Contentのヘルプ

- ゲッター・メソッドとセッター・メソッドの実装

- サーバー構成コマンド

- 電子メール構成コマンド

- システム・ステータス・コマンド

- 一般構成コマンド

- コンテンツ・セキュリティ構成コマンド

- コンポーネント・マネージャ構成コマンド

- レコード管理構成コマンド

- ユーザー・インタフェース・コマンド

- ユーザー・インタフェース接続コマンド

Oracle WebCenter ContentおよびContent Serverの管理と構成の詳細は、『Oracle Fusion Middlewareの管理』を参照してください。

注意:

Oracle WebCenter Contentカスタム・コマンドを使用するには、コンポーネントがインストールされたOracle共通ホームからWLSTスクリプトを呼び出す必要があります。詳細は、『Oracle Fusion Middlewareの管理』のJavaコンポーネントおよびOracle Fusion MiddlewareサービスでのWLSTの使用に関する項を参照してください。

3.1 WLST WebCenter Contentコマンド・カテゴリの概要

WLST WebCenter Contentコマンドは次のカテゴリに分かれています。

表3-1 WLST WebCenter Contentコマンド・カテゴリ

コマンド・カテゴリ

説明

サーバー構成コマンド

Content Serverインスタンスのサーバー構成オプションを表示および管理します。

電子メール構成コマンド

Content Serverインスタンスの電子メール構成オプションを表示および管理します。

システム・ステータス・コマンド

Content Serverインスタンスのシステム・ステータス情報を表示します。

一般構成コマンド

Content Serverインスタンスの一般構成オプションを表示および管理します。

コンテンツ・セキュリティ構成コマンド

Content Serverインスタンスのコンテンツ・セキュリティ構成オプションを表示および管理します。

コンポーネント・マネージャ構成コマンド

Content Serverインスタンスのコンポーネント・マネージャ構成オプションを表示および管理します。

レコード管理構成コマンド

Content Serverインスタンスのレコード管理構成オプションを表示および管理します。

ユーザー・インタフェース・コマンド

オプションのOracle WebCenter Contentユーザー・インタフェースの構成を表示および管理します。

ユーザー・インタフェース接続コマンド

WebCenter Content 11gリリース1 (11.1.1.8)で導入されたOracle WebCenter Contentユーザー・インタフェース用の接続を表示および管理します。

3.2 WLST WebCenter Contentのヘルプ

WLSTから呼び出すことができるWebCenter Content UCMコマンドを表示するには、WLSTプロンプトで次のコマンドを入力します。

help('UCM')

特定のOracle Webcenter Contentコマンドのヘルプを表示するには、次のようにコマンドの名前を指定します。

help('getUCMServerPort')

help('wccAdfConfig')

3.3 ゲッター・メソッドとセッター・メソッドの実装

Oracle Webcenter Content向けのWLSTコンポーネントは、getterおよびsetterメソッドを使用して、複数のアプリケーションがそれらに対応するMbeanを管理対象サーバー上に登録しているがWLSTは1つのアプリケーションのみと通信できる状況を処理します。

getterメソッド

getterメソッドは、ゼロまたは1つの引数を処理するように設計されています。

WLST WebCenter Contentコマンドに引数を指定しない場合、次の2つのうちの1つが発生します。

- サーバー上に1つのアプリケーションのみによってそのMbeanが登録されている場合、WLST WebCenter Contentコマンドは正常に機能し、その出力が表示されます。

- サーバー上に複数のアプリケーションによってMbeanが登録されている場合、エラー・メッセージが表示され、引数に具体的なアプリケーション名を入力するように求めらます。

WLST WebCenter Contentコマンドに対する引数が1つである場合、次のようになります。

- 引数を入力するときに、適切なアプリケーション名を入力する必要があります。名前が適切に入力されていない場合、エラー・メッセージが表示され、引数に有効なアプリケーション名を入力するように求めらます。

setterメソッド

setterメソッドは、1つまたは2つの引数を処理するように設計されています。

- 最初の引数は、パラメータに設定するvalueです。

- 2番目の引数はapplication nameであり、NULLまたは文字列です。

3.4 サーバー構成コマンド

表3-2のコマンドを使用して、Oracle WebCenter Content Serverインスタンスを構成します。

これらのカスタム・コマンドを使用する前に、次のように初期WLST接続を設定します。

1. 環境変数ORACLE_HOMEを<Middleware_Home>/Oracle_ECM1に設定します。

2. 次の場所からWLSTスクリプトを実行します。<middleware_home>/Oracle_ECM1/common/bin

3. connect()コマンド(たとえば、connect("weblogic","password","t3://localhost:16200"))を使用して、WebCenter Content Serverインスタンスに接続します。

表3-2 WLSTサーバー構成コマンド

使用するコマンド

目的

WLSTでの使用

getUCMHttpServerAddress

HTTPサーバー・アドレス値を表示します。

オンライン

getUCMServerPort

Intradoc Server Port構成パラメータを表示します。

オンライン

setUCMServerPort

Intradoc Server Port構成パラメータを設定します。

オンライン

getUCMIpAddressFilter

IPアドレス・フィルタ値を表示します。

オンライン

setUCMIpAddressFilter

IPアドレス・フィルタ値を設定します。

オンライン

getUCMUseSSL

SSLの使用に関する値を表示します。

オンライン

3.4.1 getUCMHttpServerAddress

WLSTでの使用: オンライン

説明

config.cfgファイルからHTTPサーバー・アドレス値を取得し、それを表示します。

構文

getUCMHttpServerAddress(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、アプリケーションOracle Universal Content Management - Content ServerのOracle Webcenter Content HTTPサーバー・アドレスを表示します。

getUCMHttpServerAddress('Oracle Universal Content Management - Content Server')
server.example.com

3.4.2 getUCMServerPort

WLSTでの使用: オンライン

説明

config.cfgファイルからIntradocサーバー・ポート構成パラメータを取得し、それを表示します。

構文

getUCMServerPort(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、アプリケーションOracle Universal Content Management - Content ServerのIntradocサーバー・ポート値を表示します。

getUCMServerPort('Oracle Universal Content Management - Content Server')
4442

3.4.3 setUCMServerPort

WLSTでの使用: オンライン

説明

サーバー・ポート構成パラメータを設定します。

構文

setUCMServerPort(value,['appName'])

引数

定義

value

サーバーのポート番号。この数は、0-65535の正の整数である必要があります。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、アプリケーションOracle Universal Content Management - Content Serverのサーバー・ポート構成パラメータを設定します。

setUCMServerPort(4442,'Oracle Universal Content Management - Content Server')

3.4.4 getUCMIpAddressFilter

WLSTでの使用: オンライン

説明

config.cfgファイルからIPアドレス・フィルタ値を取得し、それを表示します。

構文

getUCMIPpAddressFilter(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、アプリケーションOracle Universal Content Management - Content ServerのIPアドレス・フィルタ値を表示します。

getUCMIpAddressFilter('Oracle Universal Content Management - Content Server')
10.131.123.*

3.4.5 setUCMIpAddressFilter

WLSTでの使用: オンライン

説明

WebCenter Content IPアドレス・フィルタ値を設定します。

構文

setUCMIpAddressFilter(value,['appName'])

引数

定義

value

WebCenter Content IPアドレス・フィルタ番号。この番号は、*.*.*.*形式またはIPV6形式である必要があります。値は、Intradoc Server Portを介してContent Serverインスタンスと通信するために許可されているIPアドレスのリストから取得する必要があります。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、アプリケーションOracle Universal Content Management - Content ServerのWebCenter Content IPアドレス・フィルタ値を設定します。

setUCMIpAddressFilter(10.131.123.*,'Oracle Universal Content Management - Content Server')

3.4.6 getUCMUseSSL

WLSTでの使用: オンライン

説明

config.cfgファイルからSSLの使用に関する値を取得し、それを表示します。値は、TrueまたはFalseです。

構文

getUCMUseSSL(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、アプリケーションOracle Universal Content Management - Content ServerのSSLの使用に関する値を表示します。

getUCMUseSSL('Oracle Universal Content Management - Content Server')
True

3.5 電子メール構成コマンド

表3-3のコマンドを使用して、Oracle WebCenter Content Serverインスタンスの電子メールを構成します。

表3-3 WLSTの電子メール構成コマンド

使用するコマンド

目的

WLSTでの使用

getUCMMailServer

メール・サーバー値を表示します。

オンライン

setUCMMailServer

メール・サーバー値を設定します。

オンライン

getUCMSmtpPort

SMTPポート値を表示します。

オンライン

getUCMSysAdminAddress

管理アドレス値を表示します。

オンライン

setUCMSysAdminAddress

管理アドレス値を設定します。

オンライン

3.5.1 getUCMMailServer

WLSTでの使用: オンライン

説明

config.cfgファイルからメール・サーバー値を取得し、それを表示します。

構文

getUCMMailServer(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、アプリケーションOracle Universal Content Management - Content Serverのメール・サーバー値を表示します。

getUCMMailServer('Oracle Universal Content Management - Content Server')
mymailserver.example.com

3.5.2 setUCMMailServer

WLSTでの使用: オンライン

説明

config.cfgファイル内のメール・サーバー値を設定します。

構文

setUCMMailServer(value,['appName'])

引数

定義

value

メール・サーバー値。この値は、SMTPベースの電子メールを送信するためにContent Serverインスタンスによって使用されるメール・サーバーの名前です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、アプリケーションOracle Universal Content Management - Content Serverのメール・サーバー値を設定します。

setUCMMailServer(mymailserver.example.com,'Oracle Universal Content Management - Content Server')

3.5.3 getUCMSmtpPort

WLSTでの使用: オンライン

説明

config.cfgファイル内のSMTPポート値を取得し、それを表示します。

構文

getUCMSmtpPort(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、アプリケーションOracle Universal Content Management - Content ServerのSMTPポート値を表示します。

getUCMSmtpPort('Oracle Universal Content Management - Content Server')
4055

3.5.4 getUCMSysAdminAddress

WLSTでの使用: オンライン

説明

config.cfgファイルから管理アドレス値を取得し、それを表示します。値は、abc@xyz.defの形式です。

構文

getUCMSysAdminAddress(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、アプリケーションOracle Universal Content Management - Content Serverの管理アドレス値を表示します。

getUCMSysAdminAddress('Oracle Universal Content Management - Content Server')
mymail@example.com

3.5.5 setUCMSysAdminAddress

WLSTでの使用: オンライン

説明

config.cfgファイル内の管理アドレス値を設定します。

構文

setUCMSysAdminAddress(value,['AppName'])

引数

定義

value

管理アドレス値。管理アドレスは、abc@xyz.defの形式です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、アプリケーションOracle Universal Content Management - Content Serverの管理アドレス値を設定します。

setUCMSysAdminAddress(mymail@example.com,'Oracle Universal Content Management - Content Server')

3.6 システム・ステータス・コマンド

表3-4のコマンドを使用して、WebCenter Content Serverインスタンスを監視するための追加の設定を構成します。

表3-4 WLSTの追加の構成コマンド

使用するコマンド

目的

WLSTでの使用

getUCMCSVersion

バージョン番号を表示します。

オンライン

getUCMServerUptime

稼働時間値を表示します。

オンライン

3.6.1 getUCMCSVersion

WLSTでの使用: オンライン

説明

Content Serverの実行中のインスタンスのバージョン番号を取得します。

構文

getUCMCSVersion(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、アプリケーションOracle Universal Content Management - Content Serverのアクティブ・インスタンスのバージョン番号を表示します。

getUCMCSVersion('Oracle Universal Content Management - Content Server')
11g R1

3.6.2 getUCMServerUptime

WLSTでの使用: オンライン

説明

Content Serverインスタンスの稼働していた時間の長さを取得します。

構文

getUCMServerUptime(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、アプリケーションOracle Universal Content Management - Content Serverが稼働していた時間の長さを表示します。

getUCMServerUptime('Oracle Universal Content Management - Content Server')
00H:01 Min:12 Sec

3.7 一般構成コマンド

表3-5のコマンドを使用して、Oracle WebCenter Content Serverインスタンスの一般構成オプションを構成します。

表3-5 WLST一般構成オプション・コマンド

使用するコマンド

目的

WLSTでの使用

getUCMOverRideFormat

OverRideFormat値を表示します。

オンライン

setUCMOverRideFormat

OverRideFormat値を設定します。

オンライン

getUCMDownloadApplet

DownloadApplet値を表示します。

オンライン

setUCMDownloadApplet

DownloadApplet値を設定します。

オンライン

getUCMMultiUpload

MultiUpload値を表示します。

オンライン

setUCMMultiUpload

MultiUpload値を設定します。

オンライン

getUCMUseAccounts

UseAccount値を表示します。

オンライン

setUCMUseAccounts

UseAccount値を設定します。

オンライン

getUCMIsAutoNumber

AutoNumber値を表示します。

オンライン

setUCMIsAutoNumber

AutoNumber値を設定します。

オンライン

getUCMAutoNumberPrefix

AutoNumberPrefix値を表示します。

オンライン

setUCMAutoNumberPrefix

AutoNumberPrefix値を設定します。

オンライン

getUCMMajorRevLabelSeq

MajorRevLabelSeq値を表示します。

オンライン

setUCMMajorRevLabelSeq

MajorRevLabelSeq値を設定します。

オンライン

getUCMMinorRevLabelSeq

MinorRevLabelSeq値を表示します。

オンライン

setUCMMinorRevLabelSeq

MinorRevLabelSeq値を設定します。

オンライン

getUCMJspServerEnabled

JspServerEnabled値を表示します。

オンライン

setUCMJspServerEnabled

JspServerEnabled値を設定します。

オンライン

getUCMJspEnabledGroups

JspEnabledGroups値を表示します。

オンライン

setUCMJspEnabledGroups

JspEnabledGroups値を設定します。

オンライン

3.7.1 getUCMOverRideFormat

WLSTでの使用: オンライン

説明

config.cfgファイルから、OverrideFormatパラメータが設定されているかどうかを示す値を取得します。OverrideFormatパラメータを使用すると、ユーザーがコンテンツ・アイテムのアプリケーション形式を選択できるようになります。

構文

getUCMOverRideFormat(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、OverRideFormatパラメータ値を表示します。

getUCMOverRideFormat()
true

3.7.2 setUCMOverRideFormat

WLSTでの使用: オンライン

説明

OverrideFormatパラメータを設定すると、ユーザーがコンテンツ・アイテムのアプリケーション形式を選択する機能を有効または無効にできます。

構文

getUCMOverRideFormat('value',['appName'])

引数

定義

value

OverrideFormatオプションを有効にするか無効にするかを指定します。指定できる値は、Yes、No、True、False、1または0です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、OverRideFormatパラメータを有効にします。

getUCMOverRideFormat('True')

3.7.3 getUCMDownloadApplet

WLSTでの使用: オンライン

説明

config.cfgファイルから、DownloadAppletパラメータが設定されているかどうかを示す値を取得します。DownloadAppletを使用すると、ユーザーが複数のファイルを検索結果ページからダウンロードできるようになります。

構文

getUCMDownloadApplet(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、DownloadAppletパラメータ値を取得します。

getUCMDownloadApplet()
true

3.7.4 setUCMDownloadApplet

WLSTでの使用: オンライン

説明

DownloadAppletパラメータを設定すると、ユーザーが複数のファイルを検索結果ページからダウンロードする機能を有効または無効にできます。

構文

setUCMDownloadApplet('value',['appName'])

引数

定義

value

DownloadAppletオプションを有効にするか無効にするかを指定します。指定できる値は、Yes、No、True、False、1または0です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、この機能を有効にするようDownloadApplet値を設定します。

setUCMDownloadApplet('Yes')

3.7.5 getUCMMultiUpload

WLSTでの使用: オンライン

説明

config.cfgファイルから、MultiUploadパラメータが設定されているかどうかを示す値を取得します。MultiUploadを使用すると、複数のファイルを単一のコンテンツ・アイテムとして圧縮およびチェックインできるようになります。

構文

getUCMMultiUpload(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、MultiUploadパラメータ値を表示します。

getUCMMultiUpload()
true

3.7.6 setUCMMultiUpload

WLSTでの使用: オンライン

説明

MultiUploadパラメータ値を設定すると、複数のファイルを単一のコンテンツ・アイテムとして圧縮およびチェックインする操作を許可または拒否できます。

構文

setUCMMultiUpload('value',['appName'])

引数

定義

value

MultiUploadオプションを有効にするか無効にするかを指定します。指定できる値は、Yes、No、True、False、1または0です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、複数のファイルを単一のコンテンツ・アイテムとして圧縮およびチェックインする操作を許可するようMultiUploadを設定します。

setUCMMultiUpload('1')

3.7.7 getUCMUseAccounts

WLSTでの使用: オンライン

説明

config.cfgファイルから、UseAccountsパラメータが設定されているかどうかを示す値を取得します。UseAccountsを使用すると、Oracle WebCenter Content内でアカウントを使用できるようになります。

構文

getUCMUseAccounts(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、UseAccountsオプション値を表示します。

getUCMUseAccounts()
True

3.7.8 setUCMUseAccounts

WLSTでの使用: オンライン

説明

UseAccountsパラメータ値を設定すると、Oracle WebCenter Content内でのアカウントの使用を有効または無効にできます。

構文

setUCMUseAccounts('value',['appName'])

引数

定義

value

UseAccountsオプションを有効にするか無効にするかを指定します。指定できる値は、Yes、No、True、False、1または0です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、Oracle WebCenter Content内でアカウントを有効にするようUseAccountsを設定します。

setUCMUseAccounts('True')

3.7.9 getUCMIsAutoNumber

WLSTでの使用: オンライン

説明

config.cfgファイルから、IsAutoNumberパラメータが設定されているかどうかを示す値を取得します。IsAutoNumberパラメータを使用すると、コンテンツIDの自動番号付けが可能になります。

構文

getUCMIsAutoNumber(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、IsAutoNumberパラメータ値を表示します。

getUCMIsAutoNumber()
True

3.7.10 setUCMIsAutoNumber

WLSTでの使用: オンライン

説明

IsAutoNumberパラメータ値を設定すると、コンテンツIDの自動番号付けを有効または無効にできます。

構文

setUCMIsAutoNumber('value',['appName'])

引数

定義

value

AutoNumberオプションを有効にするか無効にするかを指定します。指定できる値は、Yes、No、True、False、1または0です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、コンテンツIDの自動番号付けを有効にするようIsAutoNumberを設定します。

setUCMIsAutoNumber('True')

3.7.11 getUCMAutoNumberPrefix

WLSTでの使用: オンライン

説明

config.cfgファイルから、AutoNumberPrefixパラメータ値を取得します。AutoNumberパラメータが有効になっている場合、新しくチェックインしたファイルに対して自動的に番号付けされるすべてのコンテンツIDに、この接頭辞が使用されます。

構文

getUCMAutoNumberPrefix(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、AutoNumberPrefixパラメータ値を表示します。

getUCMAutoNumberPrefix()
dadvml0231usor

3.7.12 setUCMAutoNumberPrefix

WLSTでの使用: オンライン

説明

AutoNumberPrefixパラメータ値を、新しくチェックインしたファイルに対して自動的に番号付けされる(AutoNumberパラメータが有効になっている場合)すべてのコンテンツIDに使用する接頭辞に設定します。

構文

setUCMUseAutoNumberPrefix('value',['appName'])

引数

定義

value

新しくチェックインしたファイルに対して自動的に番号付けされるすべてのコンテンツIDに使用する接頭辞です。AutoNumberパラメータが有効になっている場合のみ適用されます。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、AutoNumberPrefixを設定します。

setUCMAutoNumberPrefix('dadvml0231usor')

3.7.13 getUCMMajorRevLabelSeq

WLSTでの使用: オンライン

説明

config.cfgファイルから、リビジョン番号のメジャー・シーケンスを定義するMajorRevLabelSeq値を取得します。MajorRevLabelSeqは、リビジョン・ラベルの先頭部分です。

構文

getUCMMajorRevLabelSeq(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、MajorRevLabelSeqパラメータ値を表示します。

getUCMMajorRevLabelSeq()
A1

3.7.14 setUCMMajorRevLabelSeq

WLSTでの使用: オンライン

説明

リビジョン番号のメジャー・シーケンスを定義するMajorRevLabelSeqパラメータ値を設定します。MajorRevLabelSeqは、リビジョン・ラベルの先頭部分です。

構文

setUCMMajorRevLabelSeq('value',['appName'])

引数

定義

value

値には、A-D、1-8のいずれかを指定できます。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、MajorRevLabelSeqをA1に設定します。

setUCMMajorRevLabelSeq('A1')

3.7.15 getUCMMinorRevLabelSeq

WLSTでの使用: オンライン

説明

config.cfgファイルから、リビジョン番号のマイナー・シーケンスを定義するMinorRevLabelSeq値を取得します。MinorRevLabelSeqは、リビジョン・ラベルの2番目の部分です。

構文

getUCMMinorRevLabelSeq(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、MinorRevLabelSeqパラメータ値を表示します。

getUCMMinorRevLabelSeq()
b2

3.7.16 setUCMMinorRevLabelSeq

WLSTでの使用: オンライン

説明

リビジョン番号のマイナー・シーケンスを定義する、MinorRevLabelSeqパラメータ値を設定します。MinorRevLabelSeqは、リビジョン・ラベルの2番目の部分です。

構文

setUCMMinorRevLabelSeq('value',['appName'])

引数

定義

value

値には、a-c、1-7のいずれかを指定できます。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、MinorRevLabelSeqをb2に設定します。

setUCMMinorRevLabelSeq('b2')

3.7.17 getUCMJspServerEnabled

WLSTでの使用: オンライン

説明

config.cfgファイルから、JspServerEnabledが設定されているかどうかを示す値を取得します。パラメータが有効になっている場合、Content ServerでJava Server Pagesを実行できます。Java Server Pagesは、Content Serverにチェックインされている必要があります。

構文

getUCMJspServerEnabled(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、JspServerEnabledパラメータ値を表示します。

getUCMJspServerEnabled()
true

3.7.18 setUCMJspServerEnabled

WLSTでの使用: オンライン

説明

JspServerEnabledパラメータ値を設定します。パラメータが有効になっている場合、Content ServerでJava Server Pagesを実行できます。Java Server Pagesは、Content Serverにチェックインされている必要があります。

構文

setUCMJspServerEnabled('value',['appName'])

引数

定義

value

パラメータを有効にするか無効にするかを指定します。指定できる値は、Yes、No、True、False、1または0です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、JspServerEnabledをtrueに設定します。

setUCMJspServerEnabled('true')

3.7.19 getUCMJspEnabledGroups

WLSTでの使用: オンライン

説明

config.cfgファイルから、JspEnabledGroupsパラメータ値を取得し、リストします。JspEnabledGroupsでは、Java Server Page機能が有効になっているセキュリティ・グループをリストします。セキュリティ・グループには、コントリビュータおよび管理者用の特定の権限が含まれます。

構文

getUCMJspEnabledGroups(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、JspEnabledGroupsパラメータ値を表示します。

getUCMJspEnabledGroups()
group1
Jsp

3.7.20 setUCMJspEnabledGroups

WLSTでの使用: オンライン

説明

Java Server Page機能を有効にするセキュリティ・グループを指定する、JspEnabledGroupsパラメータ値を設定します。

構文

setUCMJspEnabledGroups('value',['appName'])

引数

定義

value

Java Server Page機能を有効にするセキュリティ・グループを指定します。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、JspEnabledGroupsをgroup1に設定します。

setUCMJspEnabledGroups('group1')

3.8 コンテンツ・セキュリティ構成コマンド

表3-6のコマンドを使用して、Oracle WebCenter Content Serverインスタンスのコンテンツ・セキュリティ・オプションを構成します。

表3-6 WLSTコンテンツ・セキュリティ構成コマンド

使用するコマンド

目的

WLSTでの使用

getUCMCopyAccess

CopyAccessパラメータ値を表示します。

オンライン

setUCMCopyAccess

CopyAccessパラメータ値を設定します。

オンライン

getUCMExclusiveCheckout

ExclusiveCheckoutパラメータ値を表示します。

オンライン

setUCMExclusiveCheckout

ExclusiveCheckoutパラメータ値を設定します。

オンライン

getUCMAuthorDelete

AuthorDeleteパラメータ値を表示します。

オンライン

setUCMAuthorDelete

AuthorDeleteパラメータ値を設定します。

オンライン

getUCMShowOnlyKnownAccounts

ShowOnlyKnownAccountsパラメータ値を表示します。

オンライン

setUCMShowOnlyKnownAccounts

ShowOnlyKnownAccountsパラメータ値を設定します。

オンライン

3.8.1 getUCMCopyAccess

WLSTでの使用: オンライン

説明

config.cfgファイルから値を取得し、それを表示します。CopyAccessを有効にすると、コンテンツ・アイテムの読取り権限を持つユーザーがネイティブ・ファイルのコピーを取得できるようになります。

構文

getUCMCopyAccess(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、CopyAccess値を表示します。

getUCMCopyAccess()
True

3.8.2 setUCMCopyAccess

WLSTでの使用: オンライン

説明

config.cfgファイル内のCopyAccess値を設定します。CopyAccessを有効にすると、コンテンツ・アイテムの読取り権限を持つユーザーがネイティブ・ファイルのコピーを取得できるようになります。

構文

setUCMCopyAccess('value',['appName'])

引数

定義

value

パラメータを有効にするか無効にするかを指定します。指定できる値は、Yes、No、True、False、1または0です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、CopyAccessパラメータを有効にするよう値を設定します。

setUCMCopyAccess('True')

3.8.3 getUCMExclusiveCheckout

WLSTでの使用: オンライン

説明

config.cfgファイル内の値を取得し、それを表示します。ExclusiveCheckoutパラメータを有効にすると、別のユーザーによってチェックインされたコンテンツ・アイテムをチェックアウトする場合に、管理権限が必要になります。

構文

getUCMExclusiveCheckout(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、ExclusiveCheckoutパラメータ値を表示します。

getUCMExclusiveCheckout()
True

3.8.4 setUCMExclusiveCheckout

WLSTでの使用: オンライン

説明

config.cfgファイル内の値を設定します。ExclusiveCheckoutパラメータを有効にすると、別のユーザーによってチェックインされたコンテンツ・アイテムをチェックアウトする場合に、管理権限が必要になります。

構文

setUCMExclusiveCheckout('value',['appName'])

引数

定義

value

パラメータを有効にするか無効にするかを指定します。指定できる値は、Yes、No、True、False、1または0です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、ExclusiveCheckoutパラメータを有効にするよう値を設定します。

setUCMExclusiveCheckout('True')

3.8.5 getUCMAuthorDelete

WLSTでの使用: オンライン

説明

config.cfgファイルから値を取得し、それを表示します。AuthorDeleteパラメータを有効にすると、削除権限を持っていない作成者がリビジョンを削除できるようになります。

構文

getUCMAuthorDelete(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、AuthorDeleteパラメータ値を表示します。

getUCMAuthorDelete()
1

3.8.6 setUCMAuthorDelete

WLSTでの使用: オンライン

説明

config.cfgファイル内のAuthorDeleteパラメータ値を設定します。AuthorDeleteパラメータを有効にすると、削除権限を持っていない作成者がリビジョンを削除できるようになります。

構文

setUCMAuthorDelete('value',['appName'])

引数

定義

value

パラメータを有効にするか無効にするかを指定します。指定できる値は、Yes、No、True、False、1または0です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、AuthorDeleteパラメータを有効にします。

setUCMAuthorDelete('1')

3.8.7 getUCMShowOnlyKnownAccounts

WLSTでの使用: オンライン

説明

config.cfgファイルから値を取得し、それを表示します。ShowOnlyKnownAccountsパラメータを有効にすると、チェックイン・ページに表示されるContent Serverアカウントのリストに、グローバルに事前定義されたアカウントのみが含まれます。

構文

getUCMShowOnlyKnownAccounts(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、有効になっているShowOnlyKnownAccountsパラメータ値を表示します。

getUCMShowOnlyKnownAccounts()
Yes

3.8.8 setUCMShowOnlyKnownAccounts

WLSTでの使用: オンライン

説明

config.cfgファイル内のShowOnlyKnownAccountパラメータ値を設定します。ShowOnlyKnownAccountsパラメータを有効にすると、チェックイン・ページに表示されるContent Serverアカウントのリストに、グローバルに事前定義されたアカウントのみが含まれます。

構文

setUCMShowOnlyKnownAccounts('value',['appName'])

引数

定義

value

パラメータを有効にするか無効にするかを指定します。指定できる値は、Yes、No、True、False、1または0です。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、ShowOnlyKnownAccountsパラメータを有効にします。

setUCMShowOnlyKnownAccounts('yes')

3.9 コンポーネント・マネージャ構成コマンド

表3-7のコマンドを使用して、Oracle WebCenter Content Serverインスタンスのコンポーネント・マネージャ・オプションを構成します。

表3-7 WLSTコンポーネント・マネージャ構成コマンド

使用するコマンド

目的

WLSTでの使用

getUCMComponentStatus

コンポーネントのステータスを表示します。

オンライン

setUCMComponentStatus

コンポーネントのステータスを設定します。

オンライン

installUCMComponent

コンポーネントをインストールします。

オンライン

uninstallUCMComponent

コンポーネントをアンインストールします。

オンライン

getUCMComponentConfig

コンポーネントの構成を表示します。

オンライン

updateUCMComponentConfig

コンポーネントの構成パラメータを設定します。

オンライン

3.9.1 getUCMComponentStatus

WLSTでの使用: オンライン

説明

コンポーネントのステータスを取得します。ステータスは有効または無効になっています。

構文

getUCMComponentStatus('componentName',['appName'])

引数

定義

componentName

有効なContent Serverコンポーネント名を指定します。たとえば、ContentFoliosなどです。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、コンポーネントContentFoliosのステータスを表示します。

getUCMComponentStatus('ContentFolios')
Enabled

3.9.2 setUCMComponentStatus

WLSTでの使用: オンライン

説明

config.cfgファイル内のコンポーネントのステータスを設定します。

構文

setUCMComponentStatus('componentName','status',['appName'])

引数

定義

componentName

有効なContent Serverコンポーネント名を指定します。たとえば、ContentFoliosなどです。

status

コンポーネントのステータスを有効にするか無効にするかを指定します。指定できる値は、EnableまたはDisableです。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、ContentFoliosのステータスをEnableに設定します。

setUCMComponentStatus('ContentFolios','Enable')

3.9.3 installUCMComponent

WLSTでの使用: オンライン

説明

指定したファイルの場所にあるコンポーネントをインストールします。

構文

installUCMComponent('filePath',['appName'])

引数

定義

filePath

コンポーネントへの有効なファイル・パスを指定します。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、場所C:/manifest.zipにあるコンポーネントをインストールします。

installUCMComponent('C:/manifest.zip')

3.9.4 uninstallUCMComponent

WLSTでの使用: オンライン

説明

指定したコンポーネントをアンインストールします。

構文

uninstallUCMComponent('componentName',['appName'])

引数

定義

componentName

有効なContent Serverコンポーネント名を指定します。たとえば、ContentFoliosなどです。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、ContentFoliosという名前のコンポーネントをアンインストールします。

uninstallUCMComponent('ContentFolios')

3.9.5 downloadUCMComponent

WLSTでの使用: オンライン

説明

指定したファイルの場所に、指定したコンポーネントをダウンロードします。

構文

downloadUCMComponent('componentName','filePath',['appName'])

引数

定義

componentName

有効なContent Serverコンポーネント名を指定します。たとえば、ContentFoliosなどです。

filePath

コンポーネントへの有効なファイル・パスを指定します。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、コンポーネントContentFoliosをC:/manifest.zipにダウンロードします。

downloadUCMComponet('ContentFolios', 'C:/manifest.zip')

3.9.6 getUCMComponentConfig

WLSTでの使用: オンライン

説明

指定したコンポーネントの構成を取得し、それを表示します。

構文

getUCMComponentConfig('componentName',['appName'])

引数

定義

componentName

有効なコンポーネント名を指定します。たとえば、ContentFoliosなどです。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、コンポーネントContentFoliosの構成を表示します。

getUCMComponentConfig('ContentFolios')

3.9.7 updateUCMComponentConfig

WLSTでの使用: オンライン

説明

指定した構成オプションを使用して、指定したコンポーネントを設定します。

構文

updateUCMComponentConfig('componentName','updateParams',['appName'])

引数

定義

componentName

有効なコンポーネント名を指定します。たとえば、Folders_gなどです。

updateParams

コンポーネントの有効なパラメータを指定します。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、コンポーネントFolders_gの構成パラメータを設定します。

updateUCMComponentConfig('Folders_g','GetCopyAccess:true,CollectionHiddenMeta:xHidden')

3.10 レコード管理構成コマンド

表3-8のコマンドを使用して、Oracle WebCenter Content Serverインスタンスのレコード管理オプションを構成します。

表3-8 WLSTレコード管理構成コマンド

使用するコマンド

目的

WLSTでの使用

getRMLevel

レコード管理構成のタイプを表示します。

オンライン

getRMConfigurationLevel

レコード管理構成レベルを表示します。

オンライン

getRMFeatures

レコード管理機能を表示します。

オンライン

getRMDispositionActions

レコード管理処理アクションを表示します。

オンライン

rmUpdate

レコード管理構成を更新します。

オンライン

addOutgoingProvider

レコード管理コンテンツの格納に使用するアダプタ・サーバーの送信プロバイダを追加します。

オンライン

registerSource

レコード管理で検出できるように、アダプタ・サーバー・リポジトリのソースを登録します。

オンライン

3.10.1 getRMLevel

WLSTでの使用: オンライン

説明

レコード管理構成のタイプを取得し、それを表示します。タイプを示す値は、次のとおりです。

- none

- standalone

- adapter

構文

getRMLevel(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、レコード管理構成のタイプを表示します。

getRMLevel()
adapter

3.10.2 getRMConfigurationLevel

WLSTでの使用: オンライン

説明

レコード管理構成レベルを取得し、それを表示します。構成レベルを示す値は、次のとおりです。

- minimal: 最小限の機能を有効にし、一部の処理アクションと大部分のアプリケーション機能を除外します。これはソフトウェアを有効にしたときのデフォルトです。

- typical: DoD構成、分類されたトピック、FOIA/PAトラッキング(情報公開法/プライバシ法)および電子メールを除くすべての処理アクションとすべての機能を有効にします。

- dod2: 標準インストールの機能、DoD構成および電子メールを有効にします。

- dodclassified: FOIA/PAを除くすべての機能を有効にします。

- custom: 様々な機能を選択できるようにします。一部の処理アクションは、他のアクションに依存しています。アクションを選択すると、依存アクションも自動的に選択されます。

構文

getRMConfigurationLevel(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、レコード管理構成のタイプを表示します。

getRMConfigurationLevel(['appName'])
minimal

3.10.3 getRMFeatures

WLSTでの使用: オンライン

説明

レコード管理機能のリストを取得し、それを表示します。リストに含まれる値は、次のとおりです。

- feature_related_content

- feature_audit_trigger

- feature_subject_to_review

- feature_revision_dates

- feature_security_markings

- feature_email_fields

- feature_dod_config

- feature_foia_privacyact

構文

getRMFeatures(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、レコード管理機能を表示します。

getRMFeatures()
feature_related_content
feature_audit_trigger
feature_subject_to_review

3.10.4 getRMDispositionActions

WLSTでの使用: オンライン

説明

レコード管理処理アクションの値を取得し、それらを表示します。リストに含まれる値は、次のとおりです。

- actions_activate

- actions_obsolete

- actions_cancel

- actions_rescind

- actions_expire

- actions_cutoff

- actions_approve_deletion

- actions_destroy

構文

getRMDispositionActions(['appName'])

引数

定義

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドは、レコード管理処理アクションのリストを表示します。

getRMDispositionActions()
actions_active
actions_obsolete
actions_cancel

3.10.5 rmUpdate

WLSTでの使用: オンライン

説明

レコード管理構成に機能と処理アクションを設定し、その構成を有効にします。

構文

rmUpdate(urmLevel, level, featuresList, dispositionActionsList, enableRTMandURMAgent,['appName'])

引数

定義

urmLevel

有効なレコード管理構成タイプを指定します。

level

有効なレコード管理レベルを指定します。

featuresList

有効なレコード管理機能を指定します。

dispositionActionsList

有効な処理アクションを指定します。

enableRTMandURMAgent

RTMおよびURMエージェントを有効にするかどうかを指定します。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、レコード管理構成を設定し、それを有効にします。

rmUpdate(urmLevel='standalone',level='custom',featuresList='feature_related_content:feature_revision_dates',dispositionActionsList='actions_activate:actions:obsolete',enableRTMandURMAgent='1')

3.10.6 addOutgoingProvider

WLSTでの使用: オンライン

説明

レコード管理が有効になっているContent Serverインスタンスへのアダプタ・サーバーの接続を可能にする送信プロバイダを定義します。

構文

addOutgoingProvider(ProviderName, ProviderDescription, ServerHostName, HTTPServerAddress,
ServerPort, InstanceName, RelativeWebRoot, extraUpdateParams,['appName'])

引数

定義

ProviderName

送信プロバイダの名前。

ProviderDescription

送信プロバイダの説明。

ServerHostname

サーバー・ホストの名前。

HTTPServerAddress

HTTPサーバーのアドレス。

ServerPort

サーバー・ポートの番号。

IntanceName

レコード管理が有効になっているContent Serverインスタンスの名前。

RelativeWebRoot

相対Webルートの名前。

extraUpdateParams

使用可能な追加パラメータは、ClientHostIpFilter、ConnectionPassword、ConnectionPasswordName、IsRefinery、ProviderClass、ProviderConfig、ProviderConnection、RefineryMaxProJobsおよびRefineryReadOnlyです。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、レコード管理インスタンスに接続するアダプタ・サーバーの送信プロバイダを定義します。

addOutgoingProvider(ProviderName='x',ProviderDescription='y',ServerHostName='localhost',HTTPServerAddress='z',ServerPort='4444',InstanceName='w',
RelativeWebRoot='cs',updateParams='RefineryMasJobs:100,IsRefinery:1')

3.10.7 registerSource

WLSTでの使用: オンライン

説明

登録を行うと、レコード管理によってアダプタが認識され、アダプタ・サーバーのリポジトリに格納されているコンテンツの管理が可能になります。

構文

registerSource(ProviderName, SourceName, SourceTableName, SourceDisplayName, ['appName'])

引数

定義

ProviderName

送信プロバイダの名前。

SourceName

アダプタ・リポジトリ内にあるソースの説明。

SourceTableName

アダプタ・リポジトリ内にあるソース表の名前。

SourceDisplayName

アダプタ・リポジトリ内にあるソースの表示名。

appName

オプション。デプロイ済アプリケーションの名前。

例

次のコマンドでは、レコード管理の格納済コンテンツに使用する、アダプタ・サーバーのリポジトリ・ソースを登録します。

registerSource(ProviderName='x',SourceName='y',SourceTableName='z',SourceDisplayName='w")

3.11 ユーザー・インタフェース・コマンド

表3-9のコマンドを使用して、Oracle WebCenter Content 11gリリース1 (11.1.1.8)で導入されたOracle WebCenter Contentユーザー・インタフェースの構成を表示および更新します。このユーザー・インタフェースの詳細は、Oracle WebCenter Contentの使用のWebCenter Contentユーザー・インタフェースのスタート・ガイドに関する説明を参照してください。

これらのカスタム・コマンドを使用するには、適切なOracleホームからWLSTスクリプトを呼び出す必要があります。WebLogic ServerホームのWLSTスクリプトは使用しないでください。Oracle WebCenter Contentユーザー・インタフェース・コマンド用のスクリプトは、次の場所にあります。

- UNIX: MW_HOME/oracle_common/common/bin/wlst.sh

- Windows: MW_HOME\oracle_common\common\bin\wlst.cmd

WLSTプロセスがWebCenter Content UIサーバーに接続してから、次の表のコマンドを実行する必要があります。

Content UIサーバー・インスタンスに接続するには、たとえば、connect()コマンドを使用します。

connect("weblogic","password","t3://localhost:16225").

これらのWLSTコマンドを使用して行った構成の変更は、WebCenter Content - Web UIアプリケーションがデプロイされている管理対象サーバーを再起動した後にのみ有効になります。

表3-9 WLST WebCenter Contentユーザー・インタフェース・コマンド

使用するコマンド

目的

WLSTでの使用

displayWccAdfConfig

WebCenter Contentユーザー・インタフェース・アプリケーションの構成を表示します。

オンライン

updateWccAdfConfig

WebCenter Contentユーザー・インタフェース・アプリケーションの構成を更新します。

オンライン

3.11.1 displayWccAdfConfig

WLSTでの使用: オンライン

説明

Oracle WebCenter Contentユーザー・インタフェース・アプリケーションの構成を表示します。

構文

displayWccAdfConfig(appName='value',[attrName='value'])

引数

定義

appName value

デプロイ済アプリケーションの名前。

attrName value

オプション。表示する属性の名前。省略した場合、すべての属性が表示されます。

例

次のコマンドは、Oracle WebCenter Content - Web UIというアプリケーション名でデプロイされたOracle WebCenter Contentユーザー・インタフェースのすべての構成属性を表示します。

wls:/wccadf_domain/serverConfig> displayWccAdfConfig(appName='Oracle WebCenter Content - Web UI')
WccInstanceName = Default
WccInstanceConnectionName = WccAdfServerConnection
ProxyContent = true
DocumentPreview = DOCUMENT_VIEWER
DefaultLocale = en_US
DefaultTimeZone = America/Los_Angeles
ApplicationUrl = null
ClusterCompatible = false
TemporaryDirectory = null
MaximumUploadedFileSize = 52428800
MaximumWindowsPerSession = 7
WccLoginPageEnabled = true
SkinFamily = wcc-skin
SkinVersion = null
CustomBrandingLogo = null
CustomBrandingTitle = null
WccCustomizationLayerValues = null
OracleCustomizationLayerValues = null
CustomerCustomizationLayerValues = null
CustomRequestBinderProperties = null
UnfiledDocumentProhibited = false

次のコマンドは、WccInstanceConnectionNameという名前の構成属性の値を表示します。

wls:/wccadf_domain/serverConfig> displayWccAdfConfig(appName='Oracle WebCenter Content - Web UI', attrName='WccInstanceConnectionName')
Attribute WccInstanceConnectionName value is: WccAdfServerConnection

3.11.2 updateWccAdfConfig

WLSTでの使用: オンライン

説明

Oracle WebCenter Contentユーザー・インタフェース・アプリケーションの構成を更新します。このコマンドを使用すると、単一の属性または複数の属性を更新できます。

構文

updateWccAdfConfig(appName, [wccInstanceName], [wccInstanceConnectionName],
[proxyContent], [documentPreview], [defaultLocale], [defaultTimeZone],
[applicationUrl], [clusterCompatible], [temporaryDirectory],
[maximumUploadedFileSize], [maximumWindowsPerSession],
[wccLoginPageEnabled], [skinFamily], [skinVersion], [customBrandingLogo],
[customBrandingTitle], [wccCustomizationLayerValues],
[oracleCustomizationLayerValues], [customerCustomizationLayerValues],
[customRequestBinderProperties], [unfiledDocumentProhibited])

引数

定義

appName

デプロイ済アプリケーションの名前。

wccInstanceName

将来の使用のために予約されています。

wccInstanceConnectionName

接続アーキテクチャ(connections.xml)に含まれるContent Server接続の名前。

proxyContent

ネイティブ・ファイル、Web表示可能レンディション、サムネイル、添付ファイルなどのドキュメント・コンテンツをブラウザでどのように取得するかを制御します。trueまたはfalseを指定する必要があります。trueの場合、ブラウザはこのコンテンツをOracle WebCenter Contentユーザー・インタフェースから要求し、そのインタフェースがコンテンツをContent Serverから取得します。falseの場合、ブラウザはこのコンテンツを直接Content Serverから要求します。

documentPreview

ドキュメントに対して表示されるプレビューを制御します。次のいずれかの値を、大文字と小文字を区別して指定する必要があります。

- DOCUMENT_VIEWER: ドキュメント・ビューアを使用します(使用可能な場合)。

- WEB_VIEWABLE: Web表示可能レンディションを表示します(使用可能な場合)。

- NONE: プレビューを表示しません

defaultLocale

ユーザーのロケールを他の方法で特定できない場合に使用するロケールです。Javaクラスjava.util.Localeで使用される形式である必要があります(en_USなど)。

defaultTimeZone

ユーザーのタイムゾーンを他の方法で特定できない場合に使用するタイムゾーン。Javaメソッドjava.util.TimeZone#getTimeZoneで使用される形式である必要があります(America/Los_Angelesなど)。

applicationUrl

Oracle WebCenter Contentユーザー・インタフェースによって生成されるURLのスキーム、ホスト名およびポートを指定します(https://wcc.example.com:16225など)。オプション。設定されていない場合、スキーム、ホスト名およびポートはHTTPリクエストから特定されます。

clusterCompatible

Oracle WebCenter Contentユーザー・インタフェースで、クラスタに含まれるノード間のセッション・レプリケーションをサポートするかどうかを指定します。trueまたはfalseを指定します。Java EE Webコンテナでセッション・レプリケーションが有効になっている場合は、trueを指定する必要があります。

temporaryDirectory

進行中のアップロードなど、Oracle WebCenter Contentユーザー・インタフェースによって作成される一時ファイルのベース・ディレクトリ。このディレクトリは空である必要があります。また、十分な空き領域を備えた高速ファイル・システム上にあり、Oracle WebCenter Contentユーザー・インタフェースを実行しているプロセスの所有者によってのみ読取りおよび書込み可能である必要があります。Oracle WebCenter Contentユーザー・インタフェースによって、サブディレクトリ構造が作成および管理されます。また、clusterCompatibleがtrueの場合、このディレクトリが存在するファイル・システムは、クラスタに含まれるすべてのノード間で共有されている必要があります。この属性は、clusterCompatibleがfalseの場合でも設定することをお薦めします。設定されていない場合、Javaシステム・プロパティjava.io.tmpdirの値が使用されます。

maximumUploadedFileSize

アップロードされるファイルの最大サイズ(バイト単位)。0未満の場合、最大サイズはありません。0の場合、ファイルのアップロードは無効になります。

maximumWindowsPerSession

セッションごとのアクティブ・ウィンドウ(ブラウザ構成によっては、ブラウザのタブ)の最大数。この制限値に達すると、最近最も使用されていないウィンドウが期限切れになり、続けてそのウィンドウを使用すると、エラー・メッセージが表示されます。

Oracle WebCenter Contentユーザー・インタフェースのメイン・ページであるwccmainは、セッションのウィンドウ・カウントとは無関係であり、セッションが期限切れになったときか、セッションからのログアウトが発生したときのみ期限切れになります。ドキュメント・プロパティ・ページであるwccdocは、documentPreviewがDOCUMENT_VIEWERの場合、2つのウィンドウと見なされますが、documentPreviewがWEB_VIEWABLEまたはNONEの場合は、1つのウィンドウと見なされます。

この属性は、各セッションで使用するアプリケーション・サーバー・メモリーの最大量を制御するために使用します。セッションごとのウィンドウ数を制限しない場合は、0に設定します。

wccLoginPageEnabled

wccloginページを有効にするか無効にするかを指定します。trueまたはfalseを指定します。シングル・サインオン(SSO)認証が有効になっている場合、ユーザーがSSOのかわりにwccloginページを使用しないように、この属性値をfalseに設定する必要があります。

skinFamily

スキン・ファミリの名前。trinidad-config.xmlの<skin-family>は、この属性の値に設定されます。

skinVersion

スキン・バージョン。trinidad-config.xmlの<skin-version>は、この属性の値に設定されます。オプション。設定されていない場合、スキン・バージョンは指定されません。

customBrandingLogo

ブランド・バーに表示するイメージのHTTP URL。オプション。設定されていない場合、デフォルト・イメージが表示されます。

customBrandingTitle

ブランド・バーに表示するタイトル。オプション。設定されていない場合、デフォルト・タイトルが表示されます。

wccCustomizationLayerValue

wccカスタマイズ・レイヤーの値。複数の値を定義するには、カンマ区切り形式を使用します。オプション。設定しない場合、このレイヤーはカスタマイズできません。例: demo、testまたはproduction。

oracleCustomizationLayerValues

oracleカスタマイズ・レイヤーの値。複数の値を定義するには、カンマ区切り形式を使用します。オプション。設定しない場合、このレイヤーはカスタマイズできません。例: demo、testまたはproduction。

customerCustomizationLayerValues

customerカスタマイズ・レイヤーの値。複数の値を定義するには、カンマ区切り形式を使用します。オプション。設定しない場合、このレイヤーはカスタマイズできません。例: demo、testまたはproduction。

customRequestBinderProperties

ContentProxyServletリクエストによってContent Serverサービス・コールに挿入できるサポート済カスタム・プロパティのリスト。複数の値を定義するには、カンマ区切り形式を使用します。オプション。設定しない場合、Content Serverサービス・コールでは注入は行われません。例: XFND_SCHEME_ID、XFND_RANDOMおよびXFND_EXPIRES。

unfiledDocumentProhibited

未ファイルのドキュメントの作成を制御します。値がtrueの場合、未ファイルのドキュメントのアップロードもファイル済ドキュメントの未ファイル化も無効になります。オプション。デフォルト値はfalseです。

例

次のコマンドでは、Oracle WebCenter Content - Web UIというアプリケーション名でデプロイされたOracle WebCenter Contentユーザー・インタフェースのproxyContent属性をtrueに設定します。この設定により、ブラウザはドキュメント・コンテンツをContent Serverから直接取得せず、Oracle WebCenter Contentユーザー・インタフェースから取得するようになります。

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', proxyContent=true)

次のコマンドでは、defaultLocale属性をen_US、defaultTimeZone属性をAmerica/Los_Angelesに設定します。Oracle WebCenter Contentユーザー・インタフェースで、ユーザーの希望するロケールおよびタイムゾーンを(ユーザー・プリファレンスなどに基づいて)特定できない場合、デフォルト言語は英語になり、America/Los_Angelesタイムゾーンを使用して時刻が表示されます。

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', defaultLocale='en_US', defaultTimeZone='America/Los_Angeles')

次のコマンドでは、temporaryDirectory属性を/prod/wcctmpに設定します。Oracle WebCenter Contentユーザー・インタフェースによって、アプリケーション・サーバー上のこのディレクトリに、一次ファイルが格納されます。

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', temporaryDirectory='/prod/wcctmp')

次のコマンドでは、wccLoginPageEnagledプロパティをfalseに設定します。これにより、ユーザーはwccloginページを使用したOracle WebCenter Contentユーザー・インタフェースへの認証を行わず、シングル・サインオン(SSO)の使用を求められるようになります。

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', wccLoginPageEnabled=false)

applcationUrl属性の値を設定することをお薦めします。

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', applicationUrl='https://wcc.example.com:16225')

maximumWindowsPerSession属性のデフォルト値は、7に設定されます。WebCenter Contentインスタンスでメモリー消費が多くなりすぎる場合、設定を4に変更して必要なヒープ・サイズを減らすことができます。

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', maximumWindowsPerSession=4)

3.12 ユーザー・インタフェース接続コマンド

表3-10のコマンドを使用して、WebCenter Content 11gリリース1 (11.1.1.8)で導入されたOracle WebCenter Contentユーザー・インタフェースの接続を管理します。このユーザー・インタフェースの詳細は、Oracle WebCenter Contentの使用のWebCenter Contentユーザー・インタフェースのスタート・ガイドに関する説明を参照してください。

これらのカスタム・コマンドを使用するには、適切なOracleホームからWLSTスクリプトを呼び出す必要があります。WebLogic ServerホームのWLSTスクリプトは使用しないでください。Oracle WebCenter Contentユーザー・インタフェース・コマンド用のスクリプトは、次の場所にあります。

- UNIX: MW_HOME/oracle_common/common/bin/wlst.sh

- Windows: MW_HOME\oracle_common\common\bin\wlst.cmd

WLSTプロセスがWebCenter Content UIサーバーに接続してから、次の表の接続コマンドを実行する必要があります。

Content UIサーバー・インスタンスに接続するには、たとえば、connect()コマンドを使用します。

connect("weblogic","password","t3://localhost:16225").

これらのWLSTコマンドを使用して行った構成の変更は、WebCenter Content - Web UIアプリケーションがデプロイされている管理対象サーバーを再起動した後にのみ有効になります。

表3-10 WLST WebCenter Contentユーザー・インタフェース接続コマンド

使用するコマンド

目的

WLSTでの使用

createRIDCConnection

新しいRIDC接続を作成します。

オンライン

updateRIDCConnection

既存のRIDC接続プロパティを更新します。

オンライン

listRIDCConnections

アプリケーション内に存在するすべてのRIDC接続MBeanをリストします。

オンライン

deleteRIDCConnection

既存のRIDC接続を削除します。

オンライン

displayRIDCConnection

RIDC接続Mbeanに関連付けられたすべての属性とそれらの値を取得します。オプションで、特定の属性名の値を取得できます。

オンライン

3.12.1 createRIDCConnection

WLSTでの使用: オンライン

説明

新しいRIDC接続参照を作成し、その接続名をMDSレイヤーに追加します。

構文

createRIDCConnection('appName','conName')

引数

タイプ

説明

appName

java.lang.String

接続を作成するアプリケーションの名前。

connName

java.lang.String

RIDC接続参照のプレースホルダーとなる接続の名前。

例

次のコマンドでは、アプリケーションOracle WebCenter Content - Web UI内にRIDC接続WccAdfServerConnectionを作成します。

createRIDCConnection('Oracle WebCenter Content - Web UI','WccAdfServerConnection')

3.12.2 updateRIDCConnection

WLSTでの使用: オンライン

説明

既存のRIDC接続参照の接続プロパティを更新します。これらの変更と追加はランタイム・データとして読み取られ、MDSレイヤーに保存されます。

構文

updateRIDCConnection(appName, connName, ['connUrl'], ['connSockettimeout'],
['connPoolMethod'], ['connPoolSize'], ['connWaitTime'], ['credUsername'],
['credPassword'], ['credAppidkey'], ['credImpersonationAllowed'], ['jaxwsStack'],
['jaxwsPolicy'], ['jaxwsJpsconfigfile'], ['jaxwsSkipstackoptimizations'],
['jaxwsServerInstancename'], ['jaxwsRegisteridentityswitchfilter'],
['httpLibrary'], ['idcsAlgorithm'], ['idcsKeystoreFile'],
['idcsKeystorePassword'], ['idcsKeystoreAlias'], ['idcsKeystoreAliasPassword'],
['idcsTrustmanagerFile'], ['idcsTrustmanagerPassword'], [sessionPoolSupport],
[sessionPoolAnonymousFallback], [sessionPoolCredentialProviderClass])

引数

タイプ

定義

appName

java.lang.String

接続を更新する必要があるアプリケーションの名前。

connName

java.lang.String

RIDC接続プロパティのプレースホルダーとなる接続の名前。

connURL

java.lang.String

RIDC接続のURLのプロパティ。

connSockettimeout

java.lang.Integer

RIDC接続のソケット・タイムアウト(秒単位)のプロパティ。

connPoolMethod

java.lang.String

RIDC接続のプール・メソッドのプロパティ。

connPoolSize

java.lang.Integer

RIDC接続のプール・サイズのプロパティ。

connWaitTime

java.lang.Integer

RIDC接続の待機時間のプロパティ。

credUsername

java.lang.String

RIDC認証資格証明のユーザー名のプロパティ。

credPassword

java.lang.String

RIDC認証資格証明のパスワードのプロパティ。

credAppidkey

java.lang.String

RIDC認証資格証明のappidキーのプロパティ。

credImpersonationAllowed

java.lang.Boolean

資格証明の偽装機能を許可するかどうかを示すプロパティ。

jaxwsStack

java.lang.String

JaxWsプロトコル・スタックのプロパティ。

jaxwsPolicy

java.lang.String

JaxWsプロトコル・ポリシーのプロパティ。

jaxwsJpsconfigfile

java.lang.String

JaxWsプロトコルJps構成ファイルのプロパティ。

jaxwsSkipstackoptimizations

java.lang.Boolean

JaxWsプロトコルのスタックの最適化をスキップするかどうかを示すプロパティ。

jaxwsServerInstancename

java.lang.String

JaxWsプロトコル・サーバー・インスタンス名のプロパティ。

jaxwsRegisteridentityswitchfilter

java.lang.Boolean

JAX-WSプロトコルのアイデンティティ・スイッチ・フィルタを登録するかどうかを示すプロパティ。

httpLibrary

java.lang.String

HTTPプロトコルのライブラリを示すプロパティ。

idcsAlgorith

java.lang.String

セキュアIntradocプロトコル・アルゴリズムのプロパティ。

idcsKeystoreFile

java.lang.String

セキュアIntradocプロトコル・キーストア・ファイルのプロパティ。

idcsKeystorePassword

java.lang.String

セキュアIntradocプロトコル・キーストア・パスワードのプロパティ。

idcsKeystorealias

java.lang.String

セキュアIntradocプロトコル・キーストア・エイリアスのプロパティ。

idcsKeystoreAliasPassword

java.lang.String

セキュアIntradocプロトコル・キーストア・エイリアス・パスワードのプロパティ。

idcsTrustmanagerFile

java.lang.String

セキュアIntradocプロトコル信頼マネージャ・ファイルを示すプロパティ。

idcsTrustmanagePassword

java.lang.String

セキュアIntradocプロトコル信頼マネージャ・パスワードのプロパティ。

sessionPoolSupport

java.lang.Boolean

RIDCセッション・プール・サポート済プロパティ。

sessionPoolAnonymousFallback

java.lang.Boolean

RIDCセッション・プール匿名フォールバック・プロパティ。

sessionPoolCredentialProviderClass

java.lang.String

RIDCセッション・プール資格証明プロバイダ・クラス・プロパティ。

例

次のコマンドでは、Intradocプロトコル接続のソケット・タイムアウトを90秒に更新します。

updateRIDCConnection('Oracle WebCenter Content - Web UI','WccAdfServerConnection',
connUrl='idc://contentserver:4444',credUsername='weblogic',connSockettimeout=90)

3.12.3 listRIDCConnections

WLSTでの使用: オンライン

説明

ADF接続アーキテクチャに基づくアプリケーション内に存在するすべてのRIDC接続MBeanをリストします。

構文

listRIDCConnections('appName')

引数

タイプ

説明

appName

java.lang.String

接続MBeanを戻す必要があるアプリケーションの名前。

例

次のコマンドでは、アプリケーションOracle WebCenter Content - Web UI内に存在する、接続タイプがRIDCのすべての接続MBeanを戻します。

listRIDCConnections('Oracle WebCenter Content - Web UI')

3.12.4 deleteRIDCConnection

WLSTでの使用: オンライン

説明

ADF接続アーキテクチャに基づくアプリケーション内に存在するすべてのRIDC接続MBeanをリストします。

構文

deleteRIDCConnection('appName','connName')

引数

タイプ

説明

appName

java.lang.String

接続を削除するアプリケーションの名前。

connName

java.lang.String

特定のアプリケーションに対して削除する接続の名前。

例

次のコマンドでは、アプリケーションOracle WebCenter Content - Web UI内に存在する接続名WccAdfServerConnectionを削除します。

deleteRIDCConnection('Oracle WebCenter Content - Web UI','WccAdfServerConnection')

3.12.5 displayRIDCConnection

WLSTでの使用: オンライン

説明

アプリケーションの特定の接続Mbean内に存在する、すべての属性の名前-値ペアを取得します。オプションで、アプリケーションの特定の接続Mbean内に存在する属性の値を取得できます。

構文

displayRIDCConnection(appName,connName,['attrName'])

引数

タイプ

説明

appName

java.lang.String

接続MBean属性の値が必要なアプリケーションの名前。

connName

java.lang.String

MBeanプロパティを含む接続の名前。

attrName

java.lang.String

オプション。値が必要な接続Mbean内の属性名。

例

次のコマンドでは、PropConnectionUrlの接続プロパティ値を取得します。

displayRIDCConnection('Oracle WebCenter Content - Web UI',
'WccAdfServerConnection','PropConnectionUrl')

次のコマンドでは、接続WccAdfServerConnection内に存在するすべての接続プロパティを取得します。

ddisplayRIDCConnection('Oracle WebCenter Content - Web UI', 'WccAdfServerConnection')

4 Oracle WebCenter Enterprise CaptureカスタムWLSTコマンド

この章では、Oracle WebCenter Enterprise Capture用のカスタムWLSTコマンド、およびそのコマンド構文、引数、コマンド例を詳細に説明します。

次以降の項では、Oracle WebCenter Enterprise CaptureのためのカスタムWLSTコマンドについて説明します。これらのコマンドを使用すると、コマンド・ラインからOracle WebCenter Enterprise Captureの様々な構成パラメータにアクセスおよび変更できます。内容は次のとおりです。

- WLST Oracle WebCenter Enterprise Captureコマンド・カテゴリの概要

- 構成コマンド

WLSTから呼び出すことができる、サポートされているすべてのCaptureコマンドを表示するには、WLSTプロンプトで次のコマンドを入力します。

help('capture')

Enterprise Captureワークスペース・コンソールの使用については、『Oracle WebCenter Enterprise Captureの管理』のCaptureワークスペース・コンソールについてに関する項を参照してください。

注意:

Oracle WebCenter Enterprise Captureカスタム・コマンドを使用するには、コンポーネントがインストールされたOracle CommonホームからWLSTスクリプトを起動する必要があります。Oracle WebCenter CaptureアプリケーションがデプロイされたOracle WebLogic Server管理対象サーバー(デフォルト・ポート16400)に接続するか、Oracle WebLogic Server管理サーバーに接続し、コマンドdomainRuntime()を実行することによって、場所をdomainRuntimeに変更します。

詳細は、『Oracle Fusion Middlewareの管理』のJavaコンポーネントおよびOracle Fusion MiddlewareサービスでのWLSTの使用に関する項を参照してください。

4.1 WLST Oracle WebCenter Enterprise Captureコマンド・カテゴリの概要

WLST Oracle WebCenter Enterprise Captureコマンドのカテゴリは、次のとおりです。

表4-1 WLST Oracle WebCenter Enterprise Captureコマンド・カテゴリ

コマンド・カテゴリ

説明

構成コマンド

Oracle WebCenter Enterprise Captureの構成を表示および管理します。

4.2 構成コマンド

表4-2のコマンドを使用して、Oracle WebCenter Enterprise Captureを構成します。

表4-2 WLSTサーバーOracle WebCenter Enterprise Capture構成コマンド

使用するコマンド

目的

WLSTでの使用

listWorkspaces

管理者またはワークスペース管理者がアクセスできるすべてのCaptureワークスペースをリストします。

オンライン

listBatches

指定したワークスペース内にあるすべてのバッチをリストします。

オンライン

exportBatch

イメージとメタデータを含むバッチを、zipファイルにエクスポートします。

オンライン

exportWorkspace

ドキュメント、メタデータ、スクリプト、プロファイルおよびジョブを含むCaptureワークスペース全体を、XMLファイルにエクスポートします。

オンライン

importWorkspace

exportWorkspaceコマンドで生成されるXMLファイルからワークスペースをインポートします

オンライン

unlockBatch

指定したバッチのバッチ・ロックに関するレコードを削除します。

オンライン

listLockedBatches

指定されたワークスペースのロックされたバッチのリストを表示します。

オンライン

listCaptureConfig

すべてのEnterprise Capture構成の属性と値のリストを表示します。

オンライン

getCaptureConfig

引数として指定した属性の値をフェッチします。

オンライン

setCaptureConfig

Enterprise Capture属性の値を、入力した値に設定します。

オンライン

scanForClientBundles

クライアント・バンドル・ディレクトリの更新済バンドルをスキャンします。

オンライン

deleteBundle

既存のクライアント・バンドルを削除します。

オンライン

setObjectProperty

Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)で定義されたプロパティの値を設定します。

オンライン

getObjectProperty

Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)のプロパティの特定の値を出力します。

オンライン

setObjectCredentials

Captureオブジェクト(プロセッサ・ジョブまたはコミット・プロファイル)に関連付けられるユーザー名とパスワードを設定します。

オンライン

updateScript

ワークスペース内でスクリプトを更新します。

オンライン

cloneWorkspaceFromID

既存のワークスペースをコピーし、新しいワークスペースを作成します。

オンライン

cloneWorkspaceFromFile

exportWorkspaceコマンドで作成された出力ファイルを読み取り、ワークスペースの一意のコピーを作成します。

オンライン

listImportHATokens

特定のワークスペースのすべてのインポート・プロセッサ・トークンを表示します。

オンライン

deleteImportHAToken

ECIMPORTHATOKENおよびECIMPORTHATOKENITEMS表から特定のインポート・プロセッサのHAトークンを削除します。

オンライン

4.2.1 listWorkspaces

WLSTでの使用: オンライン。

説明

管理者または Captureワークスペース管理者がアクセスできるすべてのワークスペースをリストします。

構文

listWorkspaces()

例

次の例では、すべてのワークスペースをリストし、先頭にそれらのIDを付けます。

listWorkspaces()
4 bills_workspace
2 certificates_workspace
5 receipts_workspace

4.2.2 listBatches

WLSTでの使用: オンライン。

説明

IDによって指定されたワークスペースのすべてのバッチをリストします。リストされる各バッチには、「バッチID」、「バッチ名」、「作成者」(ユーザー)、「最終更新者」(ユーザー)および「最終更新」(日付)という5つの列(この順序で表示されます)が含まれます。

構文

listBatches (WORKSPACE_ID)

引数

定義

WORKSPACE_ID

ワークスペースのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。

注意:
有効なワークスペースIDのリストを取得するには、listWorkspacesコマンドを使用します。

例

次の例では、IDが1の特定のワークスペースのバッチをリストします。

wls:/base_domain/domainRuntime> listBatches(1)
14 ABI1 <anonymous> <anonymous> 4/26/13
15 ABI2 <anonymous> <anonymous> 4/26/13
1 BCP11 captureuser <anonymous> 4/17/13

4.2.3 exportBatch

WLSTでの使用: オンライン。

説明

イメージとメタデータを含むバッチを、XMLファイルとバッチ・アイテム・ファイルを含むZIPファイルにエクスポートします。

構文

exportBatch(BATCH_ID,'FILE_NAME')

引数

定義

BATCH_ID

バッチのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のバッチに対して有効な引数です。

注意:
有効なバッチIDのリストを取得するには、listBatchesコマンドを使用します。

FILE_NAME

バッチのエクスポート先となるzipファイルの名前です。ファイル名は、その完全なパスとともに指定する必要があります。

注意:

パスは、オペレーティング・システムに関係なく、スラッシュ「/」で区切ってください。

例

次の例では、バッチをエクスポートします。

exportBatch(8,'/home/abc/batch8.zip')
Batch successfully exported

4.2.4 exportWorkspace

WLSTでの使用: オンライン。

説明

ドキュメント、メタデータ、スクリプト、プロファイルおよびジョブを含むワークスペース全体を、XMLファイルにエクスポートします。

注意:
ワークスペース・セキュリティ設定は、生成されたXMLファイルにはエクスポートされません。

構文

exportWorkspace(WORKSPACE_ID,'FILE_NAME')

引数

定義

WORKSPACE_ID

ワークスペースのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。

注意:
有効なワークスペースIDのリストを取得するには、listWorkspacesコマンドを使用します。

FILE_NAME

ワークスペースのエクスポート先となるファイルの名前です。ファイル名は、その完全なパスとともに指定する必要があります。

注意:

パスは、オペレーティング・システムに関係なく、スラッシュ「/」で区切ってください。

例

次の例では、IDが3のワークスペースをエクスポートします。

exportWorkspace(3,'/home/abc/workspace3.xml')
Workspace successfully exported

4.2.5 importWorkspace

WLSTでの使用: オンライン。

説明

exportWorkspaceコマンドを使用して生成したXMLファイルからワークスペースをインポートします。Oracle WebCenter Enterprise Captureデータベース内にあるワークスペースはインポートできません。

注意:
ワークスペースをインポートするときには、セキュリティ設定はインポートされません。

構文

importWorkspace('FILE_NAME')

引数

定義

FILE_NAME

ワークスペースのインポート元となるXMLファイルの名前です。ファイル名は、その完全なパスとともに指定する必要があります。

例

次の例では、名前がworkspace3.xmlのワークスペースをインポートします。

importWorkspace('/home/abc/workspace3.xml')
Workspace successfully imported

4.2.6 unlockBatch

WLSTでの使用: オンライン。

説明

指定したバッチのバッチ・ロックに関するレコードを削除します。バッチの状態がREADYになり、クライアントはそのバッチを開くことができます。

構文

unlockBatch('BATCH_ID')

引数

定義

BATCH_ID

バッチのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のバッチに対して有効な引数です。

注意:
ロックされたバッチのリストを取得するには、listLockedBatchesコマンドを使用します。

例

次の例では、IDが8のバッチのロックを解除します。

unlockBatch('8')
Batch successfully unlocked

4.2.7 listLockedBatches

WLSTでの使用: オンライン。

説明

ロックされたバッチのリストを表示します。リストされる各バッチには、「ワークスペースID」、「バッチID」、「バッチ名」、「作成者」(ユーザー)、ワークステーション(名前/IPアドレス)および「最終更新」(日付)という6つの列(この順序で表示されます)が含まれます。

構文

listLockedBatches('WORKSPACE_ID')

引数

定義

WORKSPACE_ID

ワークスペースのID番号です。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。

注意:
有効なワークスペースIDのリストを取得するには、listWorkspacesコマンドを使用します。

例

次の例では、IDが1のワークスペースのロックされたバッチをリストします。

wls:/base_domain/domainRuntime> listLockedBatches(1)
1 14 ABI1 <anonymous> sic01lzz.example.com 4/26/13
1 15 ABI2 <anonymous> slc01lzz.example.xom 4/26/13
1 17 BCP16 <captureuser> 10.159.104.189 4/30/13

4.2.8 listCaptureConfig

WLSTでの使用: オンライン。

説明

すべてのEnterprise Capture構成の属性と値のリストを表示します。値をフェッチできない場合、その値は「VALUE CANNOT BE DISPLAYED」と表示されます。値をフェッチできない最も可能性が高い原因は、権限が不十分であることです。

構文

listCaptureConfig()

例

次の例に、Enterprise Captureの構成の属性と値をリストします。

listCaptureConfig()
CaptureSystemID CAPTURE_01
BatchRefreshLimit 5

4.2.9 getCaptureConfig

WLSTでの使用: オンライン。

説明

引数として指定した属性の値をフェッチします。listCaptureConfigコマンドを使用して、可能な属性名をリストします。

構文

getCaptureConfig(['NAME_OF_ATTRIBUTE'])

引数

定義

NAME_OF_ATTRIBUTE

Enterprise Capture構成に対する属性の名前(文字列)です。

例

次の例では、Enterprise CaptureシステムIDに対する属性の値をフェッチします。

getCaptureConfig('CaptureSystemID')
CAPTURE_01

4.2.10 setCaptureConfig

WLSTでの使用: オンライン。

説明

Enterprise Capture属性の値を、入力した値に設定します。

構文

setCaptureConfig(['NAME_OF_ATTRIBUTE'],['VALUE_OF_ATTRIBUTE'])

引数

定義

NAME_OF_ATTRIBUTE

構成するEnterprise Captureの構成の属性名。

VALUE_OF_ATTRIBUTE

Enterprise Capture構成属性に設定する値です。

例

次の例では、CaptureSystemID属性を値CAPTURE_02に設定します。

setCaptureConfig('CaptureSystemID','CAPTURE_02')
Attribute 'CaptureSystemID' changed to "CAPTURE_02'

4.2.11 scanForClientBundles

WLSTでの使用: オンライン。

説明

クライアント・バンドル・ディレクトリのバンドルをスキャンします。既存のバンドルのデータが更新されるだけでなく、新しいバンドルの情報がロードされ、データベース内にキャッシュされます。

構文

scanForClientBundles()

例

次の例では、バンドルをスキャンし、処理済のバンドルをリストします。

scanForclientBundles()
Processed capture bundle.jar

4.2.12 deleteBundle

WLSTでの使用: オンライン。

説明

既存のバンドルを削除します。

構文

deleteBundle('bundlename')

引数

定義

bundlename

削除する既存のバンドルの名前です。

例

次の例では、指定したバンドルを削除します。

deleteBundle('Example')

4.2.13 setObjectProperty

WLSTでの使用: オンライン。

説明

Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)で定義されたプロパティの値を設定します。

各Captureオブジェクトに設定できるプロパティの詳細は、「Captureオブジェクト・プロパティ」を参照してください。

構文

setObjectProperty('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<PROPERTY_ASSIGNMENT_STRING>')

このコマンドに必要なパラメータは次のとおりです。

引数

定義

WORKSPACE_NAME

変更されるオブジェクトが含まれるCaptureワークスペースの名前。呼び出すユーザーが、複数のワークスペースに対して、指定された名前の権限を持っている場合、最初に検索されたワークスペースが使用されます。

注意:
ワークスペースのリストを取得するには、listWorkspacesコマンドを使用します。

CLASS_NAME

クライアント・プロファイル、プロセッサ・ジョブ、またはコミット・プロファイルを定義するクラスの名前。

OBJECT_IDENTIFIER

オブジェクトを見つけるために使用できるプロパティの名前と、そのプロパティの期待される値で構成されているキー/値ペア。

PROPERTY_ASSIGNMENT_STRING

更新するプロパティの名前と値を等号で区切ったもの。

注意点

次のリストに、setObjectPropertyコマンドを使用する場合の追加の注意点を示します。

- 変更可能なオブジェクトは、標準的なJavaBeanのゲッター/セッター・パターンを使用してプロパティを公開します。次の例では、メソッド getProfileDescとsetProfileDescが、Profileクラス内に存在すると想定しています。

- プロパティに割り当てられる値は、プロパティのデータ型と互換性を持っている必要があります。プロパティのデータ型と互換性を持たない値の場合、例外が発生します。

- 有効なクラス名を次に示します。

- oracle.oddc.data.Profile(変更されるCaptureオブジェクト: クライアント・プロファイル)

- oracle.odc.recognition.RecognitionJob(変更されるCaptureオブジェクト: 認識プロセッサ・ジョブ)

- oracle.odc.importprocessor.ImportJob(変更されるCaptureオブジェクト: インポート・プロセッサ・ジョブ)

- oracle.odc.entity.CommitProfileEntity(変更されるCaptureオブジェクト: コミット・プロファイル)

- oracle.odc.docconverter.DocConverterJob (変更されるCaptureオブジェクト: ドキュメント変換ジョブ)

- プロファイルまたはジョブ内でネストされたオブジェクト上に値を設定する必要がある場合、ネストされたプロパティにアクセスするために、「ドット」記法を使用できます: propertyName.propertyName=value。

- 複数のネスト・レベルがサポートされます。認識プロセッサ・ジョブのdocTypeBarcodeプロパティのbarcodeNameプロパティを変更する場合、次を使用できます。docTypeBarcode.barcodeName=value

- コレクションに含まれるオブジェクトのプロパティへのアクセスをサポートする場合、次のように「山カッコ」記法を使用できます: propertyName<identifierPropertyName=value>.propertyName=value。

- 山カッコの内側の値は、変更するオブジェクトをコレクション内で見つけるために使用されます。identifierPropertyNameはコレクション内でオブジェクトを識別するために使用できるプロパティの名前で、値は、プロパティが一致とみなされる場合に含む値です。例: barcodes<barcodeName=barcode 1>.barcodeName=barcode 2

例

- 次に示すのは、コミット・プロファイルに適用される<オブジェクト識別子>の例です。

profileName=Commit to CS

- 次に示すのは、クライアント・プロファイルのプロパティprofileDescを更新するための<プロパティ割当て文字列>の例です:

profileDesc=Test Profile Desc

- 次に示すのは、Commit to CSという名のWebCenter Contentコミット・プロファイルに関連付けられたプロパティ<serverURL>を設定する例です。

setObjectProperty('TEST_WORKSPACE','oracle.odc.entity.CommitProfileEntity','profileName=Commit to CS','serverURL=http://myhost.example.com:16200/cs/idcplg/')

4.2.14 getObjectProperty

WLSTでの使用: オンライン。

説明

Captureオブジェクト(クライアント・プロファイル、プロセッサ・ジョブまたはコミット・プロファイル)の特定のプロパティの値を出力します。

構文

getObjectProperty('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<PROPERTY_NAME>')

このメソッドに必要なパラメータは次のとおりです。

引数

定義

WORKSPACE_NAME

変更されるオブジェクトが含まれるCaptureワークスペースの名前。呼び出すユーザーが、複数のワークスペースに対して、指定された名前の権限を持っている場合、最初に検索されたワークスペースが使用されます。

注意:
ワークスペースのリストを取得するには、listWorkspacesコマンドを使用します。

CLASS_NAME

クライアント・プロファイル、プロセッサ・ジョブ、またはコミット・プロファイルを定義するクラスの名前。

OBJECT_IDENTIFIER

オブジェクトを見つけるために使用できるプロパティの名前と、そのプロパティの期待される値で構成されているキー/値ペア。

PROPERTY_NAME

アクセスするプロパティの名前。setObjectPropertyに記述したドット記法と山カッコ記法を使用して、アクセスするプロパティを分離することができます。

注意:

このコマンドに対するバッキングMBeanメソッドは、setObjectPropertyコマンドで行われた変更が反映されたかを検証するための自動化テストで使用できます。

例

- 有効なクラス名を次に示します。

oracle.oddc.data.Profile
oracle.odc.recognition.RecognitionJob
oracle.odc.importprocessor.ImportJob
oracle.odc.entity.CommitProfileEntity
oracle.odc.docconverter.DocConverterJob

- 次に示すのは、インポート・ジョブに適用される<オブジェクト識別子>の例です。

jobName=Import Email

- 電子メール・インポート・ジョブに関連付けられたプロパティ<serverName>の値を取得するための例を次に示します。

getObjectProperty('TEST-WORKSPACE','oracle.odc.importprocessor.ImportJob','jobName=Import Email','serverName')

4.2.15 setObjectCredentials

WLSTでの使用: オンライン。

説明

プロファイルまたはジョブに関連付けられたユーザー名とパスワードを設定するために使用されます。

構文

setObjectCredentials('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<USER_NAME>','<PASSWORD>')

このメソッドに必要なパラメータは次のとおりです。

引数

定義

WORKSPACE_NAME

変更される資格証明が含まれるCaptureワークスペースの名前。呼び出すユーザーが、複数のワークスペースに対して、指定された名前の権限を持っている場合、最初に検索されたワークスペースが使用されます。

注意:
ワークスペースのリストを取得するには、listWorkspacesコマンドを使用します。

CLASS_NAME

資格証明の変更に必要なクラスの名前。

OBJECT_IDENTIFIER

変更するオブジェクトのプロパティ名と予期される値から構成される、キー/値ペア。

USER_NAME

オブジェクトの資格証明に割り当てるユーザー名。

PASSWORD

オブジェクトの資格証明に割り当てるパスワード。

例

- 有効なクラス名は、次のとおりです。

oracle.odc.importprocessor.ImportJob
oracle.odc.entity.CommitProfileEntity

- 電子メール・インポート・ジョブに関連付けられた資格証明を設定する例を次に示します。

setObjectCredentials('TEST-WORKSPACE','oracle.odc.importprocessor.ImportJob','jobName=import Email','xyz@example.com','welcome123')

- WebCenter Imagingコミット・プロファイルに関連付けられた資格証明を設定する例を次に示します。

setObjectCredentials('TEST-WORKSPACE','oracle.odc.entity.CommitProfileEntity','profileName=commit to Imaging','admin','welcome123')

4.2.16 updateScript

WLSTでの使用: オンライン。

説明

ワークスペース内でスクリプトを更新します。

構文

updateScript('<WORKSPACE_NAME>','<SCRIPT_NAME>','<SCRIPT_FILE>')

このコマンドに必要なパラメータは次のとおりです。

引数

定義

WORKSPACE_NAME

スクリプトを含むワークスペースの名前。ワークスペースの一意の識別子をルックアップするためには、名前を使用する必要があります。名前が見つからない場合、エラー・メッセージが表示されます。

注意:
ワークスペースのリストを取得するには、listWorkspacesコマンドを使用します。

SCRIPT_NAME

更新するスクリプトの名前。スクリプトが見つからない場合、エラー・メッセージが表示されます。

SCRIPT_FILE

更新されるスクリプト・ファイルへの絶対パス。スクリプトは、このファイルのコンテンツで更新されます。

例

次の例は、ワークスペース内でスクリプトを更新します。

updateScript('TEST-WORKSPACE','Client_Script','/scratch/aime/scripts/client.txt')

4.2.17 cloneWorkspaceFromID

WLSTでの使用: オンライン。

説明

IDで指定されたワークスペースの一意のコピーを作成します。

構文

cloneWorkspaceFromID(WORKSPACE_ID, 'WORKSPACE_NAME', 'WORKSPACE_DESCRIPTION')

このコマンドに必要なパラメータは次のとおりです。

引数

定義

WORKSPACE_ID

コピーするワークスペースのID番号。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。

注意:
有効なワークスペースIDのリストを取得するには、listWorkspacesコマンドを使用します。

WORKSPACE_NAME

作成する新しいワークスペースの名前。

WORKSPACE_DESCRIPTION

作成する新しいワークスペースの説明。

例

次の例では、既存のワークスペースをクローニングします。

cloneWorkspaceFromID(3,'Expenses','Expenses Workspace')

4.2.18 cloneWorkspaceFromFile

WLSTでの使用: オンライン。

説明

exportWorkspaceコマンドで作成された出力ファイルを読み取り、ワークスペースの一意のコピーを作成します。

構文

cloneWorkspaceFromFile('FILE_NAME', 'WORKSPACE_NAME', 'WORKSPACE_DESCRIPTION')

このコマンドに必要なパラメータは次のとおりです。

引数

定義

FILE_NAME

コンテンツをコピーする必要がある出力ファイルの名前。

WORKSPACE_NAME

作成する新しいワークスペースの名前。

WORKSPACE_DESCRIPTION

作成する新しいワークスペースの説明。

例

次の例では、ワークスペースを作成するために出力ファイルを読み取ります。

cloneWorkspaceFromFile('/home/bills/expense1.xml','Expenses','Expenses Workspace')

4.2.19 listImportHATokens

WLSTでの使用: オンライン。

説明

特定のワークスペースのすべてのインポート・プロセッサ・トークンを表示します。

構文

listImportHATokens(WORKSPACE_ID)

このコマンドに必要なパラメータは次のとおりです。

引数

定義

WORKSPACE_ID

トークンを表示する必要があるワークスペースのID番号。オプションで一重引用符内に指定できます。たとえば、3と'3'は、どちらもIDが3のワークスペースに対して有効な引数です。

注意:
有効なワークスペースIDのリストを取得するには、listWorkspacesコマンドを使用します。

例

次の例では、IDが3のワークスペースのインポート・プロセッサ・トークンを表示します。

listImportHATokens(3)

4.2.20 deleteImportHAToken

WLSTでの使用: オンライン。

説明

ECIMPORTHATOKENおよびECIMPORTHATOKENITEMS表から特定のインポート・プロセッサのHAトークンを削除します。

構文

deleteImportHAToken('TOKEN_ID')

このコマンドに必要なパラメータは次のとおりです。

引数

定義

TOKEN_ID

削除するトークンのID。

例

次の例では、特定のインポート・プロセッサのHAトークンを削除します。

deleteImportHAToken('d:\bills\ha_token.lst')

A Captureオブジェクト・プロパティ

この付録では、setObjectPropertyコマンドを使用して各Captureオブジェクトに設定できるすべてのプロパティをリストします。

この付録の内容は次のとおりです。

- クライアント・プロファイル・オブジェクト・プロパティ

- インポート・プロセッサ・ジョブ・オブジェクト・プロパティ

- 認識プロセッサ・ジョブ・オブジェクト・プロパティ

- コミット・プロファイル・オブジェクト・プロパティ

- ドキュメント変換ジョブ・オブジェクト・プロパティ

A.1 クライアント・プロファイル・オブジェクト・プロパティ

次の表に、クライアント・プロファイル・オブジェクトに設定できるすべてのプロパティをリストします(クラス名: oracle.oddc.data.Profile)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

プロファイル名

profileName

String

任意の値

説明

profileDesc

String

任意の値

オンライン

profileStatus

boolean

任意の値

デフォルトの明度とコントラストの適用

applyBrightness

boolean

任意の値

バッチ接頭辞

batchPrefix

String

任意の値

プロファイル・タイプ

scanningType

int

1 - キャプチャのみ

2 - キャプチャと索引

3 - 索引付けのみ

イメージ・ファイル以外のプレビュー・ページ制限

maxPages

int

任意の値

デフォルトのステータス

defaultStatus

String

任意の値

バッチ優先度

defaultPriority

int

任意の値

ドキュメント作成オプション

docOption

int

1 - 1ページ(片面など)

2 - 2ページ(両面など)

3 - 可変ページ数

4 - ユーザー指定

セパレータ・シートのバイトしきい値

sepByteThreshold

int

任意の値

空白ページのバイトしきい値:

blankByteThreshold

long

任意の値

データベース参照プロファイル

dbLookupProfile

String

任意の値

常にレコードを表示

dbLookupHitList

boolean

任意の値

依存選択リスト

pickListRelationshipProfile

String

任意の値

返されるレコードの制限

dbLookupMaxRecords

int

任意の値

輝度

brightness

int

任意の値

コントラスト

contrast

int

任意の値

バッチ表示

batchVisibility

int

0 - ユーザーとワークステーション

1 - ユーザー

2 - すべてのユーザー

イメージ・ファイル以外のインポート・アクション

nonImageImportAction

int

0 - インポートしない

1 - ネイティブ形式でインポート

2 - イメージ形式に変換

追加のバッチ接頭辞( ; で区切り)

filterPrefix

String

任意の値

経過日数: 自

filterDaysFrom

int

任意の値

経過日数: 至

filterDaysTo

int

任意の値

バッチ・ステータス

filterStatus

List<String>

任意の値

優先度

filterPriority

List<Integer>

[0,1,2,3,4,5,6,7,8,9,10]

プライマリ・ソート

filterPrimarySort

String

BatchName/BatchPageCount/BatchDate/BatchPriority/BatchStatus

プライマリ・ソート順序

filterPrimaryOrder

int

0 - 昇順

1 - 降順

セカンダリ・ソート

filterSecondarySort

String

BatchName/BatchPageCount/BatchDate/BatchPriority/BatchStatus

セカンダリ・ソート順序

filterSecondaryOrder

int

任意の値

ドキュメント・プロファイル

supportedDocumentTypes

List<String>

任意の値

バッチ・プロセッサ

batchProcessorID

String

oracle.odc.docconverterprocessor.DocumentConverterProcessor/oracle.odc.commitprocessor.CommitProcessor/oracle.odc.recognitionprocessor.RecognitionProcessor

バッチ・プロセッサ・ジョブ

batchProcessorJobID

String

任意の値

デフォルトの色

defaultColor

int

0 - 未指定

1 - モノクロ

2 - グレー・スケール

3 - カラー

デフォルトDPI:

defaultDPI

int

0(未指定)/100 /150/200/240/300/400/600

デフォルト・オーバーライドの禁止

preventDefaultColorOverride

boolean

任意の値

デフォルト・オーバーライドの禁止

preventDefaultDPIOverride

boolean

任意の値

イメージ以外の変換:: 色

convertColor

int

0 - TIFF: モノクロ

1 - JPEG: 色

イメージ以外の変換:: JPEGイメージの品質

convertQuality

int

任意の値

イメージ以外の変換:: DPI

convertDPI

int

0(未指定)/100 /150/200/240/300/400/600

A.2 インポート・プロセッサ・ジョブ・オブジェクト・プロパティ

次以降の項では、インポート・プロセッサ・ジョブ・オブジェクトに設定できるすべてのプロパティをリストします(クラス名: oracle.odc.importprocessor.ImportJob)。

この項では、次の項目について説明します。

- 一般インポート・ジョブ・プロパティ

- フォルダ・インポート・ジョブ固有プロパティ

- リスト・ファイル・インポート・ジョブ固有プロパティ

- 電子メール・ジョブ固有プロパティ

A.2.1 一般インポート・ジョブ・プロパティ

次の表に、設定できる一般インポート・ジョブ・プロパティをリストします(使用クラス名: oracle.odc.importprocessor.ImportJob)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

オンライン

isJobOnline

ブール

任意の値

インポート・ジョブ名

jobName

String

任意の値

イメージのダウンサンプル

imageDownsample

整数

0: なし(イメージ形式を維持)

1 - 色を8ビットにダウンサンプル(グレー・スケール)

2 - 色またはグレー・スケールを白黒にダウンサンプル

JPEGイメージの品質

jpegQuality

整数

任意の値

バッチ接頭辞

batchPrefix

String

任意の値

デフォルトのバッチ・ステータス

defaultBatchStatusID

String

任意の値

デフォルトのバッチ優先度

defaultPriority

整数

任意の値

データベース参照プロファイル

dbSearchID

String

任意の値

データベース検索フィールド

dbSearchFieldID

String

任意の値

デフォルトのドキュメント・プロファイル

defaultDocumentTypeID

String

任意の値

複数のレコードが見つかった場合

searchResultOption

整数

0 - 最初のレコードを使用する

1 - レコードを選択しない

スクリプト

scriptID

String

任意の値

インポート頻度

importFrequency

整数

15: 15秒

30: 30秒

60: 1分

300: 5分

900: 15分

1800: 30分

3600: 1時間

-1: 日次

インポート・ソース

importSourceClassName

String

oracle.odc.importprocessor.folder.FolderSource /oracle.odc.importprocessor.email.EmailSource /oracle.odc.importprocessor.listfile.ListFileSource

バッチ・プロセッサ

batchProcessorClassName

String

oracle.odc.docconverterprocessor.DocumentConverterProcessor/oracle.odc.commitprocessor.CommitProcessor/oracle.odc.recognitionprocessor.RecognitionProcessor

バッチ・プロセッサ・ジョブ

batchProcessorJobID

String

任意の値

インポート頻度: 毎日: 時間:

hour

整数

任意の値

インポート頻度: 毎日: 分:

minute

整数

任意の値

デフォルトのロケール

locale

ロケール

任意の値

イメージ検証に失敗した場合:

imageFailureAction

整数

0 - バッチの削除

1 - ファイルのスキップ

デフォルトの日付書式

defaultDateFormat

String

任意の値

説明

description

String

任意の値

エンコーディング

encoding

String

任意の値

A.2.2 フォルダ・インポート・ジョブ固有プロパティ

次の表に、設定できるフォルダ・インポート・ジョブ・プロパティをリストします(使用クラス名: oracle.odc.importprocessor.ImportJob)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

インポート・フォルダ・パス

folder

String

任意の値

サブフォルダの処理

processSubfolders

boolean

任意の値

新規バッチの作成

batchCreationOption

int

0 - ファイルごと

1 - フォルダごと

ファイル・マスク

fileMasks

String

任意の値

プライマリ・ソート・タイプ

primarySortType

FolderSortType

0 - なし

1 - ファイル名

2 - ファイル拡張子

3 - ファイル変更日時

プライマリ・ソート順序

primarySortOrder

FolderSortOrder

0 - 昇順

1 - 降順

セカンダリ・ソート・タイプ

secondarySortType

FolderSortType

0 - なし

1 - ファイル名

2 - ファイル拡張子

3 - ファイル変更日時

セカンダリ・ソート順序

secondarySortOrder

FolderSortOrder

0(昇順)/1(降順)

準備完了ファイル

readyFile

String

任意の値

インポート後

postProcessingOption

int

0 - ファイルの削除

1 - ファイル拡張子の変更

2 - ファイル接頭辞の追加

新規拡張子

fileExtension

String

任意の値

接頭辞

filePrefix

String

任意の値

空の場合、処理されたサブフォルダを削除

deleteSubfolders

boolean

任意の値

A.2.3 リスト・ファイル・インポート・ジョブ固有プロパティ

次の表に、設定できるリスト・ファイル・インポート・ジョブ・プロパティをリストします(使用クラス名: oracle.odc.importprocessor.ImportJob)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

インポート・フォルダ・パス

folder

String

任意の値

新規バッチの作成:

batchCreationOption

int

0 - リスト・ファイルごと

1 - フォルダごと

ファイル・マスク

fileMasks

String

任意の値

サブフォルダの処理

processSubfolders

boolean

任意の値

フィールド・デリミタ

fieldDelimiter

String

任意の値

ドキュメントごとの最大フィールド数

maxFieldsPerRecord

int

任意の値

ドキュメント・ファイルのフィールド位置

documentFieldPosition

int

任意の値

インポート後

postProcessingOption

int

0 - ファイルの削除

1 - ファイル拡張子の変更

2 - ファイル接頭辞の追加

新規拡張子

fileExtension

String

任意の値

接頭辞

filePrefix

String

任意の値

正常なインポート後にドキュメント・ファイルを削除

deleteDocumentFiles

boolean

任意の値

A.2.4 電子メール・ジョブ固有プロパティ

次の表に、設定できる電子メール・ジョブ・プロパティをリストします(使用クラス名: oracle.odc.importprocessor.ImportJob)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

IMAP接続セキュリティ

imapConnectSecurity

EmailConnectionSecurity

0 - なし

1 - STARTTLS

2 - SSL_TLS

電子メール・サーバー名(DNS名またはIPアドレス)

serverName

String

任意の値

ポート

port

int

任意の値

処理するフォルダ

folderList

List<String>

任意の値

メッセージ・フィルタ: 送信元アドレス

filterFromAddressEnabled

boolean

任意の値

メッセージ・フィルタ: 送信元アドレス・フィールドが次を含む

filterFromAddress

String

任意の値

メッセージ・フィルタ: 件名

filterSubjectEnabled

boolean

任意の値

メッセージ・フィルタ: 件名フィールドが次を含む

filterSubject

String

任意の値

メッセージ・フィルタ: メッセージ本文

filterMessageBodyEnabled

boolean

任意の値

メッセージ・フィルタ: メッセージ本文が次を含む

filterMessageBody

String

任意の値

次のマスクと一致する添付ファイルを含める

attachmentsMask

String

任意の値

次のマスクと一致する添付ファイルを除外する

attachmentsExcludeMask

String

任意の値

電子メール・メッセージ・オプション

includeMessageBodyOption

int

0 - テキストとしてインポート

1 - EML形式でインポート

メッセージ本文ファイルのインポート

includeMessageBodyFile

boolean

任意の値

EML形式でメッセージ全体をインポート

includeEntireEMLFile

boolean

任意の値

ドキュメントの順序付け

emailDocumentOrder

List<Integer>

0 - メッセージ本文(テキスト・ファイル)

1 - メッセージ本文(EMLファイル)

2 - 電子メール・メッセージ(EMLファイル)

3 - 添付ファイル

添付ファイルが存在しない場合に含める

includeMessageBodyWithoutAttachments

boolean

任意の値

インポートの失敗時

postProcessingFailureOption

int

0 - メッセージの削除

1 - メッセージを別のフォルダに移動

2 - メッセージを削除しない

インポートの成功時:

postProcessingSuccessOption

int

0 - メッセージの削除

1 - メッセージを別のフォルダに移動

フォルダ名:

postProcessingFailureMoveFolder

String

任意の値

フォルダ名

postProcessingSuccessMoveFolder

String

任意の値

検索演算子

searchOperator

int

0 - AND

1 - OR

電子メールの重要度に基づいて決定

determineBatchPriority

boolean

任意の値

電子メールの重要度低: バッチ優先度

batchPriorityLow

int

任意の値

電子メールの重要度標準: バッチ優先度

batchPriorityNormal

int

任意の値

電子メールの重要度高: バッチ優先度

batchPriorityHigh

int

任意の値

処理する電子メール・アカウント

emailAccounts

List<String>

任意の値

A.3 認識プロセッサ・ジョブ・オブジェクト・プロパティ

次の表に、認識プロセッサ・ジョブ・オブジェクトに設定できるすべてのプロパティをリストします(使用クラス名: oracle.odc.recognition.RecognitionJob)。

この項では、次の項目について説明します。

- 一般認識ジョブ・プロパティ

- BarcodeDefinitionクラス・プロパティ

- DocumentDefinitionクラス・プロパティ

- RecognitionJobFieldクラス・プロパティ

- SeparatorDefinitionクラス・プロパティ

A.3.1 一般認識ジョブ・プロパティ

次の表に、設定できる一般認識ジョブ・プロパティをリストします(使用クラス: oracle.odc.recognition.RecognitionJob)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

認識ジョブ名

name

String

任意の値

説明

description

String

任意の値

スクリプト

scriptID

String

任意の値

オンライン

online

ブール

任意の値

バー・コード

barcodes

List<BarcodeDefinition>

任意の値

自動検出の有効化

autoDetectBarcodes

ブール

任意の値

オプションのチェックサムを確認

validateCheckSum

ブール

任意の値

バーコード認識

symbologies

List<Integer>

[0,1,2,3,4,5,6,7,8,9] (自動検出可能な1次元コード) / [10,11,12,13,14,15,16,17,18](他の1次元コード) / [19,20,21](2次元コード)

ドキュメントの編成基準

batchOrganization

整数

0 - ドキュメントごとの固定ページ数

1 - なし: ドキュメント編成を実行しない

2 - 各ページで同じバー・コード値

3 - セパレータ・ページ

4 - 階層セパレータ・ページ

ドキュメントごとのページ数:

documentPageCount

整数

任意の値

バー・コードを読み取るドキュメントごとのページ数:

pagesPerDoc2ReadBarcodes

整数

任意の値

ドキュメントごとの最大ページ数:

maxPageCountPerDoc

整数

任意の値

楽観的バーコード検出

optimizeBarcodeDetection

ブール

任意の値

セパレータ・ページ:

coverPages

List<SeparatorDefinition>

任意の値

ドキュメント内で1つのバー・コードに複数の値が見つかった場合

multiBarcodeValuesOption

整数

0 - 最初に見つかった値を使用

1 - 常にバー・コード値を上書き

2 - バー・コード値をクリア

ソース・ドキュメントの添付ファイル:

sourceDocAttachments

整数

0 - すべての添付ファイルを作成されたドキュメントに含める

1 - 一致するドキュメント・プロファイル添付タイプの添付ファイルを含める

2 - 添付ファイルを含めない

動的ドキュメント・プロファイル・オプション:

dynamicDocType

整数

0 - 動的に決定しない

1 - バーコードを使用して動的に決定

2 - セパレータ・ページを使用して動的に決定

デフォルトのドキュメント・プロファイル:

defaultDocTypeID

String

任意の値

ドキュメント・プロファイルとバー・コード値のマッピング

docTypeMappings

List<DocumentDefinition>

任意の値

フィールド

jobFields

List<RecognitionJobField>

任意の値

DBルックアップで次を使用:

dblookupUsing

整数

0 - なし

1 - バー・コード

2 - フィールド値

フィールド名

dblookupIndexDefID

String

任意の値

データベース参照プロファイル

dblookupProfile

String

任意の値

データベース検索フィールド:

dblookupSearchField

String

任意の値

複数のレコードが見つかった場合:

dblookupMultipleRecordAction

整数

0 - 最初のレコードを使用する

1 - リンクしない

レコードが見つからなかった場合:

dblookupNoMatchAction

整数

0 - ドキュメント・コミットの許可

1 - ドキュメント・コミットの禁止

バッチの名前を変更するには、接頭辞を入力します:

renamePrefix

String

任意の値

電子メール通知を送信するには、電子メール・アドレスを入力します:

renameEmail

String

任意の値

バッチ・ステータスを変更するには、ステータスを選択します:

renameStatus

String

任意の値

バッチ優先度を変更するには、優先度1から10を入力します:

renamePriority

整数

1と10の間の数

バッチ・プロセッサ

processorID

String

任意の値

バッチ・プロセッサ・ジョブ:

processorJobID

String

任意の値

バッチの名前を変更するには、接頭辞を入力します:

failureRenamePrefix

String

任意の値

電子メール通知を送信するには、電子メール・アドレスを入力します:

failureRenameEmail

String

任意の値

バッチ・ステータスを変更するには、ステータスを選択します:

failureRenameStatus

String

任意の値

バッチ優先度を変更するには、優先度1から10を入力します:

failureRenamePriority

整数

1と10の間の数

バッチ・プロセッサ

failureProcessorID

String

任意の値

バッチ・プロセッサ・ジョブ:

failureProcessorJobID

String

任意の値

バー・コード・エンジン

decoder

整数

0 - ユニバーサル・デコーダ

1 - Windowsデコーダ

イメージ当たりのバー・コードの最大数

maxBarcodes

整数

1と10の間の数

バー・コードの最小の高さ

minHeight

Double

0.2から3.0までの任意の有効な値

メジャーの単位

unitMeasure

整数

0 - インチ

1 - センチメートル

バー・コードの最大の幅

maxWidth

Double

minHeightから10までの任意の有効な値

バー・コードの最小文字数

minChars

整数

1と1000の間の数

A.3.2 BarcodeDefinitionクラス・プロパティ

次の表に、設定できるBarcodeDefinitionプロパティをリストします(使用クラス名: oracle.odc.recognition.RecognitionJob)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

名前

barcodeName

String

任意の値

検証ルール

validationRule

整数

0 - なし

1 - 長さ

2 - マスク

3 - 正規表現

4 - 選択リスト

長さ

validationLength

整数

任意の値

マスク

validationMask

String

任意の値

正規表現

validationRegularExpression

String

任意の値

選択リスト・ソース

pickListSourceID

String

任意の値

選択リスト・ソース

pickListID

String

任意の値

A.3.3 DocumentDefinitionクラス・プロパティ

次の表に、設定できるDocumentDefinitionプロパティをリストします(使用クラス名: oracle.odc.recognition.RecognitionJob)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

一致するバー・コード値:

mappingType

整数

0 - 単一の値

1 - 選択リスト

単一値:

value

String

任意の値

A.3.4 RecognitionJobFieldクラス・プロパティ

次の表に、設定できるRecognitionJobFieldプロパティをリストします(使用クラス名: oracle.odc.recognition.RecognitionJob)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

自動入力

autoPopulate

整数

0 - なし

1 - バー・コード

2 - バッチ名

3 - デフォルト

4 - 索引日付

5 - スキャン日付

バーコード

populateValue

String

任意の値

A.3.5 SeparatorDefinitionクラス・プロパティ

次の表に、設定できるSeparatorDefinitionプロパティをリストします(使用クラス名: oracle.odc.recognition.RecognitionJob)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

ルール名

name

String

任意の値

コミット時にこのセパレータ・ページを削除

deleteUponCommit

ブール

任意の値

演算子

operator

整数

0 - OR

1 - AND

ドキュメント・プロファイル

docTypeID

String

任意の値

添付ファイルの種類

attachmentTypeID

String

任意の値

A.4 コミット・プロファイル・オブジェクト・プロパティ

次の表に、コミット・プロファイル・オブジェクトに設定できるすべてのプロパティをリストします(クラス名: oracle.odc.entity.CommitProfileEntity)。

この項では、次の項目について説明します。

- 一般コミット・プロファイル・プロパティ

- テキスト・ファイル・コミット・プロファイル固有プロパティ

- Webcenterコンテンツ・コミット・プロファイル固有プロパティ

- ContentAttributeMappingInfoクラス・プロパティ

- CaptureToContentFieldMappingクラス・プロパティ

- ContentFieldNameInfoクラス・プロパティ

- Webcenter Imagingコミット・プロファイル固有プロパティ

- PDF検索可能ドキュメント出力固有プロパティ

- DOCSコミット・ドライバ・プロパティ

A.4.1 一般コミット・プロファイル・プロパティ

次の表に、設定できる一般コミット・プロファイル・プロパティをリストします(使用クラス名: oracle.odc.entity.CommitProfileEntity)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

コミット・プロファイル名

profileName

String

任意の値

ドキュメント出力書式

exportDriverID

String

oracle.odc.export.PDFSearchable/oracle.odc.export.PDFImageOnly/oracle.odc.export.TIFFMultiImage

添付ドキュメント出力書式

attachExportDriverID

String

oracle.odc.export.PDFSearchable/oracle.odc.export.PDFImageOnly/oracle.odc.export.TIFFMultiImage

コミット・ドライバ

commitDriverID

String

oracle.odc.commit.TextFileCommitDriver(テキスト・ファイル)/oracle.odc.commit.cs.ContentCommitDriver(WebCenter Content) / oracle.odc.commit.ipm.IPMCommitDriver(WebCenter Content Imaging)

オンライン

active

ブール

任意の値

実行順序の編集

executionOrder

整数

任意の値

エラー処理ポリシー

errorHandlingPolicy

整数

0 - 次のドキュメントに進む

1 - 次のコミット・プロファイルまで取消

2 - コミットの取消

コミットをドキュメント・プロファイルに制限

documentTypes

List<DocumentTypeEntity>

任意の値

デフォルトのロケール

defaultLocaleString

String

任意の値

デフォルトの日付書式

defaultDateFormat

String

任意の値

エンコーディング

encoding

String

任意の値

注意:

コミット・プロファイルに関連付けられた「デフォルトのロケール」フィールドを更新するには、ロケールの3つの部分すべて(つまり、言語、国およびバリアント)を含む値を渡します。ロケールの各部分を区切るには、縦線(|)を使用します。次の例は、ロケールをChinese (China)に設定します。defaultLocaleString = zh|CN|

A.4.2 テキスト・ファイル・コミット・プロファイル固有プロパティ

次の表に、設定できるテキスト・ファイル・コミット・プロファイル・プロパティをリストします(使用クラス名: oracle.odc.entity.CommitProfileEntity)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

コミット・テキスト・ファイルを作成しない

doNotCreateTextFile

boolean

任意の値

サブフォルダに保存

useTextSubFolder

boolean

任意の値

添付ファイルを除外

excludeAttachment

boolean

任意の値

テキスト・ファイル・フォルダ: サブフォルダ・オプション

textSubFolderOption

int

0 - 年

1 - 年と月

2 - 年、月および日

コミット・テキスト・ファイル・フォルダ

textFileFolder

String

任意の値

ファイル接頭辞

textFilePrefix

String

任意の値

ファイル拡張子

textFileExtension

String

任意の値

各ページにコピーを作成

duplicateLinkedItems

boolean

任意の値

コミット済バッチごとにフォルダを作成

oneFolderPerBatch

boolean

任意の値

サブフォルダに保存

useDocSubFolder

boolean

任意の値

ドキュメント・ファイル・フォルダ: サブフォルダ・オプション

docSubFolderOption

int

0 - 年

1 - 年と月

2 - 年、月および日

3 - メタデータ・フィールド

ドキュメント・フォルダ

docFolder

String

任意の値

選択したメタデータ・フィールド

subFolderIndexes

List<String>

任意の値

サブフォルダ・パス

subFolderPath

String

任意の値

フィールド・デリミタ

delimiterOption

int

0 - カンマ

1 - セミコロン

2 - その他

テキスト修飾子

textQualifier

int

0 -なし

1 - 二重引用符

2 - 一重引用符

その他の文字

formatDelimiter

String

任意の値

テキスト修飾子

formatFields

List<String>

任意の値

メタデータ・フィールド値に基づいてドキュメント・ファイルに名前を付ける

nameDoc

boolean

任意の値

ファイル名が無効な文字で構成されている場合

docNameInvalidCharOption

int

0 - 無効な文字の削除

1 - ドキュメント・コミットの取消

ドキュメント・ファイル・ネーミング: フィールド・デリミタ

docNameDelimiter

String

任意の値

ドキュメント・ファイル名に含めるフィールド

docNameFields

List<String>

任意の値

A.4.3 Webcenterコンテンツ・コミット・プロファイル固有プロパティ

次の表に、設定できるWebcenterコンテンツ・コミット・プロファイル・プロパティをリストします(使用クラス名: oracle.odc.entity.CommitProfileEntity)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

サーバーURL

serverURL

String

任意の値

メタデータ値に基づいてドキュメント・ファイルに名前を付ける

documentFileNaming

boolean

任意の値

ドキュメント・ファイル名

documentFilename

String

任意の値

ファイル名が無効な文字で構成されている場合:

removeDocFilenameInvalidChars

boolean

任意の値

ドキュメント・タイトル

documentTitle

String

任意の値

デフォルトのアカウント

documentAccount

String

任意の値

デフォルトのセキュリティ・グループ

documentSecurityGroup

String

任意の値

デフォルトのタイプ

documentType

String

任意の値

動的に値を割り当てる

dynamicAssignment

boolean

任意の値

値の割当て

dynamicMappingOption

int

0 - フィールド・マッピング別

1 - メタデータ・フィールド別

メタデータ・フィールド

dynamicMappingIndexField

String

任意の値

選択リスト・ソース

dynamicMappingPicklistSourceId

String

任意の値

選択リスト

dynamicMappingPicklistId

String

任意の値

アカウント

accountMappingField

String

任意の値

タイプ

contentTypeMappingField

String

任意の値

セキュリティ・グループ

securityGroupMappingField

String

任意の値

コンテンツ属性マッピング

attributeMappingList

List<ContentAttributeMappingInfo>

任意の値

ワークフローをバイパスする

bypassWorkflow

boolean

任意の値

代替チェックイン・サービス

alternateCheckInService

String

任意の値

コンテンツ・サーバー・フィールドに割り当てるキャプチャ・メタデータ・フィールドの選択

fieldMappingList

List<CaptureToContentFieldMapping>

任意の値

カスタム・フィールド

customMetadataList

List<ContentFieldNameInfo>

任意の値

添付ファイルを除外

excludeAttachments

boolean

任意の値

A.4.4 ContentAttributeMappingInfoクラス・プロパティ

次の表に、設定できるContentAttributeMappingInfoクラス・プロパティをリストします(使用クラス名: oracle.odc.entity.CommitProfileEntity)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

フィールド値

fieldValue

String

任意の値

タイプ

docType

String

任意の値

セキュリティ・グループ

docSecurityGroup

String

任意の値

アカウント

docAccount

String

任意の値

A.4.5 CaptureToContentFieldMappingクラス・プロパティ

次の表に、設定できるCaptureToContentFieldMappingクラス・プロパティをリストします(使用クラス名: oracle.odc.entity.CommitProfileEntity)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

コンテンツ・サーバー・フィールド

captureField

String

任意の値

キャプチャ・フィールド

contentField

String

任意の値

A.4.6 ContentFieldNameInfoクラス・プロパティ

次の表に、設定できるContentFieldNameInfoクラス・プロパティをリストします(使用クラス名: oracle.odc.entity.CommitProfileEntity)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

カスタム・フィールド名

name

String

任意の値

カスタム・フィールド・キャプション

caption

String

任意の値

A.4.7 Webcenter Imagingコミット・プロファイル固有プロパティ

次の表に、設定できるWebcenter Imagingコミット・プロファイル・プロパティをリストします(使用クラス名: oracle.odc.entity.CommitProfileEntity)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

コミット方法

commitMethod

int

0 - 直接コミット

1 - 入力エージェント・コミット

検索して一致するImagingドキュメントに追加

append

boolean

任意の値

Imaging WebService URL

url

String

任意の値

セキュリティ・ポリシー

policy

int

0 - 基本セキュリティ

1 - トークン・セキュリティ

キャプチャ出力ディレクトリ

inputDir

String

任意の値

入力エージェント・ディレクトリ

inputAgentDir

String

任意の値

検索定義

searchName

String

任意の値

A.4.8 PDF検索可能ドキュメント出力固有プロパティ

次の表に、設定できるPDF検索可能ドキュメント出力プロパティをリストします(使用クラス名: oracle.odc.entity.CommitProfileEntity)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

テキスト・ファイルの作成

textFormat

整数

0 - テキスト・ファイルを作成しません

1 - テキスト・ファイル形式で作成

言語:

language

String

カンマ区切りの言語ID [0-122] たとえば、「0, 2, 3, 18」

テキスト・ファイル・コード・ページ

codePage

String

任意の値

専門辞書

profDictionary

String

カンマ区切りの専門辞書名。たとえば、「英語医薬辞書、ドイツ語法律辞書」

カラー・イメージ品質

colorImageQuality

int

0 - 最小: 最小サイズ

1 - 適正: 中サイズ

2 - 最適: 大サイズ

互換性

compatibility

String

PDF14/PDF15/PDF16/PDF17/PDFA1B/PDFA2B/PDFA2U

効率的なWeb表示のためのリニアPDFの作成

linearized

boolean

任意の値

元のイメージの向きを保持

keepImgOrientation

boolean

任意の値

ページ当たり単一言語の検出

singleLangPerPage

boolean

任意の値

A.4.9 DOCSコミット・ドライバ・プロパティ

次の表に、設定できるDOCSコミット・ドライバ・プロパティをリストします(使用クラス名: oracle.odc.entity.CommitProfileEntity)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

サーバーURL

serverURL

String

任意の値

名前

parentFolderName

String

任意の値

ID

parentFolderID

String

任意の値

サブフォルダ・フィールド:

subFolderFields

List<String>

任意の値

フィールド値を使用してサブフォルダを作成

createSubFolders

boolean

任意の値

フォルダ名が無効な文字で構成されている場合:

folderInvalidCharOption

int

0 - 無効な文字の削除

1 - ドキュメント・コミットの取消

イメージ以外のファイルに元のファイル名を使用

useOriginalFileName

boolean

任意の値

メタデータ・フィールド値に基づいてドキュメント・ファイルに名前を付ける

nameDoc

boolean

任意の値

ドキュメント・ファイル名に含めるフィールド:

docFileFields

List<String>

任意の値

フィールド・デリミタ

docFileDelimiter

String

任意の値

ファイル名が無効な文字で構成されている場合:

docFileInvalidCharOption

int

0 - 無効な文字の削除

1 - ドキュメント・コミットの取消

A.5 ドキュメント変換ジョブ・オブジェクト・プロパティ

次の表に、ドキュメント変換ジョブ・オブジェクトに設定できるすべてのプロパティをリストします(クラス名: oracle.odc.docconverter.DocConverterJob)。

プロパティ名(UI上)

プロパティ名(クラス内)

データ型

有効なオプション

名前:

jobName

String

任意の値

オンライン:

online

boolean

任意の値

JPEGイメージの品質

jpegQuality

整数

1<jpegQuality<=99

変換するドキュメント:

docFilter

ブール

true: イメージ以外の選択されたドキュメント

false: イメージ以外のすべてのドキュメント

変換する添付ファイル:

docAttachmentFilter

ブール

任意の値

出力イメージ形式:

outputImageFormat

整数

0 - TIFF: モノクロ

1 - JPEG: 色

ファイル名フィルタ:

filterpattern

String

任意の値

バッチ・マージ・オプション:

documentMergeType

整数

0 - ドキュメントをマージしない

1 - 最初のドキュメントと他のすべてのドキュメントをマージ

2 - 最後のドキュメントと他のすべてのドキュメントをマージ

3 - すべてのドキュメントをマージ

ソース・ドキュメント・ページの配置:

mergeToBeginning

boolean

true: ターゲット・ドキュメントの最初

false: ターゲット・ドキュメントの最後

ソース・ドキュメントのメタデータ値の適用

applySourceMetadata

boolean

任意の値

ターゲット・ドキュメントのメタデータ値の上書き許可

overwriteDestinationMetadata

boolean

任意の値

説明:

description

String

任意の値

バッチ・プロセッサ:

processorID

String

任意の値

バッチ・プロセッサ・ジョブ:

processorJobID

String

任意の値

バッチの名前を変更するには、接頭辞を入力します:

renamePrefix

String

任意の値

電子メール通知を送信するには、電子メール・アドレスを入力します:

renameEmail

String

任意の値

バッチ・ステータスを変更するには、ステータスを選択します:

renameStatus

String

任意の値

バッチ優先度を変更するには、優先度1から10を入力します:

renamePriority

整数

[1-10]

バッチ・プロセッサ:

errProcessorID

String

任意の値

バッチ・プロセッサ・ジョブ:

errProcessorJobID

String

任意の値

バッチの名前を変更するには、接頭辞を入力します:

errRenamePrefix

String

任意の値

電子メール通知を送信するには、電子メール・アドレスを入力します:

errRenameEmail

String

任意の値

バッチ・ステータスを変更するには、ステータスを選択します:

errRenameStatus

String

任意の値

バッチ優先度を変更するには、優先度1から10を入力します:

errRenamePriority

整数

[1-10]

DPI:

dpi

整数

100 / 150 /200 / 240/300/400/600

外部変換の使用:

extConvEnabled

ブール

true: オン

false: オフ

ファイル名フィルタ:

extConvFilterPattern

String

任意の値

外部変換プログラム:

extConvProgram

String

任意の値

コマンド・ライン・パラメータ:

extConvCommandLine

String

任意の値

プロセス・モニター方法:

extConvMonitoringMethod

整数

0 - 期間タイムアウト

1 - 出力ファイル非アクティブ・タイムアウト

タイムアウト(分):

extConvTimeout

整数

[1-1000]

成功した戻りコード

extConvSuccessReturnCode

整数

任意の値

変換しない:

doNotConvertDocs

ブール

任意の値

変換しない:

doNotConvertDocAttachments

ブール

任意の値

ファイル名フィルタ:

attachmentFilterPattern

String

任意の値

ソースの添付ファイル:

documentAttachmentMergeType

整数

0 - 添付ファイルを含めない

1 - すべての添付ファイルを結合されたドキュメントに含める

2 - 一致するドキュメント・プロファイル添付タイプの添付ファイルを含める

ドキュメント・プロファイルに制限:

documentTypes

List<DocumentTypeEntity>

任意の値

添付タイプに制限:

attachmentTypes

List<DocumentAttachmentTypeEntity>

任意の値