| Oracle® WebCenter Content Site Studioテクニカル・リファレンス・ガイド 11gリリース1 (11.1.1) B72417-01 |
|
 前 |
 次 |
Site Studioには、Oracle Content Serverの多くの新規サービスが導入されています。これらのサービスは、特にWebサイトの実行に使用されます。最も重要なものについてここで説明します。
この項の内容は次のとおりです。
|
注意: これらのサービスは、Site Studio Designerアプリケーションおよびコントリビュータ・アプリケーションと、Site Studioコンポーネントにより使用されます。これらのサービスは、Site Studioアプリケーションの各リリースで変更される可能性があります。 |
サービスは、アクションを実行するためのOracle Content ServerへのHTTPリクエストです。各サービスには、アクションのセット(データベース・トランザクション、コードの実行、問合せなど)が定義されています。
Site Studioコンポーネントをインストールすると、多数のサービスが追加されます。
このサービスのリストには、Site Studioのカスタマイズに最も有用なもの(特に、サードパーティ・ソフトウェアと使用する場合)が含まれています。
説明: このサービスは、特定のサイト・ノードに子ノードを追加します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
nodeId: ノードの一意の識別子（必須）。新規に追加されるノードは、このノードの子になります。
newNodeId: 新規子ノードの識別子（オプション）。この値が指定されない場合、新しく一意の識別子が生成されます。
newNodeName: 新規子ノードのラベル（オプション）。この値が指定されない場合、New Sectionというテキストが使用されます。
戻り値:
newNodeId: 新しく作成されたノードの識別子。
セキュリティ: ユーザーは、新規子ノードを追加するノードに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、特定のドキュメントに対応するWebサイトのリストに特定のsiteIdを追加します。
パラメータ:
dDocName: dDocName(必須)。
siteId: サイトの一意の識別子（必須）。
fieldName: xWebsitesまたはxDontShowInListsForWebsite(必須)。
戻り値: なし。
セキュリティ: ユーザーは、指定されたdDocNameの最新のリビジョンに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、セット内にリストされたすべてのリンクおよびsiteIdに基づいてSS_DECODE_LINKを実行するために、SS_DECODE_LINKを対象にセットの受渡しと返却を行います。
パラメータ:
SS_DECODE_LINKにリスト入力するリンクおよびsiteIdのリストを格納したLinkというタイトルの結果セット。
戻り値:
Linksというタイトルの結果セット。入力行ごとに、SS_DECODE_LINKで解析された情報を含む行が1つ生成されます。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスはCHECKIN_UNIVERSALのラッパーで、フラグメント.zipファイルが解凍され、weblayoutにデプロイされるポストプロセスが続きます。
パラメータ:
primaryFile: フラグメント.zipファイル。必須。
alternateFile: XMLフラグメント定義。必須。
戻り値: なし。
セキュリティ: CHECKIN_UNIVERSALに対するものと同じ要件。
説明: このサービスは、セクションを選択するUIのコールに使用されます。カスタム・ユーザー・インタフェースを作成する際、Webサイト・セクションを選択する必要がある場合に使用されます。このサービスには、ss_choose_website_section.htmという名前のOracle Content Serverテンプレートがあります(\templates\内)。
パラメータ:
siteId: WebサイトのサイトID。オプション。
戻り値:
ss_choose_website_section.htmに記述されたUI。
パラメータ: なし。
説明: このサービスは、Webサイトのリストから選択できる画面を表示します。これは、コンテンツ・サーバーUIのxWebsitesフォーム要素のカスタマイズと組み合せて使用します。
パラメータ:
xWebsites: WebサイトIDのカンマ区切りリスト。
戻り値: なし。
セキュリティ: コンテンツ・サーバー内のセキュリティ・グループに対して読取りアクセス権を持っている任意のユーザーは、このサービスを起動できます。
説明:このサービスは、プレビューのクリアに使用されます。クリアが実行されない問題がある場合、プレビューは毎週自身をクリアします。ただし、領域の節約には、多くの場合、ファイルの削除が好まれます。
パラメータ:
previewId: プレビュー・キャッシュ内のプレビューID(フォルダ名)
戻り値: なし。
セキュリティ: プレビューするドキュメントへの書込みアクセス権。
説明: このサービスは、切り替えられたリージョン関連付けのメモリーをクリアします。
パラメータ:
siteId: サイトの一意の識別子（必須）。
nodeId: ノードの識別子（オプション）。このパラメータが指定されない場合、サイト全体の関連付けが消去されます。
property: primaryUrlまたはsecondaryUrl(nodeIdの指定時には必須)。
戻り値: なし。
セキュリティ: ユーザーは、ノードに対して(nodeIdを指定しない場合はサイトに対して)少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、指定されたdDocNameに対応するxWebsitesまたはxDontShowInListsForWebsitesフィールドから指定されたsiteIdをクリアします。
パラメータ:
dDocName: xWebsitesまたはxDontShowInListsForWebsitesフィールドを変更するファイルのdDocName(必須)。
removeWebsiteID: ブール値yes(必須)。
fieldName: siteIdをクリアするメタデータ・フィールド(xWebsitesまたはxDontShowInListsForWebsites)(必須)。
siteId: xWebsitesまたはxDontShowInListsForWebsitesフィールドから削除するsiteId(必須)。
戻り値: なし。
セキュリティ: ユーザーは、指定されたdDocNameに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスを実行すると、サイトの変更がコミットされます。Site Studioは、10分ごとに自動的に変更をコミットしますが、このスクリプトを必要に応じて実行し、変更をコミットできます。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値: なし。
セキュリティ: サービスを実行するには、プロジェクト・ファイルに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、コンテンツ・サーバーに空の新規サイトを作成します。
パラメータ:
siteId: 作成するサイトの一意の識別子（必須）。識別子は、siteIdのネーミング規則に準拠している必要があります。
siteLabel: サイトのラベル（オプション）。ラベルが指定されない場合、Unnamed Siteというテキストが使用されます。
siteType: 作成するサイトのタイプ。たとえば、aspまたはidoc(オプション)。
initialNodeId: ルート・セクションのnodeId(オプション)。この値が指定されない場合、一意の識別子が作成されます。
rootSectionActive: ルート・セクションをアクティブとしてマークするかどうかを示します（オプション）。有効な値は、TrueまたはFalseです。
rootSectionLabel: ルート・セクションのラベル（オプション）。この値が指定されない場合、Homeという値が割り当てられます。
rootSectionUrlPageName: ルート・セクションのurlPageName値（オプション）。
rootSectionUrlSecondaryPageName: ルート・セクションのurlSecondaryPageName（オプション）。
rootSectionUrlDirName: ルート・セクションのurlDirName値（オプション）。
戻り値:
siteId: 作成されたサイトの一意の識別子（必須）。
セキュリティ: サービスを実行するユーザーは、Site Studioプロジェクト・ファイルをチェックインする際に使用されるセキュリティ・グループに対して書込みアクセス権を持っている必要があります（このファイルは、「デフォルトのプロジェクト・ドキュメント情報の設定」管理ページで構成されます）。
説明: このサービスは、サイト・ナビゲーション・ファイルを作成します。これにより、sitenavigation.js、sitenavigationfunctions.js、sitenavigation.xml、sitenavigation.hdaおよびsitenavigation_co.hdaの各ファイルが再生成されます。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
siteNavUrl: サイト・ナビゲーション・ファイルの完全なHTTP URL。
セキュリティ: ユーザーは、ルート・ノードに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、Site Studioリンクをデコードしてリンクが解決される場所を判別します。
パラメータ:
link: サポートされる任意の形式によるSite Studioリンク（必須）。
siteId: サイトの一意の識別子（必須）。
戻り値: （空白の可能性あり）
targetIsSection: TrueまたはFalse
nodeLabel: ノードのナビゲーション・ラベル。
targetDocName: リンクのターゲットとなるdDocName。
targetNodeId: リンクのターゲットとなるセクションの識別子。
targetSiteId: リンクのターゲットとなるサイトの識別子。
targetIsSecondary: TrueまたはFalse
linkType: 入力されたSite Studioリンクのリンク・タイプ。
errors: 文字列値unknown Error、noInputLink、invalidInputSiteId、invalidSiteId、invalidNodeId、invalidPathLink、noDocInfo、notSiteStudioUrl、badUrlFormat、cantFindUrlSection、parameterCount、parameterFormatのいずれかです。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、特定のサイト・ノードとそのすべての子を削除します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
nodeId: 削除するノードの識別子（必須）。
戻り値: なし。
セキュリティ: ユーザーは、削除するノードに対して少なくとも削除アクセス権を持っている必要があります。
説明: このサービスは、最新リリースのドキュメントだけでない、ワークフロー内を含む最新のドキュメントに関する情報を取得します。このサービスは、Oracle Content ServerサービスDOC_INFO_BY_NAMEと同様に動作します。
パラメータ:
dDocName: 情報を取得するドキュメントのdDocName。
戻り値:
指定されたdDocNameの最新バージョンに関するDOC_INFO結果セット。
ドキュメントの作成者の電子メールアドレス。電子メール・アドレスは結果セットに含まれません。
セキュリティ: 最新バージョンに対する読取りアクセス権。これは、ドキュメントのワークフローに対するアクセス権を必要とする場合があります。
説明: このサービスは、「チェックアウトして開く」(COAO)の起動に使用できるHTMLページを返します。このページには、COAOの起動に必要なJavaScriptと<object>タグが含まれます。
パラメータ:
dDocName: COAO機能を使用して編集するファイルのdDocName（必須）。
戻り値: なし。
セキュリティ: ユーザーは、1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。持っていない場合、COAOを使用することはできません。
説明: このサービスは、ルートSite Studio管理ページを表示します。
パラメータ: なし。
戻り値:
管理ページ
セキュリティ: 管理アクセス権が必要です。
説明: 特定のサイトのカスタム・ノード・プロパティ定義を取得します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
CustomNodePropertyDefsという名前の結果セット。名前、タイプおよび説明の列があります。
セキュリティ: ユーザーは、ルート・ノードに対して少なくとも書込みアクセス権を持っている必要があります。
説明: ノード・プロパティの完全なセットを取得します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
nodeId: ノードの識別子（必須）。
戻り値:
2つの結果セット(StandardPropertiesおよびSiteStudioProperties)が返されます。各結果セットには1つの行が含まれます。列名はプロパティ名です。
StandardProperties結果セットには、nodeIdを示す1つの行および列のみが含まれます。
セキュリティ:
ユーザーは、ノードのフォルダに対して少なくとも読取りアクセス権を持っている必要があります。
このサービスは、Idocスクリプトから実行できます。
説明: このサービスは、サーバー上のドメインの完全なセットを取得します。
パラメータ: なし。
戻り値:
すべてのドメイン・アドレスを示すDomainMapという名前の結果セット。Key、SiteId、PatternおよびDefaultという行を含みます。Keyはドメイン、SiteIdはID、PatternはSS_GET_PAGEとしてURLが再度書き込まれる先およびDefaultはサイトのデフォルト・アドレスです。
セキュリティ: 管理アクセス権が必要です。
説明: サイト・プロパティの完全なセットを取得します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
値の行を1つ含むSiteStudioPropertiesという結果セット。列名はプロパティ名です。
セキュリティ:
ユーザーは、サイトに対して少なくとも読取りアクセス権を持っている必要があります。
このサービスは、Idocスクリプトから実行できます。
説明: このサービスは、コンテンツ・サーバー上のすべてのサイトのリストを返します。
パラメータ: なし。
戻り値:
numSites=N
site0=siteId
. . .
siteN-1=siteId
同じ情報がSiteIds結果セットで返されます。
セキュリティ: 戻されるサイトのリストは、ユーザーが少なくとも読取りアクセス権を持っているサイトのリストになります。
説明: このサービスは、デザイナに関するすべてのSite Studio基本構成情報を取得します。
パラメータ: なし。
戻り値:
基本構成情報。
セキュリティ:
ユーザーは、サイトに対して少なくとも読取りアクセス権を持っている必要があります。
このサービスは、Idocスクリプトから実行できます。
説明: このサービスは、コントリビュータに関するSite Studio基本構成情報を取得します。
パラメータ: なし。
戻り値:
基本構成情報。
セキュリティ:
ユーザーは、サイトに対して少なくとも読取りアクセス権を持っている必要があります。
このサービスは、Idocスクリプトから実行できます。
説明: このサービスは、現在のユーザーの言語のweblayout\resources\wcm\base\lang\language idからJavaScriptファイル(wcm.strings.js)をロードします。ユーザーの現在の言語のwcm.strings.jsファイルがない場合、デフォルトのEN文字列が返されます。
パラメータ: なし
戻り値:
JavaScriptファイルのコンテンツ。
セキュリティ: パラメータ: なし。ユーザーがログインしていない場合、言語IDはENです。
説明: このサービスは、定義されているすべてのドキュメント変換ルールから成る結果セットを返します。
パラメータ: なし
戻り値:
DCConversionsまたはDCConversions80(Dynamic Converterのバージョンによる)というDynamic Converterに対して定義されているすべてのルールから成る結果セット。
セキュリティ: ユーザーは、サイトに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、コンテンツIDからラベルを取得するためにコントリビュータによって使用されます。
パラメータ:
contentIdsというdDocNamesから成る結果セット。
戻り値:
指定された各dDocName値のラベル。レスポンスは、dDocName値をキーとするJSON形式です。
セキュリティ: ユーザーは、少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、Webサイトの使用状況レポートを表示します。
パラメータ:
dDocName: Webサイト使用状況レポートの実行対象のファイルのdDocName(必須)。
戻り値:
Webサイト使用状況レポート。
セキュリティ: ユーザーは、少なくとも読取りアクセス権を持っている必要があります。
説明: このサービスは、環境プロパティとして識別されるこのサイトのプロパティを取得します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
EnvironmentPropertiesという結果セット。この結果セットには、環境プロパティとして識別されるプロパティごとに1行を持つnameという単一の列が含まれます。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、サイトの最初のノードを取得します。サイト階層を列挙する場合に便利です。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
firstId: サイト階層における最初のノードの識別子。
セキュリティ:
ユーザーは、ルート・ノードに対して少なくとも読取りアクセス権を持っている必要があります。
このサービスは、Idocスクリプトから実行できます。
説明: これは、ドキュメントまたはセクションに対するフレンドリURLを作成します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
ssDocName: 表示するドキュメントのdDocName（オプション）。
ssTargetNodeId: ドキュメントを表示するセクションの識別子(オプション)。
ssDocNameまたはssTargetNodeIdのいずれかを指定する必要があります。
ssTargetSiteId: 指定されたssTargetNodeIdを含むサイトの識別子。
戻り値:
ssFriendlyUrl: 指定されたドキュメントまたはセクションのサイト相対URL。
HttpSiteAddress: Webサイトのルートのアドレス。(これらの2つの戻り値を連結して完全URLを作成できます。)
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: これは、ssLinkサーバー側リンクのサービス・バージョンです。
パラメータ:
ssDocName: 表示するドキュメントのdDocName（必須）。
TargetNodeId: ドキュメントを表示するセクションの識別子(オプション)。
TargetSiteId: 指定されたTargetNodeIdを含むサイトの識別子(オプション)。
SourceNodeId: ドキュメントのxWebsiteSection値を使用できない場合にドキュメントを表示するセクションの識別子(オプション)。
SourceSiteId: 指定されたssSourceNodeIdを含むサイトの識別子(オプション)。
戻り値:
指定されたドキュメントの絶対URLを示すssLinkパラメータ。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、Site Studioサイト内のリンクに関する情報を取得します。
パラメータ: なし。
戻り値: 次の列を含むManifestという結果セット。
siteId: サイトの一意の識別子(必須)。
layoutResultSet: 次の値が含まれます。
nodeId: セクションの識別子。
dDocName: ドキュメントの名前。
isPrimaryUrl: 結果がプライマリ・ページとして指定されているかどうか。
UrlDataFiles: 次の値が含まれます。
nodeId: セクションの識別子。
dDocName: ドキュメントの名前。
isPrimaryUrl: 結果がプライマリ・ページとして指定されているかどうか。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、リンク・ウィザードの移入に使用される構成情報を取得します。
パラメータ:
link: リンクの値。形式は任意です。
target: ターゲット・ウィンドウ。
|
注意: これらのパラメータはサービス・コールで渡されますが、使用されません。 |
戻り値:
リンク・ウィザードに対するJSONでの構成が返されます。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、サイトのコンテキスト内でのリンク・ウィザードの起動に使用されます。
パラメータ:
siteId: サイトの一意の識別子（必須）。
nodeId: ノードの一意の識別子。
link: リンクの値。形式は任意です。
target: ターゲット・ウィンドウ。
|
注意: nodeId、linkおよびtargetパラメータはサービス・コールで渡されますが、使用されません。 |
戻り値:
リンク・ウィザードに対するJSONでの構成が返されます。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: これは、ssNodeLinkサーバー側リンクのサービス・バージョンです。
パラメータ:
TargetNodeId: URLの作成対象のセクションの識別子(必須)。
TargetSiteId: 指定されたTargetNodeIdを含むサイトの識別子(オプション)。
SourceNodeId: URLの作成元のセクションの識別子。これは、リンクが絶対URLか相対URLかを確認する場合に有用です(オプション)。
SourceSiteId: 指定されたSourceNodeIdを含むサイトの識別子(オプション)。
戻り値:
結果は、ssNodeLinkパラメータとして返されます。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、ノード・プロパティを取得します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
nodeId: ノードの識別子（必須）。
property: 削除するプロパティの名前(必須)。
戻り値:
value: リクエストされたノード・プロパティの値。リクエストされたプロパティが存在しない場合、このパラメータは戻されませんが、サービス・コールは正常に完了します。
セキュリティ:
ユーザーは、ノードに対して少なくとも読取りアクセス権を持っている必要があります。
このサービスは、Idocスクリプトから実行できます。
コア・サービスであるSS_GET_PAGEは、特にSite Studio用に作成されています。このサービスは、多くの構成要素から単一のWebページを動的に生成することで、製品の中心的な役割を果します。
Site Studioリリース7.2.1以下では、SS_GET_PAGEサービスは、Site Studio WebページのURLを直接参照するために使用されていました。Site Studioの現在のリリースでは、SS_GET_PAGEサービスは、WebページのURLで直接使用されることはほとんどありません。かわりに、Webページは、より標準的なパス・ベースのURLを使用してアクセスされます。
ただし、SS_GET_PAGEコア・サービス・コールは、これらのURLの背後で処理を実行するために依然として存在しています。また、現在はWebサーバーのフィルタ・プラグインがすべてのパス・ベースのSite Studio関連のURLを中間で取得して、基礎となるSS_GET_PAGEサービス・コールに渡す前にそれらを複数の構成要素に変換しています。そのため、ここでは引き続きこのコア・サービスについて説明します。
SS_GET_PAGEサービスは、問合せ文字列の一部として、相互に排他的な次のパラメータのいずれかを必要とします。
nodeId: 指定されると、サービスはサイト階層の該当ノードを検索し、そのノードのprimaryUrlプロパティを取得します。これにより、ノードのプライマリ・ページを直接提供するのに十分な情報を取得できます。
かわりに、URLでuseSecondary=trueというパラメータを指定して、ノードのセカンダリ・ページを取得することもできます。この場合、サービスはノードのsecondaryUrlプロパティを取得し、セカンダリ・ページを提供します。この機能は、主にデザイナ・アプリケーションで使用されます。
ssDocName: (有効なdDocName値で)指定されると、サービスは管理対象コンテンツ・アイテムを検索し、3つのルールによる評価(次の「コンテンツを再利用するための3つのルール」を参照)を使用して、コンテンツ・アイテムを表示するWebサイト・セクションを決定します。
次に、セクションのprimaryUrlおよびsecondaryUrlプロパティを解析して、セクションのプライマリ・ページとセカンダリ・ページのどちらを表示するかを決定するための処理決定プロセスを実行します。決定プロセスが完了すると、適切なページが表示されます。
Site Studio Designerのインタフェースと『Oracle WebCenter Content Site Studio Designerユーザーズ・ガイド』では、サイト階層はWebサイトを構成するセクションを持つものとして説明されています。これは、製品の最初の開発時にはノードと呼ばれていました。そのため、SS_GET_PAGEサービスなどの多くの内部機能では、現在もそのように呼ばれています。Site Studioの用語では、ノードはセクションと同じです。
nodeIdパラメータとともにSS_GET_PAGEが使用される場合、サービスは指定したセクションのプライマリ・ページを表示するように明示的に指示されるため、追加の決定処理は不要です。ただし、ssDocNameパラメータとともにSS_GET_PAGEが使用される場合、サービスはドキュメントを表示するセクションを決定する必要があります。これは、次の3つのルールにより決定されます。
ターゲット: オプションのssTargetNodeIdパラメータがURLに指定されている場合、そのセクションに管理対象ドキュメントが明示的に表示されます。
セクション: 管理対象ドキュメントのxWebsiteSectionメタデータ・フィールドに値が含まれる場合、その値がセクションとして使用され、そのセクションに管理対象ドキュメントが表示されます。
ソース: オプションのssSourceNodeIdパラメータが現在のページのノードとしてURLに指定されている場合、そのセクションに管理対象ドキュメントが明示的に表示されます。
これらすべての処理により、コントリビュータは、同じサイトの異なるセクションで、または同じコンテンツ・サーバーの異なるサイトでコンテンツ(コントリビュータ・データ・ファイルとネイティブ・ドキュメント)を共有および再利用できます(『Oracle WebCenter Content Site Studio Designerユーザーズ・ガイド』のターゲット・セクションを使用したリージョン・コンテンツの共有に関する項を参照)。
（ssDocNameパラメータを使用する）SS_GET_PAGEサービスは、管理対象ドキュメントを表示するセクションを決定したら、次にプライマリ・レイアウト・ページとセカンダリ・レイアウト・ページのどちらを表示するかを決定する必要があります。これは、次のアルゴリズムにより決定されます。
前述の説明は、ssDocNameパラメータがコントリビュータ・データ・ファイルまたはネイティブ・ドキュメントを示していることが前提です。ssDocNameパラメータがレイアウト・ファイルを示している場合、異なる処理決定プロセスが発生します。この場合、Site Studioは、そのレイアウトを使用しているセクションを特定するまでサイト階層を順番に検索します。ただし、管理対象レイアウトに対する直接リンクはほとんど使用されません。この方法は、通常、デザイナにより内部的に使用されます。
nodeId、ssDocName、ssTargetNodeIdおよびssSourceNodeIdに加え、SS_GET_PAGEサービスでは、次のオプションのURLパラメータまたはCookieの値も認識されます。
SSContributor: このパラメータには、コントリビューション・モードでWebページを表示するかどうかを示すtrueまたはfalseの値が含まれます。コントリビューション・モードでは、Webページのコントリビューション・リージョンごとに、コンテンツ・アイテムのワークフロー・バージョンとコントリビューション・アイコンが表示されます。必要に応じて、このパラメータによりログイン・プロンプトも表示されます。URLパラメータとして渡されると、この値は自動的にCookie値として設定され、コントリビュータがサイトをナビゲートするのに合せて自動的に伝播されます。
PreviewId: このパラメータは、Webページの最新のチェックイン・バージョンのかわりに、一時的なプレビュー・バージョンを表示することを示します。このパラメータは、レイアウト・ページやコントリビュータ・データ・ファイルの新規バージョンをチェックインすることなくプレビュー・サービスを提供するため、（SS_GET_PAGEサービスと組み合せて）デザイナおよびコントリビュータ・アプリケーションでのみ使用します。URLパラメータとして渡されると、この値も自動的にCookie値として設定され、コントリビュータや設計者がサイトをナビゲートするのに合せてプレビュー・モードを維持するために自動的に伝播されます。
このパラメータを直接使用することは避けてください。
エラーは、SS_GET_PAGEサービス・コールの実行中のどの時点でも発生する可能性があります。たとえば、必要なREPLACEABLEリージョンが特定のセクションに対して指定されていない場合、エラーが発生することがあります。通常、これらのタイプのエラーが発生すると、コンテンツ・サーバーの標準のエラー・ページが表示され、コンシューマはWebサイトのコンテキストの外部に移されます。
エラーを表示しながらWebサイトのコンテキスト内にとどまるには、デザイナで、サイト内の1つのセクションをエラー・ハンドラ・セクションとして指定します。SS_GET_PAGEサービス内でエラーが発生すると、コンシューマは、エラー・ハンドラ・セクションに関連付けられたプライマリ・レイアウト・ページにリダイレクトされます。エラー情報を表示するレイアウト・ページでは、次の2つのIdoc変数を使用できます。
内部的には、エラー・ハンドラ・セクションを設定すると、サイト・プロパティのerrorNodeIdが、エラー・ハンドラ・セクションのnodeIdを含むように設定されます。
Site Studioで出現する可能性のあるエラー・コードのリストは、次のとおりです。
| ssErrorCode | ssErrorMessage |
|---|---|
| -0x100 | 「Webサイトのこの部分に対してレイアウト・ページが指定されていません。」 |
| -0x101 | コンテンツIDのドキュメントのドキュメント情報を検索できませんでした。 |
| -0x102 | コンテンツID '{1}'のドキュメントがセクション'{2}' (Id={3})でプライマリURLまたはセカンダリURLと一致せず、置換可能リージョンが定義されていません。 |
| -0x103 | セクションに対してプライマリURLが定義されていないため、セクション'{1}' (Id={2})へのリンクに失敗しました。 |
| -0x104 | セクションに対してセカンダリURLが定義されていないため、セクション'{1}' (Id={2})へのリンクに失敗しました。 |
| -0x105 | SiteStudio Webサイトにセクション'{1}' (Id={2})が含まれていません。 |
| -0x106 | コンテンツID '{1}'のレイアウトがSiteStudio Webサイトに保存されていません。 |
| -0x107 | コンテンツID '{1}'のレイアウトがWebサイトのセクションURLに見つかりませんでした。 |
| -0x108 | コンテンツID '{1}'のドキュメントを表示するWebサイト・セクションを識別できません。 |
| -0x200 | 「SS_GET_PAGEサービス・コールで不明なエラーが発生しました。」 |
説明: Site Studio Webページを表示します。
パラメータ:
セクションのプライマリ（スプラッシュ）・ページを表示するためのパラメータ:
siteId: サイトの識別子(オプション)。指定されない場合、この値は計算で求められます。
nodeId: セクションの識別子(必須)。
セクションに特定のドキュメントを表示するためのパラメータ:
ssDocName: 表示するドキュメントのdDocName(必須)。
ssTargetNodeId: ドキュメントを表示するセクションの識別子(オプション)。
ssTargetSiteId: 指定されたssTargetNodeIdを含むサイトの識別子(オプション)。指定されない場合、この値は計算で求められます。
ssSourceNodeId: ドキュメントのxWebsiteSection値を使用できない場合にドキュメントを表示するセクションの識別子(オプション)。
ssSourceSiteId: 指定されたssSourceNodeIdを含むサイトの識別子(オプション)。指定されない場合、この値は計算で求められます。
SSContributor: ページをコントリビューション・モードで提供するかどうかを指定します(オプション)。使用可能な値は、trueとfalseです。
戻り値:
Site Studio Webページ。
セキュリティ: ユーザーは、Webサイト・ページを構成するドキュメントに対して少なくとも読取りアクセス権を持っている必要があります。
説明: このサービスは、指定されたプレースホルダ定義に対する、Oracle Contentウィザードに必要なすべての構成を収集します。
パラメータ:
これは、次のいずれかを必要とします。
nodeId: プレースホルダ定義の一意の識別子。
または
文字列として渡されるプレースホルダ定義xmlファイル。
戻り値: 次のそれぞれについて結果セットを返します。
RegionTemplates: リージョン・テンプレートの結果セット。
RegionDefinitions: リージョン定義の結果セット。
Subtemplates: サブテンプレートの結果セット。
セキュリティ: ユーザーは、書込みアクセス権を持っている必要があります。
説明: このサービスは、SS_SWITCH_REGION_ASSOCIATIONサービスURLを介して変更されたプライマリURLおよびセカンダリURLのリージョン関連付けを返します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
Primary: サイトのすべてのプライマリURL。
Secondary: サイトのすべてのセカンダリURL。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、リージョン定義にリストされたすべての要素定義を取得します。
パラメータ:
regionDefinition: リージョン定義の一意の識別子。
戻り値:
列SSElementType、SSElementTitle、SSElementName、SSElementIsList、SSSubelementsを含むssElementConfigsという結果セット。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、特定の相対ノード識別子を取得します。サイト階層を列挙する場合に便利です。
パラメータ:
siteId: サイトの一意の識別子（必須）。
nodeId: ノードの識別子（必須）。
relative: parent、child、nextまたはpriorのいずれか（必須）。
戻り値:
relativeId: サイト階層における相対ノードの識別子。そのような相対がない場合、空の文字列が返されます。
セキュリティ:
ユーザーは、指定したノードに対して少なくとも読取りアクセス権を持っている必要があります。
このサービスは、Idocスクリプトから実行できます。
説明: このサービスは、通常のGET_SEARCH_RESULTSサービスのラッパーです。これにより、いくつかのSite Studio機能をフラグで簡単に指定し、実際の問合せ構文をサーバー上で構成できます。また、標準のSearchResults結果セットを変更して、すべての検索結果についてSite Studioで使用しやすいURLを格納したssUrlという追加列を含めることができます。
パラメータ:
siteId: サイトの一意の識別子（必須）。
ssLimitScope: これは、サイト内のみに有効範囲を制限します(オプション)。true、falseまたは-1です。
Trueは、xWebsitesに対するQueryTextを句で変更します。
Falseは、xWebsitesに対するQueryTextを変更しません。
-1は、xWebsitesに対するQueryTextを<not>句で変更します。
ssUserSearchText: ユーザー指定の検索テキスト(オプション)。これは、指定されたQueryTextに結合されます。
ssWebsiteObjectType: オブジェクト・タイプ(オプション)。これは、QueryTextに、xWebsiteObjectTypeが指定されたオブジェクト・タイプに一致する要件を追加します。
computeFriendlyUrls: これは、ssUrlを含むように結果を変更します(オプション)。このパラメータはデフォルトではtrueです。
ssDontShowInLists: これは、siteIdがxDontShowInListsForWebsitesメタデータ・フィールドに含まれているドキュメントに検索を制限します。このパラメータは、trueまたはfalseです。
これらのパラメータはすべて、GET_SEARCH_RESULTSで必要とされるパラメータ以外のものです。
戻り値:
Search Resultsという名前の結果セット。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して読取りアクセス権を持っている必要があります。
説明: このサービスは、ノードおよび属性とともにサイト全体をXMLとして取得します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
includeProperties: ノードのプロパティを結果セットとしてレスポンスに含めるかどうかを指定するtrueまたはfalseのブール型パラメータ(オプション)。
戻り値:
siteXml: サイトのXML表現。
オプションで、XMLファイルに含まれるノードのプロパティを提供する2つの結果セット(StandardPropertiesおよびSiteStudioProperties)が返されます。nodeIdパラメータにより、結果セットの各行がXMLのノードに関連付けられます。
セキュリティ: ユーザーは、階層のルート・ノードに対して少なくとも書込みアクセス権を持っている必要があります。返されるXMLでは、階層の各ノードが列挙されます。この理由は、Site Studioでは、変更可能なノードにユーザーがナビゲートできるようにツリー構造を表示する必要があるためです。
説明: このサービスは、プロジェクト・ファイルからサイトのサイト・アセット・カテゴリを取得します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
name、type、querytext、metadataおよびdescriptionの列を含むSiteAssetCategoriesという結果セット。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: これは、通常デザイナが10秒(デフォルト)ごとに実行して、サイトが変更されているかどうかを確認するハートビート・メッセージです。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
ssChangeMonitorToken: Webサイトが変更された時に変更される識別子。
セキュリティ:
ユーザーは、プロジェクト・ルート要素に対して少なくとも読取りアクセス権を持っている必要があります。
このサービスは、Idocスクリプトから実行できます。
説明: このサービスは、XMLでサイト定義を返します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
siteXml: サイト階層のXML表現。
セキュリティ: ユーザーは、プロジェクト・ルート要素に対して書込みアクセス権を持っている必要があります。
説明: このサービスは、ユーザーが読取りアクセス権を持っているすべてのノードを示したサイト定義をXMLで返します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値: なし。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、サイトのドメイン・マッピング情報を返します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
ssSiteDomains: サイトにマップされているドメインをリストした結果セット。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つのセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、サイトのすべてのフラグメントで使用されているアセットに関するすべての情報をリストします。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
アセットに関する情報が返されます。同じ情報は、「管理」ページに表示されます。
セキュリティ: ユーザーは、読取りアクセス権を持ち、ログインしている必要があります。
説明: このサービスは、サイトのプロジェクト・ファイルのdDocNameを返します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
プロジェクト・ファイルのdDocName。
セキュリティ: ユーザーは、読取りアクセス権を持っている必要があります。
説明: このサービスは、サイト・プロパティを取得します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
property: 取得するプロパティの名前(必須)。
戻り値:
value: リクエストされたサイト・プロパティの値。
リクエストされたサイト・プロパティが存在しない場合、このパラメータは戻されませんが、サービス・コールは正常に完了します。
セキュリティ: ユーザーは、サイトに対して少なくとも読取りアクセス権を持っている必要があります。このサービスは、Idocスクリプトから実行できます。
説明: このサービスは、サイトで使用されているアイテムのレポートを取得します。これは、引用サイトの正確性を保証するためにSite Studioパブリッシュ・ユーティリティ(SSPU)またはSite Studio Publisherで使用するよう設計されています。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値: サイト・コンテンツを表す多数の結果セットを返します。
セキュリティ: ユーザーは、サイトのルート・フォルダに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、サイトで使用されているアイテムのレポートを取得します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値: サイト・コンテンツを表す多数の結果セットを返します。
セキュリティ: ユーザーは、サイトに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、リストされたリージョン定義に対するコンテンツの切替え構成を返します。
パラメータ:
regionDefinition: リージョン定義の一意の識別子(必須)。
戻り値:
ssRegionConfigというリージョン定義のXMLのJSONレスポンス。
セキュリティ: ユーザーは、サイトに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、指定されたノードIDに関連付けられているサイトを返します。これは、一意のノードを使用するよう設定されているサーバーで使用します。
パラメータ:
nodeId: 関連付けられているサイトを決定するノードの一意の識別子(必須)。
preferredSiteId: 最初に検索するサイトの一意の識別子。これは、ノードが一意でない可能性がある場合に使用されます。
戻り値:
siteId: サイトの一意の識別子。nodeIdがサイトで見つからない場合、サービスは負の値を含むStatusCodeを返します。
セキュリティ:
ユーザーは、指定したノードに対して少なくとも読取りアクセス権を持っている必要があります。
このサービスは、Idocスクリプトから実行できます。
説明: このサービスは、Site Studioのバージョン番号、ビルド番号およびOracle Content Serverのバージョン番号を返します。
パラメータ: なし
戻り値:
Site Studioコンポーネントの製品バージョン番号とビルド番号、およびOracle Content Serverのバージョン番号
セキュリティ:
ユーザーは、指定したノードに対して少なくとも読取りアクセス権を持っている必要があります。
このサービスは、Idocスクリプトから実行できます。
説明: このサービスは、ssWeblayoutUrlというラベルのパラメータで完全なweblayout URLを返します。
パラメータ:
ssWebLayoutParam: dDocName、またはパスgroups/で始まるweblayout URL(必須)。
戻り値:
ssWeblayoutUrlというラベルのパラメータに含まれた完全なweblayout URL。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、ナビゲーション・ファイルが古いかどうかを判別します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
戻り値:
0または1の変数jsNavIsOutOfDate。
セキュリティ:
ユーザーは、少なくとも読取りアクセス権を持っている必要があります。
このサービスは、Idocスクリプトから実行できます。
説明: このサービスは、dDocName値をフレンドリ名に、またはフレンドリ名をdDocNameにマップします。これは、SSUrlFieldName構成設定の使用に関連します。
パラメータ:
inputName: dDocNameまたはフレンドリ名の値(必須)。
direction: fromDocNameまたはtoDocName（必須）。
戻り値: なし。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、階層内でサイト・ノードを移動します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
nodeId: 移動するノードの識別子（必須）。
newParentId: ノードの新しい親の識別子（必須）。
insertAfterId: 移動後のノードの前に位置する兄弟の識別子（オプション）。このパラメータが指定されない場合、ノードはnew_parent_idの最初の子になります。
戻り値: なし。
セキュリティ: ユーザーは、新規親ノードに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、渡されたリンクのターゲットのsiteIdおよびsiteRelativeUrlを返します。
パラメータ:
ssFriendlyUrl: サイトに存在するフレンドリURL(必須)。
戻り値:
siteId: サイトの一意の識別子。
siteRelativeUrl: 入力されたフレンドリURLの解析済URL。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: ファイルのプレビューは、チェックインされた実際のアイテムのディレクトリ下のディレクトリの一時ファイルです。このサービスは、指定されたファイルのプレビューIDを作成します。
パラメータ:
path: プレビューされるファイルのローカル・ファイル・システム・パス。
ssDocName: プレビューするアイテムのコンテンツID。
戻り値:
プレビューID。
セキュリティ: ユーザーは、プレビューするファイルに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、Site Studio Publisherと対話してノードのURLを公開するために使用される「今すぐ公開」機能と同じです。
このサービスがサイトで機能するには、サイトがSite Studio Designerでサイトの公開の有効化アクションでマークされている必要があります。
パラメータ:
nodeId: ノードの一意の識別子。(必須)
isSecondaryPage: ブール値。デフォルトは、falseです。
戻り値: なし。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、特定のドキュメントに対応するWebサイトのリストから特定のsiteIdを削除します。
パラメータ:
dDocName: サイトの一意の識別子(必須)。
siteId: サイトの一意の識別子（必須）。
fieldName: xWebsitesまたはxDontShowInListsForWebsite(必須)。
戻り値: なし。
セキュリティ: ユーザーは、指定されたdDocNameの最新のリビジョンに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、特定のサイトのカスタム・ノード・プロパティ定義を設定します。
パラメータ:
siteId: サイトの一意の識別子（必須）。CustomNodePropertyDefsという結果セットを入力とします。これには、名前、タイプおよび説明の列があります(必須)。
戻り値: なし。
セキュリティ: ユーザーは、ルート・ノードに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、更新および変更の保存のためにコントリビュータによって使用されます。これは、リビジョンの最後にコールされます。データ・ファイルのチェックアウトは、このサービスに依存しません。変更を含むデータ・ファイルをチェックインするには、そのデータ・ファイルがチェックアウトされている必要があります。
パラメータ:
dDocName: データ・ファイルの一意の識別子(必須)。
dId: チェックアウトされたリビジョンのID(必須)。
前述の2つの値は、データ・ファイルのチェックアウトで取得されます。
列element、valueおよびisListを含むSSElementDataという結果セット。isListはブール値のため、yesの場合、要素の名前とリスト・サブ要素で指定された列を含む追加の結果セット。
戻り値: なし。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、指定されたサイトに対して定義済の環境プロパティを設定します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
EnvironmentPropertiesという結果セット。この結果セットには、環境プロパティとして識別されるプロパティごとに1行を持つnameという単一の列が含まれます。
戻り値: なし。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、ノード・プロパティを設定します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
nodeId: ノードの一意の識別子（必須）。
property: 設定または削除するプロパティの名前（必須）。
value: 属性の新しい値（オプション）。値が指定されない場合、プロパティは削除されます。
戻り値: なし。
セキュリティ: ユーザーは、ノードに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、複数のノードで複数のノード・プロパティを設定する方法です。
パラメータ:
siteId: サイトの一意の識別子（必須）。
nodeId0: ノードの一意の識別子(必須)。
. . .
nodeIdN
property0: プロパティの名前(必須)。
. . .
propertyN
value0: 対応するプロパティの値(必須)。
. . .
valueN
戻り値:
プロパティ・セットの数であるrowsProcessed値
セキュリティ: ユーザーは、ノードに対して少なくとも書込みアクセス権を持っている必要があります。
このサービスは、SET_ELEMENT_DATAを特化したもので、データはプレビューの場所に保存され、チェックインされません。
詳細は、11.7.67項「SS_SET_ELEMENT_DATA」を参照してください。
説明: このサービスは、サイト・アセット・カテゴリの変更の保存に使用されます。
パラメータ:
siteId: サイトの一意の識別子（必須）。
description、metadata、name、querytextおよびtypeの列を含むSiteAssetCategoriesという結果セット。名前とタイプの値を指定する必要があります。これらの値は、『Oracle WebCenter Content Site Studio Designerユーザーズ・ガイド』の「サイト・アセット・カテゴリ」ダイアログの説明に一致します。
戻り値: なし。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、サイトのドメイン・マッピング情報を設定します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
ssSiteDomains: サイトにマップするドメインをリストした結果セット。
戻り値: なし。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、単一のサービス・コールで複数のサイト・プロパティを設定します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
property: 取得するプロパティの名前(必須)。
value: リクエストされたサイト・プロパティの値。
戻り値: なし。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
説明: このサービスは、サイト・プロパティを設定します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
property: 設定または削除するプロパティの名前（必須）。
value: 属性の新しい値（オプション）。値が指定されない場合、プロパティは削除されます。
戻り値: なし。
セキュリティ: ユーザーは、サイトに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、特定のノードの特定のリージョンに関連付けられたdDocNameを変更します。
パラメータ:
siteId: サイトの一意の識別子（必須）。
nodeId: ノードの識別子（必須）。
region: リージョン識別子（必須）。
primaryUrl: primaryUrlの指定されたリージョンに設定するdDocName値(オプション)。
secondaryUrl: secondaryUrlの指定されたリージョンに設定するdDocName値(オプション)。
primaryTemplateUrl: プライマリ・ページの指定されたリージョンに設定するリージョン・テンプレートまたはサブテンプレートのdDocName値(オプション)。
secondaryTemplateUrl: セカンダリ・ページの指定されたリージョンに設定するリージョン・テンプレートまたはサブテンプレートのdDocName値(オプション)。
戻り値: なし。
セキュリティ: ユーザーは、ノードに対して少なくとも書込みアクセス権を持っている必要があります。
説明: このサービスは、オブジェクト・タイプの既知のXSDスキーマに対してWebサイト・オブジェクト(XML)を検証します。
パラメータ:
websiteObject:path: 検証およびアップロードするローカル・オブジェクト・ファイルのパス。
websiteObjectType: ローカル・オブジェクト・ファイルのオブジェクト・タイプ。
戻り値:
メッセージとステータス・コードを含むバインダ・レスポンス。
セキュリティ: ユーザーは、コンテンツ・サーバーの1つ以上のセキュリティ・グループに対して書込みアクセス権を持っている必要があります。
このサービスはプレースホルダを評価し、Oracle Content Serverにアクセス可能などこからでもプレースホルダのコンテンツを直接取得できるようにします。
これによって、Oracle Content Serverによって管理され、Site Studio Contributorによって編集可能なXMLデータ・ファイルをベースに、完全なSite Studio Webサイトの使用を強制されずにサード・パーティ・アプリケーションを作成できます。
パラメータ:
dataFileDocName: プレースホルダに関連付けるデータ・ファイルのdDocName。
templateDocName: プレースホルダに関連付けるリージョン・テンプレートまたはサブテンプレートのdDocName。
placeholderDefinitionDocName: プレースホルダにマップするプレースホルダ定義のdDocName。
regionDefinitionDocName: templateDocNameで指定されたリージョン・テンプレートに関連付けるリージョン定義のdDocName。
placeholderActions: プレースホルダ定義の許可されるアクション。次のものがあります。
Eは、コントリビュータの更新を許可します。
Pは、ワークフローの承認を許可します。
Rは、ワークフローの却下を許可します。
Iは、docInfoの表示を許可します。
Sは、データ・ファイルの切替えを許可します。
Uは、Web使用状況レポートの表示を許可します。
Tは、Webトラッカ・レポートの表示を許可します。
Mは、docInfoの更新を許可します。
Vは、リージョン・テンプレートの切替えを許可します。
Nは、コンテンツの削除を許可します。
各選択肢は、デザイナのプレースホルダ定義の設計ビューにあるアクションのチェックボックスに対応します。
戻り値:
評価されるプレースホルダ・コンテンツ。
これらは、wcmPlaceholderスクリプト拡張機能に必要なパラメータと同じです。
このサービスは、Webキャッシュおよび部分ページ・キャッシュのEdge Side Includes (ESI)で使用できます。ページがESI環境でレンダリングされる場合、ESIサーバーはプレースホルダ・コンテンツのリクエストをキャッシュできます。
このサービスはSite Studio Contributorを表示し、ユーザーが指定されたデータ・ファイルを編集できるようにします。
パラメータ
dDocName: データ・ファイルの一意の識別子。
ファイルをチェックインする際、ヘッド・リビジョンでない場合、チェックインを完了できません。
|
注意: このサービスは、あまり直接コールしないでください。かわりに、WCM_BEGIN_EDIT_SESSIONのコールを検討してください。 |
