Oracle® Fusion Middleware

Oracle WebCenter Contentサービス・リファレンス

11g リリース1 (11.1.1)

B72418-02(原本部品番号:E11011-06)

2013年7月

Oracle WebCenter Contentサービスの詳細情報を提供する管理者および開発者向けのドキュメントです。Oracle WebCenter Contentサービスとは、Content Server、Inbound Refinery、Recordsなどによって実行される機能またはプロシージャです。

Oracle Fusion Middleware Oracle WebCenter Contentサービス・リファレンス、11gリリース1 (11.1.1)

B72418-02

Copyright © 2010, 2013,  Oracle and/or its affiliates.All rights reserved.

原本著者: Karen Johnson

原本協力者: Tok Hui Mackenthun、Gaurav Sumra、Weigang Zhong

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

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

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

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の登録商標です。

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

目次

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

はじめに

- 対象読者

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

- 関連ドキュメント

- 表記規則

このガイドで説明する新機能

- 11g リリース1 (11.1.1.8.0)の新機能と変更された機能

- 11g リリース1 (11.1.1.7.0)の新機能と変更された機能

1 Oracle WebCenter Contentのサービスの概要

- 1.1 内容

- 1.2 Oracle WebCenter Contentの用語

2 サービスの使用

- 2.1 サービスの概要

- 2.1.1 サービス・リクエストおよびサービス・レスポンス

- 2.1.1.1 内部サービス・リクエスト

- 2.1.1.2 外部サービス・リクエスト

- 2.1.1.3 リクエストのパラメータ

- 2.1.1.4 日付および時刻の書式設定

- 2.1.1.5 大/小文字の区別の検討事項

- 2.1.2 ページ取得

- 2.1.3 検索サービス

- 2.1.4 統合方法

- 2.1.5 永続URLを使用したサービスのコール

- 2.1.6 ロケール・パラメータのカスタマイズ

- 2.1.7 認証チャレンジの強制

- 2.2 カスタム・アプリケーションの例

- 2.2.1 コールされるサービス

- 2.2.2 プライベート関数

- 2.2.3 サンプル・コード

- 2.3 レスポンス出力のテンプレート・ページのリダイレクト

- 2.3.1 基本的な概念

- 2.3.2 HCSTページの作成

- 2.3.3 検索結果ページの書式再設定

- 2.3.4 追加のオプション

3 サービスのカスタマイズ

- 3.1 サービス構造の概要

- 3.1.1 名前

- 3.1.2 属性

- 3.1.2.1 サービス・クラス

- 3.1.2.2 アクセス・レベル

- 3.1.2.3 「テンプレート」ページ

- 3.1.2.4 サービス・タイプ

- 3.1.2.5 通知された件名

- 3.1.2.6 エラー・メッセージ

- 3.1.3 アクション

- 3.1.3.1 アクション・タイプ

- 3.1.3.2 アクション名

- 3.1.3.3 アクションのパラメータ

- 3.1.3.4 アクションの制御マスク

- 3.1.3.5 アクションのエラー・メッセージ

- 3.2 サービスの例

- 3.2.1 DOC_INFO Service Definition

- 3.2.2 DOC_INFO Attributes

- 3.2.3 DOC_INFO Actions

- 3.2.3.1 アクション1の定義と説明

- 3.2.3.2 アクション2の定義と説明

- 3.2.3.3 アクション3の定義と説明

- 3.2.3.4 アクション4の定義と説明

- 3.2.3.5 アクション5の定義と説明

- 3.2.3.6 アクション6の定義と説明

- 3.2.3.7 アクション7の定義と説明

- 3.2.3.8 アクション8の定義と説明

- 3.2.3.9 アクション9の定義と説明

- 3.2.3.10 アクション10の定義と説明

- 3.2.4 DOC_INFOテンプレート

- 3.3 サービス・リソースの作成

- 3.3.1 カスタム・サービスの手動作成

- 3.3.2 HTMファイルでのサービスの定義

- 3.3.2.1 カスタム・コンポーネントのHDAファイル内にあるサービスのロード

- 3.3.3 コンポーネント・ウィザードを使用したカスタム・サービスの作成

4 コアContent Serverサービス

- 4.1 コアContent Serverサービスについて

- 4.2 一般サービス(コアContent Server)

- 4.2.1 ADD_DOC_ACCOUNT

- 4.2.2 ADD_DOCEXTENSION

- 4.2.3 ADD_DOCFORMAT

- 4.2.4 ADD_DOCTYPE

- 4.2.5 APPLET_DOCINFO

- 4.2.6 CONFIG_INFO

- 4.2.7 DELETE_DOC_ACCOUNT

- 4.2.8 DELETE_DOCEXTENSION

- 4.2.9 DELETE_DOCFORMAT

- 4.2.10 DELETE_DOCTYPE

- 4.2.11 EDIT_DOCEXTENSION

- 4.2.12 EDIT_DOCFORMAT

- 4.2.13 EDIT_DOCTYPE

- 4.2.14 EDIT_TRACE_OPTIONS

- 4.2.15 GET_DATARESULTSET

- 4.2.16 GET_DOCEXTENSIONS

- 4.2.17 GET_DOCFORMATS

- 4.2.18 GET_DOCTYPES

- 4.2.19 GET_FIELD_LENGTHS

- 4.2.20 GET_FILELIST

- 4.2.21 GET_METADEFS

- 4.2.22 GET_RESULT_OPTIONS

- 4.2.23 GET_SYSTEM_AUDIT_INFO

- 4.2.24 GET_TABLE

- 4.2.25 GET_USER_METADEFS

- 4.2.26 JAVA_PROPERTIES

- 4.2.27 LM_BUILD_WEB_STRING_FILES

- 4.2.28 LM_LOAD_LAYOUTS

- 4.2.29 LM_LOAD_LAYOUTS_SUB

- 4.2.30 LOAD_DOC_ENVIRONMENT

- 4.2.31 LOGIN

- 4.2.32 MERGE_TABLE

- 4.2.33 PING_SERVER

- 4.2.34 QUERY_DOC_ACCOUNTS

- 4.2.35 SOAP_FAULT

- 4.3 ドキュメント・サービス(コアContent Server)

- 4.3.1 ASSIGN_DOCINFO_FORM

- 4.3.2 CACHE_CHECKIN_NEW

- 4.3.3 CACHE_CHECKIN_SEL

- 4.3.4 CACHE_SUBMIT_HTML_FORM

- 4.3.5 CACHE_WORKFLOW_CHECKIN

- 4.3.6 CHECKIN_ARCHIVE_NO_NOTIFY

- 4.3.7 CHECKIN_BYNAME

- 4.3.8 CHECKIN_CONFIRM_FORM

- 4.3.9 CHECKIN_LIST

- 4.3.10 CHECKIN_NEW

- 4.3.11 CHECKIN_NEW_FORM

- 4.3.12 CHECKIN_NEW_SUB

- 4.3.13 CHECKIN_SEL

- 4.3.14 CHECKIN_SEL_FORM

- 4.3.15 CHECKIN_SEL_SUB

- 4.3.16 CHECKIN_SIMILAR_FORM

- 4.3.17 CHECKIN_UNIVERSAL

- 4.3.18 CHECKOUT

- 4.3.19 CHECKOUT_BY_NAME

- 4.3.20 CHECKOUT_OK

- 4.3.21 CHECKOUT_SUB

- 4.3.22 CONTINUE_CHECKIN

- 4.3.23 CONTINUE_SUBMIT_HTML_FORM

- 4.3.24 COPY_REVISION

- 4.3.25 CREATE_SUBSCRIPTION_TYPE

- 4.3.26 DELETE_BYCLASS

- 4.3.27 DELETE_BYNAME

- 4.3.28 DELETE_BYREV

- 4.3.29 DELETE_BYREV_REVISION

- 4.3.30 DELETE_CHECKIN_CACHE

- 4.3.31 DELETE_DOC

- 4.3.32 DELETE_REV

- 4.3.33 DELETE_REV_EX

- 4.3.34 DELETE_SUBSCRIPTION_TYPE

- 4.3.35 DOC_FORMATS_WIZARD

- 4.3.36 DOC_INFO

- 4.3.37 DOC_INFO_BY_NAME

- 4.3.38 DOC_INFO_LATESTRELEASE

- 4.3.39 DOC_INFO_SIMPLE

- 4.3.40 DOC_INFO_SIMPLE_BYREV

- 4.3.41 DOC_SUBS_LIST

- 4.3.42 EDIT_DOC_FORMATS

- 4.3.43 FORM_PROCESS

- 4.3.44 FORM_SUBMIT

- 4.3.45 GET_CACHED_CHECKIN_INFO

- 4.3.46 GET_DOC_CONFIG_INFO

- 4.3.47 GET_DOC_SUBSCRIBERS

- 4.3.48 GET_DOCUMENT_HISTORY_REPORT

- 4.3.49 GET_ENVIRONMENT

- 4.3.50 GET_EXPIRED

- 4.3.51 GET_PACKAGE_ENVIRONMENT_PAGE

- 4.3.52 GET_UPDATE_FORM

- 4.3.53 NOTIFY_INDEXER

- 4.3.54 ODMA_DOC_INFO_SIMPLE

- 4.3.55 PACKAGE_ENVIRONMENT

- 4.3.56 REMOVE_METAFILE_SUB

- 4.3.57 REPLACE_METAFILE_SUB

- 4.3.58 RESTORE_REVISION

- 4.3.59 RESUBMIT_FOR_CONVERSION

- 4.3.60 REV_HISTORY

- 4.3.61 SELECTDOC

- 4.3.62 SUBMIT_HTML_FORM

- 4.3.63 SUBSCRIBE

- 4.3.64 SUBSCRIBE_DOC_USER

- 4.3.65 SUBSCRIBE_EX

- 4.3.66 SUBSCRIBE_FORM

- 4.3.67 SUBSCRIPTION_LIST

- 4.3.68 UNDO_CHECKOUT

- 4.3.69 UNDO_CHECKOUT_BY_NAME

- 4.3.70 UNSUBSCRIBE

- 4.3.71 UNSUBSCRIBE_FORM

- 4.3.72 UNSUBSCRIBE_FROM_LIST

- 4.3.73 UNSUBSCRIBE_FROM_LIST_EX

- 4.3.74 UPDATE_BYREV

- 4.3.75 UPDATE_DOCINFO

- 4.3.76 UPDATE_DOCINFO_BYFORM

- 4.3.77 UPDATE_DOCINFO_BYREV

- 4.3.78 UPDATE_DOCINFO_METAFILE_BYREV

- 4.3.79 UPDATE_DOCINFO_STATUS

- 4.3.80 UPDATE_DOCINFO_SUB

- 4.3.81 UPDATE_SUBSCRIPTION_NOTIFY

- 4.3.82 UPDATE_SUBSCRIPTION_TYPE

- 4.3.83 UPDATE_SUBSCRIPTION_USED

- 4.3.84 UPDATE_METADATA

- 4.3.85 VALIDATE_DOCINFO

- 4.3.86 WORK_IN_PROGRESS

- 4.4 ドキュメント・プロファイル・サービス(コアContent Server)

- 4.4.1 ADD_DOCPROFILE

- 4.4.2 ADD_DOCRULE

- 4.4.3 DELETE_DOCPROFILE

- 4.4.4 DELETE_DOCRULE

- 4.4.5 DOCPROFILE_PREVIEW

- 4.4.6 EDIT_DOCPROFILE

- 4.4.7 EDIT_DOCPROFILE_TRIGGER

- 4.4.8 EDIT_DOCRULE

- 4.4.9 GET_DOCPROFILE

- 4.4.10 GET_DOCPROFILES

- 4.4.11 GET_DOCRULE

- 4.4.12 GET_DOCRULES

- 4.5 ファイル・サービス(コアContent Server)

- 4.5.1 ADD_WEB_APP

- 4.5.2 APPEND_FILE_CACHING_INFO

- 4.5.3 GET_DYNAMIC_CONVERSION

- 4.5.4 GET_DYNAMIC_CONVERSION_SUB

- 4.5.5 GET_DYNAMIC_URL

- 4.5.6 GET_TEMPLATE_CONVERSIONS

- 4.5.7 GET_WEB_APP_STATUS

- 4.5.8 LOAD_RESOURCE_FILE

- 4.5.9 REMOVE_WEB_APP

- 4.5.10 SAVE_TEMPLATE_CONVERSIONS

- 4.6 インデクサ・サービス(コアContent Server)

- 4.6.1 CANCEL_SEARCH_INDEX

- 4.6.2 CONTROL_SEARCH_INDEX

- 4.6.3 GET_FILE

- 4.6.4 START_SEARCH_INDEX

- 4.7 内部サービス(コアContent Server)

- 4.7.1 CANCEL_COMPONENT_INSTALL

- 4.7.2 CLEAR_SERVER_OUTPUT

- 4.7.3 DOWNLOAD_COMPONENT

- 4.7.4 GET_COMPONENT_CONFIG

- 4.7.5 GET_COMPONENT_INSTALL_FORM

- 4.7.6 GET_COMPONENT_INSTALL_PROMPTS_FORM

- 4.7.7 GET_COMPONENT_INSTALL_SETTINGS'

- 4.7.8 GET_LOCAL_REGISTRATION_FORM

- 4.7.9 GET_MANIFEST_INFO

- 4.7.10 GET_SERVER_OUTPUT

- 4.7.11 PROXIED_REQUEST

- 4.7.12 UNINSTALL_COMPONENT

- 4.7.13 UPDATE_COMPONENT_CONFIG

- 4.7.14 UPDATE_LICENSE

- 4.7.15 UPLOAD_NEW_COMPONENT

- 4.8 メタサービス(コアContent Server)

- 4.8.1 ADD_METADEF

- 4.8.2 DEL_METADEF

- 4.8.3 EDIT_METADEF

- 4.8.4 GET_ADVANCED_SEARCH_OPTIONS

- 4.8.5 GET_DISPLAY_FIELDS

- 4.8.6 GET_DOC_METADATA_INFO

- 4.8.7 GET_OPTION_LIST

- 4.8.8 GET_USER_METADATA_INFO

- 4.8.9 MOVE_METADEF

- 4.8.10 UPDATE_ADVANCED_SEARCH_OPTIONS

- 4.8.11 UPDATE_USER_META

- 4.8.12 UPDATE_USER_META_TABLE

- 4.8.13 UPDATE_META_TABLE

- 4.8.14 UPDATE_OPTION_LIST

- 4.9 その他のサービス(コアContent Server)

- 4.9.1 CHUNKED_UPLOAD

- 4.9.2 DOWNLOAD_LISTBOX_ITEMS

- 4.9.3 LOAD_USER_LOCALIZATION

- 4.10 ページ・ハンドラ/ページ・リクエスト・サービス(コアContent Server)

- 4.10.1 DELETE_RESULT_TEMPLATE

- 4.10.2 GET_ADMIN_PAGE

- 4.10.3 GET_DOC_PAGE

- 4.10.4 GET_DYNAMIC_PAGE

- 4.10.5 GET_PERSONALIZED_JAVASCRIPT

- 4.10.6 GET_PORTAL_PAGE

- 4.10.7 GET_SECURE_PAGE

- 4.10.8 LOAD_GLOBALINCLUDES

- 4.10.9 PAGE_HANDLER

- 4.10.10 PNE_SAVE_QUERY

- 4.10.11 PNE_UPDATE_PERSONAL_URLS

- 4.10.12 PNE_UPDATE_PORTAL_INFO

- 4.10.13 SAVE_GLOBALINCLUDES

- 4.10.14 UPDATE_RESULT_TEMPLATE

- 4.11 プロバイダ・マネージャ・サービス(コアContent Server)

- 4.11.1 ADD_EDIT_PROVIDER

- 4.11.2 APPEND_DATABASE_AUDIT_INFO

- 4.11.3 DELETE_PROVIDER

- 4.11.4 ENABLE_DISABLE_PROVIDER

- 4.11.5 GET_ADD_EDIT_PROVIDER_FORM

- 4.11.6 GET_ALL_PROVIDERS

- 4.11.7 GET_PROVIDER_INFO

- 4.11.8 NOTIFY_CHANGE

- 4.11.9 REQUEST_SECURITYINFO

- 4.11.10 TEST_PROVIDER

- 4.12 スキーマ・サービス(コアContent Server)

- 4.12.1 ADD_SCHEMA_FIELD

- 4.12.2 ADD_SCHEMA_RELATION

- 4.12.3 ADD_SCHEMA_VIEW

- 4.12.4 ADDOREDIT_SCHEMA_TABLE

- 4.12.5 CONTROL_SCHEMA

- 4.12.6 DELETE_SCHEMA_FIELD

- 4.12.7 DELETE_SCHEMA_RELATION

- 4.12.8 DELETE_SCHEMA_TABLE

- 4.12.9 DELETE_SCHEMA_VIEW

- 4.12.10 EDIT_SCHEMA_FIELD

- 4.12.11 EDIT_SCHEMA_NODE

- 4.12.12 EDIT_SCHEMA_RELATION

- 4.12.13 EDIT_SCHEMA_VIEW

- 4.12.14 EDIT_SCHEMA_VIEW_VALUES

- 4.12.15 GET_SCHEMA_FIELD_INFO

- 4.12.16 GET_SCHEMA_FIELDS

- 4.12.17 GET_SCHEMA_RELATIONS

- 4.12.18 GET_SCHEMA_STATS

- 4.12.19 GET_SCHEMA_TABLE_INFO

- 4.12.20 GET_SCHEMA_TABLES

- 4.12.21 GET_SCHEMA_VIEW_EDIT_INFO

- 4.12.22 GET_SCHEMA_VIEW_FRAGMENT

- 4.12.23 GET_SCHEMA_VIEW_INFO

- 4.12.24 GET_SCHEMA_VIEW_VALUES

- 4.12.25 GET_SCHEMA_VIEWS

- 4.12.26 PUBLISH_SCHEMA

- 4.13 Search Services (Core Content Server)

- 4.13.1 APPEND_SEARCH_AUDIT_INFO

- 4.13.2 GET_EXTERNAL_DOC_INFO

- 4.13.3 GET_EXTERNAL_HIGHLIGHT_INFO

- 4.13.4 GET_EXTERNAL_XML_HIGHLIGHT_INFO

- 4.13.5 GET_HIGHLIGHT_INFO

- 4.13.6 GET_SEARCH_RESULTS

- 4.13.7 GET_SEARCH_RESULTS_FORCELOGIN

- 4.13.8 GET_XML_HIGHLIGHT_INFO

- 4.13.9 PNE_GET_SEARCH_RESULTS

- 4.13.10 VIEW_DOC

- 4.14 ユーザー・サービス(コアContent Server)

- 4.14.1 ADD_ALIAS

- 4.14.2 ADD_GROUP

- 4.14.3 ADD_ROLE

- 4.14.4 ADD_USER

- 4.14.5 CHANGE_USER_AUTH_TYPE

- 4.14.6 CHECK_USER_CREDENTIALS

- 4.14.7 DELETE_ALIAS

- 4.14.8 DELETE_GROUP

- 4.14.9 DELETE_ROLE

- 4.14.10 DELETE_USER

- 4.14.11 EDIT_ALIAS

- 4.14.12 EDIT_GROUP

- 4.14.13 EDIT_ROLE

- 4.14.14 EDIT_USER

- 4.14.15 EDIT_USER_PROFILE

- 4.14.16 GET_ALIASES

- 4.14.17 GET_FILTER_ADMIN_PAGE

- 4.14.18 GET_SELF_REGISTER_PAGE

- 4.14.19 GET_USERDOCPROFILES

- 4.14.20 GET_USER_INFO

- 4.14.21 GET_USERS

- 4.14.22 LOAD_PNE_PORTAL

- 4.14.23 LOAD_USER_TOPIC

- 4.14.24 QUERY_GROUP

- 4.14.25 QUERY_USER_ATTRIBUTES

- 4.14.26 REGISTER_USER

- 4.14.27 SAVE_USER_TOPICS

- 4.14.28 UPDATE_FILTER_INFO

- 4.14.29 UPDATE_USEROPTION_LIST

- 4.15 コラボレーション・サービス(コアContent Server)

- 4.15.1 ADD_COLLABORATION

- 4.15.2 ADD_COLLABORATION_FORM

- 4.15.3 DELETE_COLLABORATION

- 4.15.4 EDIT_CLBRA_ACCESS_LIST

- 4.15.5 EDIT_CLBRA_ACCESS_LIST_FORM

- 4.15.6 EDIT_COLLABORATION

- 4.15.7 EDIT_COLLABORATION_FORM

- 4.15.8 GET_CLBRA_DOCUMENTS

- 4.15.9 GET_CLBRA_INFO

- 4.15.10 GET_COLLABORATION_LIST

- 4.15.11 GET_USER_CLBRA_LIST

5 ワークフロー・サービス

- 5.1 ワークフロー・サービスについて

- 5.2 ドキュメント・サービスと一般サービス(ワークフロー)

- 5.2.1 ADD_PROBLEMREPORT

- 5.2.2 DELETE_PROBLEMREPORT

- 5.2.3 GET_CRITERIA_WORKFLOWS_FOR_GROUP

- 5.2.4 GET_DOCUMENT_PROBLEMREPORTS

- 5.2.5 GET_PROBLEMREPORTS_SEARCH_FORM

- 5.2.6 GET_PROBLEMREPORTS_SEARCH_RESULTS

- 5.2.7 GET_UPDATE_PROBLEMREPORT_FORM

- 5.2.8 GET_WORKFLOWDOCUMENTS

- 5.2.9 GET_WORKFLOWS_FOR_ALL

- 5.2.10 LOAD_WORKFLOW_QUEUE

- 5.2.11 NOTIFY_CONTRIBUTOR

- 5.2.12 PROBLEMREPORT_INFO

- 5.2.13 RESEND_PROBLEMREPORT

- 5.2.14 REVIEW_WORKFLOW_DOC

- 5.2.15 UPDATE_PROBLEMREPORT

- 5.2.16 WORKFLOW_CHECKIN_SUB

- 5.2.17 WORKFLOW_EDIT_REV

- 5.2.18 WORKFLOW_NEW_REV

- 5.2.19 WORKFLOW_REJECT_FORM

- 5.3 ワークフロー・テンプレート・サービス

- 5.3.1 ADD_WF_TEMPLATE

- 5.3.2 DELETE_WF_TEMPLATE

- 5.3.3 EDIT_WF_TEMPLATE

- 5.3.4 GET_WF_TEMPLATE

- 5.3.5 GET_WF_TEMPLATES

- 5.4 ワークフロー・サービス

- 5.4.1 ADD_WORKFLOW

- 5.4.2 ADD_WORKFLOW_SCRIPT

- 5.4.3 ADD_WORKFLOW_TOKEN

- 5.4.4 ADD_WORKFLOWALIASES

- 5.4.5 ADD_WORKFLOWDOCUMENT

- 5.4.6 ADD_WORKFLOWDOCUMENT_SUB

- 5.4.7 ADD_WORKFLOWDOCUMENTS

- 5.4.8 ADD_WORKFLOWSTEP

- 5.4.9 CRITERIAWORKFLOW_DISABLE

- 5.4.10 CRITERIAWORKFLOW_DISABLE_SUB

- 5.4.11 CRITERIAWORKFLOW_ENABLE

- 5.4.12 DELETE_WFCONTRIBUTORS

- 5.4.13 DELETE_WORKFLOW

- 5.4.14 DELETE_WORKFLOW_SCRIPT

- 5.4.15 DELETE_WORKFLOW_TOKEN

- 5.4.16 DELETE_WORKFLOWCRITERIA

- 5.4.17 DELETE_WORKFLOWDOCUMENTS

- 5.4.18 DELETE_WORKFLOWSTEP

- 5.4.19 EDIT_WORKFLOW

- 5.4.20 EDIT_WORKFLOW_SCRIPT

- 5.4.21 EDIT_WORKFLOW_TOKEN

- 5.4.22 EDIT_WORKFLOWCRITERIA

- 5.4.23 EDIT_WORKFLOWSTEP

- 5.4.24 GET_ACTIVE_WORKFLOWS

- 5.4.25 GET_ALL_WORKFLOWDOCREVISIONS

- 5.4.26 GET_CRITERIA_WORKFLOWS_FOR_GROUP

- 5.4.27 GET_WF_COMPANION_INFO

- 5.4.28 GET_WORKFLOW

- 5.4.29 GET_WORKFLOW_INFO

- 5.4.30 GET_WORKFLOW_INFO_BYNAME

- 5.4.31 GET_WORKFLOW_SCRIPT

- 5.4.32 GET_WORKFLOWDOCREVISIONS

- 5.4.33 GET_WORKFLOWS

- 5.4.34 TEST_WORKFLOW_SCRIPT

- 5.4.35 WORKFLOW_APPROVE

- 5.4.36 WORKFLOW_CANCEL

- 5.4.37 WORKFLOW_CHECKIN

- 5.4.38 WORKFLOW_EDIT_APPROVE

- 5.4.39 WORKFLOW_REJECT

- 5.4.40 WORKFLOW_START

6 アーカイブ・サービス

- 6.1 アーカイブ・サービスについて

- 6.2 アーカイブ・サービス

- 6.2.1 ADD_ARCHIVE

- 6.2.2 ADD_COLLECTION

- 6.2.3 ADD_PROXIEDCOLLECTION

- 6.2.4 CANCEL_ARCHIVE

- 6.2.5 CHECKIN_ARCHIVE

- 6.2.6 COPY_ARCHIVE

- 6.2.7 DELETE_ARCHIVE

- 6.2.8 DELETE_BATCH_FILE

- 6.2.9 DELETE_BATCH_FILE_DOCUMENTS

- 6.2.10 DELETE_BATCH_FILE_TABLES

- 6.2.11 EDIT_ARCHIVE

- 6.2.12 EDIT_ARCHIVEDATA

- 6.2.13 EDIT_EXPORTERS

- 6.2.14 EDIT_TRANSFEROPTIONS

- 6.2.15 EXECUTE_BATCH

- 6.2.16 EXPORT_ARCHIVE

- 6.2.17 GET_ARCHIVECOLLECTIONS

- 6.2.18 GET_ARCHIVETABLECONTENT

- 6.2.19 GET_ARCHIVED_FILE

- 6.2.20 GET_ARCHIVES

- 6.2.21 GET_ARCHIVERELATIONQUERY

- 6.2.22 GET_BATCH_FILE_DOCUMENTS

- 6.2.23 GET_BATCH_PROPERTIES

- 6.2.24 GET_BATCH_SCHEMA

- 6.2.25 GET_BATCH_VALUES

- 6.2.26 GET_BATCHFILES

- 6.2.27 GET_PROXIED_ARCHIVECOLLECTIONS

- 6.2.28 GET_PROXIEDSERVERS

- 6.2.29 GET_REPLICATION_DATA

- 6.2.30 GET_TABLECOLUMNLIST

- 6.2.31 GET_TARGET_INFO

- 6.2.32 GET_TARGET_TRANSFER_STATUS

- 6.2.33 GET_TRANSFER_SOURCE_INFO

- 6.2.34 IMPORT_ARCHIVE

- 6.2.35 IMPORT_ARCHIVE_START_AUTOMATED

- 6.2.36 IMPORT_BATCHFILE

- 6.2.37 IMPORT_DOCUMENT

- 6.2.38 IMPORT_TABLE_ENTRY

- 6.2.39 INSERT_NATIVE

- 6.2.40 INSERT_NEW

- 6.2.41 REGISTER_IMPORTER

- 6.2.42 REMOVE_COLLECTION

- 6.2.43 REMOVE_EXPORTER

- 6.2.44 REMOVE_IMPORTER

- 6.2.45 REMOVE_PROXIEDTRANSFER

- 6.2.46 REMOVE_QUEUED_IMPORT

- 6.2.47 REMOVE_TRANSFER

- 6.2.48 REQUEST_TRANSFER

- 6.2.49 TRANSFER_ARCHIVE

- 6.2.50 UPDATE_TARGET_TOTALS

- 6.2.51 UPDATE_TRANSFER_STATUS

- 6.2.52 UPLOAD_ARCHIVE_TRANSFER

7 コントリビューション・フォルダ・サービス

- 7.1 コントリビューション・フォルダ・サービスについて

- 7.2 コントリビューション・フォルダ・サービス

- 7.2.1 COLLECTION_ADD

- 7.2.2 COLLECTION_ADD_LINK

- 7.2.3 COLLECTION_BROWSE

- 7.2.4 COLLECTION_CHECKIN_NEW

- 7.2.5 COLLECTION_CHECKIN_REVISION

- 7.2.6 COLLECTION_CHECKIN_SEL_SUB

- 7.2.7 COLLECTION_COPY_ALL

- 7.2.8 COLLECTION_COPY_COLLECTION

- 7.2.9 COLLECTION_COPY_ITEM

- 7.2.10 COLLECTION_COPY_LOT

- 7.2.11 COLLECTION_DELETE

- 7.2.12 COLLECTION_DELETE_ALL

- 7.2.13 COLLECTION_DELETE_COLLECTION

- 7.2.14 COLLECTION_DELETE_ITEM

- 7.2.15 COLLECTION_DELETE_LOT

- 7.2.16 COLLECTION_DISPLAY

- 7.2.17 COLLECTION_EDIT

- 7.2.18 COLLECTION_GET_ADMIN_CONFIG

- 7.2.19 COLLECTION_GET_ADMIN_INHERIT_CONFIG

- 7.2.20 COLLECTION_GET_ADMIN_MARKED_CONFIG

- 7.2.21 COLLECTION_GET_ADMIN_META_CONFIG

- 7.2.22 COLLECTION_GET_ADMIN_METADATA_DEFAULTS

- 7.2.23 COLLECTION_GET_ADMIN_MOUNTED_CONFIG

- 7.2.24 COLLECTION_GET_ARCHIVE

- 7.2.25 COLLECTION_GET_BRANCH

- 7.2.26 COLLECTION_GET_COLLECTION

- 7.2.27 COLLECTION_GET_COLLECTIONS

- 7.2.28 COLLECTION_GET_CONTENT_FILE

- 7.2.29 COLLECTION_GET_CONTENTS

- 7.2.30 COLLECTION_GET_FILE

- 7.2.31 COLLECTION_GET_INFO

- 7.2.32 COLLECTION_GET_LINKS

- 7.2.33 COLLECTION_GET_META_MAPPING

- 7.2.34 COLLECTION_GET_PROFILE_METADATA_DEFAULTS

- 7.2.35 COLLECTION_GET_PROFILE_METADATA_REVISION_DEFAULTS

- 7.2.36 COLLECTION_GET_REFERENCE

- 7.2.37 COLLECTION_GET_SEARCH_FORM

- 7.2.38 COLLECTION_GET_SYSTEM_FILE

- 7.2.39 COLLECTION_GET_USER_CONFIG

- 7.2.40 COLLECTION_INFO

- 7.2.41 COLLECTION_ISVALID_META

- 7.2.42 COLLECTION_LOCK

- 7.2.43 COLLECTION_MOVE_ALL

- 7.2.44 COLLECTION_MOVE_COLLECTION

- 7.2.45 COLLECTION_MOVE_ITEM

- 7.2.46 COLLECTION_MOVE_LOT

- 7.2.47 COLLECTION_NEW

- 7.2.48 COLLECTION_PROFILE_GET_COLUMNS

- 7.2.49 COLLECTION_PROFILE_UPDATE_COLUMNS

- 7.2.50 COLLECTION_RESTORE_COLLECTION

- 7.2.51 COLLECTION_RESTORE_ITEM

- 7.2.52 COLLECTION_SEARCH_CONTENT

- 7.2.53 COLLECTION_SEARCH_RESULTS

- 7.2.54 COLLECTION_SET_ARCHIVE

- 7.2.55 COLLECTION_SET_USER_CONFIG

- 7.2.56 COLLECTION_UNLOCK

- 7.2.57 COLLECTION_UPDATE

- 7.2.58 COLLECTION_UPDATE_ADMIN_CONFIG

- 7.2.59 COLLECTION_UPDATE_ADMIN_INHERIT_CONFIG

- 7.2.60 COLLECTION_UPDATE_ADMIN_METADATA_DEFAULTS

- 7.2.61 COLLECTION_UPDATE_ALL

- 7.2.62 COLLECTION_UPDATE_ITEM

- 7.2.63 COLLECTION_UPDATE_META

- 7.2.64 COLLECTION_UPDATE_META_TABLE

- 7.2.65 COLLECTION_UPDATE_PROFILE_METADATA_DEFAULTS

- 7.2.66 COLLECTION_UPDATE_PROFILE_METADATA_REVISION_DEFAULTS

- 7.2.67 COLLECTION_UPDATE_STRUCTURE

- 7.2.68 COLLECTION_VERIFY_FOLDER_NAME

- 7.2.69 FOLDERSLOCAL_BUILD_MOUNT

- 7.2.70 FOLDERSLOCAL_CREATE_MOUNT

- 7.2.71 FOLDERSLOCAL_DELETE_MOUNT

- 7.2.72 FOLDERSLOCAL_UPDATE_MOUNT

- 7.2.73 GET_FOLDER_HISTORY_REPORT

- 7.2.74 GET_OPTION_LISTS

- 7.2.75 GOTO_COLLECTION

- 7.2.76 GOTO_ROOT_COLLECTION

8 フォルダ・サービス

- 8.1 フォルダ・サービスについて

- 8.2 フォルダ・サービス

- 8.2.1 FLD_BROWSE

- 8.2.2 FLD_BROWSE_POPUP

- 8.2.3 FLD_COPY

- 8.2.4 FLD_CREATE_FILE

- 8.2.5 FLD_CREATE_FILE_FORM

- 8.2.6 FLD_CREATE_FOLDER

- 8.2.7 FLD_CREATE_FOLDER_FORM

- 8.2.8 FLD_DELETE

- 8.2.9 FLD_EDIT_FILE

- 8.2.10 FLD_EDIT_FILE_FORM

- 8.2.11 FLD_EDIT_FOLDER

- 8.2.12 FLD_EDIT_FOLDER_FORM

- 8.2.13 FLD_EDIT_METADATA_RULES

- 8.2.14 FLD_EDIT_METADATA_RULES_FORM

- 8.2.15 FLD_FOLDER_MIGRATION_STATUS

- 8.2.16 FLD_FOLDER_SEARCH

- 8.2.17 FLD_FOLDER_SEARCH_FORM

- 8.2.18 FLD_GET_CHOOSE_DESTINATION_DIALOG

- 8.2.19 FLD_GET_CREATE_LINK_DIALOG

- 8.2.20 FLD_GET_CREATE_SHORTCUT_DIALOG

- 8.2.21 FLD_GET_RENAME_FILE_DIALOG

- 8.2.22 FLD_GET_RENAME_FOLDER_DIALOG

- 8.2.23 FLD_INFO

- 8.2.24 FLD_LOAD_SOFT_LINKS_FOR_DOCUMENT

- 8.2.25 FLD_MIGRATION_FOLDER_DATA

- 8.2.26 FLD_MOVE

- 8.2.27 FLD_PRE_CHECKIN

- 8.2.28 FLD_PROPAGATE

- 8.2.29 FLD_PROPAGATE_FORM

- 8.2.30 FLD_REINDEX_FOLDER_CONTENTS

- 8.2.31 FLD_RETRIEVE_CHILD_FILES

- 8.2.32 FLD_RETRIEVE_CHILD_FOLDERS

- 8.2.33 FLD_SUBSCRIBE

- 8.2.34 FLD_TEST_USER_CAPABILITIES

- 8.2.35 FLD_UNSUBSCRIBE

- 8.2.36 FLD_UNFILE

9 レコード・サービス

- 9.1 レコード・サービスについて

- 9.2 レコード・サービス

- 9.2.1 ACTIVATE_SERVICE

- 9.2.2 APPROVE_DELETE_SERVICE

- 9.2.3 BROWSE_CATEGORY_FORM

- 9.2.4 BROWSE_FOLDER_FORM

- 9.2.5 BROWSE_SERIES_FORM

- 9.2.6 CHECKIN_NEW_REVISION_SERVICE

- 9.2.7 CHECKIN_SIMILAR_FORM

- 9.2.8 CLEAR_FOLDER_CANCELLED_DATE

- 9.2.9 CLEAR_FOLDER_EXPIRATION_DATE

- 9.2.10 CLEAR_FOLDER_OSBOLETE_DATE

- 9.2.11 CLEAR_FOLDER_RESCINDED_DATE

- 9.2.12 CLEAR_FOLDER_REVIEW_DATE

- 9.2.13 CLEAR_RECORD_CANCELLED_DATE

- 9.2.14 CLEAR_RECORD_EXPIRATION_DATE

- 9.2.15 CLEAR_RECORD_OBSOLETE_DATE

- 9.2.16 CLOSE_FOLDER

- 9.2.17 CREATE_FOLDER

- 9.2.18 CREATE_FOLDER_FORM

- 9.2.19 DELETE_ALL_BUT_LAST_N_REVISIONS_ SERVICE

- 9.2.20 DELETE_FOLDER

- 9.2.21 DELETE_REVISION_SERVICE

- 9.2.22 EDIT_FOLDER

- 9.2.23 EDIT_FOLDER_FORM

- 9.2.24 FREEZE_FOLDER

- 9.2.25 FREEZE_RECORD

- 9.2.26 INFO_CATEGORY_FORM

- 9.2.27 INFO_FOLDER_FORM

- 9.2.28 INFO_FOLDER_LIFECYCLE

- 9.2.29 INFO_FOLDER_METADATA_HISTORY

- 9.2.30 INFO_FOLDER_REVIEW_HISTORY

- 9.2.31 INFO_RECORD_LIFECYCLE

- 9.2.32 INFO_RECORD_METADATA_HISTORY

- 9.2.33 INFO_RECORD_REVIEW_HISTORY

- 9.2.34 INFO_SERIES_FORM

- 9.2.35 MARK_FOLDER_ACTIVATION_DATE

- 9.2.36 MARK_FOLDER_CANCELLED_DATE

- 9.2.37 MARK_FOLDER_EXPIRATION_DATE

- 9.2.38 MARK_FOLDER_OBSOLETE_DATE

- 9.2.39 MARK_FOLDER_RESCINDED_DATE

- 9.2.40 MARK_FOLDER_REVIEW_DATE

- 9.2.41 MARK_FOLDER_REVIEW_DATE_ RECURSIVE

- 9.2.42 MARK_RECORD_CANCELLED_DATE

- 9.2.43 MARK_RECORD_EXPIRATION_DATE

- 9.2.44 MARK_RECORD_OBSOLETE_DATE

- 9.2.45 MARK_RECORD_RESCINDED_DATE

- 9.2.46 MARK_RECORD_REVIEW_DATE

- 9.2.47 MOVE_FOLDER

- 9.2.48 PREVIEW_RECORD_LIFECYCLE

- 9.2.49 RMA_CLOSE_SERVICE

- 9.2.50 RMA_CUTOFF_SERVICE

- 9.2.51 RMA_DESTROY_SERVICE

- 9.2.52 RMA_EXPORT_ARCHIVE_SERVICE

- 9.2.53 RMA_EXPORT_SERVICE

- 9.2.54 RMA_MARK_COMPLETED

- 9.2.55 RMA_NO_ACTION_SERVICE

- 9.2.56 RMA_OBSOLETE_SERVICE

- 9.2.57 RMA_SCRUB_SERVICE

- 9.2.58 RMA_SUPERSEDE_SERVICE

- 9.2.59 UNCLOSE_FOLDER

- 9.2.60 UNFREEZE_FOLDER

- 9.2.61 UNFREEZE_RECORD

10 物理コンテンツ管理サービス

- 10.1 物理コンテンツ管理サービスについて

- 10.2 物理コンテンツ管理サービス

- 10.2.1 ADD_FUNCTION_BARCODE

- 10.2.2 ADJUST_INVOICE

- 10.2.3 ADJUST_INVOICE_FORM

- 10.2.4 BARCODE_PROCESS

- 10.2.5 BATCH_STORAGE_CREATION_FORM

- 10.2.6 BLOCK_STORAGE

- 10.2.7 BROWSE_CHARGE_INVOICES_FORM

- 10.2.8 BROWSE_CHARGE_TRANSACTIONS_BY_INVOICE_FORM

- 10.2.9 BROWSE_CHARGE_TRANSACTIONS_FORM

- 10.2.10 BROWSE_CHARGE_TRANSACTIONS_WITH_NO_INVOICE_FORM

- 10.2.11 BROWSE_RESERVATION_ITEMS_FORM

- 10.2.12 BROWSE_STORAGE_FORM

- 10.2.13 CHECKIN_EXTERNAL_ITEM

- 10.2.14 CHECKOUT_EXTERNAL_ITEM

- 10.2.15 CLEAN_UP_STORAGE

- 10.2.16 CONFIG_CHARGE_BACKS

- 10.2.17 CONFIG_CHARGE_BACKS_FORM

- 10.2.18 CONFIGURE_CHARGE_BILLERS_FORM

- 10.2.19 CONFIGURE_CHARGE_PAYMENT_TYPES_FORM

- 10.2.20 CONFIGURE_CHARGE_TYPES_FORM

- 10.2.21 CREATE_CHARGE_BILLER

- 10.2.22 CREATE_CHARGE_BILLER_FORM

- 10.2.23 CREATE_CHARGE_PAYMENT_TYPE

- 10.2.24 CREATE_CHARGE_PAYMENT_TYPE_FORM

- 10.2.25 CREATE_CHARGE_TYPE

- 10.2.26 CREATE_CHARGE_TYPE_FORM

- 10.2.27 CREATE_CHARGE_TRANSACTION

- 10.2.28 CREATE_CHARGE_TRANSACTION_FORM

- 10.2.29 CREATE_CHARGE_TRANSACTION_MULTIPLE

- 10.2.30 CREATE_EXTERNAL_ITEM

- 10.2.31 CREATE_EXTERNAL_ITEM_FORM

- 10.2.32 CREATE_EXTERNAL_ITEM_SIMILAR_FORM

- 10.2.33 CREATE_MEDIA_TYPE

- 10.2.34 CREATE_MEDIA_TYPE_FORM

- 10.2.35 CREATE_OBJECT_TYPE

- 10.2.36 CREATE_OBJECT_TYPE_FORM

- 10.2.37 CREATE_RESERVATION

- 10.2.38 CREATE_RESERVATION_FORM

- 10.2.39 CREATE_STORAGE

- 10.2.40 CREATE_STORAGE_FORM

- 10.2.41 CREATE_STORAGE_TYPE

- 10.2.42 CREATE_STORAGE_TYPE_FORM

- 10.2.43 DELETE_CHARGE_BILLER

- 10.2.44 DELETE_CHARGE_INVOICE

- 10.2.45 DELETE_CHARGE_PAYMENT_TYPE

- 10.2.46 DELETE_CHARGE_TRANSACTION

- 10.2.47 DELETE_CHARGE_TYPE

- 10.2.48 DELETE_COMPLETED_RESERVATIONS

- 10.2.49 DELETE_EXTERNAL_ITEM

- 10.2.50 DELETE_MEDIA_TYPE

- 10.2.51 DELETE_OBJECT_TYPE

- 10.2.52 DELETE_RESERVATION

- 10.2.53 DELETE_RESERVATION_ITEM

- 10.2.54 DELETE_STORAGE

- 10.2.55 DELETE_STORAGE_TYPE

- 10.2.56 EDIT_CHARGE_BILLER

- 10.2.57 EDIT_CHARGE_BILLER_FORM

- 10.2.58 EDIT_CHARGE_PAYMENT_TYPE

- 10.2.59 EDIT_CHARGE_TYPE_FORM

- 10.2.60 EDIT_EXTERNAL_ITEM

- 10.2.61 EDIT_EXTERNAL_ITEM_FORM

- 10.2.62 EDIT_MEDIA_TYPE

- 10.2.63 EDIT_MEDIA_TYPE_FORM

- 10.2.64 EDIT_OBJECT_TYPE

- 10.2.65 EDIT_OBJECT_TYPE_FORM

- 10.2.66 EDIT_OBJECT_TYPE_RELATIONSHIPS

- 10.2.67 EDIT_OBJECT_TYPE_RELATIONSHIPS_FORM

- 10.2.68 EDIT_RESERVATION

- 10.2.69 EDIT_RESERVATION_FORM

- 10.2.70 EDIT_RESERVATION_ITEM

- 10.2.71 EDIT_RESERVATION_ITEM_FORM

- 10.2.72 EDIT_RESERVATION_ITEM_STATUS

- 10.2.73 EDIT_STORAGE

- 10.2.74 EDIT_STORAGE_FORM

- 10.2.75 EDIT_STORAGE_TYPE

- 10.2.76 EDIT_STORAGE_TYPE_FORM

- 10.2.77 GENERATE_CHARGE_INVOICE

- 10.2.78 GET_EXPORT_INVOICES

- 10.2.79 INFO_CHARGE_BILLER_FORM

- 10.2.80 INFO_CHARGE_INVOICE_FORM

- 10.2.81 INFO_CHARGE_PAYMENT_TYPE_FORM

- 10.2.82 INFO_CHARGE_TRANSACTION_FORM

- 10.2.83 INFO_CHARGE_TYPE_FORM

- 10.2.84 INFO_EXTERNAL_ITEM_FORM

- 10.2.85 INFO_MEDIA_TYPE_FORM

- 10.2.86 INFO_OBJECT_TYPE_FORM

- 10.2.87 INFO_RESERVATION_FORM

- 10.2.88 INFO_RESERVATION_ITEM_FORM

- 10.2.89 INFO_STORAGE_FORM

- 10.2.90 INFO_STORAGE_TYPE_FORM

- 10.2.91 MARK_INVOICE_PAID

- 10.2.92 MARK_INVOICE_PAID_FORM

- 10.2.93 MOVE_STORAGE

- 10.2.94 NOTIFY_OVERDUE_USERS

- 10.2.95 PROCESS_OVERDUE_REQUESTS

- 10.2.96 PROCESS_STORAGE_SPACE_COUNTS

- 10.2.97 RESERVE_STORAGE

- 10.2.98 RUN_CHARGEBACK_REPORT

- 10.2.99 RUN_CHARGEBACK_REPORT_MULTIPLE

- 10.2.100 RUN_FUNCTION_BARCODE_LABEL

- 10.2.101 RUN_RESERVATION_REPORT

- 10.2.102 RUN_RESERVATION_SEARCH_RESULTS_REPORT

- 10.2.103 RUN_STORAGE_BARCODE_LABEL

- 10.2.104 RUN_STORAGE_REPORT

- 10.2.105 RUN_USER_BARCODE_LABEL

- 10.2.106 SCREEN_CHARGE_BACKS_ADVANCED_FORM

- 10.2.107 SCREEN_CHARGE_BACKS_FORM

- 10.2.108 SEARCH_EXTERNAL_ITEM_FORM

- 10.2.109 UNRESERVE_STORAGE

- 10.2.110 UPDATE_STORAGE_DEPTHS

- 10.2.111 UPDATE_USERS_WITH_NO_BARCODES

11 拡張ユーザー属性サービス

- 11.1 拡張ユーザー属性サービスについて

- 11.2 拡張ユーザー属性サービス

- 11.2.1 ADD_EXTENDED_USER_ATTRIBUTES

- 11.2.2 EDIT_EXTENDED_USER_ATTRIBUTES

- 11.2.3 DELETE_EXTENDED_USER_ATTRIBUTES

- 11.2.4 DELETE_EXTENDED_ATTRIBUTES_BY_APPLICATION

- 11.2.5 DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_USER

- 11.2.6 DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_APPLICATION

- 11.2.7 QUERY_EXTENDED_USER_ATTRIBUTES

- 11.2.8 QUERY_EXTENDED_ATTRIBUTE_MAPPINGS

- 11.2.9 EC_SET_PROPERTY

- 11.2.10 EC_DELETE_PROPERTY

- 11.2.11 EC_GET_PROPERTY

- 11.2.12 EC_GET_PROPERTY_BY_KEY

- 11.2.13 SET_DEFAULT_ATTRIBUTES

- 11.2.14 DELETE_DEFAULT_ATTRIBUTES

- 11.2.15 GET_DEFAULT_ATTRIBUTES

- 11.2.16 SET_EXTENDED_ATTRIBUTE_MAPPINGS

- 11.2.17 DELETED_EXTENDED_ATTRIBUTE_MAPPINGS

- 11.2.18 ADD_USER

- 11.2.19 EDIT_USER

- 11.2.20 DELETE_USER

- 11.2.21 QUERY_USER_ATTRIBUTES

12 フォリオ・サービス

- 12.1 フォリオ・サービスについて

- 12.2 フォリオ・サービス

- 12.2.1 LOAD_FOLIO_NODE

- 12.2.2 UPDATE_FOLIO

- 12.2.3 CHECKIN_NEW_FOLIO

- 12.2.4 CREATE_FOLIO_SNAPSHOT

- 12.2.5 LOCK_FOLIO

- 12.2.6 UNLOCK_FOLIO

- 12.2.7 CREATE_FOLIO_RENDITION

- 12.2.8 GENERATE_GUIDS

13 リンク・マネージャ・サービス

- 13.1 リンク・マネージャ・サービスについて

- 13.2 リンク・マネージャ・サービス

- 13.2.1 ABORT_LINKS_ACTIVITY

- 13.2.2 ADD_MANAGED_DOCLINKS

- 13.2.3 DELETE_MANAGED_DOCLINKS

- 13.2.4 GET_LINK_INFO

- 13.2.5 GET_LINKS_ADMIN_PAGE

- 13.2.6 LK_GET_SEARCH_RESULTS

- 13.2.7 RECOMPUTE_MANAGED_LINKS

- 13.2.8 REFRESH_MANAGED_DOCLINKS

- 13.2.9 REFRESH_MANAGED_LINKS

- 13.2.10 REFRESH_REFS_MANAGED_LINKS

14 仮想コンテンツ・リポジトリ・サービス

- 14.1 仮想コンテンツ・リポジトリ・サービスについて

- 14.2 仮想コンテンツ・リポジトリ・サービス

- 14.2.1 VCR_FOLDER_INFO

- 14.2.2 VCR_GET_CONTENT_TYPE

- 14.2.3 VCR_GET_CONTENT_TYPES

- 14.2.4 VCR_GET_DOCUMENT

- 14.2.5 VCR_GET_DOCUMENT_BY_NAME

A アクション

- A.1 サービス・アクションについて

- A.2 A

- A.3 B

- A.4 C

- A.5 D

- A.6 E

- A.7 F

- A.8 G

- A.9 H

- A.10 I

- A.11 L

- A.12 M

- A.13 N

- A.14 P

- A.15 Q

- A.16 R

- A.17 S

- A.18 T

- A.19 U

- A.20 V

索引

はじめに

このガイドでは、Oracle WebCenter Content Serverおよび事前定義済のコンポーネントによって実行される機能またはプロシージャであるOracle WebCenter Contentサービスに関する詳細情報について説明します。

対象読者

このガイドは、サービスを使用してソフトウェアのカスタマイズを行う開発者およびOracle WebCenter Content Serverの機能にアクセスするアプリケーション開発者を対象としています。

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

Oracleのアクセシビリティについての詳細情報は、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)を参照してください。

Oracle Supportへのアクセス

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)を参照してください。

関連ドキュメント

詳細は、Oracle WebCenter Contentドキュメント・セットに含まれる次のドキュメントを参照してください。

- Oracle Fusion Middleware Oracle WebCenter Contentの管理

- Oracle Fusion Middleware Oracle WebCenter Contentの管理

- Oracle Fusion Middleware Oracle WebCenter Contentによる開発

- Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス

Oracle WebCenter Content Serverサービスおよびその使用に関する詳細は、『The Definitive Guide to Stellent Content Server Development』(Brian Huff著、2006年、Apress、Berkeley、CA)を参照してください。

表記規則

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

規則

意味

太字

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

イタリック体

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

固定幅フォント

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

このガイドで説明する新機能

次の各トピックでは、このガイドに記述されている、Oracle WebCenter Contentの新サービスと変更されたサービスや、その他の重大な変更を紹介し、追加情報の参照先を示します。

11g リリース1 (11.1.1.8.0)の新機能と変更された機能

Oracle WebCenter Content 11gリリース1 (11.1.1)の新しいサービスと変更されたサービスは次のとおりです。

- COPY_REVISION: 新しいリビジョン・クラスを作成するために、特定のドキュメントのリビジョンをコピーする新しいサービスです。

- FLD_BROWSE: ユーザー・インタフェースをサポートするための追加のオプション・パラメータおよび返されたデータ情報を含んでいます。

- FLD_SUBSCRIBE: フォルダへのユーザーのサブスクライブを可能にする新しいサービスです。

- FLD_TEST_USER_CAPABILITIES: ドキュメント、フォルダまたはライブラリに対して、操作を実行するユーザーの機能をテストする新しいサービスです。

- FLD_UNSUBSCRIBE: フォルダへのユーザーのサブスクライブを解除できる新しいサービスです。

- GET_DISPLAY_FIELDS: 動的ツリーなど、別のContent Serverページのカスタム・メタデータ・フィールドに関するメタデータ情報を返す新しいサービスです。

- GET_FIELD_LENGTHS: 長さが制限されたフィールドの最大長の情報を返す新しいサービスです。

- GET_USER_INFO: ユーザーが使用可能なロケールに関する情報を返す、新しいUserLocaleLanguageMap ResultSetを含んでいます。

- GET_USERDOCPROFILES: 現在のユーザーが使用可能なチェックインおよび検索プロファイルに関する情報を返す新しいサービスです。

- RESTORE_REVISION: 新しい(最新)リビジョンとして指定されたdIDに対応するドキュメントのリビジョンをリストアするサービスです。

11g リリース1 (11.1.1.7.0)の新機能と変更された機能

変更の詳細は次のとおりです。

- このドキュメントは、旧名『Oracle WebCenter Contentサービス・リファレンス・ガイド』の新版です。

1 Oracle WebCenter Contentのサービスの概要

この章では、Oracle WebCenter Contentのサービスの概要について説明します。このサービスは、Oracle WebCenter Content Server、Oracle WebCenter Content: Inbound Refinery、Oracle WebCenter Content: RecordsなどのOracle WebCenter Contentの各種機能によって実行される関数またはプロシージャです。

Oracle WebCenter Contentのシステムと通信したりOracle Content Serverのデータベースにアクセスするには、WebCenter Contentのサービスをコールする(サービス・リクエストを行う)ことが唯一の方法です。このガイドでは、サービスの使用法や構文について説明し、一般的に使用され事前定義されているOracle WebCenter Contentサービスの詳細な説明や例を記述しています。

このガイドに記載されている情報は、11gリリース1 (11.1.1)に基づいています。ここに記載されている情報は、製品テクノロジの進化、およびハードウェアとオペレーティング・システムの作成や変更によって、変更されることがあります。ブラウザ、データベース、Webサーバーおよびオペレーティング・システムの技術的な特徴により、オラクル社では第三者製品のすべてのバージョンおよび機能との互換性を保証することはできません。

注意:

Oracle WebCenter Contentシステムのカスタマイズおよび統合の詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentでの開発』を参照してください。

この章の内容は、次のとおりです。

- 第1.1項「内容」

- 第1.2項「Oracle WebCenter Contentの用語」

1.1 内容

このガイドはOracle WebCenter Contentの機能またはコンポーネントに従って並べられ、具体的なサービスについての情報を見つけやすくなっています。広範囲にわたって使用されるサービスは、さらに詳しく説明されています。さらに、頻繁に使用されるサービスには、各章の冒頭にあるリストでアスタリスク(*)が付けられています。

- 第2章「サービスの使用」では、Oracle WebCenter Contentのサービスがどのように機能するかを説明し、Content Serverのサービスを外部のカスタム・アプリケーションからどのようにコールできるかの例を示します。

- 第3章「サービスのカスタマイズ」では、Oracle WebCenter Contentのサービスの構造を説明し、サービス、問合せおよびテンプレートがどのように連動するかを示し、カスタム・コンポーネントで使用するためのサービス・リソースを作成する方法を記述します。

- 第4章「コアContent Serverサービス」では、Content Serverのコア・サービスを、一般的な使用法別に説明します。

- 第5章「ワークフロー・サービス」では、Content Serverで使用されるワークフロー・サービスについて説明します。

- 第6章「アーカイブ・サービス」では、Content Serverで使用されるアーカイブ・サービスについて説明します。

- 第7章「コントリビューション・フォルダ・サービス」では、Content Serverでコントリビューション・フォルダ(Folders_gコンポーネントでサポート)とともに使用されるサービスについて説明します。

- 第8章「フォルダ・サービス」では、Content Serverでフォルダ(FrameworkFoldersコンポーネントでサポート)とともに使用されるサービスについて説明します。

- 第9章「レコード・サービス」では、Oracle WebCenter Content: Recordsとともに使用されるサービスについて説明します。

- 第10章「物理コンテンツ管理サービス」では、物理コンテンツ・マネージャとともに使用されるサービスについて説明します。

- 第11章「拡張ユーザー属性サービス」では、Content Serverの拡張ユーザー属性とともに使用されるサービスについて説明します。

- 第12章「フォリオ・サービス」では、Content ServerでFoliosとともに使用されるサービスについて説明します。

- 第13章「リンク・マネージャ・サービス」では、リンク・マネージャとともに使用されるサービスについて説明します。

- 第14章「仮想コンテンツ・リポジトリ・サービス」では、仮想コンテンツ・リポジトリ(VCR)サービス・プロバイダのインタフェースを操作するアプリケーションによって使用されるサービスについて説明します。

- 付録A「アクション」では、個別のサービスによって使用されるアクションについて説明します。

1.2 Oracle WebCenter Contentの用語

- Oracle WebCenter Contentのドキュメントでは、Oracle WebCenter ContentおよびContent Serverの構成に関連付けられたディレクトリ内の変数を指すときに、次の用語を使用しています。

- IdcHomeDir: この変数は、Oracle WebCenter Contentのホームにあるucm/idcディレクトリを参照しており、このディレクトリには、Oracle WebCenter Contentサーバー・メディアが置かれています。サーバー・メディアは、Oracle WebCenter Content Server、Oracle WebCenter Content: Inbound RefineryまたはOracle WebCenter Content: Recordsのソフトウェアを実行できます。これは、基本的に読取り専用のディレクトリです。デフォルトの場所はWCC_ORACLE_HOME/ucm/idcです。デフォルトの場所の変数部分は変更可能ですが、パスをucm/idcから変更することはできません。

- DomainHome: この変数は、Oracle WebLogic Serverのアプリケーション・サーバー上で実行するためにOracle WebCenter Contentアプリケーションがデプロイされる、ユーザー指定のディレクトリを参照します。DomainHome/ucm/short-product-id/binディレクトリには、intradoc.cfgファイルおよび実行可能ファイルがあります。DomainHomeのデフォルトの場所はMW_HOME/user_projects/domains/base_domainですが、このパスとドメイン名(base_domain)は、アプリケーション・サーバーにOracle WebCenter Contentアプリケーションをデプロイするときに変更できます。

- short-product-id: この変数は、アプリケーション・サーバーにデプロイされるOracle WebCenter Contentサーバーのタイプを参照します。この名前はコンテキスト・ルート(デフォルトはHttpRelativeWebRoot構成値)として使用されます。次の値を指定できます。

- cs(Oracle WebCenter Content Server)

- ibr(Oracle WebCenter Content: Inbound Refinery)

- urm(Oracle WebCenter Content: Records)

- IntradocDir: この変数は、アプリケーション・サーバーにデプロイされているOracle WebCenter Contentアプリケーションの一部であるOracle WebCenter Contentのインスタンスに固有の、構成およびデータファイルのルート・ディレクトリを参照します。Oracle WebCenter Contentインスタンスのいずれかのタイプ(Content Server(cs)、Inbound Refinery(ibr)またはRecords(urm))用に、このIdocスクリプト変数を構成します。このディレクトリは別の場所にあってもかまいませんが、デフォルトの場所はDomainHome/ucm/short-product-idです。指定したディレクトリは、インスタンス・ディレクトリへの絶対パスで、特定のサーバーまたはノードに一意である必要があります。このディレクトリには、起動ファイル(intradoc.cfgおよび実行可能ファイル)を含んだbin/ディレクトリがあります。

2 サービスの使用

この章では、Oracle WebCenter Contentのサービスの使用方法について説明し、カスタム・サービスの例を示します。

この章の内容は次のとおりです。

- 第2.1項「サービスの概要」

- 第2.2項「カスタム・アプリケーションの例」

- 第2.3項「レスポンス出力のテンプレート・ページのリダイレクト」

2.1 サービスの概要

サービスとは、Oracle WebCenter Contentシステムで実行される関数またはプロシージャです。クライアントがOracle WebCenter Contentのシステムと通信したりOracle WebCenter Content Serverのデータベースにアクセスするには、Oracle WebCenter Contentのサービスをコールする(サービス・リクエストを行う)ことが唯一の方法です。

この項の内容は次のとおりです。

- 第2.1.1項「サービス・リクエストおよびサービス・レスポンス」

- 第2.1.2項「ページ取得」

- 第2.1.3項「検索サービス」

- 第2.1.4項「統合方法」

- 第2.1.5項「永続URLを使用したサービスのコール」

- 第2.1.6項「ロケール・パラメータのカスタマイズ」

2.1.1 サービス・リクエストおよびサービス・レスポンス

どのようなサービスでも、外部的に(Oracle WebCenter Contentシステムの外から)でも内部的に(Oracle WebCenter Contentシステム自体の中で)でもコールできます。通常の場合、クライアント・サービスは外部的にコールされ、管理サービスは内部的にコールされます。サービスが要求されたら、該当する任意のパラメータがサービスに渡されます。サービスでは、指定されたパラメータに基づいて、サービスの属性、およびリクエストを実行するアクションを使用します。サービスはこれを受けて、外部的と内部的いずれか適した方法でレスポンスを返します。この項の内容は次のとおりです。

- 第2.1.1.1項「内部サービス・リクエスト」

- 第2.1.1.2項「外部サービス・リクエスト」

- 第2.1.1.3項「リクエストのパラメータ」

- 第2.1.1.4項「日付および時刻の書式設定」

- 第2.1.1.5項「大/小文字の区別の検討事項」

2.1.1.1 内部サービス・リクエスト

どのようなサービスも内部的にコールできますが、通常の場合、内部的にコールされるのは管理サービスのみです。内部サービス・リクエストは、Oracle WebCenter Content自体の中で行われ、結果はOracle WebCenter Contentのみに返されます。たとえば、START_SEARCH_INDEXサービスを使用すると、バックグラウンド・スレッドで自動的に、検索索引が更新または再構築されます。

2.1.1.2 外部サービス・リクエスト

どのような外部プログラムでもHTMLページでも、Oracle WebCenter Contentの任意のサービスをコールして、Oracle WebCenter Contentシステムに情報を要求したり、全文検索やメタデータ検索、ライブラリ・サービス、ワークフロー・サービス、サブスクリプション通知、コンテンツ変換機能など、指定した機能を実行できます。通常の場合、クライアント・サービスのみが外部的にコールされます(管理サービスは通常、内部的にコールされます)。たとえば、Content ServerのWebページで「検索」リンクをクリックすると、GET_DOC_PAGEサービスによってWebブラウザに標準的な検索ページが表示されます。このとき、次のURLセグメントが使用されます。

IdcService=GET_DOC_PAGE&Action=GetTemplatePage&Page=STANDARD_QUERY_PAGE

外部リクエストは、数多くのプロトコルのいずれかを使用して、クライアント(たとえばWebブラウザ)からWebサーバーに送信されます。サービス・コールには、サービスで必要とされる任意のパラメータが含まれている必要があります。Webサーバーは、任意の必須パラメータおよびオプション・パラメータとともに、サービス・リクエストをOracle WebCenter Contentシステムにルーティングします。次にOracle WebCenter Contentシステムは、提供されたパラメータを使用してサービスを実行します。検索サービスの場合は、検索リクエストが検索エンジンに送信されます。次にOracle WebCenter Contentシステムは結果をWebサーバーに返し、Webサーバーは結果をWebブラウザ・クライアントに返します。

図2-1 コンテンツ管理システムの要素の間での外部リクエストおよび外部レスポンス

2.1.1.3 リクエストのパラメータ

サービス・リクエストには、サービスで必要とされるあらゆるパラメータが含まれている必要があります。たとえば、コンテンツ・アイテムの情報を取得するためにDOC_INFOサービスをコールするとき、このサービス・コールは、dID (生成されたコンテンツ・アイテムのリビジョンのID)をサービスに提供する必要があります。次のセグメントは、これが永続URLでどのように行われるかを示しています。

http://cs.example.com/cs/idcplg?
IdcService=DOC_INFO&dID=194

2.1.1.4 日付書式および時間書式

Content Server用の日付および時刻のデフォルトの書式設定は、「システム・プロパティ」ユーティリティ・インタフェースで「ローカライゼーション」タブを使用して決定されます。日付および時刻の一般的な書式は次のとおりです。

MM/DD/{yy} {hh:mm[:ss] {aa} [zzz]} !mAM,PM!zTimezoneCity

- 日付の書式はY(年)、D(日)、M(月)をグループにまとめたもの、時刻の書式は、h(時間)、m(分)、s(秒)をグループにまとめたものです。文字の繰返し回数によって、使用される最小桁数が指定されます(たとえば、YY/MM/DD hh:mmだと04/12/09 12:12と指定され、MM/DD/YYYY hh:mm:ssだと09/12/2004 04:12:33になります)。

- aは、午前と午後を示す記号(たとえば、AMまたはPM)を表しています。

- mは分を表しています。

- 中カッコ({ })は、このアイテムが、データ入力時には省略可能だが出力には常に表示されることを示しています。

- 感嘆符(!)は、日付書式の追加指定を区切るときに使用します。たとえば、!mXXX,YYYとすると、午前と午後を示す記号が指定されます(XXXは「午前中」を意味する記号であり、YYYは「午後」を意味する記号です)。感嘆符の後ろにあるものはすべて、午前と午後を示す記号およびタイムゾーンを示す記号を、日付書式とともに渡します。

2.1.1.5 大/小文字の区別の検討事項

大/小文字の区別は、Oracle WebCenter Contentの標準サービスをコールするときに重要です。

- パラメータ: パラメータでは、大文字と小文字が区別されます。たとえば、IdcServiceパラメータを指定するときには、IDCSERVICEでなくIdcServiceを使用する必要があります。

- パラメータの値: パラメータの値では通常、大文字と小文字が区別されます。IdcServiceパラメータの値では常に、大文字と小文字が区別されます。また、Oracle WebCenter Contentの標準サービスで使用される表記規則はすべて大文字です。たとえば、IdcServiceパラメータの値を指定するときには、Doc_InfoでなくDOC_INFOを使用する必要があります。

- データベース: Oracle WebCenter Contentとともに使用しているデータベースが、パラメータおよびパラメータの値の大/小文字の区別に影響を与える場合があります。たとえば、一部のデータベースには大文字と小文字が区別される列があり、他のデータベースではデフォルトで大文字と小文字が区別されません。したがって、あるデータベースで「DDOCNAME」が格納されていたとしても、Oracle WebCenter Contentシステムで予想される値は引き続き「dDocName」です。また、一部のデータベースでは、値が大文字で格納されますが、大文字と小文字が区別された問合せが実行されます。たとえば、「BouncyCaps」というdDocNameを格納した場合、「bouncycaps」を問い合せるとその行が見つかります。

2.1.2 ページ取得

Oracle WebCenter ContentシステムからWebページが要求されると、次のページ・タイプのいずれかが返されます。

- 静的ページ: 静的なWebページのコンテンツが事前に書式設定され、あるリクエストから次のリクエストの間に変わることはありません。Oracle WebCenter Contentの通常のWebサイトでは、静的ページはゲスト・ホーム・ページ(たとえば、DomainHome/ucm/cs/weblayout/portal.htm)のみです。

- 動的ページ: 動的なWebページは、Webサーバー・リクエストの時点で構成されます。このとき、コンテンツと書式設定は、Oracle WebCenter Contentのサービスとテンプレートを使用して決定されます。たとえば、各ユーザーのポータル・デザイン・ページは、Oracle WebCenter ContentのGET_PORTAL_PAGEというサービス、およびPNE_PORTAL_DESIGN_PAGEをいうテンプレートを使用して生成されます。

2.1.3 検索サービス

検索リクエストは、Oracle WebCenter Contentの特殊な種類のサービスです。Oracle WebCenter Contentシステムは、検索リクエストを受信すると、検索エンジンのAPIを使用して、そのリクエストを検索エンジンに送信します。これによって、Oracle WebCenter Contentシステムとともに各種の検索エンジンを使用できます。

2.1.4 統合方法

サービス・リクエストは、多様なプロトコルを使用して、外部プログラムまたはHTMLページで行うことができます。Oracle WebCenter Contentシステムは、多様な統合方法を使用して、他のエンタープライズ・アプリケーションと統合できます。1つの一般的な統合方法は、Oracle WebCenter Contentシステム内で永続URLによって管理されるコンテンツを参照することです。詳細は、第2.1.5項「永続URLを使用したサービスのコール」を参照してください。

他に考えられる統合方法は次のとおりです。

- WebLogic JAXPとWebLogic SAMLの統合サポートを使用した、Oracle WebLogic ServerのWebサービス(WS)

- Content Server向けのOracle WebCenter ContentのWebサービス・コンポーネント、およびクライアント向けのRemote Intradoc Client (RIDC)コンポーネント

- IdcCommand Javaコマンド・ユーティリティを使用したJava API (IdcCommand)統合

- Oracle WebCenter Contentで稼働しているJSP、Oracle WebCenter Content JavaBeanを通じたJSP、またはJ2EEアプリケーション・サーバーにデプロイされているOracle WebCenter Content Enterprise JavaBean (EJB)を通じたJSPからのJava Server Page (JSP)統合

- J2EE準拠のアプリケーション・サーバーにOracle WebCenter Content Enterprise JavaBeanをデプロイすることによるJava 2 Enterprise Edition API (J2EE)統合

- SOAPプロトコルを使用したSimple Object Access Protocol (SOAP)統合

- Folders_gコンポーネントを使用した仮想フォルダ統合

- Web Distributed Authoring and Versioning (WebDAV)コンポーネントを使用したWebDAV統合

- ActiveXユーティリティまたはIntradocClient OCXコンポーネントを使用したComponent Object Model (COM)統合

注意:

使用可能な統合方法の詳細は、Oracle WebCenter Content Content Server開発者ガイドを参照してください。

2.1.5 永続URLを使用したサービスのコール

この統合方法では、サービス・コールに必要な情報がすべて、URLを通じてContent Serverに送信されます。次の例は典型的なURLを示しており、この場合はホーム・ページのURLです。

http://cs.example.com/cs/idcplg?
IdcService=GET_DOC_PAGE&Action=GetTemplatePage&Page=HOME_PAGE

- http://cs.example.com/は、Content ServerインスタンスのWebアドレスです。

- cs/idcplgは、Webサーバーのフィルタへのパスです。

- IdcService=GET_DOC_PAGEは、Content Serverに対して、GET_DOC_PAGEサービスを実行するように指示します。

- Action=GetTemplatePageは、Content Serverに対して、指定したテンプレート・ページを使用して結果を返すように指示します。このパラメータは、GET_DOC_PAGEサービスの例に固有です。

- Page=HOME_PAGEは、Content Serverに対して、どのテンプレート・ページを使用するか指示します。このパラメータは、GET_DOC_PAGEサービスの例に固有です。

- 疑問符(?)は、Webサーバーのパスの終了とContent Serverのパラメータの開始を示しています。

- アンパサンド(&)は、Content Serverのパラメータ間の区切り文字として使用されます。

- Idocスクリプトの特定の変数をURLに含めて、ページ・リクエストの時点でのページ表示に影響を与えることができます。これは、トラブルシューティングに、またはContent Serverのページのカスタマイズに役立ちます。

トラブルシューティングの例

- IsJava=1

- IsPageDebug=1

カスタマイズの例

- StdPageWidth=1000

- dDocType=HRForm

例

次の例では、Content Serverに対する動的ページの要求に永続URLが使用される場合に発生するステップについて説明します。

1. ナビゲーション領域でユーザーが「管理」リンクをクリックすると、GET_ADMIN_PAGEサービスに対するリクエストがWebサーバーに送信されます。「管理」リンクのURLには、次のコマンドが含まれます。

IdcService=GET_ADMIN_PAGE&Action=GetTemplatePage&Page=ADMIN_LINKS

2. Webサーバーは、このリクエストをContent Serverの関数と認識し、具体的なリクエストをContent Serverに送信します。

3. Content Serverは、リクエストを処理したら、その結果を元のWebサーバーに渡します。「管理」リンクの場合は、GET_ADMIN_PAGEサービスの内容は次のようになります。

- ユーザーが現在ログインしていない場合はログイン・プロンプトを表示します。

- ユーザーにadmin権限が付与されていることを検証します。

- ADMIN_LINKSテンプレートを使用して「管理」ページを構成します。

- 構成されたWebページをWebサーバーに返します。

4. Webサーバーは、Content Serverサービスの結果を、元のWebブラウザ・クライアントに配信します。

例

次の例では、検索リクエストの実行に永続URLが使用される場合に発生するステップについて説明します。

1. 標準的な「検索」ページでユーザーが「検索」ボタンをクリックすると、GET_SEARCH_RESULTSサービスに対するリクエストがWebサーバーに送信されます。検索リクエストのURLでは、次のように、実行するサービス、検索条件、および結果パラメータを指定します。

IdcService=GET_SEARCH_RESULTS&QueryText=oracle&ftx=1
&AdvSearch=True&ResultCount=25&SortField=dInDate&SortOrder=Desc

2. Webサーバーは、このリクエストをContent Serverの関数と認識し、具体的なリクエストをContent Serverに送信します。

3. Content Serverは、リクエストを検索エンジンに渡します。

4. 検索エンジンは、検索結果をContent Serverに返します。

5. Content Serverは、ユーザーのログイン権限およびセキュリティ権限に基づき、検索結果ページを構成してWebサーバーに返します。

6. Webサーバーは、結果を元のWebブラウザ・クライアントに配信します。

2.1.6 ロケール・パラメータのカスタマイズ

Content Serverをクライアント・サーバー操作モードで使用している場合は、いくつかのパラメータを使用してロケール依存型のデータの処理を向上させ、日付とエンコーディングに不整合の障害が発生しないようにすることができます。

次の説明では、Content Serverに対して、HDA書式設定されたリクエストが、IdcClient、IdcCommandUX、IdcServerBean、カスタム・サーバー通信などの操作を使用して行われていると想定しています。

使用できるパラメータは、次のとおりです。

- UserDateFormat: 受信リクエスト内の日付、およびリクエストに対するレスポンスで生成された日付に対して、日付/時刻の書式を指定します。これを指定しないと、レスポンスの書式は常に、ログイン・ユーザーの日付ロケールを使用します。それが使用できない場合は、Content Serverのロケール日付を使用します。アーカイバのバッチ・ロード・ファイルに対しては、Content Serverで内部的に使用されるODBC日付/時刻書式を使用しないでください。タイムゾーンの多義性エラーが発生する恐れがあります。

UserDateFormat=M/D/YYYY hh:mm[:ss]{aa}!mAM,PM!zUTC

- blDateFormat: 受信リクエストの本文における日付の書式を指定します。レスポンスの書式には影響しません。これを設定すると、UserDateFormatで設定される値をオーバーライドします。これを指定しないと、受信リクエストの書式は、ログイン・ユーザーのロケール日付書式を使用します。それが使用できない場合は、Content Serverのロケール日付書式を使用します。このパラメータは使用できません。ただし、リクエストの前にあるヘッダーのいずれかが、POSTの値が付いているREQUEST_METHODヘッダーである場合は例外です。GETスタイルのリクエストでは、このパラメータはサポートされません。

- ClientEncoding: レスポンスで使用される文字エンコーディングを指定します。charsetとjcharsetいずれの指定にもHDAヘッダー行がない場合は、リクエストの本文のデコードに使用されるエンコーディングもこのパラメータで指示されます。

ClientEncoding=cp1252

- HEADER_ENCODING: HDAリクエストの本文の前にあるヘッダーで使用されます。要求する側のエージェントはこれによって、ヘッダーのエンコーディングを指定できます。この機能は、ヘッダーのエンティティであるHTTP_INTERNETUSERおよびREMOTE_USERのエンコーディングを指示する際に役立ちます。

- blFieldTypes: レスポンスを翻訳する際のフィールド・タイプ(日付またはメッセージ)を指定します。「メッセージ」は、書式設定された文字列(通常はエラー・メッセージ)で、ローカライズされていません。このパラメータを使用すると、ODBC書式設定されたフィールドが解析され、blDateFormatまたはUserDateFormatで指定された書式で返されて、そのフィールドがリクエストにはなくレスポンスにのみある場合でも適用されます。フィールド・タイプがbiFieldTypesで指定されていない場合、フィールドは未加工の文字列として扱われ、フィールドに対してローカライズは実行されません。
そのような翻訳を通常必要とするフィールドは、Content Serverの動作をカスタマイズした拡張で作成されたフィールド(たとえば、Idocスクリプトを使用して作成されたフィールド)のみです。これは、POSTスタイルのリクエスト(POSTの値が付いているREQUEST_METHODヘッダー)にのみ使用可能です。これは通常、追加の日付フィールドを指定する場合に使用されます。また、フィールドが日付として特殊な扱いを必要とすることを示すには、UserDateFormatまたはblDateFormatと組み合せて使用することが最適です。

blFieldTypes=xNewDate date, xComment message

- extraFieldTypes: レスポンスをHDA書式設定されたリクエストに翻訳する際のフィールド・タイプを指定するもので、blFieldTypesのかわりに使用されます。Content Serverのリクエストに応える際に実行されるIdocスクリプトの式の内側で使用するのが最適です。レスポンスの書式を生成する際にIdocスクリプトで使用することはできません。レスポンスが(HDAなどの)データ形式になっているからです。ただし、HCSPフォームを処理したり、ドキュメント・プロファイルの効果を判別するなど、リクエストのロジックを実行する際に、Idocスクリプトが評価される他の場所で使用することはできます。

extraFieldTypes=xNewDate date, xComment message

- convertDatabaseDate: blFieldTypesまたはextraFieldTypesが使用され、ODBC日付書式をレスポンスの目的の日付書式に変換していることを確認します。この変数は、blFieldTypes変数またはextraFieldTypes変数を使用する際に必要です。
この変数が設定されていない場合は、ODBC日付書式がレスポンスの目的の日付書式に変換されていないことがあります。この変数が設定されていない場合でも、ODBC日付は引き続き変換できます。これは、ある日付書式から別の日付書式への全面強制がレスポンスに必要であるとContent Serverが判定した場合に発生します。これは通常、受信した日付書式と送信する日付書式が異なる場合にのみ発生します。

convertDatabaseDate=1

- SuppressResultLocalization: レスポンスの返信前に実行されるローカライゼーション変換を抑止します。受信データに対する変換は、引き続き実行できます。
このパラメータは、メッセージがローカライズされないようにしたり、日付が全面変換されないようにする際に役立ちます。使用例としては、レスポンスを別のContent Serverインスタンスに転送して処理する場合や、データを永続的に格納し、必要に応じて元のContent Serverインスタンスに対して再実行する場合があります。

SuppressResultLocalization=1

日付とメッセージの処理に影響を与えるパラメータのすべては、このパラメータとともに使用できますが、それ以外のパラメータを使用できるのは、別のContent Serverインスタンスまたは現在のContent Serverインスタンスに対してデータを再実行するときのみです。

注意:

HDAリクエストを行う操作によって、これらのパラメータの値が設定される場合があります。したがって、値を設定したのに予想どおりに動作が変わらないとユーザーが気づく場合があります。

2.1.7 認証チャレンジの強制

Content Serverサービスなどのアクティビティのためにユーザーを再認証することが必要になる場合があります。たとえば、ワークフロー中に、ワークフロー・プロセスの具体的なステップで、ユーザーのデジタル署名を取得することが必要になる場合が考えられます。これは、isRepromptLogin構成変数を使用して行うことができます。この変数の詳細は、Oracle Fusion Middleware Oracle WebCenter Content構成リファレンスを参照してください。

任意のサービスの再認証を強制するには、次の手順を実行します。

1. サービス定義関数としてcheckForRevalidateLoginを追加します。

2. 行われているサービス・コールに対し、ランダムに生成された値とともに、パラメータとしてrevalidateLoginIDを追加します。

これらの2つのアクションを実行すると、revalidateLoginIDに対するパラメータと同じ値でAllowedLoginID Cookieが設定されるまで、Content Serverは現在指定されている資格証明を受け入れることを拒否します。このCookieは、現在の資格証明に対する冗長なチャレンジ中に設定されます。

これによって現在の資格証明がクリアされ、ユーザーがContent Serverのいずれの機能にアクセスする場合でも、ログインが再び必要になることに注意してください。

2.2 カスタム・アプリケーションの例

この例では、アプリケーションは5つのサービスをコールし、6つのプライベート関数を定義しています。

- コールされるサービス

- プライベート関数

- サンプル・コード

2.2.1 コールされるサービス

これらのサービスがコールされ、シリアライズされたHDA文字列がそれぞれに構築されます。

- CHECKOUT_BY_NAME

- CHECKIN_UNIVERSAL

- DOC_INFO

- GET_FILE

CHECKIN_UNIVERSALに対して定義されるパラメータは次のとおりです。

- doFileCopy

- dDocName

- dDocTitle

- dDocType

- dSecurityGroup

- dDocAuthor

- dDocAccount

- primaryFile

GET_TABLEサービスがコールされ、次のパラメータが定義されます。

- tableName

2.2.2 プライベート関数

定義されるプライベート関数は次のとおりです。

- getNativeFilePath

- checkOutByName

- checkinUniversal

- getDocInfo

- getFile

- parseResultSet

2.2.3 サンプル・コード

このサンプルはVisual Basicで記述されています。

' Defines a private function.
Private Function getNativeFilePath() As String
Dim idccmd As IdcCommandX
Dim str As String
Dim res
Dim dID As String, dExtension As String, dDocType As String, dDocAccount As String

dID = "2"
dExtension = "pdf"
dDocType = "acc"
dDocAccount = ""

' Builds a serialized HDA string.
str = "@Properties LocalData" + vbCrLf
str = str + "dID=" + dID + vbCrLf
str = str + "dExtension=" + dExtension + vbCrLf
str = str + "dDocType=" + dDocType + vbCrLf
str = str + "dDocAccount=" + dDocAccount + vbCrLf
str = str + "@end" + vbCrLf

Set idccmd = New IdcCommandX
res = idccmd.init("sysadmin", "c:\oracle\bin")
res = idccmd.computeNativeFilePath(str)

Open "c:\newdoc.txt" For Binary Access Write As #1
Put #1, , str
Put #1, , res
Close #1
MsgBox (res)
End Function

' Defines a private function.
Private Function checkOutByName(ByVal dDocName As String) As String
Dim idccmd As IdcCommandX
Dim idcService As String, str As String
Dim res

' Calls a service and builds a serialized HDA string.
idcService = "CHECKOUT_BY_NAME"
str = "@Properties LocalData" + vbCrLf
str = str + "IdcService=" + idcService + vbCrLf
str = str + "dDocName=" + dDocName + vbCrLf
str = str + "@end" + vbCrLf

' In an actual application the return codes need to be handled. For this example,
' the service is called while there is no content with that specific dDocName.
Set idccmd = New IdcCommandX
res = idccmd.init("sysadmin", "c:\oracle\bin")
res = idccmd.executeCommand(str)
End Function

' Defines a private function.
Private Function checkinUniversal(ByVal doFileCopy As String, ByVal dDocName As
String, ByVal dDocTitle As String, ByVal dDocType As String, ByVal dSecurityGroup
As String, ByVal dDocAuthor As String, ByVal dDocAccount As String, ByVal
primaryFile As String) As String

' Builds a serialized HDA string.
Dim idccmd As IdcCommandX
Dim idcService, res, str As String

' Calls a service and builds a serialized HDA string.
idcService = "CHECKIN_UNIVERSAL"
str = "@Properties LocalData" + vbCrLf
str = str + "IdcService=" + idcService + vbCrLf
str = str + "doFileCopy=" + doFileCopy + vbCrLf
str = str + "dDocName=" + dDocName + vbCrLf
str = str + "dDocTitle=" + dDocTitle + vbCrLf
str = str + "dDocType=" + dDocType + vbCrLf
str = str + "dSecurityGroup=" + dSecurityGroup + vbCrLf
str = str + "dDocAuthor=" + dDocAuthor + vbCrLf
str = str + "dDocAccount=" + dDocAccount + vbCrLf
str = str + "primaryFile=" + primaryFile + vbCrLf
str = str + "@end" + vbCrLf

' exec hda...
Set idccmd = New IdcCommandX
res = idccmd.init("sysadmin", "c:\oracle\bin")
res = idccmd.executeCommand(str)
MsgBox (CStr(res))
End Function

' Defines a private function.
Private Function getDocInfo(ByVal dID As String) As String
Dim idccmd As IdcCommandX
Dim idcService As String, str As String
Dim res

' Calls a service and builds a serialized HDA string.
idcService = "DOC_INFO"
str = "@Properties LocalData" + vbCrLf
str = str + "IdcService=" + idcService + vbCrLf
str = str + "dID=" + dID + vbCrLf
str = str + "@end" + vbCrLf

' exec hda....
Set idccmd = New IdcCommandX
res = idccmd.init("sysadmin", "c:\oracle\bin")
res = idccmd.executeCommand(str)
MsgBox (res)
End Function

' Defines a private function.
Private Function getFile(ByVal dID As String, ByVal dDocName As String, ByVal
RevisionSelectionMethod As String, ByVal Rendition As String)
Dim idccmd As IdcCommandX
Dim idcService, str As String

Dim res As Variant
Dim fileName As String
Dim fileSize As Long
Dim indexStop As Integer

' Calls a service and builds a serialized HDA string.
idcService = "GET_FILE"
str = "@Properties LocalData" + vbCrLf
str = str + "IdcService=" + idcService + vbCrLf
str = str + "dDocName=" + dDocName + vbCrLf
str = str + "dID=" + dID + vbCrLf
If (RevisionSelectionMethod = "Specific" Or RevisionSelectionMethod = "Latest"
Or RevisionSelectionMethod = "LatestReleased") Then

' Ignore dDocName and use dID instead.
str = str + "RevisionSelectionMethod=" + RevisionSelectionMethod + vbCrLf
End If
If (Revision = "Primary" Or Revision = "Web" Or Revision = "Alternate") Then
str = str + "Revision=" + Revision + vbCrLf
End If
str = str + "@end" + vbCrLf

' exec hda...
Set idccmd = New IdcCommandX
res = idccmd.init("sysadmin", "c:\oracle\bin")
res = idccmd.executeCommand(str)

Open "c:\newdoc.txt" For Binary Access Write As #1
Put #1, , res
Close #1
MsgBox (Len(res))

' chop at filename= and store fileName
indexStop = InStr(res, "filename=")
tmpStr = (Mid(res, indexStop))
indexStop = InStr(tmpStr, Chr(13))
fileName = Mid(tmpStr, 10, indexStop - 10)
MsgBox (fileName)
' MsgBox (CStr(Asc(Mid(tmpStr, 2, 1))))

' chop at Content-length: and store fileSize
tmpStr = Mid(tmpStr, indexStop)
indexStop = InStr(tmpStr, "Content-Length: ")
tmpStr = (Mid(tmpStr, indexStop))
indexStop = InStr(tmpStr, Chr(10))
fileSize = CLng(Mid(tmpStr, 17, indexStop - 17))
MsgBox (CStr(fileSize))
MsgBox (Len(res))
End Function

Private Sub cmdAddUser_Click()
frmAddUser.Show
End Sub

Private Sub cmdCheckin_Click()
Dim idcService As String, doFileCopy As String, dDocName As String
Dim dDocTitle As String, dDocType As String, dSecurityGroup As String
Dim dDocAuthor As String, dDocAccount As String, primayFile As String

' Calls a service and defined parameters.
idcService = "CHECKIN_UNIVERSAL"
doFileCopy = "1"
dDocName = "myDocNameNewh"
dDocTitle = "myDocTitleb"
dDocType = "ADACCT"
dSecurityGroup = "Public"
dDocAuthor = "Jennifer"
dDocAccount = ""
primaryFile = "c:/junk_b.doc"

' In an actual application check for errors.
' Lock the file in order to upload a new revision.
Call checkOutByName(CStr(dDocName))
' If the dDocName is not in the system, it gets added as first revision
' by the CHECKIN_UNIVERSAL call.
Call checkinUniversal(doFileCopy, dDocName, dDocTitle, dDocType, dSecurityGroup,
dDocAuthor, dDocAccount, primaryFile)
End Sub

Private Sub cmdDocInfo_Click()
Call getDocInfo("269")
End Sub

Private Sub cmdDownload_Click()
Call ba
End Sub

Private Sub cmdGetFile_Click()
Call getFile("14", "", "", "")
End Sub

Private Sub cmdGetNativeFile_Click()
Call getNativeFilePath
End Sub

Private Sub Command1_Click()
Dim idccmd As IdcCommandX
Dim res, str
Open "c:\adduser.txt" For Append As #1
Set idccmd = New IdcCommandX
res = idccmd.init("sysadmin", "c:\oracle\bin")
str = "@Properties LocalData" + vbCrLf + "IdcService=ADD_USER" + vbCrLf +
"dName=Jennifer" + vbCrLf + "dFullName=Jennifer Smith" + vbCrLf +
"dPassword=password" + vbCrLf + "dEmail=email@example.com" + vbCrLf +
"dUserAuthType=LOCAL" + vbCrLf + "@end" + vbCrLf + "@ResultSet UserAttribInfo" +
vbCrLf + "2" + vbCrLf + "dUserName" + vbCrLf + "AttributeInfo" + vbCrLf +
"Jennifer" + vbCrLf + "role,admin,15" + vbCrLf + "@end" + vbCrLf
res = idccmd.executeCommand(str)
Print #1, res
Close #1
End Sub

Private Sub Command2_Click()
Dim idccmd As IdcCommandX
Dim res, str

Dim myRS As String
Dim idcService, tableName As String

idcService = "GET_TABLE"
tableName = "Accounts"

Open "c:\a_getsec.txt" For Append As #1
Set idccmd = New IdcCommandX
res = idccmd.init("sysadmin", "c:\oracle\bin")
str = "@Properties LocalData" + vbCrLf + "IdcService=" + idcService + vbCrLf +
"tableName=" + tableName + vbCrLf + "@end" + vbCrLf
myRS = idccmd.executeCommand(str)

' Parse out the results set.
Call parseResultSet(myRS, tableName)
Print #1, res
Close #1
End Sub

' Calls a private function.
Private Function parseResultSet(strResultsSet As String, strSearchString As
String) As String
Dim indexStop As Integer
Dim tmpStr As String

Dim numberOfRows As Integer
Dim numberOfElementsInSet As Integer
Dim resultElement()
MsgBox (strResultsSet)

' Start of results set.
indexStop = InStr(strResultsSet, "@ResultSet " & strSearchString)

' Check for error (0 index) before moving on.
tmpStr = (Mid(strResultsSet, indexStop))
MsgBox (tmpStr)

' Determine how many data lines are in the HTA file.
indexStop = InStr(tmpStr, "@end")
For i = 1 To indexStop
If (Mid(tmpStr, i, 1) = Chr(10)) Then
numberOfRows = numberOfRows + 1
End If
Next i
numberOfRows = numberOfRows - 2 ' Remove the first line of data.

' Find first line that identifies the ResultsSet
indexStop = InStr(tmpStr, Chr(10))
tmpStr = (Mid(tmpStr, indexStop + 1))

' Get number of elements in record set, chop the line off the record set...
indexStop = InStr(tmpStr, Chr(10))
numberOfElementsInSet = CInt((Mid(tmpStr, 1, indexStop)))
tmpStr = (Mid(tmpStr, indexStop + 1))

' Set storage array.
ReDim resultElement((numberOfRows / numberOfElementsInSet), numberOfElementsInSet)
Dim junk As String
' Populate array from HTA dataset
For i = 1 To (numberOfRows / numberOfElementsInSet)
For j = 1 To numberOfElementsInSet
indexStop = InStr(tmpStr, Chr(10))
resultElement(i, j) = Mid(tmpStr, 1, indexStop - 1)
tmpStr = (Mid(tmpStr, indexStop + 1))
junk = junk + resultElement(i, j)
Next j
Next i
MsgBox (junk)
parseResultSet = "je"
End Function

' Set storage array.
Sub ba()
Dim b() As Byte 'This byte array will capture the file
Dim strURL As String ' URL string
Dim strDest As String ' Destination File

' Set the strURL to a valid address.
'strURL = "http://localhost/cs/idcplg?IdcService=GET_FILE&dID=14"
'strDest = "C:\myjunk.html"
strURL = "localhost"
b() = Inet1.OpenURL(strURL, icByteArray)
'Open strDest For Binary Access Write As #1
'Put #1, , b()
'Close #1
End Sub

2.3 レスポンス出力のテンプレート・ページのリダイレクト

場合によっては、CGIリクエスト(GETとPOSTのいずれか)を実行した後で、デフォルト以外のページを表示(レスポンス・テンプレートの配信メカニズムを変更)したほうが好ましいこともあります。たとえば、ログイン後、または検索の実行後に、ページをリダイレクトすることができます。これを行う1つの方法としては、コンポーネント・アーキテクチャを通じてサービス・コールを変更し、別のテンプレート・ページを指定します。必要に応じてこれを行う別の、より柔軟な方法としては、urlTemplateパラメータを指定し、レスポンス・ページをHCSPまたはHCSTにリダイレクトして、結果の書式を好きなように再設定します。

この項の内容は次のとおりです。

- 第2.3.1項「基本的な概念」

- 第2.3.2項「HCSTページの作成」

- 第2.3.3項「検索結果ページの書式再設定」

- 第2.3.4項「追加のオプション」

2.3.1 基本的な概念

この演習に取りかかる前に、Idocスクリプトと動的サーバー・ページ(HCST、HCSP、HCSF)にある程度慣れておいてください。また、Content Serverの機能とコンポーネント・アーキテクチャにも、ある程度慣れておいてください。HTML FORMオブジェクトに慣れておくことも役立ちます。詳細は、Oracle WebCenter Content Content Server開発者ガイドおよびOracle Fusion Middleware Oracle WebCenter Content構成リファレンスを参照してください。

2.3.2 HCSTページの作成

例として、URLテンプレートとして使用できるHCSTページを作成して、検索結果の書式を再設定します。HCSPを使用することもできますが、簡略にするためにHCSTを使用します。ファイルにtest_result.hcstという名前を付け、次のテキストを含めます。

<html>
<table width=300>
<tr bgcolor="#000000" style="color: #ffffff;">
<td><b>Name</b></td>
<td><b>Title (Author)</b></td>
</tr>
<$loop SearchResults$>
<tr <$if doShade$>bgcolor="#E5E7D4"<$endif$>>
<td><a href="<$URL$>"><$dDocName$></a></td>
<td><$dDocTitle$> (<$dDocAuthor$>)</td>
</tr>
<$if doShade$><$doShade=""$><$else$><$doShade="1"$><$endif$>
<$endloop$>
</table>
</html>

次に、このファイルをContent Serverインスタンスにチェックインします。簡略にするために、パブリック・セキュリティ・グループにチェックインし、コンテンツ・タイプをADACCT、コンテンツIDをtest_resultとします。そのURLは次のようになります。

http://myhost/oracle/groups/public/documents/document/test_result.hcst

2.3.3 検索結果ページの書式再設定

新規のテンプレートをテストするには、まず検索ページに進みます。いずれかの検索条件に入力して「検索」をクリックします。標準的な検索ページが表示され、そこには結果も含まれます。

ここで、検索結果ページに誘導したURLの最後に、次のテキストを追加します。

&urlTemplate=/oracle/groups/public/documents/adacct/test_result.hcst

同じ検索結果が、最小のHTMLページに書式設定された状態で表示されます。完全URLが使用されるのではなく、ホスト・コンピュータを基準としたURLのみが使用されることに注意してください。

デフォルトの検索ページを、ページの初期設定に際して常にこのテンプレートを使用するようにする場合は、検索ページ上のHTML FORMオブジェクトを変更して、次のフィールドも含むようにすることができます。

<input type=hidden name='urlTemplate'
value='/oracle/groups/public/documents/document/test_result.hcst'>

これを行うには、インクルードquery_results_optionsを変更したコンポーネントを作成して、サンプルのHTMLを含むようにします。あるいは、urlTemplateの値を、JavaScriptを使用して検索ページで動的に計算し、ユーザーによって入力されたメタデータに基づいて別のページにリダイレクトすることもできます。

2.3.4 追加のオプション

結果ページを変更するには、urlTemplate以外に、docTemplateName、docTemplateID、RedirectUrlの各パラメータも使用できます。これらの動作は、次のようにすべて異なります。

- urlTemplate: 使用するhcstページの完全な相対URLに設定します。例:

IdcService=DOC_INFO&urlTemplate=/idc1/groups/public/documents/adacct/test_result.hcst

RedirectURLはすべてのサービス・コールと連携しているわけではなく、6.0より古いバージョンのContent Serverソフトウェアでは、docTemplateNameとdocTemplateIDに小規模なデータ汚染の不都合があるため、通常の場合、urlTemplateを使用するのが最も安全な方法です。ただし、テンプレートのコンテンツ・タイプまたはセキュリティ・グループを変更すると、そのURLは有効でなくなり、更新することが必要になります。また、このパラメータは、POSTサービスに使用されるテンプレートをオーバーライドする場合にはお薦めしません。

- docTemplateName: テンプレートのdDocName(たとえば、test_result)に設定します。このパラメータはurlTemplateのように動作しますが、dDocNameがdocTemplateNameであるドキュメントの、最新リリースのWeb表示可能ファイルの場所を見つけます。

- docTemplateID: 特定のリビジョンのテンプレートのdID(たとえば、100)に設定します。docTemplateNameのように動作しますが、特定のdIDリビジョンのWeb表示可能ファイルを見つけます。

- RedirectUrl: Content Serverに戻す、CGI URLの最後の部分(たとえば、IdcService=DOC_INFO&dID=<$dID$>)に設定します。これは、アクションprepareRedirectを実行する数十個のPOSTサービス(CHECKIN_NEWやSUBMIT_HTML_FORMなど)のみを対象としています。

- それぞれのHTML POST後にリダイレクトを使用すると、エンド・ユーザーはポストを再発行しなくても、レスポンス・ページを安全にリフレッシュできます。これらのサービスそれぞれの定義には、3:prepareRedirect:….:0:null行があります。RedirectUrlは、prepareRedirectメソッドの結果をオーバーライドします。また、リダイレクト先の場所として別のURLを使用できるようにします。RedirectUrlの中には、リダイレクトの発行直前に実行されるIdocスクリプトを組み込むことができます。これによって、Idocスクリプトでのネスティングが複雑なものになる可能性があります。それは、RediretUrlの割当ては通常、リソース・インクルードの中で行われるからです。例:

… Standard Idoc form beginning …
<input type=edit name=myparam value=''>
<input type=hidden name=RedirectUrl
value='<$HttpCgiPath$>?<$xml('IdcService=MY_RESPONSE_TEMPLATE&dID=<$dID$>&
myparam=<$myparam$>')$>'>
… Standard Idoc form closure …

Idocスクリプトの多くは、Idocのリテラル文字列の内側でネストされます。この場合、リダイレクトURLが計算されるまで、スクリプトの実行が遅れます。これにより、myparamの値をユーザーが選択することが引き続き必要でも、この値はRedirectUrlによって選択できます。

外側には一重引用符、内側には二重引用符を使用します。これで混乱がなくなります。また、HTMLとIdocスクリプトの両方が、引用の際に一重と二重両方の引用符をサポートしているため、コンストラクトをネストする際に、この2つを切り替えることが適切となることがあります。

xml関数の使用に注意してください。これにより、入力フィールドの値は間違いなく、適切に書式設定されたHTMLリテラル文字列コンストラクトになります。具体的に、この場合には不要です。ただし、より複雑なコンストラクトには役立つ場合があります。

3 サービスのカスタマイズ

この章では、サービスのカスタマイズに役立つOracle WebCenter Contentのサービスの基本構成について説明します。

この章の内容は、次のとおりです。

- 第3.1項「サービス構造の概要」

- 第3.2項「サービスの例」

- 第3.3項「サービス・リソースの作成」

3.1 サービス構造の概要

この項では、Oracle WebCenter Content Serverに標準サービスがどのように実装されるかを説明します。他のプログラムからのサービスのコールの詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentでの開発』の、統合方法に関する章を参照してください。

サービス・リソースは、次の3つの列があるResultSet表を使用したHTMファイルで定義されます。

- 第3.1.1項「名前」

- 第3.1.2項「属性」

- 第3.1.3項「アクション」

コンテンツ・サーバーの標準的なサービスは、IdcHomeDir/resources/core/tables/std_services.htmファイルのStandardServices表に定義されています。同じディレクトリのworkflow.htmファイルには、特殊な目的のサービスもあります。

サービスが機能を実行する際には、他のリソース定義に左右されます。

- HTMLを返すサービスでは、テンプレートを指定する必要があります。広く知られている例外はPING_SERVERサービスであり、このサービスはブラウザにページを返しません。

- ほとんどのサービスでは問合せを使用します。広く知られている例外はSEARCHサービスであり、このサービスは検索コレクションにリクエストを直接送信します。

サービス・リソースにマージ・ルールは不要です。ただし、サービス・リソースは、ResourceDefinition ResultSetに表として一覧表示されている必要があります。

図3-1に表示されている表の行は、サービス定義の例です。

図3-1 サービス定義の例

3.1.1 名前

StandardServices表の「名前」列では、各サービスの名前が定義されています。クライアント側のサービス・リクエストでは、これは、第2.1.5項「永続URLを使用したサービスのコール」でコールされている名前です。標準的なWebリクエストでは、これはほぼ必ず、コンテンツ・サーバーのWebページに対するURLです。

図3-2 DELETE_DOCサービス定義の「名前」列

3.1.2 属性

StandardServices表の「属性」列では、各サービスの側面が定義されており、それらについては次の各項で説明されています。

- 第3.1.2.1項「サービス・クラス」

- 第3.1.2.2項「アクセス・レベル」

- 第3.1.2.3項「「テンプレート」ページ」

- 第3.1.2.4項「サービス・タイプ」

- 第3.1.2.5項「通知された件名」

- 第3.1.2.6項「エラー・メッセージ」

図3-3 DELETE_DOCサービス定義の「属性」列

3.1.2.1 サービス・クラス

「サービス・クラス」属性は、サービスからアクセスできるJavaクラス・オブジェクトを指定します。完全パスが指定されていないかぎり、クラスパス接頭辞intradoc.serviceが想定されます。サービス・クラスによって、サービスで実行できるアクションが一部決定されます。考えられるサービス・クラスは次のとおりです。

サービス・クラス

説明

ArchiveService

アーカイブに関連する機能を実行します。

BatchService

バッチのロードに関連する機能を実行します。

ChunkedService

アプレットのアップロードおよびダウンロードのためのHTTPファイルのチャンク化に関連する機能を実行します。

DocService

ドキュメントに対するアクションを実行します。チェックイン、チェックアウト、ドキュメント情報、サブスクリプションなどのサービスがその例です。

DocProfileService

ドキュメントのプロファイルに対して、プロファイルの追加、編集、削除などのアクションを実行します。

FileService

コンテンツ・サーバーからファイルを取得します。

IndexerService

検索エンジンのメンテナンスのための索引付けに関連する機能を実行します。

ListBoxService

コンテンツ・サーバーからリストをダウンロードします。たとえば、ユーザーのリストや依存選択リストなどです。

LocaleService

ユーザーの場所または環境に固有の(たとえば、ユーザーの場所を識別し、適切な言語による文字列ファイルを提供するための国際化で使用される)機能を実行します。

MetaService

メタデータ・フィールドを管理します。

PageHandlerService

(Webレイアウト・エディタで作成される)ライブラリWebページを管理します。

PageRequestService

HTMLページを取得します。

ProjectService

Publisherプロジェクトを管理します。

ProviderManagerService

プロバイダ(外部のエンティティへの接続を確立するアプリケーション・プログラミング・インタフェース(API))を管理します。

SchemaService

オプション・リストなど、データベース表のJavaScriptファイルのサーバー側のパブリッシュを管理します。

SearchService

検索に関連する機能を実行します。

Service

一般的なサービスを実行します。

UserService

ユーザーを管理します。

WorkflowService

ワークフローを管理します。

WorkflowTemplateService

ワークフロー・テンプレートを管理します。

intradoc.admin.AdminService

管理サーバー全体にわたる機能を実行します。一般的に、コンテンツ・サーバー自体から内部的にコールされます。これらのサービスは非常に複雑なため、適切にコールできないと、コンテンツ・サーバーのデータが失われたり破損したりする可能性があります。したがって、これらのサービスは、使用も変更もしないことを強くお薦めします。

DELETE_DOCサービスの例では、このサービス・クラスは、次に示すようにDocServiceとなります。

DocService 4 MSG_PAGE null documents !csUnableToDeleteItem(dDocName)

3.1.2.2 アクセス・レベル

サービスのセキュリティ・モデルは、コンテンツ・サーバー全体で使用されるドキュメントのセキュリティ・モデルに似ています。「アクセス・レベル」属性は、サービスに権限レベルを割り当てます。このサービスを実行しようとするユーザーは誰でも、最低限、この権限が付与されている必要があります。

セキュリティ・アクセスは、ビット・フラグとして格納されています。一般的に、1つのサービスには、読取り、書込み、削除、管理のいずれかの権限が割り当てられます。アクセス・レベル番号は、使用可能な次のビット・フラグの合計です。

ビット・フラグ

権限

説明

1

READ_PRIVILEGE

読取り権限は、サービス内で参照されるセキュリティ・グループに必要です、

2

WRITE_PRIVILEGE

書込み権限は、サービス内で参照されるセキュリティ・グループに必要です、

4

DELETE_PRIVILEGE

削除権限は、サービス内で参照されるセキュリティ・グループに必要です、

8

ADMIN_PRIVILEGE

管理権限は、サービス内で参照されるセキュリティ・グループに必要です、

16

GLOBAL_PRIVILEGE

このサービスはグローバル・セキュリティ・チェックをコールし、このサービスを実行する権限が現在のユーザーに付与されているかどうかを判別します。このチェックは、adminロールが必要かどうか、または、少なくとも1つのセキュリティ・グループに対して、指定された権限(読取り、書込み、または削除)のみがユーザーに必要かどうかを検証します。

32

SCRIPTABLE_SERVICE

スクリプト可能なサービスはパラメータ入力が不要であるため、動的サーバー・ページでexecuteService関数を実行することでコールできます。

サービスの実行対象がドキュメントの場合は、サービスを実行するために、そのドキュメントのセキュリティ・グループに対して、読取り、書込み、削除、管理のいずれかの権限が(この順序で)、そのユーザーに付与されている必要があります。たとえば、ドキュメントをサブスクライブする場合、ユーザーには、そのドキュメントのセキュリティ・グループに対する読取り権限のみが必要です。ただし、新規のドキュメントにチェックインする場合は、ユーザーには、そのドキュメントのセキュリティ・グループに対する書込み権限も必要です。

(GET_USER_INFOやCHECKIN_NEW_FORMなどのように)サービスの実行対象が特定のドキュメントでない場合は、GLOBAL_PRIVILEGEビット・フラグを、少なくとももう1つの権限ビット・フラグとともに設定する必要があります。ユーザーはそのサービスを実行するために、少なくとも1つのセキュリティ・グループで、そのレベルの権限が付与されている必要があります。

注意:

サービスは、GLOBAL_PRIVILEGEビット・フラグのみを指定するものではありません。少なくとも、権限ビット・フラグをもう1つ指定する必要があります。

SCRIPTABLE_SERVICE権限とは、このサービスが、IdocスクリプトのexecuteService関数で実行できるという意味です。これは、GET_SEARCH_RESULTSやGET_USER_INFOなどのように、読取り専用サービスに制限する必要があります。

次に示すのは、すべてのアクセス・レベルおよびそれぞれの意味の詳細なリストです。

- 0: アクセスは許可されない

- 1: 読取り権限が必要

- 2: 書込み権限が必要

- 3: 読取り/書込み権限が必要

- 4: 削除権限が必要

- 8: 管理権限が必要

- 16: グローバルな権限が必要

- 17: グローバルな読取り権限が必要

- 18: グローバルな書込み権限が必要

- 19: グローバルな読取り/書込み権限が必要

- 23: グローバルな読取り/書込み/削除権限が必要

- 24: グローバルな管理権限が必要

- 32: スクリプト可能な権限が必要

- 33: スクリプト可能な読取り権限が必要

- 34: スクリプト可能な書込み権限が必要

- 40: スクリプト可能な管理権限が必要

- 49: スクリプト可能でグローバルな読取り権限が必要

- 50: スクリプト可能でグローバルな書込み権限が必要

- 51: スクリプト可能でグローバルな読取り/書込み権限が必要

- 56: スクリプト可能でグローバルな管理権限が必要

DELETE_DOCサービスの例では、アクセス・レベルは4です。これは、このサービスを実行するには、ユーザーにDELETE_PRIVILEGEが付与されている必要があるという意味です。

DocService 4 MSG_PAGE null documents !csUnableToDeleteItem(dDocName)

別の例では、ADD_ALIASサービスのアクセス・レベルは24です。これは、このサービスを実行するには、ユーザーにADMIN_PRIVILEGEとGLOBAL_PRIVILEGEが付与されている必要があるという意味です。

ADD_ALIAS UserService 24 null null aliases !csUnableToAddAlias

ユーザー・アカウントとロール権限の詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentの管理』を参照してください。

3.1.2.3 「テンプレート」ページ

「「テンプレート」ページ」属性は、サービスの結果を表示するテンプレートを指定します。(PageHandlerServiceタイプのように)サービスの結果にページ表示が必要ない場合は、この属性はnullにします。

テンプレートとは、HTMLとIdocスクリプトの組合せです。Idocスクリプトは、HTMLを書式設定し、レスポンスにデータを表示するために使用します。次に示すように、テンプレート・ページ名は、IdcHomeDir/components/Folders/resources/templates/templates.hdaファイル内のHTMファイルにマップされます。

- ほとんどのテンプレート・ページは、IntradocTemplates ResultSet内にマップされます。

- 検索テンプレート・ページは、SearchResultTemplates ResultSet内にマップされます。

DELETE_DOCサービスの例では、サービスの結果を表示するテンプレート・ページはMSG_PAGEとなり、次に示すように、msg_page.htmファイルにマップされます。

DocService 4 MSG_PAGE null documents !csUnableToDeleteItem(dDocName)

3.1.2.4 サービス・タイプ

「サービス・タイプ」属性は、サービスを別のサービス内でサブサービスとして実行するかどうかを指定します。2番目のサービスがサブサービスでないかぎり、メインのサービスから2番目のサービスをコールすることはできません。

サービス・タイプ

説明

SubService

このサービスは、別のサービス内でのみ実行されるサブサービスです。

null

このサービスはサブサービスではありません。

たとえば、UPDATE_DOCINFOサービスが、SubServiceをサービス・タイプとするUPDATE_DOCINFO_SUBを実行するとします。

DELETE_DOCサービスの例では、このサービスはサブサービスでないため、サービス・タイプは、次に示すようにnullとなります。

DocService 4 MSG_PAGE null documents !csUnableToDeleteItem(dDocName)

3.1.2.5 通知された件名

「通知された件名」属性は、サービスによって通知されるサブジェクト(サブシステム)を指定します。サービスが1つ以上のサブジェクトを変更する場合は、キャッシュされた情報が更新されたことをサービスがリモート・ソース(データベース表など)に通知する必要があります。

たとえば、いずれかのサービスに対してIsJava=1コールを行った場合、レスポンスにはchangedSubjectsとrefreshSubjectsが常に表示されます。これらのサブジェクトは、コンテンツ・サーバー・インスタンスの状態が変化したときにクライアントに通知するために使用されます。たとえば、システムに新しいユーザーが追加されたとき、新しいドキュメントにチェックインされたとき、カスタム・メタデータが変更されたときなどに、クライアントに通知されます。これによって、コンテンツ・サーバーの状態が変化したときに、外部アプリケーションがそのデータをリフレッシュできます。これは、コンテンツ・サーバーの管理アプレットを最新のものにして、ユーザーの数、ドキュメント・タイプ、およびシステム内のドキュメントを反映させる際に基礎となるメカニズムでもあります。たとえば、リポジトリ・マネージャを起動して新しいドキュメントにチェックインした場合、(ほんの数秒で)そのアイテムがアプレットに表示されます。

通知された件名の文字列は、変更された件名のカンマ区切りリストです(件名が通知されない場合は、この属性はnullにします)。たとえば、EDIT_METADEFサービスの通知された件名属性の値がmetadata,dynamicqueriesとします。このサービスによってメタデータ・フィールドが変更され、続いて、metadataサブジェクトおよびdynamicqueriesサブジェクトが変化したことがシステムに知らされます。

考えられるサブジェクトは次のとおりです。

サブジェクト

変更したら通知が必要になるもの

accounts

定義済アカウント

aliases

ユーザー・エイリアス

collections

アーカイバ・コレクション

config

グローバルな構成情報

docformats

ファイル形式

doctypes

コンテンツ・タイプ

documents

新規のコンテンツ・アイテム、改訂されたコンテンツ・アイテム、または更新されたコンテンツ・アイテム・メタデータ

dynamicqueries

データベースからメタデータ・フィールドのリストを取得する動的な問合せ

indexerstatus

インデクサのステータス

indexerwork

コンテンツ・アイテムであり、更新サイクルの索引付けが必要であることを指定します

metadata

メタデータ・フィールド

metaoptlists

メタデータ・フィールドのオプション・リスト

pagelist

ライブラリ(Webレイアウト・エディタ)ページ

renditions

(XML Converter、サムネイルなどからの)追加のレンディション

reports

レポートのデータソース

schema

スキーマ定義

searchapi

索引付け検索エンジンへの接続

subscriptiontypes

サブスクリプション・タイプ

templates

(Webレイアウト・エディタから構成されている)検索結果テンプレート

usermetaoptlists

ユーザー情報フィールドのオプション・リスト

users

ユーザー情報

wfscripts

ワークフロー・イベント・スクリプト

wftemplates

ワークフロー・テンプレート

workflows

ワークフロー

DELETE_DOCサービスの例では、次に示すdocumentsサブジェクトが、通知される唯一のサブジェクトです。

DocService 4 MSG_PAGE null documents !csUnableToDeleteItem(dDocName)

3.1.2.6 エラー・メッセージ

「エラー・メッセージ」属性は、アクション・エラー・メッセージによってオーバーライドされない場合、サービスによって返されるエラー・メッセージを定義します。これは、実際のテキスト文字列にも、ロケールに依存する文字列への参照にすることもできます。詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentでの開発』を参照してください。

DELETE_DOCサービスの例では、エラー・メッセージは、次に示すようにローカライズされた文字列となります。

DocService 4 MSG_PAGE null documents !csUnableToDeleteItem(dDocName)

3.1.3 アクション

「アクション」列は、サービスを処理するために実施される1つ以上の手順を定義します。アクションとは、サービス・スクリプトの一部として実行される操作です。アクションでは、SQL文の実行、問合せの実行、コードの実行、問合せ結果のキャッシュまたはオプション・リストのロードを行えます。あるアクションによって返されたデータが、それ以降のアクションの動作を変える場合があります。

アクションは、次の形式を使用した、コロン区切りのセグメントのリストとして定義されます。

type:name:parameters:control mask:error message

詳細は、次の各項を参照してください。

- 第3.1.3.1項「アクション・タイプ」

- 第3.1.3.2項「アクション名」

- 第3.1.3.3項「アクションのパラメータ」

- 第3.1.3.4項「アクションの制御マスク」

- 第3.1.3.5項「アクションのエラー・メッセージ」

注意:

サービスを定義するHTMリソース・ファイルでは、「アクション」列の<br>タグはブラウザでの表示を目的としたものにすぎないため、省略可能です。ただし、</td>タグは、アクションのリストの直後に置くもので、その間に改行を入れてはなりません。

図3-4 DELETE_DOCサービス定義の「アクション」列

3.1.3.1 アクション・タイプ

アクション文の最初のセグメントでは、アクションのタイプを定義します。

- アクション・タイプ番号: サービス・リソース・ファイルでアクション・タイプを特定するために使用します。

- コンポーネント・ウィザードID: コンポーネント・ウィザードでアクション・タイプを特定するために使用します。サービス・リソース・ファイルでは、アクション・タイプは番号で表されています。

- Java定数: Javaコードでアクション・タイプを特定するために使用します。

考えられるアクション・タイプは次のとおりです。

アクション・タイプ番号

コンポーネント・ウィザードID

Java定数

説明

1

問合せの選択

QUERY_TYPE

情報を取得するために、事前定義されたSQLデータベース問合せを実行し(読取り専用のアクション)、その直後に結果を破棄します。たとえば、「問合せの選択」は、データベースに特定のdDocName(コンテンツID)がすでに存在しているかどうかを確かめるような場合に使用できます。この問合せは、アクションの「アクション名」で指定できます。

2

問合せの実行

EXECUTE_TYPE

データベース内の情報を削除、追加または更新するために、事前定義されたSQLデータベース問合せを実行します。

3

Javaメソッド

CODE_TYPE

サービスを実装するJavaクラスの一部であるコード・モジュールを指定します。

4

オプション・リストのロード

OPTION_TYPE

システムに格納されているオプション・リストをロードします。これは、非推奨のアクション・タイプです。

5

キャッシュ問合せの選択

CACHE_RESULT_TYPE

情報を取得するために、SQLデータベース問合せを実行し(読取り専用のアクション)、後で使用できるように結果を格納します。たとえば、「キャッシュ問合せの選択」は、コンテンツ・アイテムをサブスクライブしているユーザーをすべて見つけ、リストを保存してコンシューマの画面に表示するような場合に使用できます。この問合せは、アクションの「アクション名」で指定できます。

DELETE_DOCサービスの最初のアクションの例では、このアクションは次のような「キャッシュ問合せの選択」タイプ(5)になります。

5:QdocInfo:DOC_INFO:6:!csUnableToDeleteItem(dDocName)!csRevisionNoLongerExists

3.1.3.2 アクション名

アクション文の2番目のセグメントでは、アクションの名前を定義します。

- アクション・タイプが「Javaメソッド」の場合は、アクション名はJavaメソッドとなります。

- アクション・タイプが「オプション・リストのロード」の場合は、アクション名はオプション・リストとなります。

- アクション・タイプが「問合せの選択」、「問合せの実行」および「キャッシュ問合せの選択」の場合は、アクション名は問合せ名となります。コンテンツ・サーバーの標準サービスでは、通常の場合、接頭辞を使用して、データベースに対して実行されるアクションを特定します。問合せに考えられる接頭辞は次のとおりです。

問合せの接頭辞

説明

Q

データベースに情報を問い合せます(取得します)(読取り専用のアクション)。

D

データベースから情報を削除します。

I

データベースに情報を挿入(追加)します。

U

データベース内の情報を更新します。

DELETE_DOCサービスの最初のアクションの例では、このアクションの名前はQdocInfoです。これは次のように、データベースに対して読取り専用の問合せ(Q)が実行されることを指定します。

5:QdocInfo:DOC_INFO:6:!csUnableToDeleteItem(dDocName)!csRevisionNoLongerExists

3.1.3.3 アクションのパラメータ

アクション文の3番目のセグメントでは、アクションに必要なパラメータを指定します。必須のパラメータがない場合は、このセグメントを空白にしておきます(パラメータのかわりに2つのコロンが表示されます)。

- アクションでパラメータが必要になる場合は、そのパラメータをカンマ区切りリストとして入力します。

- アクション・タイプが「キャッシュ問合せの選択」である場合、第1パラメータは問合せから返されたResultSetにアクションが割り当てる名前となります。このResultSetは、テンプレート・ページで参照できます。

- アクション・タイプが「オプション・リストのロード」の場合、パラメータはオプションです。ただし、パラメータを指定する場合、第1パラメータはオプション・リストがロードされるキー、第2パラメータはHTMLページに表示するために選択した値となります。

DELETE_DOCサービスの最初のアクションの例では、サービス問合せから返されるResultSetには、次に示すように、DOC_INFOという名前が付けられます。

5:QdocInfo:DOC_INFO:6:!csUnableToDeleteItem(dDocName)!csRevisionNoLongerExists

3.1.3.4 アクションの制御マスク

アクション文の4番目のセグメントは省略可能なビット・フラグで、コンテンツ・サーバー・データベースに対する問合せの結果を制御します。

- 制御マスクのビット・フラグ: サービス・リソース・ファイルで制御マスクを特定するために使用します。サービス・リソース・ファイルで使用される制御マスク番号は、適用されている制御すべてのビット・フラグの合計を表しています。コンテンツ・サーバーの標準サービスでは、通常の場合、制御マスクの文字列値でなく制御マスクのビット・フラグが使用されます。

- 制御マスクの文字列値: サービス・リソース・ファイルで制御マスクを特定するために使用します。制御マスクが複数ある場合、文字列値はカンマ区切りリストに置かれます。カスタム・サービスでは、制御マスクのビット・フラグでなく文字列値が使用されます。

- コンポーネント・ウィザードID: コンポーネント・ウィザードで制御マスクを特定するために使用します。サービス・リソース・ファイルでは、制御マスクは、そのビット・フラグの合計(コンテンツ・サーバーの標準サービス)とビット・フラグの文字列値のカンマ区切りリスト(カスタム・サービス)のいずれかで表されます。

- Java定数: Javaコードで制御マスクを特定するために使用します。

考えられる制御マスクは次のとおりです。

制御マスクのビット・フラグ

制御マスクの文字列値

コンポーネント・ウィザードID

Java定数

説明

0

-

-

-

適用される制御はありません。

1

ignoreError

エラーを無視

CONTROL_IGNORE_ERROR

エラー発生時にサービスを終了しません。

2

mustExist

結果が空でないことのチェック

CONTROL_MUST_EXIST

問合せによって、少なくとも1つのレコードが戻される必要があり、戻されないとアクションは失敗します。アクション・タイプが「問合せの選択」の場合と「キャッシュ問合せの選択」の場合にのみ使用されます。

4

beginTran

トランザクションの開始

CONTROL_BEGIN_TRAN

データベース・トランザクションを開始します。

8

commitTran

トランザクションのコミット

CONTROL_COMMIT_TRAN

データベース・トランザクションを終了します。

16

mustNotExist

結果が空であることのチェック

CONTROL_MUST_NOT_EXIST

問合せによって行が戻されてはならず、戻されるとアクションは失敗します。アクション・タイプが「問合せの選択」の場合と「キャッシュ問合せの選択」の場合にのみ使用されます。

32

retryQuery

問合せのリトライ

CONTROL_RETRY QUERY

アクション・タイプが「問合せの実行」に設定されていて問合せが失敗すると、エラーがログに記録されます。この問合せは3秒後に再実行されます。問合せが3回失敗すると、サービスは失敗します。その用途は、コンテンツのチェックインがほとんどです。もう使用されなくなりました。

64

doNotLog

ログに記録しない

CONTROL_DO_NOT_LOG

アクション・タイプが「問合せの選択」に設定されていて問合せが失敗すると、サービスは失敗します。ただし、エラーはシステム・ログに記録されません。テスト用のデバッグ・フラグとしてコンポーネントを開発するときに、内部的に使用されます。

注意:

制御マスク「結果が空でないことのチェック」および「結果が空であることのチェック」は、アクション・タイプが「問合せの選択」の場合と「キャッシュ問合せの選択」の場合にのみ使用されます。第3.1.3.1項「アクション・タイプ」を参照してください。

DELETE_DOCサービスの最初のアクションの例では、制御マスクの値が6になっています。これは、この問合せによって少なくとも1つのレコードが戻される必要がある(2)という意味です。また、このアクションによってデータベース・トランザクションが開始されます(4)。

5:QdocInfo:DOC_INFO:6:!csUnableToDeleteItem(dDocName)!csRevisionNoLongerExists

これがコンポーネント・ウィザードを使用して作成されたカスタム・サービスであれば、次に示すように、制御マスクのビット・フラグの合計は、ビット・フラグの文字列値のカンマ区切りリストに置換されます。

5:QdocInfo:DOC_INFO:mustExist, beginTran:!csUnableToDeleteItem(dDocName)
!csRevisionNoLongerExists

3.1.3.5 アクションのエラー・メッセージ

アクション文の5番目のセグメントでは、このアクションが失敗した場合に表示されるエラー・メッセージを定義します。これは、実際のテキスト文字列にも、ロケールに依存する文字列への参照にすることもできます。詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentでの開発』を参照してください。

- アクションのエラー・メッセージは、サービスの属性として用意されているエラー・メッセージをオーバーライドします。

- アクションのエラー・メッセージがnullでない場合は、サービス内のアクションのリマインダに対するエラー・メッセージとなります。

- アクションのエラー・メッセージがnullの場合は、エラー・メッセージは前のアクションからそのまま変わりません。

- 文字列参照の前には感嘆符が置かれます。

DELETE_DOCサービスの最初のアクションの例では、このエラー・メッセージは次に示すように、ローカライズされた2つの文字列を組み合せたものです。

5:QdocInfo:DOC_INFO:6:!csUnableToDeleteItem(dDocName)!csRevisionNoLongerExists

3.2 サービスの例

DOC_INFOサービスでは、サービス、問合せおよびテンプレートがまとまってどのように機能しているかの好例が提供されています。この項の内容は次のとおりです。

- 第3.2.1項「DOC_INFOサービス定義」

- 第3.2.2項「DOC_INFOの属性」

- 第3.2.3項「DOC_INFOのアクション」

- 第3.2.4項「DOC_INFOテンプレート」

3.2.1 DOC_INFOサービス定義

この項では、IdcHomeDir/resources/core/tables/std_services.htmファイルにあるDOC_INFOサービス定義の詳細を示します。

テキスト・エディタに表示されるDOC_INFOサービス定義の例は、次のとおりです。

<@table StandardServices@>
<table border=1><caption><strong>Scripts For Standard Services</strong></caption>
<tr>
<td>Name</td><td>Attributes</td><td>Actions</td>
</tr>
<tr>
<td>DOC_INFO</td>
<td>DocService
33
DOC_INFO
null
null<br>
!csUnableToGetRevInfo</td>
<td>5:QdocInfo:DOC_INFO:2:!csItemNoLongerExists2
3:mapNamedResultSetValues:DOCINFO,dStatus,dStatus,dDocTitle,dDocTitle:0:null
3:checkSecurity:DOC_INFO:0:!csUnableToGetRevInfo2(dDocName)
3:getDocFormats:QdocFormats:0:null
3:getURLAbsolute::0:null
3:getUserMailAddress:dDocAuthor,AuthorAddress:0:null
3:getUserMailAddress:dCheckoutUser,CheckoutUserAddress:0:null
3:getWorkflowInfo:WF_INFO:0:null
3:getDocSubscriptionInfo:QisSubscribed:0:null
5:QrevHistory:REVISION_HISTORY:0:!csUnableToGetRevHistory(dDocName)</td>
</tr>
</table>
<@end@>

図3-5 DOC_INFOサービス定義の例

3.2.2 DOC_INFOの属性

次の表では、DOC_INFOサービスの属性について説明します。

属性

値

説明

サービス・クラス

DocService

このサービスは、コンテンツ・アイテムに関する情報を提供しています。

アクセス・レベル

33

1 = サービスをリクエストするユーザーには、コンテンツ・アイテムに対する読取り権限が必要です。

32 =このサービスは、IdocスクリプトのexecuteService関数で実行できます。

「テンプレート」ページ

DOC_INFO

このサービスでは、DOC_INFOテンプレート(doc_info.htmファイル)を使用しています。アクションの結果がこのテンプレートにマージされて、ユーザーの画面に表示されます。

サービス・タイプ

null

このサービスはサブサービスではありません。

通知された件名

null

このサービスの影響を受ける件名はありません。

エラー・メッセージ

!csUnableToGetRevInfo

このサービスが英語コンテンツ・サーバー・システムで失敗した場合は、次のエラー・メッセージ文字列が返されます。

リビジョンに関する情報を取得できません。

3.2.3 DOC_INFOのアクション

DOC_INFOサービスでは、次の10個のアクションを実行します。

3.2.3.1 アクション1の定義と説明

アクション1は、次のように実行されます。

- Action 1 - 5:QdocInfo:DOC_INFO:2:!csItemNoLongerExists2

- 5: 問合せを使用してデータベースから情報を取得する、キャッシュ問合せの選択アクション。

- QDocInfo: このアクションでは、query.htmファイル内のQDocInfo問合せを使用して、コンテンツ・アイテム情報を取得します。

- DOC_INFO: この問合せの結果がDOC_INFOというResultSetに割り当てられ、後で使用できるように格納されます。

- 2: 「結果が空でないことのチェック」制御マスクによって、問合せがレコードを返す必要があり、返さないとアクションが失敗すると指定されます。

- !csItemNoLongerExists2: このアクションが英語コンテンツ・サーバー・システムで失敗した場合は、次のエラー・メッセージ文字列が返されます。
該当コンテンツ・アイテムはもはや存在しません。

3.2.3.2 アクション2の定義と説明

アクション2は、次のように実行されます。

- Action 2 : 3:mapNamedResultSetValues:DOCINFO,dStatus,dStatus,dDocTitle,dDocTitle:0:null

- 3: サービスを実装するJavaクラスの一部であるモジュールを指定するJavaメソッドのアクション。

- mapNamedResultSetValues: このアクションでは、DOC_INFO ResultSetの最初の行からdStatusおよびdDocTitleの値を取得して、ローカル・データに格納します。(これによってスピードが上がり、正しい値が使用されるようになります。)

- DOC_INFO,dStatus,dStatus,dDocTitle,dDocTitle: mapNamedResultSetValuesアクションに必須のパラメータ。

- 0: 制御マスクが指定されていません。

- null: エラー・メッセージが指定されていません。

3.2.3.3 アクション3の定義と説明

アクション3は、次のように実行されます。

- Action 3 : 3:checkSecurity:DOC_INFO:0:!csUnableToGetRevInfo2(dDocName)

- 3: サービスを実装するJavaクラスの一部であるモジュールを指定するJavaメソッドのアクション。

- checkSecurity: このアクションでは、DOC_INFO ResultSetに割り当てられているデータを取得し、割り当てられているセキュリティ・レベルを評価して、ユーザーがこのアクションを実行する権限があることを確認します。

- DOC_INFO: checkSecurityアクションによって評価されるセキュリティ情報を含むResultSet。

- 0: 制御マスクが指定されていません。

- !csUnableToGetRevInfo2(dDocName): このアクションが英語コンテンツ・サーバー・システムで失敗した場合は、次のエラー・メッセージ文字列が返されます。
'{dDocName}'に対する情報を取得できません。

3.2.3.4 アクション4の定義と説明

アクション4は、次のように実行されます。

- Action 4 : 3:getDocFormats:QdocFormats:0:null

- 3: サービスを実装するJavaクラスの一部であるモジュールを指定するJavaメソッドのアクション。

- getDocFormats: このアクションでは、query.htmファイル内のQdocFormats問合せを使用して、コンテンツ・アイテムのファイル形式を取得します。ファイル形式のカンマ区切りのリストが、dDocFormatsとしてローカル・データに格納されます。

- QdocFormats: ファイル形式の取得に使用される問合せを指定します。

- 0: 制御マスクが指定されていません。

- null: エラー・メッセージが指定されていません。

3.2.3.5 アクション5の定義と説明

アクション5は、次のように実行されます。

- Action 5 : 3:getURLAbsolute::0:null

- 3: サービスを実装するJavaクラスの一部であるモジュールを指定するJavaメソッドのアクション。

- getURLAbsolute: このアクションでは、コンテンツ・アイテムのURLを解決し、DocUrlとしてローカル・データに格納します。

- 空白: このアクションではパラメータを利用しません。

- 0: 制御マスクが指定されていません。

- null: エラー・メッセージが指定されていません。

3.2.3.6 アクション6の定義と説明

アクション6は、次のように実行されます。

- Action 6 : 3:getUserMailAddress:dDocAuthor,AuthorAddress:0:null

- 3: サービスを実装するJavaクラスの一部であるモジュールを指定するJavaメソッドのアクション。

- getUserMailAddress: このアクションでは、コンテンツ・アイテムの作者の電子メール・アドレスを解決します。

- dDocAuthor,AuthorAddress: このアクションでは、パラメータとしてdDocAuthorとAuthorAddressを渡します。

- 0: 制御マスクが指定されていません。

- null: エラー・メッセージが指定されていません。

3.2.3.7 アクション7の定義と説明

アクション7は、次のように実行されます。

- Action 7 : 3:getUserMailAddress:dCheckoutUser,CheckoutUserAddress:0:null

- 3: サービスを実装するJavaクラスの一部であるモジュールを指定するJavaメソッドのアクション。

- getUserMailAddress: このアクションでは、コンテンツ・アイテムがチェックアウトされているユーザーの電子メール・アドレスを解決します。

- dCheckoutUser,CheckoutUserAddress: このアクションでは、パラメータとしてdCheckoutUserとCheckoutUserAddressを渡します。

- 0: 制御マスクが指定されていません。

- null: エラー・メッセージが指定されていません。

3.2.3.8 アクション8の定義と説明

アクション8は、次のように実行されます。

- Action 8 : 3:getWorkflowInfo:WF_INFO:0:null

- 3: サービスを実装するJavaクラスの一部であるモジュールを指定するJavaメソッドのアクション。

- getWorkflowInfo: このアクションでは、コンテンツ・アイテムがワークフローの一部かどうかを評価します。WF_INFO ResultSetが存在している場合は、ワークフロー情報がDOC_INFOテンプレートにマージされます。

- WF_INFO: このアクションでは、パラメータとしてWF_INFOを渡します。

- 0: 制御マスクが指定されていません。

- null: エラー・メッセージが指定されていません。

3.2.3.9 アクション9の定義と説明

アクション9は、次のように実行されます。

- Action 9 : 3:getDocSubscriptionInfo:QisSubscribed:0:null

- 3: サービスを実装するJavaクラスの一部であるモジュールを指定するJavaメソッドのアクション。

- getDocSubscriptionInfo: このアクションでは、現在のユーザーがコンテンツ・アイテムをサブスクライブしているかどうかを評価します。

- ユーザーがサブスクライブしている場合は、「サブスクライブ解除」ボタンが表示されます。

- ユーザーがサブスクライブしていない場合は、「サブスクライブ」ボタンが表示されます。

- QisSubscribed: サブスクリプション情報の取得に使用される問合せを指定します。

- 0: 制御マスクが指定されていません。

- null: エラー・メッセージが指定されていません。

3.2.3.10 アクション10の定義と説明

アクション10は、次のように実行されます。

- Action 10 :
5:QrevHistory:REVISION_HISTORY:0:!csUnableToGetRevHistory(dDocName)

- 5: 問合せを使用してデータベースから情報を取得する、キャッシュ問合せの選択アクション。

- QrevHistory: このアクションでは、query.htmファイル内のQrevHistory問合せを使用して、リビジョン履歴情報を取得します。

- REVISION_HISTORY: この問合せの結果が、REVISION_HISTORYというResultSetに割り当てられます。DOC_INFOテンプレートはResultSet上をループし、各リビジョンに関する情報を表示します。

- 0: 制御マスクが指定されていません。

- !csUnableToGetRevHistory(dDocName): このアクションが英語コンテンツ・サーバー・システムで失敗した場合は、次のエラー・メッセージ文字列が返されます。
''{dDocName}''に対するリビジョン履歴を取得できません。

3.2.4 DOC_INFOテンプレート

DOC_INFOサービスのテンプレート・ページはDOC_INFOテンプレートです。ファイル間で何が行われているかを知って、テンプレート・ページとサービス内で実行されるアクションの相互作用を理解できるようにしておくことが重要です。

doc_info.htmテンプレートに含まれるコンテンツの定義は、IdcHomeDir/components/Folders/resources/std_page.htmファイル内にあります。両方のファイルのコードが、次のマークアップ・セクションに表示されます。

IdcHomeDir/resources/core/templates/doc_info.htmファイルからのマークアップ:

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>

<$include std_info_html_head_declarations$>

</head>
<$include info_body_def$>
<$include info_page_content$>
</body>
</html>

doc_info.htmテンプレートに何が表示されるかを定義する、IdcHomeDir/components/Folders/resources/std_page.htmファイルからのマークアップ:

<@dynamichtml info_page_content@>
<$include std_page_begin$>
<$include std_header$>
…
<!-- Do a loop on DOC_INFO so that all substitution tags will use DOC_INFO as
their first place to find their values.  Otherwise their is confusion between
this result set and the REVISION_HISTORY table that comes later.  For example
'dStatus' is a value in both tables-->
<$loop DOC_INFO$>
<$if AllowPrimaryMetaFile and isTrue(AllowPrimaryMetaFile) and
isTrue(dFormat like "*idcmeta*")$>
<$showPrimaryMetaFileFields = "1"$>
<$endif$>
<$include doc_info_notify_data$>

<table border=0 cellpadding=2 cellspacing=0 width=<$docInfoWidth-30$>>
<caption align=top><h4 class=pageTitle><$pageTitle$></caption>
<$include special_checkin_fields1$>
<$include std_revision_label_field$>
<$include std_document_type_field$>
<$include std_document_title_field$>
<$include author_checkin_field$>
<$include std_meta_fields$>
<$include security_checkin_fields$>
<$include checkout_author_info_field$>
<$if IsStagingDoc$>
<$include doc_date_fields$>
<$endif$>
<$fieldName = "dStatus", fieldCaption = "Status"$><$include std_displayonly_field$>
<$if HasOriginal$>
<$fieldName = "dDocFormats", fieldCaption = "Formats"$><$include std_display_field$>
<$endif$>
<$include workflow_list_for_doc$>
<$if HasUrl$>
<$include doc_url_field$>
<$endif$>
<$if HasOriginal and not ClientControlled and not showPrimaryMetaFileFields$>
<$fieldName = "dOriginalName", fieldCaption = "Get Native File"$>
<$if DownloadApplet$>
<$valueStyle="xxsmall", fieldValue = strTrimWs(inc("download_file_by_applet_form_content"))$>
<$else$>
<$fieldValue = strTrimWs(inc("doc_file_get_copy"))$>
<$endif$>
<$if DownloadApplet$><form name=downloadForm><$endif$>
<$include std_displayonly_field$>
<$if DownloadApplet$></form><$endif$>
<$endif$>
<$if IsFailedConversion or IsFailedIndex or IsDocRefinePassthru$>
<$if IsFailedConversion$><$include std_namevalue_separator$><$endif$>
<tr>
<td align=right><span class=errorHighlight>
<$if IsFailedIndex$>Index Error:
<$else$>Conversion Error:
<$endif$></span></td>
<td>
<table>
<tr>
<td><span class=tableEntry>
<$dMessage$>
<$if IsFailedIndex$>
<br>Content has been indexed with Info only.
Resubmit should only be performed if the problem has been resolved.
<$elseif IsDocRefinePassthru$>
<br>Content Refinery failed to convert the content item but released it to the
web by copying the native file.
<$endif$></span></td>
<td><form action="<$HttpCgiPath$>" method="POST">
<input type=hidden name=dID value="<$dID$>">
<input type=hidden name=dDocName value="<$dDocName$>">
<input type=hidden name=IdcService value="RESUBMIT_FOR_CONVERSION">
<input type=submit value= "Resubmit ">
<$if ClientControlled$>
<input type=hidden name=ClientControlled value="DocMan">
<$endif$>
</form></td>
</tr>
</table>
</td>
</tr>
<$if IsFailedConversion$><$include std_namevalue_separator$><$endif$>
<$endif$>
</table>
<$if IsNotSyncRev$>
<table width="100%">
<tr>
<td align=center><span class=errorHighlight>The local copy of this content item has
not been updated to the latest revision.  Use <i>Get Native File</i> or <i>Check out</i>
to update your local copy of <i><$dDocName$></i>.</span></td>
</tr>
</table>
<$endif$>

<$if IsStagingDoc$>
<br>
<table width="90%">
<tr>
<td width="20%" align=center><$include doc_problem_reports$></td>
<td width="20%" align=center><$include project_problem_reports$></td>
</tr>
</table>
<$include doc_provider_info$>
<$else$>
<table width="90%">
<tr>
<$if ClientControlled$>
<td width="20%" align=center><$include doc_select_actions$></td>
<$else$>
<td width="20%" align=center><$include doc_file_undo_checkout$></td>
<td width="20%" align=center><$include doc_file_checkout$></td>
<td width="20%" align=center><$if showPrimaryMetaFileFields$><$include meta_file_update$>
<$else$><$include doc_file_update$><$endif$></td>
<$endif$>
<td width="20%" align=left><$include doc_subscription_unsubscription$></td>
<$if ClientControlled$>
<td width="20%"></td>
<td width="20%"></td>
<$endif$>
</tr>
</table>
<$endif$>
<$if HasOriginal and DownloadApplet$>
<$include download_native_applet$>
<$endif$>

<!-- end loop on DOC_INFO-->
<$endloop$>
<$if IsStagingDoc$>
<!-- present a problem report form -->
<$include doc_add_problem_report$>
<$else$>
<!-- Table holding information about all revisions of this document-->
<$include doc_rev_table$>
<$endif$>
</td>
</tr>
</table>
<$include std_page_end$>
<@end@>

3.3 サービス・リソースの作成

カスタム・コンポーネントとともに使用するためにサービス・リソースを作成するには、次の2つの方法があります。

- 第3.3.1項「カスタム・サービスの手動作成」

- 第3.3.3項「コンポーネント・ウィザードを使用したカスタム・サービスの作成」

注意:

カスタム・コンポーネントの詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentでの開発』を参照してください。

3.3.1 カスタム・サービスの手動作成

カスタム・サービス・リソースを手動で作成するには:

- 第3.3.2項「HTMファイルでのサービスの定義」

- 第3.3.2.1項「カスタム・コンポーネントのHDAファイル内にあるサービスのロード」

3.3.2 HTMファイルでのサービスの定義

HTMファイルには、StandardServices表と構造が同一な表が格納されている必要があります。第3.1項「サービス構造の概要」を参照してください。

std_services.htmファイルのコピーを作成し、それをカスタム・コンポーネントの/resourcesディレクトリ内に置いて、混乱が生じないようにこのファイルの名前を変更します。例:

/custom/my_component/resources/my_services.htm

1. StandardServices表の名前を新しい名前に変更します。例:

<@table MyServices@>

2. 作成するサービスに類似したサービスを除き、表の中の行をすべて削除します。

3. 「名前」、「属性」、「アクション」の各列のエントリを編集します。

4. ファイルを保存して閉じます。

たとえば、次のHTMファイルは、ADD_REPORTとREPORTS_LISTという2つのカスタム・サービスを示しています。

テキスト・エディタに表示されるカスタム・サービスのHTMファイルの例は、次のとおりです。

<HTML>
<HEAD>
<META HTTP-EQUIV='Content-Type' content='text/html; charset=iso-8859-1'>
<TITLE>Custom Scripted Services</TITLE>
</HEAD>
<BODY>
<@table MyServices@>
<table border=1><caption><strong>Scripts For Custom Services
</strong></caption>
<tr>
<td>Name</td><td>Attributes</td><td>Actions</td>
</tr>
<tr>
<td>ADD_REPORT</td>
<td>Service
18
ADD_REPORT_FORM
null
null<br>
Unable to add report.</td>
<td>2:Ireport::0:null</td>
</tr>
<tr>
<td>REPORTS_LIST</td>
<td>Service
17
REPORT_LIST_FORM
null
null<br>
Unable to retrieve reports.</td>
<td>5:Qreports:REPORT_LIST:0:null</td>
</tr>
</table>
<@end@>
<br><br>
</BODY>
</HTML>

図3-6 Webブラウザに表示されるカスタム・サービスのHTMファイルの例

3.3.2.1 カスタム・コンポーネントのHDAファイル内にあるサービスのロード

1. テキスト・エディタでカスタム・コンポーネントのコンポーネント定義(glue)ファイルを開きます。たとえば、DomainHome/ucm/cs/custom/my_component/my_component.hdaのようになります。

2. 新しいHTMファイルをResourceDefinition ResultSetに追加します。例:

@ResultSet ResourceDefinition
4
type
filename
tables
loadOrder
service
resources/my_services.htm
MyServices
1
@end

3. ファイルを保存します。

3.3.3 コンポーネント・ウィザードを使用したカスタム・サービスの作成

コンポーネント・ウィザードを使用してサービス・リソースを作成するには、次の手順を実行します。

1. コンポーネント・ウィザードで、リソースを作成するコンポーネントを開きます。

2. 「リソースの定義」タブで、「追加」をクリックします。

図3-7 新しいカスタム・サービスの定義

1. 「リソースを追加します。」ウィンドウで「サービス」オプションを選択します。

2. リソース・ファイルのファイル名を入力します。デフォルトのファイル名は、resources/componentname_service.htmです。
サービスにリソース・ファイルが作成されている場合、ファイル名を選択して、新規のサービス表を既存のファイルに追加できます。ロード順に変更を加えた場合は、リソース・ファイル全体に適用されます。

別のファイル名で新規リソース・ファイルを作成するには、ファイル名を入力します。例: my_services.htm。

3. 新規リソース・ファイルを特定の順序でロードする場合は、「ロード順」フィールドに数値を入力します。

注意:

リソース・ファイルを他のリソースの後にロードする特別な理由がある場合を除き、ロード順は1に設定されたままにしてください。

4. 「次へ」をクリックします。

図3-8 新しいサービス表の定義

1. 「サービス表情報の追加」で、サービス表の名前を追加します。
コンポーネント名を接頭辞として残すことをお薦めします。例: My_Component_Services。

サービス表が別のリソース・ファイルにある場合であっても、コンポーネントの各サービス表には、一意の名前を付ける必要があります。

2. 「次へ」をクリックします。

図3-9 サービスの属性の定義

1. 「サービスの追加」ウィンドウで、サービスの属性を直接入力するか、または次のようにして既存のサービス定義から始めます。

1. 「選択」をクリックします。よく使用されるサービスのリストが表示されます。

2. 「すべて表示」チェック・ボックスを選択して、事前定義サービスのリスト全体を表示します。

3. リストからサービスを選択します。サービスの詳細を表示するには、そのサービス名をハイライトして、「プレビュー」をクリックします。

ヒント:

選択したサービスのオンライン・ヘルプを表示するには、「サービスservice_nameの情報をプレビュー」ダイアログで「ヘルプ」ボタンをクリックします。

4. 「OK」をクリックします。サービスの属性とアクションが入力されます。

注意:

サービスの名前を変更しない場合、このコンポーネントを最後にロードすると、カスタム・サービスにより標準サービスおよび同じ名前の他のカスタム・サービスがオーバーライドされます。

5. 必要に応じて、サービスの属性を編集します。

2. 必要に応じて、アクションを入力します。

- アクションは、実行順に「アクション」リストに表示される必要があります。「上へ」および「下へ」ボタンを使用して、選択したアクションを移動します。

- アクションを追加する場合は、「追加」をクリックします。アクション定義を入力して、「OK」をクリックします。

- アクションを編集する場合は、アクションを選択して「編集」をクリックします。アクション定義を変更して、「OK」をクリックします。

- アクションを削除する場合は、アクションを選択して「削除」をクリックします。

図3-10 アクションの定義

1. 「終了」をクリックします。

2. ダイアログ・ボックスが表示され、テキスト・エディタを起動して編集を続行するように求められます。リソース・ファイルをテキスト・エディタで開く場合は、「はい」をクリックします。コンポーネント・ウィザードに戻る場合は、「いいえ」をクリックします。
サービス・リソース・ファイルが「カスタム・リソース定義」リストに表示され、サービス表が右ペインの「表名」リストに表示されます。

図3-11 コンポーネント・ウィザードで定義されたカスタム・サービス・リソース

4 コアContent Serverサービス

この章では、Oracle WebCenter Content Serverに使用可能なコア・サービスについて説明します。サービスはサービス・クラスに従って分けられています。

この章の内容は、次のとおりです。

- 第4.1項「コアContent Serverサービスについて」

- 第4.2項「一般サービス(コアContent Server)」

- 第4.3項「ドキュメント・サービス(コアContent Server)」

- 第4.4項「ドキュメント・プロファイル・サービス(コアContent Server)」

- 第4.5項「ファイル・サービス(コアContent Server)」

- 第4.6項「インデクサ・サービス(コアContent Server)」

- 第4.7項「内部サービス(コアContent Server)」

- 第4.8項「メタサービス(コアContent Server)」

- 第4.9項「その他のサービス(コアContent Server)」

- 第4.10項「ページ・ハンドラ/ページ・リクエスト・サービス(コアContent Server)」

- 第4.11項「プロバイダ・マネージャ・サービス(コアContent Server)」

- 第4.12項「スキーマ・サービス(コアContent Server)」

- 第4.13項「検索サービス(コアContent Server)」

- 第4.14項「ユーザー・サービス(コアContent Server)」

- 第4.15項「コラボレーション・サービス(コアContent Server)」

4.1 コアContent Serverサービスについて

Oracle WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

特定のコアContent Serverサービスの場所は、各サービス内にリスト表示されています。

注意:

最も一般的に使用されるサービスには、より広範囲な説明があります。

重要:

すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。

4.2 一般サービス(コアContent Server)

一般サービスはContent Server全体にわたって使用され、特定の機能に関連付けられることはほとんどありません。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

この項では、これらのサービスについて説明します。

- ADD_DOC_ACCOUNT

- ADD_DOCEXTENSION

- ADD_DOCFORMAT

- ADD_DOCTYPE

- APPLET_DOCINFO

- CONFIG_INFO

- DELETE_DOC_ACCOUNT

- DELETE_DOCEXTENSION

- DELETE_DOCFORMAT

- DELETE_DOCTYPE

- EDIT_DOCEXTENSION

- EDIT_DOCFORMAT

- EDIT_DOCTYPE

- EDIT_TRACE_OPTIONS

- GET_DATARESULTSET

- GET_DOCEXTENSIONS

- GET_DOCFORMATS

- GET_DOCTYPES

- GET_FIELD_LENGTHS

- GET_FILELIST

- GET_METADEFS

- GET_RESULT_OPTIONS

- GET_SYSTEM_AUDIT_INFO

- GET_TABLE

- GET_USER_METADEFS

- JAVA_PROPERTIES

- LM_BUILD_WEB_STRING_FILES

- LM_LOAD_LAYOUTS

- LM_LOAD_LAYOUTS_SUB

- LOAD_DOC_ENVIRONMENT

- *LOGIN

- MERGE_TABLE

- *PING_SERVER

- QUERY_DOC_ACCOUNTS

- SOAP_FAULT

4.2.1 ADD_DOC_ACCOUNT

新しいアカウントを作成するために使用されるサービス。最も発生しがちなエラーは、アカウント名が一意ではないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocAccount: コンテンツ・アイテムのセキュリティ・アカウント。

例

IdcService=ADD_DOC_COLLECTION
dDocAccount=newaccount

4.2.2 ADD_DOCEXTENSION

既存のファイルにファイル拡張子を追加するサービス。最も発生しがちなエラーは、その拡張子を持つ一致するファイルがすでにシステムに存在することです。

追加の必須サービス・パラメータ

- dExtension: hcsf、doc、txtなどのファイル拡張子。

- dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。

例

IdcService=ADD_DOCEXTENSION
dExtension=doc
dFormat=application/doc

4.2.3 ADD_DOCFORMAT

新しいファイル・フォーマットを作成するサービス。最も発生しがちなエラーは、ファイル・フォーマットがシステムにすでに存在することです。

場所: IdcHomeDir3

追加の必須サービス・パラメータ

- dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。

- dConversion: 変換アルゴリズムは、パラメータdConversionで決定されます。

変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。

ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。

- dDescription: ファイル・フォーマットの説明。

例

IdcService=ADD_DOCFORMAT
dFormat=application/doc
dDescription=msword
dConversion=PASSTHRU

4.2.4 ADD_DOCTYPE

新しいコンテンツ・アイテムのタイプを作成するために使用されるサービス。最も発生しがちなエラーは、コンテンツ・アイテムのタイプ名が一意でないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocType: 新しいコンテンツ・アイテムのタイプ。

- dDescription: 新しいタイプの説明。

- dGif: 新しいドキュメント・タイプを表すためのアイコンとして表示されるGIFイメージのファイル名。.gif拡張子を含めます。

例

IdcService=ADD_DOCTYPE
dDocType=MYTEST
dDescription=My Description.
dGif=adeng.gif

4.2.5 APPLET_DOCINFO

コンテンツ・アイテムの情報を取得するサービス。最も発生しがちなエラーは、コンテンツ・アイテムがシステムに存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

例

IdcService=APPLET_DOCINFO
dID=47

4.2.6 CONFIG_INFO

Content Serverの管理サーバーから構成情報を取得するサービス。現在アクティブなコンポーネントの構成情報を取得するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.7 DELETE_DOC_ACCOUNT

既存のアカウントを削除するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocAccount: アカウント名。

例

IdcService=DELETE_DOC
dDocAccount=mainaccount

4.2.8 DELETE_DOCEXTENSION

既存のファイル拡張子を削除するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dExtension: hcsf、doc、txtなどのファイル拡張子。

例

IdcService=DELETE_DOCEXTENSION
dExtension=hcsf

4.2.9 DELETE_DOCFORMAT

既存のドキュメント形式を削除するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dFormat: MIMEフォーマットの名前。たとえば、application/hcsfまたはapplication/doc.。

例

IdcService=DELETE_DOCFORMAT
dFormat=application/hcsf

4.2.10 DELETE_DOCTYPE

既存のコンテンツ・アイテムのタイプを削除するサービス。最も発生しがちなエラーは、指定されたファイル・タイプが存在しないか、そのタイプのファイルがシステムに存在することです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocType: コンテンツ・アイテムのタイプ。

例

IdcService=DELETE_DOCTYPE
dDocType=TEST

4.2.11 EDIT_DOCEXTENSION

既存のファイル拡張子を変更するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dExtension: doc、txt、pdfなどのファイル拡張子。

- dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。

例

IdcService=EDIT_DOCEXTENSION
dExtension=hcsf
dFormat=application/hcsf

4.2.12 EDIT_DOCFORMAT

既存のコンテンツ・アイテムのフォーマットを変更するサービス。このサービスは「構成マネージャ」アプレットからコールされます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。

- dDescription: フォーマットの説明。

- dConversion: 変換アルゴリズムは、このパラメータで決定されます。
変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。

ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。

例

IdcService=EDIT_DOCFORMAT
dFormat=application/hcsf
dDescription=hypercontent
dConversion=PASSTHRU

4.2.13 EDIT_DOCTYPE

既存のコンテンツ・アイテムのタイプを変更するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocType: コンテンツ・アイテムのタイプ。

- dDescription: タイプの説明。

- dGif: タイプを表すためのアイコンとして表示されるGIFイメージのファイル名。.gif拡張子を含めます。

例

IdcService=EDIT_DOCTYPE
dDocType=MY_TEST
dDescription=edit testing
dGif=admkt.gif

4.2.14 EDIT_TRACE_OPTIONS

「システム監査情報」ページのトレース・オプションを取得するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.15 GET_DATARESULTSET

このサービスでは、「問合せの選択」をデータベースに対して実行します。問合せはdataSourceパラメータから構築されます。このサービスは次の情報を返します。

- 問合せの結果を含む結果セット。

- 結果が切り捨てられたかどうかを示すもの。dataSourceが最大行数を超えられないように定義されている場合、および問合せが許可されている最大数を超える数を返す場合、copyAbortedキーは1 (true)に設定されます。これは返された結果セットが問合せのサブセットのみを含むことを示します。

特定のコアContent Serverの表に対して選択しようとする問合せには、セキュリティ句が適用されています。特に、ドキュメント、リビジョン、ユーザーなどの表にはその他のセキュリティ句が適用されています。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dataSource: コール元によって提供される潜在的なWHERE句およびORDER BY句を持つSelect問合せ。dataSourceは、DataSources表で定義される、Content Serverリソースです(dataSourcesの標準リストのresource.htmファイルを参照。)

オプションのサービス・パラメータ

- whereClause: Select問合せへのWHERE句。

- orderClause: trueに設定されると、句別に問合せをソートします。

- resultName: 問合せの結果セットに使用する名前を指定します。

4.2.16 GET_DOCEXTENSIONS

すべてのコンテンツ・アイテムの拡張子と各拡張子のマップ先のファイル・フォーマットのリストを返すサービス。プロパティ情報およびExtensionFormatMap ResultSetを返します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.17 GET_DOCFORMATS

すべてのコンテンツ・アイテムのフォーマットとそれに関連した変換メソッドと説明のリストを返すサービス。プロパティ情報およびDocFormats ResultSet.を返します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.18 GET_DOCTYPES

すべてのコンテンツ・アイテムのタイプ、その説明および関連するGIFイメージのリストを返すサービス。プロパティ情報およびDocTypes ResultSetを返します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.19 GET_FIELD_LENGTHS

長さが制限されたフィールドの最大長の情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

オプションのサービス・パラメータ

- tableNames: 調査対象となる表のコンマで区切られたリスト。リストを指定しない場合、tableNamesはドキュメントおよびフォルダ表のリスト(DocMeta,Documents,Revisions,FolderFolders,FolderFiles)に設定されます。

結果

- ResultSet:

- FIELD_LENGTH: フィールドの最大文字数を含む結果セット。このResultSetには2つの列があります。

- fieldName: フィールドの名前。

- fieldLength: フィールドに許可されている文字の最大数。

4.2.20 GET_FILELIST

指定されたフィルタに一致する、ディレクトリにリストしているファイルを取得する管理サービス。ディレクトリはユーザーではなく、IDにより指定されます。このサービスはIDをディレクトリにマップします。

実際には、このサービスは構成マネージャ・アプレットに対するコンテンツ・タイプのGIFリストを取得するためにのみ使用されます。このリストは、/weblayout/images/docgifsディレクトリにあります。結果は、オプション・リストとしてfileListNameパラメータで指定された値で返されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- directoryID: ディレクトリ識別子。使用可能な値は、docgifs、mages、templates、resourcesです。

- fileFilter: ファイルを選択するために使用するワイルド・カード・フィルタ。

- fileListName: 返された値を保持するオプション・リスト。

4.2.21 GET_METADEFS

すべてのカスタム・メタデータ・フィールドとその属性のリストを返すサービス。プロパティ情報およびMetaFieldInfo ResultSetを返します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.22 GET_RESULT_OPTIONS

検索結果テンプレートから情報を返すサービス。

注意:

バージョン3.5.3では、Content Serverはこのサービスを使用していません。これは下位互換性を維持するために、レガシー・コードとしてstd_services.htmファイルに残っています。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.23 GET_SYSTEM_AUDIT_INFO

Content Serverのシステム監査情報を取得するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.24 GET_TABLE

HDAファイルの結果セットにデータベース表をエクスポートするサービス。

指定された表が見つからない場合、サービスは失敗します。HDAデータを受信して、後で使用するためにこの結果セットを格納するのは、コール元プログラムです。

最も発生しがちなエラーは、表名が存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- tableName: エクスポートする表の名前。

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=GET_TABLE
tableName=Users

- HDA形式:

@Properties LocalData
IdcService=GET_TABLE
tableName=Users
@end

4.2.25 GET_USER_METADEFS

すべてのユーザー情報フィールドとその属性のリストを返すサービス。プロパティ情報およびResultSetを返します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.26 JAVA_PROPERTIES

使用中のJavaリソース環境に関する情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.27 LM_BUILD_WEB_STRING_FILES

文字列を静的.jsファイルにパブリッシュするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.28 LM_LOAD_LAYOUTS

DomainHome/ucm/cs/weblayout/common/layoutsディレクトリからユーザー・インタフェース・レイアウトをロードするサービス。LM_LOAD_LAYOUTS_SUBをコールします。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.29 LM_LOAD_LAYOUTS_SUB

DomainHome/ucm/cs/weblayout/common/layoutsディレクトリからレイアウトをコールするために使用されるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.30 LOAD_DOC_ENVIRONMENT

このサブサービスは、コンテンツ・アイテム環境用のテンプレート・ページ構成情報をロードします。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.31 LOGIN

強制的にログインし、HTMLページ・リクエストを実行するサービス。これは、ユーザーをWebサーバーで認証するための様々な方法の1つです。

アクセス・レベル: N/A (0)

場所: IdcHomeDir/resources/core/templates/std_services.htm

追加の必須サービス・パラメータ

- Action: 実行するアクション。通常GetTemplatePage。

- Page: ページ・テンプレートの名前。

- Auth: ブラウザ・インタフェースからログインする場合にのみ必要。例:

Auth=Internet

他の考えられる値はIntranetで、NTLMログインに使用されます。

結果

- ローカル・データ:

- dUser

- RedirectParams

- StatusMessage

- レスポンス・テンプレート: null(デフォルトでHOME_PAGEにリダイレクトします)

次が使用

- リソース・インクルード:

- pne_nav_userprofile_links

- subscription_action_script

- home_page_static_content

- テンプレート:

- QUERY_NOTIFICATION (query_notification_mail.htm)

- SELF_REGISTER_PROMPT_LOGIN (self_register_prompt_login.htm)

- (std_home_page.htm)

- 標準ナビゲーション: commonNav.js

例

Content Serverにログインする際のホーム・ページを表示します。

IdcService=LOGIN

Action=prepareRedirect
Page=HOME_PAGE

4.2.32 MERGE_TABLE

結果セットを既存のデータベース表にマージするサービス。エラーはすべてContent Serverのログに記録されます。

重要:

デフォルトでは、このサービスはエラー・トレラントではなく、トランザクションでマージを実行しません。したがって、isErrorTolerantまたはisTransactionalオプション・パラメータがtrueに設定されず、かつこのサービスでエラーが発生すると、エラーが発生した場所で終了し、すでに更新され挿入された行はロールバックされません。この場合、制約を指定しないで、マージ表を再実行すると、制約違反により、Microsoft SQL ServerおよびContent Serverではマージが失敗します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- tableName: マージするデータベース表の名前。結果セットはこの表と同じ名前を持つ必要があります。

重要:

挿入または更新する行を含む表のResultSet定義も指定する必要があります。

オプションのサービス・パラメータ

- constraintKeys: 一意の識別子として使用される、カンマで区切られた列名のリストを指定します。このサービスは、最初にこれらの制約を調べます。行が見つかる場合、サービスは更新を行います。それ以外の場合は、新しい行が挿入されます。

パラメータが定義されていない場合、サービスは行を挿入しようとします。

- isDeleteTable: trueの場合、サービスはマージしようとする前に表を削除します。isTransactionalがtrueに設定される場合、マージを伴うトランザクションで削除が実行されます。デフォルトで、この値はfalseです。

- isErrorTolerant: trueの場合、マージ中にエラーが発生すると終了しません。デフォルトで、この値はfalseです。

- isTransactional: trueの場合、トランザクションでマージが実行されます。マージ中にエラーが発生して、isErrorTolerantがfalseの場合、マージが終了し、すべての変更がロールバックされます。デフォルトで、この値はfalseです。

例

- IdcCommandコマンド・ファイル・フォーマット:

# Merge new entries into the Alias table
IdcService=MERGE_TABLE
tableName=Alias
constraintKeys=dAlias

# Rows to be updated or inserted
@ResultSet Alias
2
dAlias
dAliasDescription
MyAlias
Just a test alias
@end
<<EOD>>

# Delete the alias table and insert new rows, do a rollback if something fails.
IdcService=MERGE_TABLE
tableName=Alias
isTransactional=true
isDeleteTable=true

# Rows to be updated or inserted
@ResultSet Alias
2
dAlias
dAliasDescription
MyAlias
Just a test alias
@end
<<EOD>>

- HDA形式(例1):

@Properties LocalData
IdcService=MERGE_TABLE
tableName=Alias
constraintKeys=dAlias
@end
@ResultSet Alias
2
dAlias
dAliasDescription
MyAlias
Just a test alias
@end

- 表名およびResultSetを定義し、新しい行をデータベースに挿入する(新しい行をUsers表に挿入する)HDA形式:

@Properties LocalData
IdcService=MERGE_TABLE
tableName=Users
@end
@ResultSet Users
2
dName
dUserAuthType
user15
LOCAL
@end

4.2.33 PING_SERVER

Content Serverインスタンスへの接続が存在し、ステータス情報を返すかどうかを評価するサービス。ユーザーがログインしていない場合には、強制的にログインするように促します。

ヒント:

Content Serverインスタンスへの接続が確立されており、コマンドの実行権限を持つユーザーとしてログインしていることを確認するために、他のサービスをコールする前にPING_SERVERリクエストを実行します。

アクセス・レベル: N/A (0)

場所: IdcHomeDir/resources/core/tables/std_services.htm

結果

- ローカル・データ:

- dUser

- StatusMessage

- レスポンス・テンプレート: null

次が使用

- アプレット:

- バッチ・ローダー

- 構成マネージャ

- ページ・ビルダー

- テンプレート:

- SUBSCRIBE_FORM (subscribe_form.htm)

- SUBSCRIPTION_LIST (subscription_list.htm)

- UNSUBSCRIBE_FORM (unsubscribe_form.htm)

例

HDA形式:

@Properties LocalData
IdcService=PING_SERVER
IsJava=1
Auth=Internet
@end

サンプルの戻り情報:

Content-type: text/html
Content-Length: 421

<?hda version="6.0 SNAP-020207" jcharset=Cp1252 encoding=iso-8859-1?>

@Properties LocalData
dUser=sysadmin
blFieldTypes=StatusMessage message
refreshSubMonikers=
StatusMessage=You are logged in as 'sysadmin'.
loadedUserAttributes=1
blDateFormat=M/d{/yy} {h:mm[:ss] {aa}[zzz]}!tAmerica/Chicago!mAM,PM
changedSubjects=
refreshSubjects=
Auth=Internet
refreshMonikers=
changedMonikers=
IdcService=PING_SERVER
IsJava=1
@end

4.2.34 QUERY_DOC_ACCOUNTS

Content Serverのすべてのアカウントのリストを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.2.35 SOAP_FAULT

失敗したSOAPリクエストを処理するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3 ドキュメント・サービス(コアContent Server)

ドキュメント・サービスは、チェックイン、チェックアウト、サブスクリプション・アクション、ドキュメント情報へのアクセスなど、ドキュメントに関するアクションを実行します。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

この項では、これらのサービスについて説明します。

- ASSIGN_DOCINFO_FORM

- CACHE_CHECKIN_NEW

- CACHE_CHECKIN_SEL

- CACHE_SUBMIT_HTML_FORM

- CACHE_WORKFLOW_CHECKIN

- CHECKIN_ARCHIVE_NO_NOTIFY

- CHECKIN_BYNAME

- *CHECKIN_CONFIRM_FORM

- *CHECKIN_LIST

- *CHECKIN_NEW

- *CHECKIN_NEW_FORM

- *CHECKIN_NEW_SUB

- *CHECKIN_SEL

- *CHECKIN_SEL_FORM

- CHECKIN_SEL_SUB

- *CHECKIN_SIMILAR_FORM

- *CHECKIN_UNIVERSAL

- *CHECKOUT

- CHECKOUT_BY_NAME

- *CHECKOUT_OK

- *CHECKOUT_SUB

- CONTINUE_CHECKIN

- CONTINUE_SUBMIT_HTML_FORM

- COPY_REVISION

- CREATE_SUBSCRIPTION_TYPE

- DELETE_BYCLASS

- DELETE_BYNAME

- DELETE_BYREV

- DELETE_BYREV_REVISION

- DELETE_CHECKIN_CACHE

- DELETE_DOC

- *DELETE_REV

- DELETE_REV_EX

- DELETE_SUBSCRIPTION_TYPE

- DOC_FORMATS_WIZARD

- *DOC_INFO

- *DOC_INFO_BY_NAME

- *DOC_INFO_LATESTRELEASE

- *DOC_INFO_SIMPLE

- *DOC_INFO_SIMPLE_BYREV

- *DOC_SUBS_LIST

- EDIT_DOC_FORMATS

- FORM_PROCESS

- FORM_SUBMIT

- GET_CACHED_CHECKIN_INFO

- GET_DOC_CONFIG_INFO

- GET_DOC_SUBSCRIBERS

- GET_DOCUMENT_HISTORY_REPORT

- GET_ENVIRONMENT

- *GET_EXPIRED

- GET_PACKAGE_ENVIRONMENT_PAGE

- *GET_UPDATE_FORM

- NOTIFY_INDEXER

- ODMA_DOC_INFO_SIMPLE

- PACKAGE_ENVIRONMENT

- REMOVE_METAFILE_SUB

- REPLACE_METAFILE_SUB

- RESTORE_REVISION

- *RESUBMIT_FOR_CONVERSION

- *REV_HISTORY

- SELECTDOC

- *SUBMIT_HTML_FORM

- *SUBSCRIBE

- SUBSCRIBE_DOC_USER

- SUBSCRIBE_EX

- *SUBSCRIBE_FORM

- *SUBSCRIPTION_LIST

- *UNDO_CHECKOUT

- UNDO_CHECKOUT_BY_NAME

- *UNSUBSCRIBE

- *UNSUBSCRIBE_FORM

- *UNSUBSCRIBE_FROM_LIST

- UNSUBSCRIBE_FROM_LIST_EX

- UPDATE_BYREV

- *UPDATE_DOCINFO

- *UPDATE_DOCINFO_BYFORM

- UPDATE_DOCINFO_BYREV

- UPDATE_DOCINFO_METAFILE_BYREV

- UPDATE_DOCINFO_STATUS

- UPDATE_DOCINFO_SUB

- UPDATE_SUBSCRIPTION_NOTIFY

- UPDATE_SUBSCRIPTION_TYPE

- UPDATE_SUBSCRIPTION_USED

- UPDATE_METADATA

- VALIDATE_DOCINFO

- *WORK_IN_PROGRESS

4.3.1 ASSIGN_DOCINFO_FORM

DOCINFO_FORMを取得し、それをコンテンツに割り当てるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.2 CACHE_CHECKIN_NEW

プレビューで使用されるサービス。ユーザーがチェックイン中にプレビューを実行する場合、サーバー側で情報がキャッシュされます。このサービスは非キャッシュ・バージョンをモデル化し、同じパラメータをCHECKIN_NEWとして使用します。

空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.3 CACHE_CHECKIN_SEL

プレビューで使用されるサービス。ユーザーがチェックイン中にプレビューを実行する場合、サーバー側で情報がキャッシュされます。このサービスは非キャッシュ・バージョンをモデル化し、同じパラメータをCHECKIN_SELとして使用します。

空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.4 CACHE_SUBMIT_HTML_FORM

プレビューで使用されるサービス。ユーザーがチェックイン中にプレビューを実行する場合、サーバー側で情報がキャッシュされます。このサービスは非キャッシュ・バージョンをモデル化し、同じパラメータをSUBMIT_HTML_FORM.として使用します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.5 CACHE_WORKFLOW_CHECKIN

プレビューで使用されるサービス。ユーザーがチェックイン中にプレビューを実行する場合、サーバー側で情報がキャッシュされます。このサービスは非キャッシュ・バージョンをモデル化し、同じパラメータをWORKFLOW_CHECKINとして使用します。

コンテンツ・アイテム・ファイルが空の場合に、このサービスがエラーを返すようにするには、構成設定ValidatePrimaryFileNotEmpty=1を使用します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.6 CHECKIN_ARCHIVE_NO_NOTIFY

クライアント・アプリケーションで使用される一般的なチェックイン・サービス。このサービスは一般的に、クライアント・アプリケーションが多数のファイルをチェックインしていることを認識し、チェックイン・アクティビティによってインデクサを開始しない場合に使用されます。

NO_NOTIFYは、チェックイン中に通常通知されるContent Serverサブジェクトをこのサービスが通知しないことを示します。このサービスは、インデクサを開始する、「リリースされたドキュメント」サブジェクトを非表示にします。

このサービスのユーザーは、NOTIFY_INDEXERサービスをコールすることによって作業を続行するために、インデクサ・サブジェクトに通知する必要があります。

このサービスは、アーカイバにより使用されません。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

追加のパラメータについては、「CHECKIN_ARCHIVE」を参照してください。

オプションのサービス・パラメータ

追加のパラメータについては、「CHECKIN_ARCHIVE」を参照してください。

例

IdcService=CHECKIN_ARCHIVE_NO_NOTIFY
Action=insert
dDocAuthor=user1
dDocName=test
dDocTitle=new content
dSecurityGroup=Public
primaryFile=c:/test.txt
doFileCopy=true

4.3.7 CHECKIN_BYNAME

コンテンツ・アイテム名またはコンテンツIDに基づいてコンテンツ・アイテムのリビジョンをチェックインするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

ユーザーがセキュリティ・グループ(dSecurityGroup)、アカウント(dDocAccount)、または作成者(dDocAuthor)を変更するには、コンテンツ・アイテムのセキュリティ設定への管理者権限を持っている必要があります。

- コンテンツ・アイテムがエンティティ・セキュリティを使用する場合、ユーザーがドキュメントに割り当てられているセキュリティ・グループに対する管理者権限を持っている場合を除き、ユーザーはそのエンティティにより少なくとも書込み権限を付与されている必要があります。

- コンテンツ・アイテムがワークフローに存在している場合、ユーザーは現在のステップのレビューアまたはコントリビュータである必要があります。

- メタファイルの生成が(AllowPrimaryMetaFileまたはAllowAlternateMetaFile環境変数、またはその両方を設定することにより)有効であり、メタファイル生成変数(createPrimaryMetaFile and createAlternateMetaFile)がtrueである場合、実際のファイルを現在のコンテンツ・アイテムに関連付けることはできません。コンテンツ・アイテムに関連付けることができるメタファイルは1つのみです。createPrimaryMetaFileがtrueの場合、createAlternateMetaFileはfalseである必要があります。その逆もまた同様です。

- 最も発生しがちなエラーは、リビジョンを挿入できないこと、またはリファイナリが正常に開始されないことです。

重要:

コンテンツ・アイテム名またはコンテンツ・アイテムのリビジョンIDを指定する必要があります。

空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- コンテンツID自動生成が有効な場合、このパラメータは必要ありません。dDocNameが定義されている場合、自動生成されたコンテンツIDをオーバーライドします。

- コンテンツIDに、スペースまたは無効な文字(/ \?:@&=+"#%<>*~|[ ])を含めることはできません。

- dDocAuthor: コンテンツ・アイテムの作成者(コントリビュータ)。

- dDocTitle: コンテンツ・アイテムのタイトル。

- dDocType: コンテンツ・アイテムのタイプ。

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

- dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。

- primaryFile: サーバーから見た、ファイルの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。
プライマリ・ファイルは、メタデータのみをチェックインするのではないかぎり、指定する必要があります。プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。

- プライマリ・ファイルが指定されない場合、そのかわりにメタファイルを使用できます。各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。

- プライマリと代替の両方のファイルを指定する場合、それらの拡張子は異なっている必要があります。

- doFileCopy: 1 (true): ファイルはチェックイン後にハード・ドライブから削除されません。

- 0 (false): ファイルはチェックイン後にハード・ドライブから削除されます。

- 必須カスタム・フィールド: 必須のカスタム・メタデータ・フィールドも指定する必要があります。

オプションのサービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- alternateFile: 変換のための代替ファイル。

- 各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。
プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。

- AutoNumberPrefix: これは構成エントリですが、パラメータとして指定できます。リビジョン・クラスIDの生成後およびメタデータ検証前に自動接頭辞スクリプトが評価されます。

- createAlternateMetaFile: 代替メタファイルの生成を有効にするには、AllowAlternateMetaFile環境の値をtrueにし、パラメータcreateAlternateMetaFileをtrueにする必要があります。

- createPrimaryMetaFile: プライマリ・メタファイルの生成を有効にするには、AllowPrimaryMetaFile環境の値をtrueにし、パラメータcreatePrimaryMetaFileをtrueにする必要があります。

- dConversion: 変換アルゴリズムは、このパラメータで決定されます。

変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。

ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。

- dCreateDate: コンテンツ・アイテムが作成された日付。デフォルトでは、これは現在の日付です。

- dExtension: hcsf、doc、txtなどのファイル拡張子。

- dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。

- dInDate: コンテンツのリリース日。コンテンツ・アイテムがWebにリリースされる日付。デフォルトでは、これは現在の日付です。

コンテンツのリリース日(dInDate)が指定されない場合、作成日(dCreateDate)が使用されます。この値が指定されない場合、自動的に生成されます。

- dOutDate: コンテンツの有効期限。デフォルトでは、これはブランクであり、有効期限は指定されません。

コンテンツの有効期限(dOutDate)が入力されない場合、値は空のままになります。これは有効な状態です。

- dPublishState: パブリッシュ状態。コンテンツ・アイテムがシステムに存在している場合、dPublishStateは空である必要があります。

- dReleaseState: リリース状態(リビジョンのWeb状態を示すために使用されます)。

- dRevClassID: リビジョンのクラスID。

- dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。設定された場合、このラベルを使用して、指定されたリビジョンを検索します。

- dWfType: 基本や基準などのワークフロー・タイプ。

- IsAutoNumber: これは構成エントリですが、パラメータとして指定できます。構成変数IsAutoNumberがtrueに設定される場合、コンテンツID (dDocName)が自動プリフィックスをリビジョンのクラスID (dRevClassID、一意に区別されたコンテンツ・アイテムのカウンタ)と連結されることにより生成され、先行ゼロが6桁になるように事前入力されます。コンテンツID (dDocName)がすでに指定されている場合は、自動ナンバリングが実行されません。

- IsEditRev: trueに設定される場合、このエントリは、コンテンツのリビジョンがワークフローに存在し、編集が有効であるかどうかをチェックします。

- IsWorkflowInfo: これは構成エントリですが、パラメータとして指定できます。trueに設定された場合、このエントリはワークフロー情報を確認し、ワークフロー・ステップの許容されるアクションであるかどうかをチェックします。

- webViewableFile: コンテンツ・アイテムがそれに関連付けられたWeb表示可能ファイルを持つ場合、変換形式はweb表示可能ファイルのフォーマット(パラメータwebViewableFile:format)で、拡張子はweb表示可能ファイルの拡張子(パラメータdWebExtension)です。それ以外の場合、拡張子およびファイル形式はそれぞれ、パラメータdExtensionおよびdFormatで決定されます。ユーザーはこれらの追加パラメータを設定することにより、ファイル・フォーマットおよび拡張子をオーバーライドできます。

- オプションのカスタム・フィールド: 必須ではないカスタム・メタデータ・フィールドも指定できます。

例

IdcService=CHECKIN_BYNAME
dDocName=test1000
dSecurityGroup=public
dDocAuthor=sysadmin
dDocType=ADENG
dDocTitle=another test
doFileCopy=true
primaryFile=c:/test.txt

4.3.8 CHECKIN_CONFIRM_FORM

ブラウザから正常なチェックイン時に確認を返すサービス。

アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: コンテンツID。

- dDocAuthor: ドキュメントの作成者。

- dDocName: ドキュメント名。

- dDocTitle: ドキュメントのタイトル。

結果

- ローカル・データ:

- dDocAuthor

- dDocName

- dDocTitle

- dID

- レスポンス・テンプレート: CHECKIN_CONFIRM (checkin_confirm.htm)

次が使用

- リダイレクト・サービスの対象: CHECKIN_NEW、CHECKIN_SEL、CONTINUE_CHECKIN

4.3.9 CHECKIN_LIST

(チェックインまたは削除されない)チェックアウト・アイテムのリストを返すサービス。最も発生しがちなエラーは、チェックアウト・リストがデータベースから取得できないことです。

アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)

実行される問合せ: QcheckinCachesForUser

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加のオプション・サービス・パラメータ

- userOnly: 1 (true)の場合、現在のユーザーにチェックアウトされたアイテムのみを返します。

- MaxQueryRows: リストに返されるアイテム数を制御します。

結果

- ResultSets:

- CHECKIN_LIST(チェックアウトされたリビジョン用のRevisionsおよびDocMetaからのすべてのフィールド)

- CHECKIN_CACHES (DatedCachesからのすべてのフィールド)

- ローカル・データ:

- copyAborted

- DataSource

- レスポンス・テンプレート: CHECKIN_LIST (checkin_list.htm)

次が使用

- リソース・インクルード:

- pne_nav_management_links

- std_doc_man_pages

- checkin_multiuploadapplet_processing_functions

- Standard Navigation:

- commonNav.js

- commonBundle.js

- その他:

- SoapCustom:Wsdl:CheckIn:Services

- リダイレクト・サービスの対象: DELETE_CHECKIN_CACHE

4.3.10 CHECKIN_NEW

新しいコンテンツ・アイテムをチェックインするサービス。このサービスはCHECKIN_NEW_SUBサブサービスをコールします。

アクセス・レベル: 書込み(2)

場所: IdcHomeDir/resources/core/tables/std_services.htm

- 作成者(dDocAuthor)を現在ログインしているユーザー以外のユーザーに設定しようとする場合、ドキュメントに割り当てられているセキュリティ属性に対して管理者権限を持っている必要があります。

- コンテンツがエンティティ・セキュリティを使用する場合、ユーザーがドキュメントに割り当てられているセキュリティ・グループに対する管理者権限を持っている場合を除き、ユーザーは少なくともそのエンティティにより付与された書込み権限を持っている必要があります。

- メタファイルの生成が(AllowPrimaryMetaFileまたはAllowAlternateMetaFile環境変数、またはその両方を設定することにより)有効であり、メタファイル生成変数(createPrimaryMetaFileおよびcreateAlternateMetaFile)がtrueである場合は、実際のファイルを現在のコンテンツ・アイテムに関連付けることはできません。1つのメタファイルは1つのコンテンツ・アイテムにのみ関連付けることができます: createPrimaryMetaFileがtrueの場合、createAlternateMetaFileはfalseである必要があります。その逆もまた同様です。

- 最も発生しがちなエラーは、コンテンツ・アイテムが適切に定義されていなかったことです。

- このサービスはCHECKIN_NEW_SUBサブサービスを実行します。このサブサービスは、新しいコンテンツ・アイテムのリビジョンをチェックインします。

- プライマリ・ファイルが必要です。プライマリ・ファイルをチェックインしないでメタデータのみをチェックインする場合は、追加のパラメータを含む必要があり、また、構成エントリをContent Serverに追加する必要があります。

- 空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1

必要な追加パラメータ(メタデータ・チェックイン):

createPrimaryMetaFile=true

必要なContent Server構成エントリ(メタデータ・チェックイン):

AllowPrimaryMetaFile=true

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- コンテンツID自動生成が有効な場合、このパラメータは必要ありません。dDocNameが定義されている場合、自動生成されたコンテンツIDをオーバーライドします。

- コンテンツIDに、スペースまたは無効な文字(/ \?:@&=+"#%<>*~|[ ])を含めることはできません。

- dDocAuthor: コンテンツ・アイテムの作成者(コントリビュータ)。

- dDocTitle: コンテンツ・アイテムのタイトル。

- dDocType: コンテンツ・アイテムのタイプ。

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

- dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。

- primaryFile: サーバーから見た、ファイルの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。
プライマリ・ファイルは、メタデータのみをチェックインするのではないかぎり、指定する必要があります。プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。

- プライマリ・ファイルが指定されない場合、そのかわりにメタファイルを使用できます。各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。

- プライマリと代替の両方のファイルを指定する場合、それらの拡張子は異なっている必要があります。

- 必須カスタム・フィールド: 必須のカスタム・メタデータ・フィールドも指定する必要があります。

オプションのサービス・パラメータ

- alternateFile: 変換のための代替ファイル。

- 各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。

- プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。

- AutoNumberPrefix: これは構成エントリですが、パラメータとして指定できます。リビジョン・クラスIDの生成後およびメタデータ検証前に自動接頭辞スクリプトが評価されます。

- createAlternateMetaFile: 代替メタファイルの生成を有効にするには、AllowAlternateMetaFile環境の値をtrueに設定し、パラメータcreateAlternateMetaFileをtrueに設定する必要があります。

- createPrimaryMetaFile: プライマリ・メタファイルの生成を有効にするには、AllowPrimaryMetaFile環境の値をtrueにし、パラメータcreatePrimaryMetaFileをtrueに設定する必要があります。

- DirectReleaseNewCheckinDoc: Inbound Refinery、ワークフローおよび索引付けをバイパスするためにチェックインされるコンテンツ・アイテムをダイレクトします。デフォルトは0です。有効にするには、DirectReleaseNewCheckinDoc=1を設定します。
このパラメータは、外部リポジトリからContent Serverストレージにコンテンツ・アイテムを転送する場合に高取込み率をサポートするために使用できます。この設定により、コンテンツ・チェックインの速度が向上するため、Content Serverが一度にサポート可能なチェックイン数が増加します。この機能は、多数のアイテムが一度にチェックインすることが期待されるアプリケーション(たとえば、スキャン・アプリケーションなど)では非常に好ましいです。

この設定を有効にする前に、次の重要な考慮事項を検討してください。

- この方法でチェックインされたコンテンツ・アイテムはDATABASE.METADATAを検索することのみにより検出できます。ただし、他のコンテンツ・アイテムは通常のチェックインを行い、全文索引作成が行われます。

- 索引の再構築では、索引を作成するためにこのパラメータを使用してコンテンツをチェックインしません。

- コンテンツの変更(新しいリビジョンの更新またはチェックイン)により、このパラメータを使用してチェックインされたドキュメントで索引付けが行われます。

- dConversion: 変換アルゴリズムは、このパラメータで決定されます。
変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。

ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。

- dCreateDate: コンテンツ・アイテムが作成された日付。デフォルトでは、これは現在の日付です。

- dFormat: コンテンツ・アイテムのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。たとえば、application/hcsfまたはapplication/doc.。

- dInDate: リリース日。デフォルトでは、これは現在の日付です。コンテンツのリリース日(dInDate)が指定されない場合、作成日(dCreateDate)が使用されます。この値が指定されない場合、自動的に生成されます。

- dOutDate: 有効期限。デフォルトでは、これはブランクであり、有効期限は指定されません。コンテンツの有効期限(dOutDate)が入力されない場合、値は空のままになります。これは有効な状態です。

- dRendition: コンテンツ・アイテムの追加のレンディションを指定するために使用されます。

- dRevClassID: リビジョンのクラスID。

- dRevisionLabel: コンテンツ・アイテムのリビジョン・ラベル。設定された場合、このラベルを使用して、指定されたリビジョンを検索します。

- IsAutoNumber: これは構成エントリですが、パラメータとして指定できます。構成変数IsAutoNumberがtrueに設定される場合、コンテンツID (dDocName)が自動プリフィックスをリビジョンのクラスID (dRevClassID、一意に区別されたコンテンツ・アイテムのカウンタ)と連結されることにより生成され、先行ゼロが6桁になるように事前入力されます。コンテンツID (dDocName)がすでに指定されている場合は、自動ナンバリングが実行されません。

- webViewableFile: コンテンツ・アイテムがそれに関連付けられたWeb表示可能ファイルを持つ場合、変換形式はweb表示可能ファイルのフォーマット(パラメータwebViewableFile:format)で、拡張子はweb表示可能ファイルの拡張子(パラメータdWebExtension)です。それ以外の場合、拡張子およびファイル形式はそれぞれ、パラメータdExtensionおよびdFormatで決定されます。ユーザーはこれらの追加パラメータを設定することにより、ファイル・フォーマットおよび拡張子をオーバーライドできます。

- オプションのカスタム・フィールド: 必須ではないカスタム・メタデータ・フィールドも指定できます。

結果

- ローカル・データ:

- dAction

- dActionDate

- dClbraName

- dConversion(リファイナリによって処理される場合、変換の内容に関する情報が含まれます。)

- dCreateDate

- dDocAccount

- dDocAuthor

- dDocID

- dDocName

- dDocTitle

- dDocType

- dExtension

- dFileSize

- dFormat

- dID: 新しいコンテンツ・アイテムのIDへの内部参照。

- dInDate

- dIsWebFormat

- dIsPrimary

- dLocation

- dOriginalName

- dOutDate

- dpAction

- dpEvent

- dProcessingState

- dPublishState

- dPublishType

- dRawDocID

- dReleaseState

- dRevClassID

- dRevisionID

- dRevLabel

- dRevRank

- dSecurityGroup

- dStatus

- dUser

- dWorkflowState

- isDocProfileUsed

- isEditMode

- isNew

- isStatusChanged

- prevReleaseState

- primaryFile

- StatusCode

- StatusMessage

- VaultfilePath

- WebfilePath

- xClbraAliasList

- xClbraUserList

- およびチェックインされるアイテムに関連するカスタム・メタデータ

- レスポンス・テンプレート:

- REDIRECT_TEMPLATE (redirect_template.htm)

- デフォルトのリダイレクト・サービス: CHECKIN_CONFIRM_FORM

次が使用

- リソース・インクルード: std_doc_page_definitions

例

IdcService=CHECKIN_NEW
dDocName=test1111
dDocTitle=test information
dDocAuthor=john
dSecurityGroup=public
primaryFile=c:/test.txt

4.3.11 CHECKIN_NEW_FORM

ブラウザに新しいコンテンツ・アイテムのチェックイン・フォームを返すサービス。最も発生しがちなエラーは、コンテンツ・アイテムが適切に定義されていなかったことです。

アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)

場所: IdcHomeDir/resources/core/templates//std_services.htm

結果

- ResultSets:

- DocFormats (dFormat、dConversion、dDescription)

- dDocType (dDocType、dDescription、dGif)

- レスポンス・テンプレート: CHECKIN_NEW_FORM (checkin_new.htm)

次が使用

- アプレット:

- リポジトリ・マネージャ

- ワークフロー管理

- ユーザー管理

- 構成マネージャ

- リソース・インクルード:

- pne_nav_management_links

- pne_nav_bookmark_links

- calculate_doc_profile_urls

- std_doc_man_pages

- Standard Navigation:

- commonNav.js

- commonBundle.js

4.3.12 CHECKIN_NEW_SUB

新しいコンテンツ・アイテムのリビジョンをチェックインするサブサービス。このサブサービスをコールするサービスによって、このコンテンツ・アイテムが基準ワークフローに属するかどうかを決定するなど、他の検証が実行されます。また、導出されたフィールドの計算、レンディションの追加およびリファイナリ処理の開始も含まれます。このサブサービスを実行する前に、グループおよびアカウントに対するセキュリティ・チェックを行う必要がある場合があります。

アクセス・レベル: サブサービス(N/A)

入力: コンテンツ・チェックインに必要なすべての標準フィールド、およびオプションのコンテンツ・メタデータを入力する必要があります。

実行される問合せ:

- QnextRevID

- UnextRevID

- Irevision

- Imeta

- Idocument

- IdocHistory

場所: IdcHomeDir/resources/core/templates//std_services.htm

結果

- ローカル・データ:

- dAction

- dActionDate

- dClbraName

- dConversion

- dCreateDate

- dDocAccount

- dDocAuthor

- dDocID

- dDocName

- dDocTitle

- dDocType

- dExtension

- dFileSize

- dFormat

- dID

- dInDate

- dIsPrimary

- dIsWebFormat

- dLocation

- dOriginalName

- dOutDate

- dpAction

- dpEvent

- dProcessingState

- dPublishState

- dPublishType

- dRawDocID

- dReleaseState

- dRevClassID

- dRevisionID

- dRevLabel

- dRevRank

- dSecurityGroup

- dStatus

- dUser

- dWorkflowState

- isDocProfileUsed

- isEditMode

- isNew

- isStatusChanged

- prevReleaseState

- primaryFile

- StatusCode

- StatusMessage

- VaultfilePath

- xClbraAliasList

- xClbraUserList

- WebfilePath

- およびチェックインされるアイテムに関連するカスタム・メタデータ

次が使用

- サービス: CHECKIN_NEW

4.3.13 CHECKIN_SEL

既存のコンテンツ・アイテムのリビジョンをチェックインするサービス。これはCHECKIN_SEL_SUBサブサービスをコールします。

アクセス・レベル: 書込み(2)

場所: IdcHomeDir/resources/core/tables/std_services.htm

- このサービスを実行するには、コンテンツ・アイテムをチェックアウトする必要があります。

- コンテンツ・アイテムがワークフローに存在している場合、ユーザーは現在のステップのレビューアまたはコントリビュータである必要があります。

- ユーザーがセキュリティ・グループ(dSecurityGroup)、アカウント(dDocAccount)または作成者(dDocAuthor)を変更するには、コンテンツ・アイテムのセキュリティ設定に対して管理者権限を持っている必要があります。

- メタファイルの生成が(AllowPrimaryMetaFileまたはAllowAlternateMetaFile環境変数、またはその両方を設定することにより)有効であり、メタファイル生成変数(createPrimaryMetaFile and createAlternateMetaFile)がtrueである場合、実際のファイルを現在のコンテンツ・アイテムに関連付けることはできません。コンテンツ・アイテムに関連付けることができるメタファイルは1つのみです。createPrimaryMetaFileがtrueの場合、createAlternateMetaFileはfalseである必要があります。その逆もまた同様です。

- コンテンツ・アイテムはパブリッシュ状態にできません。

- 現在のユーザーはコンテンツ・アイテムの作成者であるか、またはリビジョンをチェックインするための管理者権限を持っている必要があります。

- 最も発生しがちなエラーは、コンテンツ・アイテムがシステムに存在しないことです。

- このサービスはCHECKIN_SEL_SUBサブサービスを実行します。このサブサービスは、コンテンツ・アイテムのリビジョンをチェックインします。

- 空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- コンテンツID自動生成が有効な場合、このパラメータは必要ありません。dDocNameが定義されている場合、自動生成されたコンテンツIDをオーバーライドします。

- コンテンツIDに、スペースまたは無効な文字(/ \?:@&=+"#%<>*~|[ ])を含めることはできません。

- dDocAuthor: コンテンツ・アイテムの作成者(コントリビュータ)。

- dDocTitle: コンテンツ・アイテムのタイトル。

- dDocType: コンテンツ・アイテムのタイプ。

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

- dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。

- primaryFile: サーバーから見た、ファイルの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。プライマリ・ファイルは、メタデータのみをチェックインするのではないかぎり、指定する必要があります。プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。

- プライマリ・ファイルが指定されない場合、そのかわりにメタファイルを使用できます。各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。

- プライマリと代替の両方のファイルを指定する場合、それらの拡張子は異なっている必要があります。

- doFileCopy: 1 (true): ファイルはチェックイン後にハード・ドライブから削除されません。0 (false): ファイルはチェックイン後にハード・ドライブから削除されます。

- 必須カスタム・フィールド: 必須のカスタム・メタデータ・フィールドも指定する必要があります。

オプションのサービス・パラメータ

- alternateFile: 変換のための代替ファイル。

- 各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。

- プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。

- createAlternateMetaFile: 代替メタファイルの生成を有効にするには、AllowAlternateMetaFile環境の値をtrueに設定し、パラメータcreateAlternateMetaFileをtrueに設定する必要があります。

- createPrimaryMetaFile: プライマリ・メタファイルの生成を有効にするには、AllowPrimaryMetaFile環境の値をtrueに設定し、パラメータcreatePrimaryMetaFileをtrueに設定する必要があります。

- dConversion: 変換アルゴリズムは、パラメータdConversionで決定されます。

変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。

- ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。

- dCreateDate: コンテンツ・アイテムが作成された日付。デフォルトでは、これは現在の日付です。

- dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。例: application/hcsfまたはapplication/doc.。

- dInDate: コンテンツのリリース日。コンテンツ・アイテムがWebにリリースされる日付。デフォルトでは、これは現在の日付です。コンテンツのリリース日(dInDate)が指定されない場合、作成日(dCreateDate)が使用されます。この値が指定されない場合、自動的に生成されます。

- dOutDate: コンテンツの有効期限。デフォルトでは、これはブランクであり、有効期限は指定されません。コンテンツの有効期限(dOutDate)が入力されない場合、値は空のままになります。これは有効な状態です。

- dPublishState: パブリッシュ状態。コンテンツ・アイテムがシステムに存在している場合、dPublishStateは空である必要があります。

- dRevClassID: リビジョンのクラスID。

- AutoNumberPrefix: これは構成エントリですが、パラメータとして指定できます。リビジョン・クラスIDの生成後およびメタデータ検証前に自動接頭辞スクリプトが評価されます。

- IsAutoNumber: これは構成エントリですが、パラメータとして指定できます。構成変数IsAutoNumberがtrueに設定される場合、コンテンツID (dDocName)が自動プリフィックスをリビジョンのクラスID (dRevClassID、一意に区別されたコンテンツ・アイテムのカウンタ)と連結されることにより生成され、先行ゼロが6桁になるように事前入力されます。コンテンツID (dDocName)がすでに指定されている場合は、自動ナンバリングが実行されません。

- IsWorkflowInfo: これは構成エントリですが、パラメータとして指定できます。trueに設定された場合、このエントリはワークフロー情報を確認し、ワークフロー・ステップの許容されるアクションであるかどうかをチェックします。

- webViewableFile: コンテンツ・アイテムがそれに関連付けられたWeb表示可能ファイルを持つ場合、変換形式はweb表示可能ファイルのフォーマット(パラメータwebViewableFile:format)で、拡張子はweb表示可能ファイルの拡張子(パラメータdWebExtension)です。それ以外の場合、拡張子およびファイル形式はそれぞれ、パラメータdExtensionおよびdFormatで決定されます。ユーザーはこれらの追加パラメータを設定することにより、ファイル・フォーマットおよび拡張子をオーバーライドできます。

- RedirectUrl: トピック・ファイルが変更された後で、別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。

- オプションのカスタム・フィールド: 必須ではないカスタム・メタデータ・フィールドも指定できます。

結果

- ローカル・データ:

- dConversion: リファイナリによって処理される場合、これには変換の内容に関する情報が含まれます。

- dID: 新しいコンテンツ・アイテムの内部参照ID。

- IsWorkflow: アイテムがチェックイン時にワークフローに入る場合は、1 (true)が返されます。

- レスポンス・テンプレート:

- REDIRECT_TEMPLATE (redirect_template.htm)

- デフォルトのリダイレクト・サービス: CHECKIN_CONFIRM_FORM

次が使用

- リソース・インクルード: std_doc_page_definitions

例

IdcService=CHECKIN_SEL
dDocName=test_000036
dDocTitle=my test
dDocAuthor=sysadmin
dDocType=ADENG
dSecurityGroup=Public
dID=49
dRevLabel=1
doFileCopy=1

4.3.14 CHECKIN_SEL_FORM

ブラウザに新しいコンテンツ・アイテムのリビジョンのチェックイン・フォームを返すサービス。このサービスは、アイテムの現在のコンテンツ情報をロードします。「フォーム」ページに古いメタデータ情報が表示されます。

最も発生しがちなエラーは、コンテンツ・アイテム名がシステムに存在しないこと、コンテンツ・アイテムに関する情報が見つからないこと、またはシステムがリビジョンのプロパティを確認できないことです。

アクセス・レベル: 書込み、スクリプト作成可能(34)

実行される問合せ: QdocID、Qrevisions、QdocInfo

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

オプションのサービス・パラメータ

- dDocName

- dWfName

結果

- ResultSets:

- DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- DocFormats (dFormat、dConversion、dDescription)

- dDocType (dDocType、dDescription、dGif)

- ローカル・データ:

- CurRevCheckoutUser

- CurRevID

- CurRevIsCheckedOut

- dDocAccount

- dDocAuthor

- dDocName

- defaultAccount

- dID

- DocUrl

- dPublishState

- dReleaseState

- dRevClassID

- dRevLabel

- dSecurityGroup

- dStatus

- dUser

- dWorkflowState

- isCurRevEmpty

- IsNotLatestRev

- IsWorkflow

- latestID

- およびすべてのDocMetaフィールド

- レスポンス・テンプレート: CHECKIN_SEL_FORM (checkin_sel.htm)

次が使用

- リソース・インクルード:

- classic_info_page_content

- workflow_action_popup

- checkin_list_action_popup

- legacy_checked_out_content_table

- workflow_doc_action_links

- docinfo_checkin_similar_option

- setup_checked_out_content_action_popups

- wf_reviewer_doc_action_links

- テンプレート:

- CHECKOUT_OK (chkook.htm)

- WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

例

IdcService=CHECKIN_SEL_FORM
dID=55

4.3.15 CHECKIN_SEL_SUB

チェックインされるコンテンツ・アイテムがすでに存在する場合、チェックアウトされている場合、またはワークフロー内に存在しない場合に使用されるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.16 CHECKIN_SIMILAR_FORM

同様なコンテンツ・アイテムからのメタデータを入力して、ブラウザに新しいコンテンツ・アイテムのチェックイン・フォームを返すサービス。最も発生しがちなエラーは、コンテンツ・アイテムが適切に定義されていなかったことです。

アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)

実行される問合せ: QdocInfoSimilarCheckin

場所: IdcHomeDir/resources/core/tables/std_services.htm

結果

- ResultSets:

- DOC_INFO_SIMILAR (指定されたリビジョンのdDocTitle、dDocType、dSecurityGroup、dDocAccount)

- DocFormats (dFormat、dConversion、dDescription)

- dDocType (dDocType、dDescription、dGif)

- ローカル・データ:

- dDocAccount

- dDocType

- dSecurityGroup

- レスポンス・テンプレート: CHECKIN_NEW_FORM (checkin_new.htm)

次が使用

- リソース・インクルード:

- search_results_action_popup

- docinfo_checkin_similar_option

- doc_file_checkin_similar

- setup_search_results_action_popups

- Templates: CHECKIN_CONFIRM (checkin_confirm.htm)

4.3.17 CHECKIN_UNIVERSAL

Content Serverによって制御されるチェックインを実行するサービス。

アクセス・レベル: 書込み(2)

場所: IdcHomeDir/resources/core/tables/std_services.htm

- このサービスは、ブラウザまたは「リポジトリ・マネージャ」アプリケーションを介したチェックイン時にコールされる同じサブサービスである、次のサブサービスのいずれかにチェックイン・リクエストを送信します。(これらのサブサービスは、バッチ・ローダーまたはアーカイブのインポート中にはコールされません。)

- CHECKIN_NEW_SUB - コンテンツ・アイテムがサーバーに存在しない場合。このサブサービスは、チェックイン・データを検証し、このコンテンツ・アイテムが基準ワークフローに属しているかどうかを判断します。

- CHECKIN_SEL_SUB - コンテンツ・アイテムがシステムに存在し、コンテンツ・アイテムがチェックアウトされ、コンテンツ・アイテムがワークフロー内にない場合。

- WORKFLOW_CHECKIN_SUB - コンテンツ・アイテムが存在し、ワークフロー内にある場合。

- このサービスは、セキュリティをチェックして、ユーザーがコンテンツ・アイテムのチェックインを実行するための十分な権限を持っているかどうかを判断します。

- コンテンツID (dDocName)をキーとして使用してデータベースに問合せを行うことにより、コンテンツ・アイテムが新規のものであるか、システムにすでに存在しているものであるかを判断します。

- コンテンツ・アイテムがシステムに存在している場合、パブリッシュ状態(dPublishState)は空である必要があります。

- アイテムが存在して、チェックアウトされる場合は、新しいリビジョンがチェックインされます。

- 最も発生しがちなエラーは、パラメータの不一致、またはコンテンツ・アイテムが正常にチェックインされなかったことです。

注意:

すべてのパスがファイルの区切り文字としてスラッシュ(/)を使用します。これは、バックスラッシュ(\)がエスケープ文字であるからです。例: primaryFile=d:/temp/myfile.txt。

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- コンテンツID自動生成が有効な場合、このパラメータは必要ありません。

- dDocNameが指定され、Content Serverシステムに存在する場合、リビジョンがチェックインされます。dDocNameが指定され、Content Serverに存在しない場合、新しいコンテンツ・アイテムがチェックインされます。

- コンテンツIDに、スペースまたは無効な文字(/ \?:@&=+"#%<>*~|[ ])を含めることはできません。

- dDocAuthor: コンテンツ・アイテムの作成者(コントリビュータ)。

- dDocTitle: コンテンツ・アイテムのタイトル。

- dDocType: コンテンツ・アイテムのタイプ。

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

- dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。

- primaryFile: サーバーから見た、ファイルの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。プライマリ・ファイルは、メタデータのみをチェックインするのではないかぎり、指定する必要があります。プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。

- プライマリ・ファイルが指定されない場合、そのかわりにメタファイルを使用できます。各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。

- プライマリと代替の両方のファイルを指定する場合、それらの拡張子は異なっている必要があります。

- doFileCopy: 1 (true): ファイルはチェックイン後にハード・ドライブから削除されません。0 (false): ファイルはチェックイン後にハード・ドライブから削除されます。

- 必須カスタム・フィールド: 必須のカスタム・メタデータ・フィールドも指定する必要があります。

- オプションのサービス・パラメータ

- alternateFile: 変換のための代替ファイル。

- 各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。

- プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリは代替ファイルを変換します。それ以外の場合、プライマリ・ファイルが変換されます。

- dCreateDate: コンテンツ・アイテムが作成された日付。デフォルトでは、これは現在の日付です。

- dInDate: コンテンツのリリース日。コンテンツ・アイテムがWebにリリースされる日付。デフォルトでは、これは現在の日付です。コンテンツのリリース日(dInDate)が指定されない場合、作成日(dCreateDate)が使用されます。この値が指定されない場合、自動的に生成されます。

- dOutDate: コンテンツの有効期限。デフォルトでは、これはブランクであり、有効期限は指定されません。コンテンツの有効期限(dOutDate)が入力されない場合、値は空のままになります。これは有効な状態です。

- dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。設定された場合、このラベルを使用して、指定されたリビジョンを検索します。リビジョン・ラベル(dRevLabel)が指定された場合、このサービスは、そのコンテンツ・リビジョンがシステムに存在しているかどうかをチェックします。存在する場合は、例外がスローされます。

- isFinished: これがワークフロー・チェックインであり、その編集が完了している場合は、true (1)に設定します。

- 追加情報については、「WORKFLOW_CHECKIN」を参照してください。

注意:

コンテンツID (dDocName)と内部のコンテンツ・アイテム・リビジョン識別子(dID)を混同しないでください。dIDは、コンテンツ・アイテムの特定のレンディションへの、生成済の参照です。

結果

- ローカル・データ:

- dConversion: リファイナリによって処理される場合、これには変換の内容に関する情報が含まれます。

- dID: 新しいコンテンツ・アイテムの内部参照ID。

- IsWorkflow: アイテムがチェックイン時にワークフローに入る場合は、1 (true)が返されます。

次が使用

- リソース・インクルード: std_doc_page_definitions

- その他:

- SoapCustom:Esdl:CheckIn:Services

- SoapCustom:Wsdl:Workflow:Services

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=CHECKIN_UNIVERSAL
dDocName=adsales
dDocType=ADACCT
dDocTitle=Advertising Sales
dSecurityGroup=Secure
dDocAuthor=user1
dRevLabel=1
dDocType=ADACCT
primaryFile=c:/temp/docs/mydoc.txt
doFileCopy=1

# If this is a workflow check-in and you have finished editing it, mark it as finished.
#isFinished=true

#Required depending on configuration
dDocAccount=mainaccount

#Optional fields:
#dCreateDate=
#dInDate=
#dOutDate=
#alternateFile=

#Custom metadata fields:
xComments=
xLocation=
xProjects=

- HDA形式(コンテンツ・アイテムmyDocNameのチェックイン):

@Properties LocalData
IdcService=CHECKIN_UNIVERSAL
doFileCopy=1
dDocName=myDocName
dDocTitle=My document title
dDocType=ADACCT
dSecurityGroup=Secure
dDocAuthor=user1
primaryFile=c:/temp/docs/mydoc.txt
dDocAccount=mainaccount
xComments=
xLocation=
xProjects=
@end

4.3.18 CHECKOUT

ブラウザからコンテンツ・アイテムの最新のリビジョンをチェックアウトするサービス。

- コンテンツ・アイテムがシステムに存在しない場合、コンテンツ・アイテムがすでにチェックアウトされている場合、またはコンテンツ・アイテムをチェックアウトするのに十分な権限がユーザーにない場合、サービスは失敗します。

- 最も発生しがちなエラーは、コンテンツがシステムに存在しないこと、またはシステムがリビジョン情報を取得できないことです。

- このサービスはCHECKOUT_SUBサブサービスを実行します。このサブサービスは、コンテンツ・アイテムのリビジョンをチェックアウトします。

アクセス・レベル: 書込み、スクリプト作成可能(34)

サブサービスのコール: CHECKOUT_SUB

実行される問合せ:

- QdocID

- Qrevisions

- QdocInfo

場所: IdcHomeDir/resources/core/tables/std_services.htm

注意:

このサービスは、コンテンツ・アイテムをロック済としてマークするだけです。ダウンロードは実行しません。

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

オプションのサービス・パラメータ

- dDocTitle: コンテンツ・アイテムのタイトル。

- RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。

結果

- ローカル・データ:

- CurRevCheckoutUser

- CurRevIsCheckedOut

- CurRevID

- dAction

- dActionDate

- dActionMillis

- dCheckoutUser

- dClbraName

- dDocName

- dIsCheckedOut

- dPublishState

- dReleaseState

- dRevClassID

- dRevLabel

- dSecurityGroup

- dStatus

- dWorkflowState

- isCurRevEmpty

- isFinished

- IsNotLatestRev

- IsWorkflow

- latestID

- prevReleaseState

- RedirectParams

- wfAction

- レスポンス・テンプレート:

- REDIRECT_TEMPLATE (redirect_template.htm)

- デフォルトのリダイレクト・サービス: CHECKOUT_OK

次が使用

- アプレット:

- リポジトリ・マネージャ

- ワークフロー管理者

- リソース・インクルード:

- classic_search_result_item_checkout

- clbra_active_doc_display

- doc_file_checkout

- docinfo_checkout_form

- searchapi_result_table_content_end

- search_results_action_popup

- setup_search_results_action_popups

- wf_reviewer_doc_action_links

- wips_list_action_popup

- workflow_action_popup

- workflow_doc_action_links

- workflow_docs_table

- workflow_in_queue_table

- work_in_progress_table

- テンプレート: WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

- その他: SoapCustom:Wsdl:CheckIn:Services

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=CHECKOUT
dID=55

- 任意のパラメータを持つHDA形式:

@Properties LocalData
IdcService=CHECKOUT
dID=55
dDocTitle=Sample Title
@end

4.3.19 CHECKOUT_BY_NAME

アプレットまたはアプリケーションからコンテンツ・アイテムをチェックアウトするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

- コンテンツ・アイテムがシステムに存在しない場合、コンテンツ・アイテムがすでにチェックアウトされている場合、またはコンテンツ・アイテムをチェックアウトするのに十分な権限がユーザーにない場合、サービスは失敗します。

- 最も発生しがちなエラーは、コンテンツ・アイテム名がシステムに存在しないことです。

- このサービスはCHECKOUT_SUBサブサービスを実行します。このサブサービスは、コンテンツ・アイテムのリビジョンをチェックアウトします。

注意:

このサービスは、コンテンツ・アイテムをロック済としてマークするだけです。ダウンロードは実行しません。

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

オプションのサービス・パラメータ

- dDocTitle: コンテンツ・アイテムのタイトル。

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=CHECKOUT_BY_NAME
dDocName=myDocument

- 任意のパラメータを持つHDA形式:

@Properties LocalData
IdcService=CHECKOUT_BY_NAME
dDocName=myDocument
dDocTitle=Just a title
@end

4.3.20 CHECKOUT_OK

ブラウザからコンテンツ・アイテムをチェックアウトし、チェックアウト確認ページを表示するサービスによるリダイレクト・サービスとしてコールされます。

アクセス・レベル: 書込み、スクリプト作成可能(34)

実行される問合せ: QdocInfo

場所: IdcHomeDir/resources/core/tables/std_services.htm

- 最も発生しがちなエラーは、リビジョンが存在しないこと、またはシステムがリビジョン情報を取得できないことです。

- このサービスはCHECKOUT_SUBサブサービスを実行します。このサブサービスは、コンテンツ・アイテムのリビジョンをチェックアウトします。

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- CurRevCheckoutUser: アイテムをチェックアウトしたユーザー。

オプションのサービス・パラメータ

- CurRevID: 現在のリビジョンのID。通常はdIDと同じ。

結果

- ResultSet: DOC_INFO(指定されたバージョンのRevisionsおよびDocMetaからのすべてのフィールド)

- レスポンス・テンプレート: CHECKOUT_OK (chkook.htm)

次が使用

- その他: CHECKOUT、CHECKOUT_BY_NAMEのリダイレクト・サービス

例

IdcService=CHECKOUT_OK
dID=48

4.3.21 CHECKOUT_SUB

コンテンツ・アイテムのリビジョンをチェックアウトするサブサービス。バインダに、コンテンツ・アイテム最新バージョンのQdocInfo(または同等)の結果を含むDOC_INFOという結果セットが含まれる必要があります。

アクセス・レベル: サブサービス(N/A)

実行される問合せ:

QworkflowDocInfo

- IdocHistory

- UcheckoutRevision

場所: IdcHomeDir/resources/core/tables/std_services.htm

結果

- ローカル・データ:

- CurRevCheckoutUser

- dAction

- dActionDate

- dActionMillis

- dCheckoutUser

- dClbraName

- dIsCheckedOut

- hasUserAccessChanged

- isCurRevEmpty

- isFinished

- IsNotLatestRev

- prevReleaseState

- wfAction

次が使用

- サービス:

- CHECKOUT

- CHECKOUT_BY_NAME

- FORM_PROCESS (processFormメソッドにより間接的に)

4.3.22 CONTINUE_CHECKIN

CACHE_CHECKIN_NEWまたはCACHE_CHECKIN_SELサービスで開始されたチェックインを完了するサービス。

プレビューが実行され、チェックイン・データがキャッシュされた後で、ユーザーはこのサービスを使用してチェックインを完了または続行することを決定できます。

正常なチェックインを実行するには、キャッシュされたデータがこのサービスに提供される必要があります。キャッシュおよびチェックイン動作をカスタマイズするためにフィルタが提供されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

4.3.23 CONTINUE_SUBMIT_HTML_FORM

CACHE_SUBMIT_HTML_FORMサービスで開始されたチェックインを完了するサービス。

プレビューが実行され、チェックイン・データがキャッシュされた後で、ユーザーはこのサービスを使用してチェックインを完了または続行することを決定できます。

正常なチェックインを実行するには、キャッシュされたデータがこのサービスに提供される必要があります。キャッシュおよびチェックイン動作をカスタマイズするためにフィルタが提供されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

4.3.24 COPY_REVISION

新しいリビジョン・クラスを作成するために、特定のドキュメントのリビジョンをコピーするサービス。元のリビジョンのドキュメント・メタデータのほとんどは引き継がれます。呼出し元では、リクエストのパラメータでメタデータ値を設定することにより、上書きすることもできます。

ユーザーに必要なのは、元のドキュメント・リビジョンへの読取り権限のみです。ただし、新しいリビジョンは元のメタデータを継承するため、ユーザーに元のリビジョンへの書込み権限がない場合、新しいセキュリティ・メタデータの値を設定する必要があります。

このサービスはContent Serverの構成でGetCopyAccessがTRUEに設定されていることを仮定しています。

サービス・クラス: DocService

場所: IdcHomeDir/resources/core/tables/std_services.htm

必須のサービス・パラメータ

- dID: (整数)コピーするドキュメント・リビジョンのID。

- dDocName: コピーするドキュメント・リビジョンのコンテンツID。適切なエラー・メッセージに使用されます。

オプションのサービス・パラメータ

- newDocName: 新しいリビジョン・クラスのdDocName。これを指定せず、自動ナンバリングが有効な場合、dDocNameは自動的に生成されます。

結果

- ResultSets:

- NewDocInfo: 新しく作成されたドキュメントについての情報。

- OriginalDocInfo: コピーされた元のドキュメントについての情報。

4.3.25 CREATE_SUBSCRIPTION_TYPE

新しいサブスクリプション・タイプを作成するサービス。最も発生しがちなエラーは、サブスクリプション・タイプ名が一意でないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- scpType: サブスクリプションのタイプ。

- scpDescription: サブスクリプションの説明。

- scpEnabled: 1 (true): サブスクリプション通知が有効です。0 (false): サブスクリプション通知が無効です。

- scpFields: サブスクリプション条件を定義するメタデータ・フィールド。例: dDocAuthor、dDocType。

例

IdcService=CREATE_SUBSCRIPTION_TYPE
scpType=subscription_test
scpFields=dDocType
scpDescription=testing the subscription
scpEnabled=1

4.3.26 DELETE_BYCLASS

特定のパラメータに基づいてコンテンツ・アイテムを削除するために使用されるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.27 DELETE_BYNAME

特定のパラメータに基づいてコンテンツ・アイテムを削除するために使用されるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.28 DELETE_BYREV

特定のパラメータに基づいてコンテンツ・アイテムを削除するために使用されるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.29 DELETE_BYREV_REVISION

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.30 DELETE_CHECKIN_CACHE

特定のパラメータに基づいてコンテンツ・アイテムを削除するために使用されるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.31 DELETE_DOC

コンテンツ・アイテム全体とすべてのリビジョンを削除するサービス。ユーザーはコンテンツ・アイテムを削除する権限が必要です。最も発生しがちなエラーは、コンテンツ・アイテムがシステムに存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムID。

- dDocName: ドキュメントのdocumentID。実際のコンテンツID。

例

IdcService=DELETE_DOC
dID=48
dDocName=test1000

4.3.32 DELETE_REV

ブラウザから既存のコンテンツ・アイテムのリビジョンを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があること、コンテンツ・アイテムがシステムに存在しないこと、またはコンテンツ・アイテムがワークフローの一部であることです。

アクセス・レベル: 読取り、書込み(3)

サブサービスのコール: DELETE_BYREV_REVISION

実行される問合せ: QdocInfo

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

結果

- ResultSets: DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- ローカル・データ:

- Content Server:

- currentReleaseState

- dAction (returns 'Delete Revision')

- dReleaseState

- isAllRevisionsDeleted (アイテムの最新リビジョンが削除されたときにtrueを返します)

- isCurRevEmpty

- newReleaseState

- prevID

- 削除されるアイテムが現在ワークフロー内にある場合、オペレーションは失敗し、次のワークフロー情報が返されます。

- dWfCurrentStepID

- dWfDocState

- dWfID

- dWfName

- dWfStatus

- dWfStepDescription

- dWfStepID

- dWfStepIsAll

- dWfStepName

- dWfStepType

- dWfStepWeight

- dWfType

- dWorkflowState

- IsWorkflow

- wfStepCheckinType

- レスポンス・テンプレート:

- REDIRECT_TEMPLATE (redirect_template.htm)

- デフォルトのリダイレクト・サービス: DOC_INFO

次が使用

- リソース・インクルード:

- delete_rev_form

- delete_revision_form

例

IdcService=DELETE_REV
dID=51

4.3.33 DELETE_REV_EX

アプレットまたはアプリケーションから既存のコンテンツ・アイテムのリビジョンを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があること、コンテンツ・アイテムがシステムに存在しないこと、またはコンテンツ・アイテムがワークフローの一部であることです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

例

IdcService=DELETE_REV_EX
dID=56

4.3.34 DELETE_SUBSCRIPTION_TYPE

既存のサブスクリプション・タイプを削除するサービス。最も発生しがちなエラーは、サブスクリプション・タイプがシステムに存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- scpType: サブスクリプションのタイプ。

例

IdcService=DELETE_SUBSCRIPTION_TYPE
scpType=subscription_test

4.3.35 DOC_FORMATS_WIZARD

コンテンツ・アイテムの形式の拡張子を取得するサービス。コンテンツ・アイテム構成情報をロードし、デフォルトのコンテンツ・アイテムの形式拡張子を設定するために使用されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.36 DOC_INFO

コンテンツ・アイテムの特定のリビジョンのコンテンツ・アイテム情報を取得するサービス。コンテンツ・アイテムのそのリビジョンに関連付けられているすべてのメタデータを返します。最も発生しがちなエラーは、そのコンテンツ・アイテムがすでにシステムに存在していないか、ユーザーがこのアクションを実行するためのセキュリティ・レベルを持っていないことです。

REVISION_HISTORY結果セットから他のリビジョンの限定情報が提供されます。

このサービスは、サブスクリプション情報、およびアイテムがワークフロー内にある場合はワークフロー情報を返します。

アクセス・レベル: 読取り、スクリプト作成可能(33)

実行される問合せ:

- QdocInfo

- QdocFormats

- QisSubscribed

- QrevHistory

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: コンテンツ・アイテムのリビジョンID。

- dDocName: コンテンツ・アイテムID。

結果

- ResultSets:

- DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- REVISION_HISTORY(すべての非削除リビジョンのdFormat、dInDate、dOutDate、dStatus、dProcessingState、dRevLabel、dID、dDocName、dRevisionID)

- アイテムがワークフロー内にある場合: WF_INFO(指定されたリビジョンのWorkflowsおよびWorkflowDocumentsからのすべてのフィールド)

- ローカル・データ:

- Content Server:

- AuthorAddress

- dDocFormats

- dDocTitle

- dID

- DocUrl

- dStatus

- dSubscriptionAlias

- dSubscriptionID

- dSubscriptionType

- dUser

- アイテムがワークフロー内にある場合:

- dWfCurrentStepID

- dWfDocState

- dWfID

- dWfName

- dWfStatus

- wfStepCheckinType

- dWfStepDescription

- dWfStepID

- dWfStepIsAll

- dWfStepName

- dWfStepType

- dWfStepWeight

- dWfType

- IsWorkflow

- 文字列: DocURL (このリビジョンに関連付けられたweblayoutファイルへの完全URL)

- レスポンス・テンプレート: DOC_INFO (doc_info.htm)

次が使用

- リソース・インクルード:

- checkin_list_action_popup

- checkin_multiuploadapplet_processing_functions

- classic_doc_rev_info

- clbra_active_doc_display

- clbra_wf_doc_list

- dam_result_table_content_row

- doc_info_action_image

- docinfo_page_title

- doc_rev_info

- doc_revisions_table

- email_docinfo_body_by_id

- email_docinfo_body_by_name

- legacy_basic_subscriptions_table

- legacy_checked_out_content_table

- legacy_expired_content_table

- legacy_work_in_progress_table

- my_view_result_table_cells

- searchapi_result_doc_href_start

- searchapi_result_table_content_end

- search_result_info_button

- search_results_action_popup

- setup_checked_out_content_action_popups

- setup_search_results_action_popups

- setup_subscription_action_popups

- setup_work_in_progress_action_popups

- slim_result_table_content_row

- subscription_action_popup

- trays_search_result_section

- wf_in_queue_display

- wf_reviewer_mail_link

- wips_list_action_popup

- テンプレート:

- CHECKIN_CONFIRM (checkin_confirm.htm)

- DOCUMENT_PROBLEMREPORTS (doc_problemreports.htm)

- DOC_SUB_LIST (doc_sub_list.htm)

- PR_CONTRIBUTOR_MAIL (pr_contributor_mail.htm)

- PROBLEMREPORT_INFO (pr_info.htm)

- QUERY_NOTIFICATION (query_notification_mail.htm)

- SUBSCRIPTION_MAIL (subscription_mail.htm)

- WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

- WORKFLOW_REVIEW_FRAMES (workflow_review_frames.htm)

- その他:

- LC変数のリンク: wwCommentOnRevision

- SoapCustom:Wsdl:DocInfo:Services

- SoapCustom:Wsdl:DocInfo:Service:DocInfoByID:ResponseParams

- SoapCustom:Wsdl:DocInfo:Service:DocInfoByName:ResponseParams

- SoapCustom:Wsdl:GetFile:Service:GetFileByID:ResponseParams

- リダイレクト・サービスの対象:

- DELETE_REV

- RESUBMIT_FOR_CONVERSION

- SUBSCRIBE

- UNDO_CHECKOUT

- UNSUBSCRIBE

- UPDATE_DOCINFO_BYFORM

例

IdcService=DOC_INFO
dID=54321

4.3.37 DOC_INFO_BY_NAME

DOC_INFOサービスによって必要とされるリビジョン固有のdIDパラメータではないパラメータとしてコンテンツID (dDocName)に基づいたコンテンツ・アイテムの最新リビジョンに関する情報を取得するサービス。RevisionSelectionMethodパラメータは、固有のリビジョンに関する情報を返すため、specificに設定できます。

デフォルトで、このサービスは、リリースされるかどうかにかかわらず、最新リビジョンの情報を返します。あるアイテムはワークフロー外となるまでリリースされません。指定されたリビジョンに対して返される結果は、DOC_INFOサービスの結果と同じです。

アクセス・レベル: 読取り、スクリプト作成可能(33)

実行される問合せ:

- QdocInfo

- QdocFormats

- QisSubscribed

- QrevHistory

- QlatestIDByName (RevisionSelectionMethodが空であるかまたは「最新」である場合)

- QlatestReleasedIDByName (RevisionSelectionMethodが「LatestReleased」である場合)

場所: IdcHomeDir/resources/core/tables/std_services.htm

重要:

コンテンツ・アイテム名(dDocName)が指定されるか、またはRevisionSelectionMethodパラメータを持つコンテンツID(dDocName)が指定される必要があります。

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテム名。

オプションのサービス・パラメータ

- RevisionSelectionMethod: 最新のバージョンを取得するにはLatest、最新のリリース・バージョンを取得するにはLatestReleasedまたはSpecific (Specificに設定する場合、dIDを指定する必要があります)に設定できます。Specificに設定された場合、特定のバージョンをポイントするため、dDocNameではなくdIDを使用できます。

結果

- ResultSets:

- DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- REVISION_HISTORY(すべての非削除リビジョンのdFormat、dInDate、dOutDate、dStatus、dProcessingState、dRevLabel、dID、dDocName、dRevisionID)

- アイテムがワークフロー内にある場合: WF_INFO(指定されたリビジョンのWorkflowsおよびWorkflowDocumentsからのすべてのフィールド)

- ローカル・データ:

- Content Server:

- AuthorAddress

- dDocFormats

- dDocTitle

- dID

- DocUrl

- dStatus

- dSubscriptionAlias

- dSubscriptionID

- dSubscriptionType

- dUser

- アイテムがワークフロー内にある場合:

- dWfStatus

- dWfCurrentStepID

- dWfDocState

- dWfID

- dWfName

- dWfStepDescription

- dWfStepID

- dWfStepIsAll

- dWfStepName

- dWfStepType

- dWfStepWeight

- dWfType

- IsWorkflow

- wfStepCheckinType

- レスポンス・テンプレート: DOC_INFO (doc_info.htm)

次が使用

- リソース・インクルード:

- email_docinfo_body_by_id

- email_docinfo_body_by_name

- setup_workflow_action_popups

- workflow_action_popup

- テンプレート: PR_PUBLISHER_MAIL (pr_publisher_mail.htm)

- その他: SoapCustom:Wsdl:DocInfo:Services

4.3.38 DOC_INFO_LATESTRELEASE

リリースされたコンテンツ・アイテムの最新のリビジョンのみの情報を取得するサービス。コンテンツ・アイテムにリリース・バージョンがない場合、このサービスは対応するStatusMessage値とともに、StatusCode -1を返します。DOC_INFO結果セット(リビジョン、ワークフロー、またはサブスクリプション情報なし)のみを返します。テンプレートがないため、生データのみを返します。

最も発生しがちなエラーは、そのコンテンツ・アイテムがすでにシステムに存在していないか、ユーザーがこのアクションを実行するためのセキュリティ・レベルを持っていないことです。

アクセス・レベル: 読取り、スクリプト作成可能(33)

実行される問合せ: QlatestReleasedIDByName、QdocInfo

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのドキュメント名。

結果

- ResultSets: DOC_INFO(リリースされた最新リビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- ローカル・データ:

- AuthorAddress

- dDocName

- dID

- dUser

例

IdcService=DOC_INFO_LATESTRELEASE
dDocName=PublicDoc1_ia3c488971

4.3.39 DOC_INFO_SIMPLE

ワークフローまたはサブスクリプション情報なしに特定のコンテンツ・アイテムに関する情報を返すサービス。Documents表およびRevisions表からの特定のフィールドの選択肢ではないRevisions表からの行の単純なリストとしてリビジョン情報を返します。これらの相違により、このサービスは標準のDOC_INFOサービスより安価なオペレーションになります。

テンプレートがないため、生データのみを返します。

アクセス・レベル: 読取り、スクリプト作成可能(33)

実行される問合せ: QdocInfo、QdocName

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: コンテンツ・アイテムのコンテンツID。

結果

- ResultSets:

- DOC_INFO(特定のリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- DocRevisions(すべての非削除リビジョンのRevisionsからのすべてのフィールド)

- ローカル・データ:

- AuthorAddress

- dID

- dUser

4.3.40 DOC_INFO_SIMPLE_BYREV

リビジョン番号に基づいたコンテンツ・アイテムに関する情報を返すサービス。このサービスは、必須パラメータとしてコンテンツID (dDocName)とリビジョン番号(dRevLabel)の組合せを必要とする点が他のサービスと異なります。他のすべてのリビジョン固有のdoc_infoサービスにはdIDが必要です。

このサービスは、DOC_INFO結果セットを返します。DOC_INFO_SIMPLEは、リビジョン情報も返します。

アクセス・レベル: 読取り、スクリプト作成可能(33)

実行される問合せ: QdocRev、QdocInfo

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのドキュメント名。

- dRevLabel: コンテンツ・アイテムのリビジョン番号。

結果

- ResultSets:

- DOC_INFO(特定のリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- ローカル・データ:

- dUser

- dRevLabel

- dID

- AuthorAddress

- dDocName

4.3.41 DOC_SUBS_LIST

特定のサブスクリプションのコンテンツ・アイテムのリストを返すサービス。

条件ベースのサブスクリプションの場合、条件に一致するアイテムを返します。基本サブスクリプションの場合、サブスクリプションIDに一致する名前を持つアイテムを返します。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

実行される問合せ: QuserSubscription

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dSubscriptionID: サブスクリプションID。基本サブスクリプションの場合、これはコンテンツIDです。条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。

たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1が作成者であるパブリック・コンテンツ・アイテムの値はPublic,user1となります。

- dSubscriptionType: サブスクリプション・タイプ。Basicまたはカスタム名のいずれか。基本サブスクリプションの場合は、基本に設定する必要があります。

オプションのサービス・パラメータ

- dSubscriptionAlias: エイリアスまたはユーザー名を渡すために使用します。エイリアスに設定される場合、有効なエイリアスを使用する必要があります。 ユーザーに設定される場合、有効なユーザー名が必要です。無効なエイリアスまたはユーザー名が使用されると、エラーが発生します。空のままの場合、デフォルト値はユーザーで、現在のユーザー(dUser)に設定されます。

- dSubscriptionAliasType: dSubscriptionAliasの値として想定されるサービスを決定します。有効な値はエイリアスまたはユーザーです。

- unsubscribeService: ユーザーがサブスクライブ解除できるリンクを提供する(このサービスのデフォルト・テンプレートなど)「レスポンス」ページの場合、値はパラメータとして渡される必要があります。省略されると、エラーは表示されませんが、「レスポンス」ページの「サブスクライブ解除」リンクをクリックすると、エラーが生成されます(標準の値はUNSUBSCRIBEである必要があります)。

- subscribeService: ユーザーがサブスクリプションにサブスクライブされていない場合はサブスクライブするためのリンクが提供される場合を除いて、unubscribeServiceパラメータと同じ(標準の値はSUBSCRIBEである必要があります)。

- MaxQueryRow: DOCUMENT_LIST結果セットに対して返される行数を切り捨てます。

結果

- ResultSets:

- DOCUMENT_LIST: サブスクリプション条件に一致するアイテムのRevisionsおよびDocMetaからのすべてのフィールド。このデータは、ユーザーが指定されたサブスクリプションにサブスクライブされるかどうかにかかわらず返されます。

- USER_SUBSCRIPTION: 指定されたサブスクリプションをユーザー/エイリアスに割り当てる行のSubscriptionsからのすべてのフィールド。ユーザー/エイリアスが指定されたサブスクリプションにサブスクライブされていない場合、結果セットは空です。

- ローカル・データ:

- dataSource

- dSubscriptionAlias

- dSubscriptionAliasType

- dSubscriptionID

- dSubscriptionType

- dUser

- MaxQueryRows

- resultName

- scpDescription

- scpEnabled

- whereClause

- レスポンス・テンプレート: DOC_SUB_LIST (doc_sub_list.htm)

次が使用

- アプレット: リポジトリ・マネージャ

- リソース・インクルード:

- criteria_subscription_info_image

- legacy_criteria_subscriptions_table

- setup_subscription_action_popups

- subscription_action_popup

- テンプレート:

- SUBSCRIBE_FORM (subscribe_form.htm)

- UNSUBSCRIBE_FORM (unsubscribe_form.htm)

例

IdcService=DOC_SUBS_LIST
dSubscriptionType=my_subscription
dSubscriptionID=ADENG

4.3.42 EDIT_DOC_FORMATS

既存のファイル・フォーマットを変更するサービス。このサービスは、コンテンツ・アイテムのフォーマットおよびファイル拡張子情報を更新します。このサービスはInbound Refineryによってブラウザ・インタフェースで実行されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dFormat: コンテンツのWeb表示可能バージョンを作成するために使用されるフォーマット・プロセス。例: application/hcsfまたはapplication/doc.。

- dDescription: フォーマットの説明。

- dConversion: 変換アルゴリズムは、このパラメータで決定されます。

変換タイプがPassthruまたはNoConversion (デフォルト値)で、コンテンツがWeb表示可能でないか、またはパブリッシュ状態である場合、コンテンツはキューに追加されて変換されます。それ以外の場合、サーバーはWeb表示可能ファイル(該当する場合)およびボールト・ファイルを検索し、そのファイルがすでに変換されていることを伝えるために、処理状態を更新します。

ファイルのMIMEタイプがapplication/FDFである場合、サーバーは変換をexchange-fdfに設定します。

- extensions: doc、txt、pdfなどのファイル拡張子。

例

IdcService=EDIT_DOC_FORMATS
dFormat=application/msword
extensions=doc
dConversion=PASSTHRU
dDescription=adding the description

4.3.43 FORM_PROCESS

送信用のPDFフォームを処理するサービス。このサービスは、FORM_SUBMITによりコールされます。自動生成されたClientIdパラメータを使用します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

注意:

このサービスはIdcコマンドで実行することはできません。

4.3.44 FORM_SUBMIT

PDFフォームを送信するサービス。このサービスは、送信前にPDFフォームを処理するために、FORM_PROCESSサービスをコールします。

場所: IdcHomeDir/resources/core/tables/std_services.htm

注意:

このサービスはIdcコマンドで実行することはできません。

4.3.45 GET_CACHED_CHECKIN_INFO

CACHE_CHECKIN_NEWなどのキャッシュ・チェックイン用のキャッシュされたデータを表示するために使用されるサービス。このサービスはチェックアウト・コンテンツ・リストから利用できます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

4.3.46 GET_DOC_CONFIG_INFO

Content Server構成情報を返すサービス。サーバー環境フォーム外部アプリケーションのダンプを取得します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

結果

プロパティ情報、セキュリティ・グループ・オプション・リストおよびこれらのResultSetを返します。

- DOC_DEFAULT_INFO

- DocMetaDefinition

- DocTypes

- DocFormats

例

- IdcCommandコマンド・ファイル・フォーマット:

#Retrieves content item configuration information
IdcServer=GET_DOC_CONFIG_INFO

- HDA形式:

@Properties LocalData
IdcService=GET_DOC_CONFIG_INFO
@end

4.3.47 GET_DOC_SUBSCRIBERS

特定のコンテンツ・アイテムへのサブスクライバのリストを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

例

IdcService=GET_DOC_SUBSCRIBERS
dDocName=test_000036

4.3.48 GET_DOCUMENT_HISTORY_REPORT

キャッシュ・サービスおよび他の目的によって使用されるDocumentHistory表における変更を返すサービス。

サービス・クラス: DocService

場所: IdcHomeDir/resources/core/tables/std_services.htm

オプションのサービス・パラメータ

- actionDateGreaterThan: DocumentHistory表に対する問合せに使用されるODBCフォーマットのデータ。時間がわずかにずれるクラスタ・サーバーを想定して、2分が自動的にこの日付から減算されます。このパラメータは、デフォルトでは現在の時間の5分前です。

結果

- ResultSets:

- HistoryReport: 各行には、ドキュメント履歴イベントに関する情報(名前の変更、更新、移動、削除)が含まれます。

例

IdcService=GET_DOCUMENT_HISTORY_REPORT
actionDateGreaterThan={ts '2012-11-19 15:58:00.100'}

4.3.49 GET_ENVIRONMENT

Content Server環境の構成値の設定を取得するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

オプションのサービス・パラメータ

- startTime: インスタンスが起動した時間(ミリ秒単位)。

4.3.50 GET_EXPIRED

期限切れ予定のアイテムおよび期限切れアイテムのリストを取得するために使用されるサービス。オプションのisExpiredQueryパラメータをtrueに設定すると、このサービスはすでに期限切れになったアイテムのみをリストします。

このパラメータがない場合、リストにはendDateおよびstartDateによって指定される日付範囲内に期限切れになるようにスケジュールされるアイテムも含まれます。これには、開始日が現在のシステム時間よりも前の場合にすでに期限切れになっているアイテムが含まれる場合があります。

アクセス・レベル: 読取り、書込み、グローバル(18)

場所: IdcHomeDir/resources/core/tables/std_services.htm

オプションのサービス・パラメータ

- endDate: この日付よりも前に期限切れ予定のアイテムが表示されます。

- isExpiredQuery: このパラメータを1 (true)に設定すると、期限切れのアイテムのみが検索されます。trueに設定され、終了日が指定されない場合、現在のシステム時間がデフォルトの終了日として使用されます。これは、特定の開始日によって制限される場合を除き、すでに期限切れになっているコンテンツをリストします。

- 0 (false)に設定され、開始日が空の場合、現在のシステム時間がデフォルトの開始日として使用されます。これは、指定された終了日によって制限される、将来に期限切れになるコンテンツ・アイテムをリストします。

その他のすべての状況において、空の開始日または終了日は空として処理され、問合せ時に対応する制約が課されることはありません。

- startDate: この日付よりも後に期限切れ予定のアイテムが表示されます。

結果:

- 結果セット: EXPIRED_LIST(日付およびisExpiredQueryパラメータによって定義される期限切れまたは期限切れ予定のアイテムのRevisionsおよびDocMetaからのすべてのフィールド。)

- ローカル・データ:

- dataSource

- endDate

- expiredQuery

- isExpiredQuery

- isQueryResult

- MaxQueryRows

- orderClause

- resultName

- startDate

- userDefinedEndDate

- userDefinedStartDate

- whereClause

- レスポンス・テンプレート: EXPIRED_PAGE (expired_page.htm)

次が使用

- リソース・インクルード:

- pne_nav_management_links

- std_doc_man_pages

- テンプレート: EXPIRED_PAGE (expired_page.htm)

- 標準ナビゲーション: commonNav.js

4.3.51 GET_PACKAGE_ENVIRONMENT_PAGE

環境のパッケージ化を開始するページを取得するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.52 GET_UPDATE_FORM

既存のコンテンツ・アイテムの情報更新フォームを生成するために使用されるサービス。

最も発生しがちなエラーは、コンテンツ・アイテムの名前がシステムに存在しないことです。

アクセス・レベル: 書込み、スクリプト作成可能(34)

実行される問合せ: QdocInfo

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

結果

- ResultSets:

- DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- DocFormats (DocFormatsデータベース表のすべての行およびフィールド)

- DocTypes (DocTypesデータベース表のすべての行およびフィールド)

- ローカル・データ:

- dDocAccount

- dDocName

- dDocType

- defaultAccount

- dID

- dSecurityGroup

- dUser

- レスポンス・テンプレート: UPDATE_DOC_INFO (update_docinfo.htm)

例

IdcService=GET_UPDATE_FORM
dID=59

4.3.53 NOTIFY_INDEXER

作業が実行されることをインデクサに通知するために使用されるサービス。このサービスは、通常はチェックインがインデクサに通知するか、またはインデクサが独自のタイマーを持っていて、5分ごとに「すべき作業」を確認するため、使用されません。

このサービスは、NO_NOTIFYチェックインが実行されているか、クライアント・アプリケーションが通常の索引作成サイクルを待機しない場合にのみ使用される必要があります。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.54 ODMA_DOC_INFO_SIMPLE

指定されたコンテンツ・アイテムに対するコンテンツ情報を取得するためにODMAクライアント・アプリケーションによって使用されるサービス。

このサービスは現在使用されていません。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: アイテム・リビジョンの一意のID。

4.3.55 PACKAGE_ENVIRONMENT

Content Server環境ファイルを含むパッケージ化されたzipファイルを作成するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.56 REMOVE_METAFILE_SUB

ドキュメント・メタ情報を変更するためにコールされるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.57 REPLACE_METAFILE_SUB

ドキュメント・メタ情報を置き換えるためにコールされるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.58 RESTORE_REVISION

新しい(最新)リビジョンとして指定されたdIDに対応するドキュメントのリビジョンをリストアするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

必須のサービス・パラメータ

- dID: 最新リビジョンとしてリストアするアイテムのドキュメントID。

結果

- dID: 作成された新しいリビジョンのID。

- dDocName: 作成された新しいリビジョンのドキュメント名。

- dDocTitle: 作成された新しいリビジョンのドキュメントのタイトル。

4.3.59 RESUBMIT_FOR_CONVERSION

初期変換試行に失敗した場合に、変換用にコンテンツ・アイテムを再送信するサービス。最も発生しがちなエラーは、そのコンテンツ・アイテムがすでにシステムに存在していないか、ユーザーがこのアクションを実行するためのセキュリティ・レベルを持っていないことです。

このサービスは、成功した変換と失敗した変換を再送信できます。

アクセス・レベル: 書込み(2)

実行される問合せ: QdocInfo、QlatestID、Qdocuments

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

オプションのサービス・パラメータ

- RedirectUrl: リダイレクトされたサービスに使用されるURL。

- AlwaysResubmit: 1 (true)に設定されると、このサービスは正常に変換されたアイテムで使用できます。それ以外の場合は、このサービスは失敗した変換でのみ操作を行います。

結果

- ローカル・データ:

- dConversion

- dCurRevID

- dDocID

- dExtension

- dFileSize

- dFormat

- dID

- dOriginalName

- dProcessingState

- dPublishState

- dRawDocID

- dReleaseState

- dRevClassID

- dStatus

- dWorkflowState

- IsNotLatestRev

- isStatusChanged

- prevReleaseState

- RedirectParams

- VaultfilePath

- WebfilePath

- wfAction

- レスポンス・テンプレート:

- REDIRECT_TEMPLATE (redirect_template.htm)

- デフォルトのリダイレクト・サービス: DOC_INFO

次が使用

- アプレット: リポジトリ・マネージャ

- リソース・インクルード:

- classic_info_page_content

- docinfo_resubmit_option

- std_docinfo_error_msg

例

IdcService=RESUBMIT_FOR_CONVERSION
dID=62

4.3.60 REV_HISTORY

コンテンツ・アイテムのリビジョンに対するリビジョン履歴を返すサービス。

アクセス・レベル: 読取り、スクリプト作成可能(33)

実行される問合せ: QdocInfo、QrevHistoryReleased

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

結果

- ResultSets:

- DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- REVISIONS(次のフィールドを含むすべてのアイテムのリリース済リビジョンをリストする行: dDocAccount、dDocName、dDocType、dFormat, dID、dInDate、dProcessingState、dReleaseState、dRevLabel、dRevisionID、dSecurityGroup、dStatus、dWebExtension)

- ローカル・データ: dID

- レスポンス・テンプレート: REV_HISTORY (rev_history.htm)

次が使用

- リソース・インクルード:

- classic_search_result_item_revision

- searchapi_result_table_content_end

例

IdcService=REV_HISTORY
dID=62

4.3.61 SELECTDOC

コンテンツ・アイテム情報を返し、ODMAを使用してコンテンツ・アイテムを選択するときにユーザーのセキュリティ・レベルを評価するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

例

IdcService=SELECTDOC
dID=62

4.3.62 SUBMIT_HTML_FORM

処理のためにHCSPまたはHCSFフォームを送信するサービス。これらはHTMLベースのビジネス・フォームを処理するために使用される動的サーバー・ページです。このサービスはintradoc.server.FormHandler.retrieveHtmlFormState()メソッドからJavaコードでコールされる、GET_FILEサブサービスをコールします。

通常、HTMLフォームを送信するために、自動コンテンツID機能が有効にされています。有効ではない場合、送信されたフォームごとに一意のコンテンツIDを割り当てる必要があります。

最も発生しがちなエラーは、HTMLフォームが存在しないことです。

アクセス・レベル: 書込み(2)

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。指定されたリビジョンはHTMLフォームである必要があります。

オプションのサービス・パラメータ

- RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。

- isFormFinished: HCSPファイルで使用。これが1 (true)に設定される場合、HCSPを再送信できません。

- テキスト・フィールド: フォームのテキスト・フィールドをオプション・パラメータとして送信し、そのフィールドに値を渡すことができます。フォームがProductと呼ばれるテキスト・フィールドを持つ場合、文字列値publisherをそのフィールド(Product=publisher)に割り当てることができます。

結果

- ResultSets:

- DocTypes

- DocFormats

- ローカル・データ:

- dDocTitle

- dID

- レスポンス・テンプレート:

- null

- デフォルトのリダイレクト・サーバー(GET_DOC_PAGE: HOME_PAGE)

次が使用

- リソース・インクルード: std_html_form_submit_start

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=SUBMIT_HTML_FORM
dID=44

- オプションのパラメータを持つHDA形式(値をテキスト・フィールドに割り当てます)。

@Properties LocalData
IdcService=SUBMIT_HTML_FORM
dID=44
Product=publisher
@end

4.3.63 SUBSCRIBE

コンテンツ・アイテムまたはアイテムのグループにユーザーをサブスクライブするサービス。最も発生しがちなエラーは、そのコンテンツ・アイテムがすでにシステムに存在していないか、ユーザーがこのアクションを実行するためのセキュリティ・レベルを持っていないことです。サブスクリプションを作成するために、認証が必要であることに注意してください。

アクセス・レベル: 読取り(1)

実行される問合せ:

- QdocInfo

- QuserSubscription

- Quser

- UuserEmail

- Isubscription

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dSubscriptionEmail: サブスクリプションの電子メール・アドレス。このサービスは、ユーザー・プロファイルでユーザーの電子メールをオーバーライドするための値を使用します。値がこのパラメータに対して渡されない場合、プロファイルは更新されません。本質的に、このサービスが実行されるたびに、ユーザーの電子メール・アドレスが更新されます。

- dSubscriptionType: サブスクリプションのタイプ。オプションでカスタム・サブスクリプションの名前を提供できます。このパラメータが使用される場合、このサービスは指定されたカスタム・サブスクリプションの条件フィールドがdIDパラメータから指定されたアイテムの対応するメタデータの値に一致する条件ベースのサブスクリプションにユーザーをサブスクライブします。dSubscriptionTypeが空白のままの場合、「基本」サブスクリプションがデフォルトで使用されます。

オプションのサービス・パラメータ

- RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。

結果

- ローカル・データ:

- dID

- dName

- dSubscriptionAlias

- dSubscriptionAliasType

- dSubscriptionCreateDate

- dSubscriptionID

- dSubscriptionType

- dUser

- レスポンス・テンプレート:

- DOC_INFO

- デフォルトのリダイレクト・サービス: DOC_INFO

次が使用

- リソース・インクルード:

- docinfo_subscription_form

- doc_subscription_unsubscription

- その他: SoapCustom:Wsdl:Subscription:Services

例

これらのパラメータは、このコマンドを実行するために、ブラウザ環境で渡されます。

<input type=hidden name=IdcService value="SUBSCRIBE">
<input type=hidden name=dID value="63">
<input type=hidden name=dSubscriptionType value=my_subscription>
<input type=hidden name=dSubscriptionEmail value=sysadmin@example.com>

4.3.64 SUBSCRIBE_DOC_USER

ユーザーがコンテンツ・アイテムをサブスクライブする(サブスクリプション・ページを構築する)際にブラウザ環境で使用されるサービス。

このサービスは、ユーザーがドキュメントをサブスクライブする(検索を実行し、「サブスクライブ」をクリックする)と実行されます。システムに複数のサブスクリプション・タイプがある場合、ユーザーは異なる条件をサブスクライブできる「サブスクリプション」ページにリダイレクトされます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

注意:

ユーザーがコンテンツ・アイテムをサブスクライブする際に追加のパラメータが渡されます(次の例を参照してください)。

例

これらのパラメータは、このコマンドを実行するために、ブラウザ環境で渡されます。

<form name=SubscriptionForm action="/cs/idcplg"method="GET"">
<input type=hidden name=dID value="63">
<input type=hidden name=dDocName value="test_000045">
<input type=hidden name=IdcService value="SUBSCRIBE_DOC_USER">
<input type=hidden name=subscribeService value=SUBSCRIBE>
<input type=hidden name=exitUrl value="/cs/idcplg?IdcService=DOC_INFO&dID=63&dDocName=test_000045">
<input type=hidden name=title value="Subscriptions">
<input type=hidden name=unsubscribeService value=UNSUBSCRIBE>
<input type=submit value="Subscriptions">
</form>

4.3.65 SUBSCRIBE_EX

サブスクリプションにユーザーまたはエイリアスを追加するためにリポジトリ・マネージャで使用されるサービス。このタイプをサブスクライブしたユーザーおよびエイリアスのリストを返します。最も発生しがちなエラーは、指定されたサブスクリプションのエイリアス・タイプまたはサブスクリプションのエイリアスが存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dSubscriptionAlias: サブスクリプションのエイリアス。

- dSubscriptionAliasType: ユーザーのタイプ。この値はuserまたはaliasを指定できます。この値はdSubscriptionAliasで定義された値を参照します。

- dSubscriptionEmail: サブスクリプションの電子メール・アドレス。

- dSubscriptionID: サブスクリプションID。

- 基本サブスクリプションの場合、これはコンテンツIDです。

- 条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。

たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1 が作成者であるPublicコンテンツ・アイテムのdSubscriptionIDパラメータ値は Public,user1となります。

- dSubscriptionType: アプレットで定義されているサブスクリプション・タイプの名前。サブスクリプション・タイプはフィールドのリストで構成されます。サブスクリプション・タイプをサブスクライブする場合、ユーザーはサブスクリプション・タイプを構成する各フィールドの値を指定する必要があります。

オプションのサービス・パラメータ

サブスクライブしているユーザーに関する情報を返すには、このサービスには次のパラメータが必要です。

- dataSource: データソース。

- resultName: ResultSet名。

- whereClause: プログラム句。

例

IdcService=SUBSCRIBE_EX
dSubscriptionID=user20
dSubscriptionAlias=sysadmin
dSubscriptionAliasType=user
dSubscriptionType=test
dSubscriptionEmail=user20@example.com
resultName=USER_LIST
dataSource=Subscriptions
whereClause=dSubscriptionType='test'

4.3.66 SUBSCRIBE_FORM

コンテンツ・アイテム・サブスクリプションに使用されるサブスクリプション・フォームを取得するサービス。

このサービスは、それが返すテンプレートを除いて、UNSUBSCRIBE_FORMサービスと同じです。

アクセス・レベル: 読取り(1)

実行される問合せ: QdocInfo, QSubscribed

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- unsubscribeService: ユーザーがサブスクライブ解除できるリンクを提供する(このサービスのデフォルト・テンプレートなど)「レスポンス」ページの場合、値はパラメータとして渡される必要があります。省略されると、エラーは表示されませんが、「レスポンス」ページの「サブスクライブ解除」リンクをクリックすると、エラーが生成されます(標準の値はUNSUBSCRIBEである必要があります)。

- subscribeService: ユーザーがサブスクリプションにサブスクライブされていない場合はサブスクライブするためのリンクが提供される場合を除いて、unubscribeServiceパラメータと同じ(標準の値はSUBSCRIBEである必要があります)。

結果

- ResultSets:

- DOC_INFO (dIDで指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- SUBSCRIPTION_LIST (Subscription表からのすべてのフィールドおよびすべての定義されたサブスクリプションの追加フィールド(scpFields、scpDescription、scpEnabledおよびnotSubscribed))

- ローカル・データ:

- dID

- dSubscriptionAlias

- dSubscriptionID

- dSubscriptionType

- dUser

- レスポンス・テンプレート: SUBSCRIBE_FORM (subscribe_form.htm)

次が使用

- リソース・インクルード:

- docinfo_subscription_form

- doc_subscription_unsubscription

4.3.67 SUBSCRIPTION_LIST

特定のユーザーのためのすべてのサブスクライブ済コンテンツ・アイテムのリストを返すサービス。

ユーザーがサブスクリプションを持つエイリアスに属している場合にも、このサービスによってエイリアス・ベースのサブスクリプションは返されません。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

実行される問合せ: QdocNameSubscription、QnotDocNameSubscriptions

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dUser: 現在ログインしているユーザーのユーザー名。

結果

- ResultSets: SUBSCRIPTION_LIST(各行には、各現在のユーザーのサブスクリプションに対応するSubscription表からのすべてのフィールドが含まれます。また、基本サブスクリプションの場合、各行には、サブスクライブされたアイテムの最新リビジョンのSubscription表(メタデータ)からのすべてのフィールドが含まれます。)

- ローカル・データ: dUser

- レスポンス・テンプレート: SUBSCRIPTION_LIST (subscription_list.htm)

次が使用

- リソース・インクルード: pne_nav_userprofile_links

- テンプレート:

- DOC_SUB_LIST (doc_sub_list.htm)

- USER_INFO (user_info.htm)

- 標準ナビゲーション: commonNav.js

- その他:

- SoapCustom:Wsdl:Subscription:Services

- SoapCustom:Wsdl:Subscription:Service:SubscriptionList:ResponseParams

- リダイレクト・サービスの対象: UNSUBSCRIBE_FROM_LIST

例

IdcService=SUBSCRIPTION_LIST
dUser=sysadmin

4.3.68 UNDO_CHECKOUT

ブラウザからコンテンツ・アイテムのチェックアウトを基に戻すサービス。コンテンツ・アイテムがシステムに存在しない場合、コンテンツ・アイテムがチェックアウトされていない場合、またはチェックアウトを元に戻すのに十分な権限がユーザーにない場合、サービスは失敗します。

アクセス・レベル: 書込み(2)

- 実行される問合せ:

- QdocID

- Qrevisions

- QdocInfo

- IdocHistory

- QdocWebFormat

- Uuncheckout

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

オプションのサービス・パラメータ

- RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。

結果

- ローカル・データ:

- CurRevCheckoutUser

- CurRevID

- CurRevIsCheckedOut

- dAction

- dCheckoutUser

- dClbraName

- dDocAccount

- dDocName

- dID

- dIsCheckedOut

- dReleaseState

- dRevClassID

- dRevLabel

- dSecurityGroup

- dStatus

- dUser

- isFinished

- IsWorkflow

- latestID

- noDocLock

- prevReleaseState

- wfAction

- レスポンス・テンプレート:

- REDIRECT_TEMPLATE (redirect_template.htm)

- デフォルトのリダイレクト・サービス: GET_PORTAL_PAGE (Page=WF_INQUEUE_LIST)

次が使用

- アプレット:

- リポジトリ・マネージャ

- ワークフロー

- リソース・インクルード:

- checkin_list_action_popup

- doc_file_checkout

- docinfo_undo_checkout_form

- setup_checked_out_content_action_popups

- setup_workflow_action_popups

- wf_reviewer_doc_action_links

- workflow_action_popup

- テンプレート: WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

- その他: SoapCustom:Wsdl:CheckIn:Services

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=UNDO_CHECKOUT
dID=44

- HDA形式:

@Properties LocalData
IdcService=UNDO_CHECKOUT
dID=44
@end

4.3.69 UNDO_CHECKOUT_BY_NAME

アプレットまたはアプリケーションからコンテンツ・アイテムのチェックアウトを元に戻すサービス。コンテンツ・アイテムがシステムに存在しない場合、コンテンツ・アイテムがチェックアウトされていない場合、またはチェックアウトを元に戻すのに十分な権限がユーザーにない場合、サービスは失敗します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

オプションのサービス・パラメータ

- dDocTitle: コンテンツ・アイテムのタイトル。

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=UNDO_CHECKOUT_BY_NAME
dDocName=myDocument

- 任意のパラメータを持つHDA形式:

@Properties LocalData
IdcService=UNDO_CHECKOUT_BY_NAME
dDocName=myDocument
dDocTitle=Just a title
@end

4.3.70 UNSUBSCRIBE

基本サブスクリプションが定義されている場合にのみコンテンツ・アイテムのサブスクリプションを取り消すサービス。このサービスは、「コンテンツ情報」ページの「サブスクライブ解除」ボタンをクリックすることにより実行されます。

このサービスは、主にそれが返すデータ内容においてUNSUBSCRIBE_FROM_LISTサービスとは異なります。UNSUBSCRIBEは、dIDで指定されたアイテムのコンテンツ情報をロードするように、デフォルトで「コンテンツ情報」ページにリダイレクトします。UNSUBSCRIBE_FROM_LISTは、ユーザーのサブスクリプションを表示するために必要なデータをロードするように、デフォルトでサブスクリプション・リストのページにリダイレクトします。

アクセス・レベル: 読取り(1)

実行される問合せ: QdocInfo、Dsubscription

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dSubscriptionID: サブスクリプションID。

- 基本サブスクリプションの場合、これはコンテンツIDです。

- 条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。

たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1 が作成者であるPublicコンテンツ・アイテムのdSubscriptionIDパラメータ設定は Public,user1となります。

- dSubscriptionType: サブスクリプションのタイプ。

オプションのサービス・パラメータ

- RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。

- dSubscriptionAlias: 条件サブスクリプションのユーザーまたはエイリアス(dSubscriptionAliasTypeの値によって、有効なユーザー名またはエイリアスに設定されます)。

- dSubscriptionAliasType: サブスクリプション・タイプのエイリアス。有効な値はuserまたはaliasです。

現在のユーザーに管理者権限がある場合は、dSubscriptionAliasTypeとともにdSubscriptionAliasパラメータを使用して、サブスクリプションから別のユーザーまたはエイリアスをサブスクライブ解除できます。これらのパラメータが省略される場合、このサービスはデフォルトでuserのdSubscriptionAliasTypeに設定され、dSubscriptionAliasの値に現在のユーザー(dUser)を使用します。これらのパラメータが含まれるが、現在のユーザーに管理者権限がない場合、これらは無視されます。

結果

- ローカル・データ:

- dCheckoutUser

- dDocAccount

- dDocName

- dID

- dRevClassID

- dSecurityGroup

- dUser

- レスポンス・テンプレート:

- DOC_INFO

- デフォルトのリダイレクト・サービス: DOC_INFO

次が使用

- リソース・インクルード:

- docinfo_subscription_form

- doc_subscription_unsubscription

- その他: SoapCustom:Wsdl:Subscription:Services

例

IdcService=UNSUBSCRIBE
dID=66
dSubscriptionType=test
dSubscriptionID=test_000048

4.3.71 UNSUBSCRIBE_FORM

コンテンツ・アイテムからサブスクライブ解除する場合に使用されるフォームを取得するサービス。

このサービスは、それが返すテンプレートを除いて、SUBSCRIBE_FORMサービスと同じです。

アクセス・レベル: 読取り(1)

実行される問合せ: QdocInfo、QisSubscribed

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- subscribeService: ユーザーにサブスクライブ解除できるリンクを提供する(このサービスのデフォルト・テンプレートなど)「レスポンス」ページの場合、値はパラメータとして渡される必要があります。省略されると、エラーは表示されませんが、「レスポンス」ページの「サブスクライブ解除」リンクをクリックすると、エラーが生成されます(標準の値はUNSUBSCRIBEである必要があります)。

結果

- ResultSets:

- DOC_INFO (dIDで指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- SUBSCRIPTION_LIST (Subscription表からのすべてのフィールドおよびすべての定義されたサブスクリプションの追加フィールド(scpFields、scpDescription、scpEnabledおよびnotSubscribed))

- ローカル・データ:

- dID

- dSubscriptionAlias

- dSubscriptionID

- dSubscriptionType

- dUser

- レスポンス・テンプレート: UNSUBSCRIBE_FORM (unsubscribe_form.htm)

次が使用

- リソース・インクルード:

- docinfo_subscription_form

- doc_subscription_unsubscription

4.3.72 UNSUBSCRIBE_FROM_LIST

複数のサブスクリプションが定義されている場合に、ブラウザからコンテンツ・アイテムのサブスクリプションを取り消すサービス。

このサービスは、「サブスクライブ解除」リンクをクリックするか、そのコンテンツ・アイテムの「サブスクリプション情報」リンクをクリックしてから「サブスクリプション情報」ページの「サブスクライブ解除」をクリックすることにより、「サブスクリプション」ページから実行されます。

このサービスは、主にそれが返すデータ内容においてUNSUBSCRIBEサービスとは異なります。UNSUBSCRIBE_FROM_LISTは、ユーザーのサブスクリプションを表示するために必要なデータをロードするように、デフォルトでサブスクリプション・リストのページにリダイレクトします。UNSUBSCRIBEは、dIDで指定されたアイテムのコンテンツ情報をロードするように、デフォルトで「コンテンツ情報」ページにリダイレクトします。

アクセス・レベル: 読取り、グローバル(17)

実行される問合せ:

- Dsubscription

- QdocNameSubscription

- QnotDocNameSubscriptions

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dSubscriptionID: サブスクリプションID。基本サブスクリプションの場合、これはコンテンツIDです。条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。

たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1 が作成者であるPublicコンテンツ・アイテムのdSubscriptionIDパラメータ設定は Public,user1となります。

- dSubscriptionType: サブスクリプションのタイプ。

- オプションのサービス・パラメータ

- RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。

- dSubscriptionAlias: dSubscriptionAliasTypeの値によって、有効なユーザー名またはエイリアスに設定される、条件サブスクリプションのユーザーエイリアス。

- dSubscriptionAliasType: userまたはaliasに設定される、サブスクリプション・タイプのエイリアス。

- 現在のユーザーに管理者権限がある場合は、dSubscriptionAliasTypeとともにdSubscriptionAliasパラメータを使用して、サブスクリプションから別のユーザーまたはエイリアスをサブスクライブ解除できます。これらのパラメータが省略される場合、このサービスはデフォルトでuserのdSubscriptionAliasTypeに設定され、dSubscriptionAliasの値に現在のユーザー(dUser)を使用します。これらのパラメータが含まれるが、現在のユーザーに管理者権限がない場合、これらは無視されます。

結果

- ResultSets: SUBSCRIPTION_LIST.各行には、各現在のユーザーのサブスクリプションに対応するSubscription表からのすべてのフィールドが含まれます。また、基本サブスクリプションの場合、各行には、サブスクライブされたアイテムの最新リビジョンのSubscription表(メタデータ)からのすべてのフィールドが含まれます。

- ローカル・データ:

- dID

- dSubscriptionAlias

- dSubscriptionAliasType

- dUser

- レスポンス・テンプレート:

- SUBSCRIPTION_LIST

- デフォルトのリダイレクト・サービス: SUBSCRIPTION_LIST

次が使用

- アプレット: リポジトリ・マネージャ

- リソース・インクルード: pne_nav_userprofile_links

- テンプレート:

- DOC_SUB_LIST (doc_sub_list.htm)

- USER_INFO (user_info.htm)

- 標準ナビゲーション: commonNav.js

例

IdcService=UNSUBSCRIBE_FROM_LIST
dSubscriptionType=test
dSubscriptionID=test_000046

4.3.73 UNSUBSCRIBE_FROM_LIST_EX

サブスクリプション・タイプからユーザーまたはエイリアスを削除するために「リポジトリ・マネージャ」アプレットで使用されるサービス。ユーザーまたはエイリアスの追加の詳細は、「SUBSCRIBE_EX」を参照してください。

このサービスは通常、「リポジトリ・マネージャ」アプレットのサブスクリプションからユーザーを削除することにより実行されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dSubscriptionAlias: アプレットで定義されているサブスクリプション・タイプの名前。

- dSubscriptionAliasType: ユーザーのタイプ。この値はuserまたはaliasを指定できます。この値はdSubscriptionAliasで定義された値を参照します。

- dSubscriptionID: サブスクリプションID。

- 基本サブスクリプションの場合、これはコンテンツIDです。

- 条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。

たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1 が作成者であるPublicコンテンツ・アイテムのdSubscriptionIDパラメータ設定は Public,user1となります。

- dSubscriptionType: サブスクリプションのタイプ。

オプションのサービス・パラメータ

サブスクライブしているユーザーに関する情報を返すには、このサービスには次のパラメータが必要です。

- dataSource: データソース。

- resultName: ResultSet名。

- whereClause: プログラム句。

例

sysadminによってチェックインされるコンテンツからuser20をサブスクライブ解除します。

IdcService=UNSUBSCRIBE_FROM_LIST_EX
dSubscriptionID=sysadmin
dSubscriptionAlias=user20
dSubscriptionAliasType=user
dSubscriptionType=test
dSubscriptionEmail=sysadmin@example.com
resultName=USER_LIST
dataSource=Subscriptions
whereClause=dSubscriptionType='test'

4.3.74 UPDATE_BYREV

特定のパラメータに基づいてコンテンツ・アイテムをチェックインするために使用されるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.75 UPDATE_DOCINFO

アプレットまたはアプリケーションからコンテンツ・アイテムのメタデータを更新するサービス。このサービスは、リポジトリ・マネージャによって使用され、UPDATE_DOCINFO_SUBサブサービスを実行します。

このサービスは、テンプレートを表示するためにリダイレクトするオプションを提供する、UPDATE_DOCINFO_BYFORMサービスとは異なります。UPDATE_DOCINFOは表示オプションを提供しません。

アクセス・レベル: 書込み(2)

サブサービスのコール:

- UPDATE_DOCINFO_SUB。このサブサービスでは、REMOVE_METAFILE_SUB、REPLACE_METAFILE_SUBおよびUPDATE_DOCINFO_STATUSをコールすることも可能です。

実行される問合せ(サブサービス内で実行されるすべての問合せ):

- QdocInfo

- QlatestID

- Qdocuments

- Ddocument

- Idocument

- Urevision2

- Umeta

- IdocHistory

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

- dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。

オプションのサービス・パラメータ

- メタデータ・フィールド: メタデータ・フィールドをオプション・パラメータとして送信し、そのフィールドに値を渡すことができます。

- SkipIndexingForUpdate: trueに設定されると、コンテンツ・アイテムは更新の一環として索引付けされません。(アイテムが更新後に再度索引付けされる通常の動作。)いずれの場合も、コンテンツ・アイテムは全索引の再構築において、索引付けされません。

結果

- ローカル・データ:

- Content Server:

- dAction

- dActionDate

- dClbraName

- dCreateDate

- dDocAccount

- dDocType

- dDocName

- dExtension

- dID

- dOriginalName

- dOutDate

- dpAction

- dpEvent

- dPublishState

- dPublishType

- dReleaseState

- dRevClassID

- dRevLabel

- dSecurityGroup

- dStatus

- dUser

- isCurRevEmpty

- isDocProfileUsed

- isEditMode

- IsNotLatestRev

- IsUpdate

- IsUpdateMetaOnly

- prevReleaseState

- updateSideEffectServices

- ワークフロー:

- dCurRevID

- dWfComputed

- dWfCurrentStepID

- dWfDirectory

- dWfDocState

- dWfID

- dWfName

- dWfStatus

- dWfStepDescription

- dWfStepID

- dWfStepIsAll

- dWfStepName

- dWfStepType

- dWfStepWeight

- dWfType

- dWorkflowState

- IsWorkflow

- wfAction

- wfCurrentStepPrefix

- wfEditFinished

- wfMessage

- wfQueueActionState

- wfStepCheckinType

- およびすべてのカスタム・ドキュメント・メタフィールド

- レスポンス・テンプレート: null

次が使用

- アプレット: リポジトリ・マネージャ

- その他: SoapCustom:Wsdl:CheckIn:Services

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=UPDATE_DOCINFO
dID=66
dDocName=test_000048
dSecurityGroup=Secure
dRevLabel=2

- 追加およびオプションのパラメータを持つHDA形式(値をメタデータ・フィールドに割り当てます)。

@Properties LocalData
IdcService=UPDATE_DOCINFO
dID=66
dDocName=test_000048
dSecurityGroup=Secure
dRevLabel=2
dDocAccount=mainaccount
xComments=Preliminary
@end

4.3.76 UPDATE_DOCINFO_BYFORM

ブラウザからコンテンツ・アイテムのコンテンツ情報を更新するサービス。このサービスはUPDATE_DOCINFO_SUBサブサービスを実行します。このサブサービスはコンテンツ・アイテム情報を更新します。

このサービスとUPDATE_DOCINFO間の相違は、このサービスはテンプレートを表示するためにリダイレクトするオプションを提供することです。

アクセス・レベル: 書込み(2)

サブサービスのコール:

- UPDATE_DOCINFO_SUBは、REMOVE_METAFILE_SUB、REPLACE_METAFILE_SUBおよびUPDATE_DOCINFO_STATUSもコールできます。

実行される問合せ(サブサービス内で実行されるすべての問合せ):

- QdocInfo

- QlatestID

- Qdocuments

- Ddocument

- Idocument

- Urevision2

- Umeta

- IdocHistory

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

- dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。

オプションのサービス・パラメータ

- メタデータ・フィールド: メタデータ・フィールドをオプション・パラメータとして送信し、そのフィールドに値を渡すことができます。たとえば、システムがxCommentsと呼ばれるメタデータ・フィールドを持つ場合、文字列値Preliminaryをそのフィールド(xComments=Preliminary)に割り当てることができます。

- RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。

結果

- ローカル・データ:

- Content Server:

- dAction

- dActionDate

- dClbraName

- dCreateDate

- dDocAccount

- dDocName

- dDocType

- dExtension

- dID

- dOriginalName

- dOutDate

- dpAction

- dpEvent

- dPublishState

- dPublishType

- dReleaseState

- dRevClassID

- dRevLabel

- dSecurityGroup

- dStatus

- dUser

- isCurRevEmpty

- isDocProfileUsed

- isEditMode

- IsNotLatestRev

- IsUpdate

- IsUpdateMetaOnly

- prevReleaseState

- updateSideEffectServices

- ワークフロー:

- dCurRevID

- dWfComputed

- dWfCurrentStepID

- dWfDirectory

- dWfDocState

- dWfID

- dWfName

- dWfStatus

- dWfStepDescription

- dWfStepID

- dWfStepIsAll

- dWfStepName

- dWfStepType

- dWfStepWeight

- dWfType

- dWorkflowState

- IsWorkflow

- wfAction

- wfCurrentStepPrefix

- wfEditFinished

- wfMessage

- wfQueueActionState

- wfStepCheckinType

- およびすべてのカスタム・ドキュメント・メタフィールド

- レスポンス・テンプレート:

- REDIRECT_TEMPLATE (redirect_template.htm)

- デフォルトのリダイレクト・サービス: DOC_INFO

次が使用

- リソース・インクルード: std_doc_page_definitions

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=UPDATE_DOCINFO_BYFORM
dID=66
dSecurityGroup=Secure
dDocName=test_000048
dRevLabel=2

- 追加およびオプションのパラメータを持つHDA形式(値をメタデータ・フィールドに割り当てます)。

@Properties LocalData
IdcService=UPDATE_DOCINFO_BYFORM
dID=66
dSecurityGroup=Secure
dDocName=test_000048
dRevLabel=2
dDocAccount=mainaccount
xComments=Preliminary
@end

4.3.77 UPDATE_DOCINFO_BYREV

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.78 UPDATE_DOCINFO_METAFILE_BYREV

場所: IdcHomeDir/resources/core/templates//std_services.htm

4.3.79 UPDATE_DOCINFO_STATUS

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.80 UPDATE_DOCINFO_SUB

コンテンツ・アイテムの情報を更新するサブサービス。

場所I: IdcHomeDir/resources/core/tables/std_services.htm

4.3.81 UPDATE_SUBSCRIPTION_NOTIFY

コアContent Serverソフトウェアで現在は使用されていません。

通知タイムスタンプを更新し、ユーザーをRedirectUrlパラメータで指定されたページにリダイレクトするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.82 UPDATE_SUBSCRIPTION_TYPE

「条件」サブスクリプションを更新するサービス。最も発生しがちなエラーは、指定されたサブスクリプション・タイプが存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- scpType: サブスクリプションのタイプ。

オプションのサービス・パラメータ

- scpDescription: サブスクリプションの説明。

- scpEnabled:

- 1 (true): サブスクリプション通知が有効になっています。

- 0 (false): サブスクリプション通知が無効になっています。

- scpFields: サブスクリプション条件を定義するメタデータ・フィールドのカンマ区切りのリスト。例: dDocAuthor,dDocType。

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=UPDATE_SUBSCRIPTION_TYPE
scpType=my_subscription

- HDAファイル・フォーマット(作成者のサブスクリプションを変更し、そのサブスクリプションを無効にします)。

@Properties LocalData
IdcService=UPDATE_SUBSCRIPTION_TYPE
scpType=my_subscription
scpFields=dDocAuthor
scpDescription=updating subscription
scpEnabled=false
@end

4.3.83 UPDATE_SUBSCRIPTION_USED

サブスクリプション通知からコンテンツ・アイテムにアクセスする場合にユーザーのサブスクリプション・レコードを更新するサービス。このサービスは、Subscriptionデータベース表のdSubscriptionUsedDate列のデータを更新します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- dSubscriptionAlias: 条件サブスクリプションのユーザーのエイリアス。

- dSubscriptionAliasType: エイリアスのサブスクリプション・タイプ。

- dSubscriptionID: サブスクリプションID。

- 基本サブスクリプションの場合、これはコンテンツIDです。

- 条件サブスクリプションの場合、これは条件フィールドの値のカンマ区切りのリストです。

たとえば、「条件」フィールドが「作成者」および「セキュリティ・グループ」である場合、user1 が作成者であるPublicコンテンツ・アイテムのdSubscriptionIDパラメータ設定は Public,user1となります。

- dSubscriptionType: サブスクリプションのタイプ。

例

IdcService=UPDATE_SUBSCRIPTION_USED
dSubscriptionType=test_subscription
dSubscriptionID=sysadmin
dDocName=test_000056
dSubscriptionAlias=global
dSubscriptionAliasType=user

4.3.84 UPDATE_METADATA

メタデータを更新するサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.85 VALIDATE_DOCINFO

ヘビー・クライアントのメタデータ専用チェックインに使用されるサービス(InternalUpload = 1)。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.3.86 WORK_IN_PROGRESS

GENWWWまたはDONEステータスのすべてのコンテンツ・アイテムのリストを返すサービス。現在ワークフロー内のアイテムは表示されません。

アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)

場所: IdcHomeDir/resources/core/tables/std_services.htm

オプションのサービス・パラメータ

- orderClause: リストのソート先にフィールド名を提供するために使用されます。

- MaxQueryRows: リストに返されるアイテム数を制御するために使用します。

結果

- ResultSets: DOC_LIST (RevisionsおよびDocMetaからのすべてのフィールド)

- ローカル・データ:

- copyAborted

- dataSource

- MaxQueryRows

- レスポンス・テンプレート: WIPS (wips_list.htm)

次が使用

- リソース・インクルード:

- pne_nav_management_links

- std_doc_man_pages

- Standard Navigation:

- commonBundle.js

- commonNav.js

4.4 ドキュメント・プロファイル・サービス(コアContent Server)

次のサービスは、ドキュメント・プロファイルを作成、維持または削除する際に使用されます。

- ADD_DOCPROFILE

- ADD_DOCRULE

- DELETE_DOCPROFILE

- DELETE_DOCRULE

- DOCPROFILE_PREVIEW

- EDIT_DOCPROFILE

- EDIT_DOCPROFILE_TRIGGER

- EDIT_DOCRULE

- GET_DOCPROFILE

- GET_DOCPROFILES

- GET_DOCRULE

- GET_DOCRULES

4.4.1 ADD_DOCPROFILE

ドキュメント・プロファイルを追加するために使用されるサービス。このサービスは、コンテンツ・プロファイル・リストにプロファイルと説明を追加し、渡されるデータからプロファイル定義ファイルを生成します。

注意:

このサービスに提供されるデータはプロファイル定義になります。プロファイルを編集する(EDIT_DOCPROFILEを使用する)際には、最初にGET_DOCPROFILEを使用してプロファイル定義を参照してから目的の値を追加または変更する必要があります。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dpName: プロファイルの名前。この名前は一意である必要があります。

- dpDescription: 新しいプロファイルの説明。

- dpTriggerValue: プロファイルに関連付けられたトリガー値。

- dpDisplayLabel: プロファイルの表示ラベル。

オプションのサービス・パラメータ

- isValidateTrigger: trueに設定すると、トリガー値が存在することを検証します。値が存在しない場合、サービスは失敗します。falseに設定すると、トリガーを検証せずにプロファイルが追加されます。

4.4.2 ADD_DOCRULE

新しいコンテンツ・プロファイル・ルールを作成するために使用されるサービス。このサービスは、コンテンツ・ルール・リストへルールを追加し、ルール定義ファイルを作成します。このサービスに提供されるデータはルール定義になります。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dpRuleName: 新しいルールの名前。この名前は一意である必要があります。

- dpRuleDescription: ルールの説明。

4.4.3 DELETE_DOCPROFILE

プロファイル・リストからドキュメント・プロファイルを削除し、コンテンツ・プロファイル定義ファイルを削除するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dpName: プロファイルの名前。

4.4.4 DELETE_DOCRULE

ルール・リストからコンテンツ・ルールを削除し、システムからコンテンツ・ルール定義ファイルを削除するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dpRuleName: ルールの名前。

4.4.5 DOCPROFILE_PREVIEW

コンテンツ・プロファイルの使用をシミュレートするために、「構成マネージャ」アプレットで使用されるサービス。プレビューは必要なコンテキストで実行され、データ・バインダに結果データを返します。コンテキストはイベント(送信、リクエストまたはインポート)およびアクション(検索、チェックインなど)で構成されます。必要に応じて、ユーザー名およびコンテンツ・アイテムも含まれます。データには、各フィールドの表示情報および各フィールドの表示を決定したルールが含まれます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dpName: プレビューで使用されるルールの名前。

- dpTriggerValue: プレビューに使用するトリガー値。

4.4.6 EDIT_DOCPROFILE

ドキュメント・プロファイルを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dpName: 編集されるプロファイルの名前。

- dpDescription: プロファイルの新しい説明。

- dpTriggerValue: プロファイルの新しいトリガー値。

- dpDisplayLabel: 新しい表示ラベル。

4.4.7 EDIT_DOCPROFILE_TRIGGER

コンテンツ・プロファイルのトリガー・フィールドとして使用されるメタデータ・フィールドを変更するサービス。

注意:

メタデータ・フィールドを変更すると、すべての既存のプロファイルが無効になる可能性があります。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dpName: 編集されるプロファイルの名前。

- dpTriggerField: プロファイルに使用される新しいトリガー・フィールド。トリガーを空(dpTriggerfield=)に変更すると、すべてのプロファイルが無効になります。

4.4.8 EDIT_DOCRULE

ドキュメント・ルールの説明を変更するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dpRuleName: 編集されるルールの名前。

- dpRuleDescription: ルールの新しい説明。

4.4.9 GET_DOCPROFILE

指定されたルールのプロファイル定義ファイルを返すサービス。返されたデータは、データ・バインダ内にあり、プロファイルを定義するために使用されるすべての情報が含まれます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dpName: 使用されるプロファイルの名前。

4.4.10 GET_DOCPROFILES

コンテンツ・プロファイルのリスト・ファイルを返すサービス。リスト・ファイルには、各プロファイルの名前、説明、トリガー値および表示ラベルが含まれます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.4.11 GET_DOCRULE

指定されたルールのルール定義ファイルを返すサービス。返されたデータは、データ・バインダに戻され、ルールを定義するために使用されるすべての情報が含まれます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dpRuleName: 使用されるプロファイルの名前。

4.4.12 GET_DOCRULES

コンテンツ・ルールのリスト・ファイルを返すサービス。リスト・ファイルには、システムの各ルールの名前および説明が含まれます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.5 File Services (Core Content Server)

ファイル・サービスは、動的変換やリソース・ファイルなど、ファイルを操作するサービスです。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

次のファイル・サービスは、この項で説明します。

- ADD_WEB_APP

- APPEND_FILE_CACHING_INFO

- GET_DYNAMIC_CONVERSION

- GET_DYNAMIC_CONVERSION_SUB

- *GET_DYNAMIC_URL

- GET_TEMPLATE_CONVERSIONS

- GET_WEB_APP_STATUS

- LOAD_RESOURCE_FILE

- REMOVE_WEB_APP

- SAVE_TEMPLATE_CONVERSIONS

4.5.1 ADD_WEB_APP

内部Tomcatエンジンで使用されます。

TomcatエンジンにWARファイルを追加し、含まれるJSPページを有効にするために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- pathToWAR: WARファイルへの完全なパス。

4.5.2 APPEND_FILE_CACHING_INFO

「システム監査情報」ページの情報を返すためにGET_SYSTEM_AUDIT_INFOで使用されるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.5.3 GET_DYNAMIC_CONVERSION

Dynamic Converterによって変換されるHTMLまたはXMLファイルとしてコンテンツ・アイテムを返すサービス。これは、Dynamic Converterコンポーネントがインストールされ、有効な場合に使用できます。

dIDまたはdDocNameおよびRevisionSelectionMethodパラメータを指定すると、このサービスは、そのリビジョンの特定のレンディションのファイル名を決定し、そのファイルをクライアントに返します。最も発生しがちなエラーは、パラメータに不整合があるか、存在しないコンテンツ・アイテムに対するリクエストがあることです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

注意:

dDocNameは、リクエスタがdDocNameを認識しているコンテンツ・アイテムのすべてのリクエストに含まれる必要があります。Content Serverシステムのエラー・メッセージは、フォームなど、他の機能と同様に、これが存在しているということを想定しています。

追加の必須サービス・パラメータ

重要:

コンテンツ・アイテムのリビジョンID (dID)が指定されているか、RevisionSelectionMethodパラメータを持つコンテンツID (dDocName)が指定されている必要があります。

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dIDが指定されない場合、dDocNameおよびRevisionSelectionMethodを指定する必要があります。

- このIDを持つコンテンツ・アイテムのリビジョンのレンディションが存在し、かつRevisionSelectionMethodパラメータが存在しないか、値Specificを持つ場合は、そのレンディションが返されます。

- dDocName: コンテンツ・アイテムのコンテンツID。

- dDocNameが存在しない場合は、dIDが存在しなければならず、RevisionSelectionMethodが存在してはなりません。

- RevisionSelectionMethodが指定された場合、その名前を持つコンテンツ・アイテムのリビジョンのレンディションが返されます(存在する場合)。RevisionSelectionMethodが指定されない場合、エラー・メッセージにdDocNameが示されます。

- RevisionSelectionMethod: リビジョン選択メソッド。

- これが指定された場合は、dDocNameも指定する必要があります。この変数の値は、指定されたdDocNameからdIDを計算するために使用されるメソッドです。このパラメータで設定可能な値は、Specific、LatestまたはLatestReleasedです。

- 値がSpecificである場合、dDocNameパラメータは無視され、dIDが要求され、これを使用してリビジョンが取得されます。値がLatestである場合、コンテンツ・アイテムの最新リビジョンを使用してdIDが計算されます。値がLatestReleasedである場合、コンテンツ・アイテムの最新リリースのリビジョンを使用してdIDが計算されます。

オプションのサービス・パラメータ

- conversionTemplate: 変換テンプレート。このパラメータは、テンプレート変換条件ページをオーバーライドするためにサービスに渡すことできます。

- DCViewFormat: 変換および表示されるファイル: 通常は、Native、Alternate,またはWebViewable。

- useDocInfoCache: 個々のコンテンツ・アイテムをリクエストしている間にキャッシング・メカニズムを無効にします。単一リクエストにのみ適用されます。このパラメータを使用して、最適化された問合せ機能をテストまたはトラブルシューティングすることができます。このパラメータを使用するには、それをContent Server URLに次のように追加します(パラメータは太字です)。

http://server_name/cs/idcplg?IdcService= GET_DYNAMIC_CONVERSION
&dDocName=aTest&RevisionSelectionMethod= LatestReleased&useDocInfoCache=false

- conversionRule: 変換ルールを変換ルール基準により選択できるようにするのではなく、使用する変換ルールを指定します。

例

- IdcCommandコマンド・ファイル・フォーマット:

# Retrieve a web-viewable revision
IdcService=GET_DYNAMIC_CONVERSION
dDocName=corporatereport
RevisionSelectionMethod=LatestReleased
DCViewFormat=WebViewable

- HDA形式:

@Properties LocalData
IdcService=GET_DYNAMIC_CONVERSION
dID=54321
@end

4.5.4 GET_DYNAMIC_CONVERSION_SUB

GET_DYNAMIC_CONVERSIONで使用されるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.5.5 GET_DYNAMIC_URL

/weblayoutディレクトリにマップされるかどうかを決定するために、Web表示可能URLから情報を抽出するために内部で使用されるサービス。マップされない場合は、例外をスローします。

このサービスは通常、動的ページを取得するために使用されます。このサービスは動的コンテンツWeb表示可能ファイルを配信するためにWebサーバーからコールされます。サービスに対するレスポンス・ページを動的に変更するためにコアでコールされます。

アクセス・レベル: 読取り、スクリプト作成可能(33)

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- fileUrl: アイテムの相対URL。これには、Content Serverのチェックイン・アイテム、SchemaまたはLayout Manager用Javaスクリプト・ファイル、/imagesディレクトリからのイメージファイルを指定できます。

結果

- ResultSets:

- DocFormats

- DocTypes

- ローカル・データ:

- ref:dDocAccount

- ref:dDocName

- ref:dDocType

- ref:dExtension

- ref:dSecurityGroup

- ref:hasDocInfo

- ref:isLatestRevision

- SourceID

- HCSP/Fメタデータ(idcbegindataとidcenddataタグ間のカスタムXMLデータを含む)

- レスポンス・テンプレート: null (fileUrlパラメータでリクエストされたファイルを返します。)

4.5.6 GET_TEMPLATE_CONVERSIONS

変換中に使用されるテンプレートのリストを取得するためにDynamic Converterで使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.5.7 GET_WEB_APP_STATUS

内部Tomcatエンジンで使用されます。

内部Tomcatエンジンのステータスを返すサービス。内部使用専用。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.5.8 LOAD_RESOURCE_FILE

リソース・ファイルを返すサービス。

dIDまたはdDocNameおよびRevisionSelectionMethodパラメータを指定すると、このサービスは、そのリビジョンの特定のレンディションのファイル名を決定し、そのファイルをクライアントに返します。

最も発生しがちなエラーは、パラメータになんらかの不整合があるか、存在しないリビジョンまたはレンディションに対するリクエストであることです。

注意:

リクエスタがdDocNameを認識している場合、dDocNameがコンテンツ・アイテムのすべてのリクエストに含まれるようにすることをお薦めします。Content Serverシステムのエラー・メッセージは、フォームなど、他の機能と同様に、これが存在しているということを想定しています。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

重要:

コンテンツ・アイテムのリビジョンID (dID)が指定されているか、コンテンツ・アイテム名(dDocName)とRevisionSelectionMethodパラメータが指定されている必要があります。

オプションのサービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dIDが指定されない場合、dDocNameおよびRevisionSelectionMethodを指定する必要があります。

- このIDを持つコンテンツ・アイテムのリビジョンのレンディションが存在し、かつRevisionSelectionMethodパラメータが存在しないか、値Specificを持つ場合は、そのレンディションが返されます。

- dDocName: コンテンツ・アイテムのコンテンツID。

- dDocNameが存在しない場合は、dIDが存在しなければならず、RevisionSelectionMethodが存在してはなりません。

- RevisionSelectionMethodが指定された場合、その名前を持つコンテンツ・アイテムのリビジョンのレンディションが返されます(存在する場合)。RevisionSelectionMethodが指定されない場合、エラー・メッセージにdDocNameが示されます。

- RevisionSelectionMethod: リビジョン選択メソッド。

- これが指定された場合は、dDocNameも指定する必要があります。この変数の値は、指定されたdDocNameからdIDを計算するために使用されるメソッドです。このパラメータで設定可能な値は、Specific、LatestまたはLatestReleasedです。

- 値がSpecificである場合、dDocNameは無視され、dIDが要求され、これを使用してレンディションが取得されます。値がLatestである場合、コンテンツ・アイテムの最新リビジョンを使用してdIDが計算されます。値がLatestReleasedである場合、コンテンツ・アイテムの最新リリースのリビジョンを使用してdIDが計算されます。

- Rendition: コンテンツ・アイテムのレンディション。このパラメータは、コンテンツ・アイテムのレンディションを指定するもので、Primary、WebまたはAlternateに設定できます。Renditionが指定されない場合、デフォルトでPrimaryが設定されます。

- 値がPrimaryである場合、選択されたリビジョンのプライマリ・レンディションが返されます。

- 値がWebである場合、選択されたリビジョンのWeb表示可能レンディションが返されます。

- 値がAlternateである場合、選択されたリビジョンの代替レンディションが返されます。

例

IdcService=LOAD_RESOURCE_FILE
dID=456

4.5.9 REMOVE_WEB_APP

内部Tomcatエンジンで使用されます。

このサービスは内部Tomcatエンジンとの併用からWARファイルを削除するために使用されます。内部使用専用。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.5.10 SAVE_TEMPLATE_CONVERSIONS

変換テンプレートを保存するためにDynamic Converterで使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.6 インデクサ・サービス(コアContent Server)

インデクサ・サービスは、検索索引の制御に使用されます。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

この項では、次のサービスについて説明します。

- CANCEL_SEARCH_INDEX

- CONTROL_SEARCH_INDEX

- *GET_FILE

- START_SEARCH_INDEX

4.6.1 CANCEL_SEARCH_INDEX

現在の索引付けセッションをキャンセルするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.6.2 CONTROL_SEARCH_INDEX

検索索引を更新または再構築するサービス。更新および再構築は、バックグラウンド・スレッドで自動的に実行されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

重要:

検索索引を再構築することは、メタデータ・フィールドを変更または追加する場合に必要です。ファイルの数とサイズによって、このプロセスには、数日かかる場合があります。再構築はシステム集約型です。そのため、システム使用率がピーク以外の時間帯に再構築を実施するように計画してください。

- このサービスは、「リポジトリ・マネージャ: インデクサ」タブで提供される「自動更新サイクル」および「コレクション再構築サイクル」オプションに変更が行われる場合にコールされます。

- 「自動更新サイクルの構成」または「コレクション再構築サイクルの構成」画面で定義されるオプションは次のパラメータにマップします。

- 1度のインデクサ・バッチで処理されるコンテンツ・アイテム数(MaxCollectionSize)

- チェックポイントごとのコンテンツ・アイテム数(IndexerCheckpointCount)

- インデクサのデバッグ・レベル(SearchDebugLevel)

- インデクサの自動更新(sEnableAutoUpdate)

追加の必須サービス・パラメータ

- cycleID: 索引のサイクル・タイプ。

- 更新: 索引データベースを追加的に更新します。

- 再構築: 検索索引が完全に再構築され、再構築が完了すると古い索引コレクションは新しい索引コレクションに置き換えられます。

- action: 実行するアクション。このエントリは、次の値に設定できます。

- 開始: 更新または再構築サイクルを開始します。

- 取消: 更新または再構築サイクルを停止し、今後の再開を許可しません。

- 一時停止: 更新または再構築サイクルを停止し、今後の再開を許可します。

- 再開: 一時停止が実行された後で、更新または再構築サイクルを再開します。

- setConfiguration: 更新サイクルを有効または無効にする際に使用されます。この値を設定すると、チェックポイント(IndexerCheckpointCount)、バッチ・サイズ(MaxCollectionSize)、デバッグ・レベル(SearchDebugLevel)および自動更新(sEnableAutoUpdate)オプションを調整できます。

追加のオプション・サービス・パラメータ

このサービスには実行するアクションに応じて、次のパラメータが必要な場合があります(次の例を参照してください)。

GetCurrentIndexingStatus: このパラメータを1 (true)に設定すると、インデクサ・サイクルのステータスを返します。

- アイドル: インデクサ・サイクルが完了しています。

- アクティブ: インデクサ・サイクルは現在実行中です。

- 割込み: 索引付けサイクルが急に終了する、予期しないイベント。例: 処理能力、データベースまたはファイル・システムの障害。

- 中断: 索引付けが制御された方法で停止されます。たとえば、「リポジトリ・マネージャ: インデクサ」タブの「中断」ボタンを使用するなど。

- 再開: 中断されたサイクルが再び開始されます。中断されたサイクルを再開している場合は、中断の原因となった問題を解決していることを確認してください。

- 取消: 索引付けサイクルが再開することなく停止されます。

- getStatus: このパラメータを1 (true)に設定すると、インデクサ設定およびステータス情報が返されます。

- PerformProcessConversion: インデクサ再構築プロセスの開始または再開時に処理変換を有効にします。

- 1 (true): 処理変換が実行されます。

- 0 (false): 処理変換が実行されません。

- IndexerCheckpointCount: 各索引付け状態を一度に通過するファイルの数。

- チェックポイントごとに、複数のファイル・バッチを索引付けできます。

- このエントリを更新するには、アクションをsetConfigurationに設定する必要があります。

- MaxCollectionSize: 検索索引で同時に処理されるファイルの最大数。

- デフォルトが25の場合、25ファイルがまとめて索引付けされた後、次の25ファイルが索引付けされます。

- サイズの大きい複雑なファイルを検索エンジンで索引付けすることに伴う問題が発生している場合には、この設定を1に変更できます。ただし、システム性能が低下する原因になる場合があります。

- このエントリを更新するには、アクションをsetConfigurationに設定する必要があります。

- SearchDebugLevel: インデクサのデバッグ・レベル。

- サーバー・ウィンドウ内にリストされたデバッグ情報が多いほど、索引付けの速度は下がります。

- このエントリを更新するには、アクションをsetConfigurationに設定する必要があります。

- 次にデバッグ・レベルを(デバッグ情報の少ない順に)示します。

- なし: アクセスされた各ファイルの情報は表示されません。

- 詳細: アクセスされた各ファイルの情報が表示されます。「索引付け」、「無視」、「失敗」のいずれかが示されます。

- デバッグ: 中レベルの情報が表示されます。

- トレース: 最低レベルの情報が表示されます。

- すべて: 最高レベルの情報が表示されます。

- sEnableAutoUpdate: このエントリを更新するには、アクションをsetConfigurationに設定する必要があります。

- 1 (true): 自動更新サイクルが有効になっています。

- 0 (false): 自動更新サイクルが無効になっています。

例

次に別のプロセスからインデクサを制御するための例を示します。

- 定義された設定およびステータス情報を返すためのHDA形式:

@Properties LocalData
IdcService=CONTROL_SEARCH_INDEX
getStatus=1
@end

- 更新サイクルを有効にするためのHDA形式:

@Properties LocalData
IdcService=CONTROL_SEARCH_INDEX
MaxCollectionSize=500
sEnableAutoUpdate=1
cycleID=update
action=setConfiguration
SearchDebugLevel=none
IndexerCheckpointCount=5000
GetCurrentIndexingStatus=1
@end

- 更新サイクルを無効にするためのHDA形式:

@Properties LocalData
IdcService=CONTROL_SEARCH_INDEX
MaxCollectionSize=500
sEnableAutoUpdate=0
cycleID=update
action=setConfiguration
SearchDebugLevel=none
IndexerCheckpointCount=5000
GetCurrentIndexingStatus=1
@end

- インデクサ再構築を開始するためのHDA形式:

@Properties LocalData
IdcService=CONTROL_SEARCH_INDEX
cycleID=rebuild
action=start
getStatus=1
GetCurrentIndexingStatus=1
PerformProcessConversion=1
@end

- インデクサ再構築を取り消すためのHDA形式:

@Properties LocalData
IdcService=CONTROL_SEARCH_INDEX
cycleID=rebuild
action=cancel
getStatus=1
GetCurrentIndexingStatus=1
@end

- インデクサ再構築を中断するためのHDA形式:

@Properties LocalData
IdcService=CONTROL_SEARCH_INDEX
cycleID=rebuild
action=suspend
getStatus=1
GetCurrentIndexingStatus=1
@end

- インデクサ再構築を中断後に再開するためのHDA形式:

@Properties LocalData
IdcService=CONTROL_SEARCH_INDEX
cycleID=rebuild
action=restart
getStatus=1
GetCurrentIndexingStatus=1
PerformProcessConversion=1
@end

4.6.3 GET_FILE

ブラウザにコンテンツ・アイテムのリビジョンの特定のレンディションを返すサービス。チェックアウトを実行せずにファイルのコピーを取得します。

- dIDまたはdDocNameおよびRevisionSelectionMethodパラメータを指定すると、このサービスは、そのリビジョンの特定のレンディションのファイル名を決定し、そのファイルをクライアントに返します。

- 最も発生しがちなエラーは、パラメータになんらかの不整合があるか、存在しないリビジョンまたはレンディションに対するリクエストであることです。

注意:

リクエスタがdDocNameを認識している場合、dDocNameがコンテンツ・アイテムのすべてのリクエストに含まれるようにすることをお薦めします。Content Serverインスタンスのエラー・メッセージは、フォームなど、他の機能と同様に、これが存在しているということを想定しています。

アクセス・レベル: 読取り、スクリプト作成可能(33)

実行される問合せ:

- QdocInfo

- QlatestIdByName

- QlatestReleasedIDByName

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

注意:

コンテンツ・アイテムのリビジョンID(dID)が指定されているか、コンテンツID(dDocName)とRevisionSelectionMethodパラメータが定義されている必要があります。

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dIDが指定されない場合、dDocNameおよびRevisionSelectionMethodを指定する必要があります。

- このIDを持つコンテンツ・アイテムのリビジョンのレンディションが存在し、かつRevisionSelectionMethodパラメータが存在しないか、値Specificを持つ場合は、そのレンディションが返されます。

- dDocName: コンテンツ・アイテムのコンテンツID。

- dDocNameが存在しない場合は、dIDが存在しなければならず、RevisionSelectionMethodが存在してはなりません。

- RevisionSelectionMethodが指定された場合、その名前を持つコンテンツ・アイテムのリビジョンのレンディションが返されます(存在する場合)。RevisionSelectionMethodが指定されない場合、エラー・メッセージにdDocNameが示されます。

- オプションのサービス・パラメータ

- allowInterrupt: 1 (true)に設定されると、ユーザーがファイルのダウンロードを取り消す場合エラーが表示されません。

- RevisionSelectionMethod: リビジョン選択メソッド。

- これが指定された場合は、dDocNameも指定する必要があります。この変数の値は、指定されたdDocNameからdIDを計算するために使用されるメソッドです。このパラメータで設定可能な値は、Specific、LatestまたはLatestReleasedです。

- 値がSpecificである場合、dDocNameは無視され、dIDが要求され、これを使用してレンディションが取得されます。値がLatestである場合、コンテンツ・アイテムの最新リビジョンを使用してdIDが計算されます。値がLatestReleasedである場合、コンテンツ・アイテムの最新リリースのリビジョンを使用してdIDが計算されます。

- Rendition: コンテンツ・アイテムのレンディション。このパラメータは、コンテンツ・アイテムのレンディションを指定するもので、Primary、WebまたはAlternateに設定できます。Renditionが指定されない場合、デフォルトでPrimaryが設定されます。

- 値がPrimaryである場合、選択されたリビジョンのプライマリ・レンディションが返されます。

- 値がWebである場合、選択されたリビジョンのWeb表示可能レンディションが返されます。

- 値がAlternateである場合、選択されたリビジョンの代替レンディションが返されます。

- IsXml: trueまたは1に設定されると、一部のHCSP、HCSTおよびHCSFページに存在するXMLデータ・アイランドを返します。必要に応じて、追加の情報を渡すために変更可能な、std_html_form_xml_wrapperインクルード内でラップされるデータ・アイランドを返します。

結果

- レスポンス・テンプレート: null(リクエストされたファイルのみが返されます。)

次が使用

- アプレット: 構成マネージャ

- リソース・インクルード:

- doc_file_get_copy

- doc_odma_select_get

- download_form_fields

- email_docinfo_body_by_id

- email_docinfo_body_by_name

- legacy_workflow_in_queue_table

- subscription_info_cell

- subscription_info_cells

- wf_in_queue_display

- wf_review_cannot_view_msg

- テンプレート:

- CHECKOUT_OK (chkook.htm)

- DOWNLOAD_OK (dwnldok.htm)

- QUERY_NOTIFICATION (query_notification_mail.htm)

- REDIRECTION_FILE_TEMPLATE (redirectionfile_template.htm)

- REV_HISTORY (rev_history.htm)

- SELECTDOC_OK (slctdcok.htm)

- WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

- WORKFLOW_REVIEW_FRAMES (workflow_review_frames.htm)

- その他: SoapCustom:Wsdl:GetFile:Services

例

- IdcCommandコマンド・ファイル・フォーマット:

# Retrieve a web-viewable revision
IdcService=GET_FILE
dDocName=corporatereport
RevisionSelectionMethod=LatestReleased
Rendition=Web

- HDA形式:

@Properties LocalData
IdcService=GET_FILE
dID=54321
@end

4.6.4 START_SEARCH_INDEX

検索索引を更新または再構築するサービス。このサービスは非同期であり、アクションは、バックグラウンド・スレッドで実行されます。このサービスは、Content Serverインスタンスのコンテキストでのみ実行することができ、Content Serverインスタンスに接続された場合にのみ正常に完了します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

オプションのサービス・パラメータ

- IsRebuild: 索引付けプロセスの範囲を設定します。

- 1 (true): インデクサが検索索引の完全な再構築を実行します。0 (false): インデクサが検索索引の増分更新を実行します。

- デフォルトは0 falseです。

例

- IdcCommandコマンド・ファイル・フォーマット:

# Rebuild the entire search index
IdcService=START_SEARCH_INDEX
IsRebuild=true

4.7 内部サービス(コアContent Server)

次のサービスは、Content Serverシステムで内部的にコールされます。これらのサービスを使用または変更しないでください:

- CANCEL_COMPONENT_INSTALL

- CLEAR_SERVER_OUTPUT

- DOWNLOAD_COMPONENT

- GET_COMPONENT_CONFIG

- GET_COMPONENT_INSTALL_FORM

- GET_COMPONENT_INSTALL_PROMPTS_FORM

- GET_COMPONENT_INSTALL_SETTINGS'

- GET_LOCAL_REGISTRATION_FORM

- GET_MANIFEST_INFO

- GET_SERVER_OUTPUT

- PROXIED_REQUEST

- UNINSTALL_COMPONENT

- UPDATE_COMPONENT_CONFIG

- UPDATE_LICENSE

- UPLOAD_NEW_COMPONENT

4.7.1 CANCEL_COMPONENT_INSTALL

使用しないでください。

4.7.2 CLEAR_SERVER_OUTPUT

使用しないでください。

4.7.3 DOWNLOAD_COMPONENT

使用しないでください。

4.7.4 GET_COMPONENT_CONFIG

使用しないでください。

4.7.5 GET_COMPONENT_INSTALL_FORM

使用しないでください。

4.7.6 GET_COMPONENT_INSTALL_PROMPTS_FORM

使用しないでください。

4.7.7 GET_COMPONENT_INSTALL_SETTINGS'

使用しないでください。

4.7.8 GET_LOCAL_REGISTRATION_FORM

使用しないでください。

4.7.9 GET_MANIFEST_INFO

使用しないでください。

4.7.10 GET_SERVER_OUTPUT

使用しないでください。

4.7.11 PROXIED_REQUEST

使用しないでください。

4.7.12 UNINSTALL_COMPONENT

使用しないでください。

4.7.13 UPDATE_COMPONENT_CONFIG

使用しないでください。

4.7.14 UPDATE_LICENSE

使用しないでください。

4.7.15 UPLOAD_NEW_COMPONENT

使用しないでください。

4.8 メタサービス(コアContent Server)

メタサービスは、Content Serverシステムでメタデータを管理および変更するために使用されます。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

この項では、次のサービスについて説明します。

- ADD_METADEF

- DEL_METADEF

- EDIT_METADEF

- GET_ADVANCED_SEARCH_OPTIONS

- GET_DISPLAY_FIELDS

- *GET_DOC_METADATA_INFO

- GET_OPTION_LIST

- GET_USER_METADATA_INFO

- MOVE_METADEF

- UPDATE_ADVANCED_SEARCH_OPTIONS

- UPDATE_USER_META

- UPDATE_USER_META_TABLE

- UPDATE_META_TABLE

- UPDATE_OPTION_LIST

4.8.1 ADD_METADEF

新しいメタデータ・フィールドを作成するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

注意:

詳細は、「UPDATE_META_TABLE」および「START_SEARCH_INDEX」を参照してください。これらのサービスは、新しいメタデータ・フィールドのデータを格納するために実行される必要があります。OptionListsデータベース表の更新の詳細は、「UPDATE_OPTION_LIST」も参照してください。

追加の必須サービス・パラメータ

- dName: フィールドの内部名。

- dCaption: 「コンテンツ・サーバー」ページでフィールドをラベル付けするために使用されるユーザー表示可能キャプション。

- dIsRequired: フィールドに値が含まれない場合、ファイルがチェックインされないようにします。値は1(必須)または0(必須ではない)。デフォルトは0です。

- dIsEnabled: 「ユーザー・インタフェース」ページに表示されるフィールドを有効にします。値は1(有効)または0(無効)です。デフォルトは1です。

- dIsSearchable: 索引付けし、検索可能なフィールドを有効にします。値は1(検索可能)または0(検索不可)です。デフォルトは1です。

- dIsOptionList: 「コンテンツ・サーバー」ページのユーザーが選択可能なオプション・リストの使用を許可します。値は1(有効)または0(無効)です。デフォルトは0です。1が使用される場合は、dOptionListKeyも必要です。

- dOptionListKey: 使用されるオプション・リストの名前。

- dOptionListType: 使用されるオプション・リストのタイプを指定します。値はchoice(Vタイプの選択リスト)、chunval(NVタイプの選択リスト)、combo(単一値選択リスト)、multi2(複数選択リスト)またはmulti(複数値選択リスト)のいずれかになります。

- dType: フィールドのタイプ。値は、Text(テキスト)、BigText(ロング・テキスト)、Int(整数)、Date(日付)、Memo(メモ)のいずれかになります。デフォルト: Text。

- dOrder: フィールドが「コンテンツ・サーバー」ページに表示される順序。デフォルト値は、既存のフィールドの現在の最高値+1。

- dDefaultValue: 作成されるメタデータ・フィールドのデフォルト値。

例

IdcService=ADD_METADEF
dIsRequired=0
dOptionListKey=Web_SectionList
dOptionListType=choice
dIsOptionList=1
dOrder=5
dName=xWeb_Section
dIsSearchable=1
dIsEnabled=1
dType=Text
FieldName=Web_Section
dCaption=Web Section

4.8.2 DEL_METADEF

既存のカスタム・メタデータ・フィールドを削除するサービス。dDocName、dSecurityGroupなど、標準メタデータ・フィールドを削除できません。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dName: 「x」接頭辞を含む、メタデータ・フィールド名。

例

IdcService=DEL_METADEF
dName=xCustomField

4.8.3 EDIT_METADEF

既存のカスタム・メタデータ・フィールドを変更するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dName: 「x」接頭辞を含む、メタデータ・フィールド名。例: xDepartment。

- dCaption: メタデータ・フィールドのキャプション。

- dType: Text、BigText、Memo、Date、Integerなど、メタデータ・フィールドのタイプ。

- dOrder: 表示順序。

- dIsRequired: 1 (true): このフィールドは必須です。0 (false): このフィールドはオプションです。

- dIsEnabled: 1 (true): このフィールドはユーザー・インタフェースで有効になっています。0 (false): このフィールドはユーザー・インタフェースで無効になっています。

- dIsSearchable: 1 (true): このフィールドは検索可能です。0 (false): このフィールドは検索不可です。

- dDefaultValue: メタデータ・フィールドのデフォルト値。

- dIsOptionList: 1 (true): このフィールドはオプション・リストを持ちます。0 (false): このフィールドはオプション・リストは持ちません。

- dOptionListKey: オプション・リスト・キー。

- dOptionListType: オプション・リストのタイプ。

例

IdcService=EDIT_METADEF
dName=xDepartment
dType=BigText
dIsRequired=1
dIsEnabled=1
dIsSearchable=1
dCaption=Caption_Changed
dIsOptionList=1
dDefaultValue=two
dOptionListKey=xDepartmen_fieldList
dOptionListType=chunval
dOrder=4

4.8.4 GET_ADVANCED_SEARCH_OPTIONS

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.8.5 GET_DISPLAY_FIELDS

別のContent Serverページのカスタム・メタデータ・フィールドに関するメタデータ情報を返すサービス。この情報はフロントエンドのクライアントがカスタム・メタデータ・フィールドをレンダリングするために使用できます。

このサービスでは、特定のContent Serverページへマップするアクションが必要です。これによりそのページのメタデータ情報が返されます。

また、このサービスでは、動的選択リスト(DCL)のオプションや動的ツリーを生成するサポートも提供しています。

場所:

必須のサービス・パラメータ

- dpAction: Content Serverのアクションを示します。有効なアクションは次のとおりです。

- CheckinNew

- CheckinSel

- CheckinSimilar

- Info

- Update

- Search

- FLDMetadataUpdate

- FLDMetadataInfo

条件によって必要なるサービス・パラメータ

- dID: dpActionがCheckinSel、CheckinSimilar、InfoまたはUpdateの場合に必要。

- fFolderGUID: dpActionがFLDMetadataUpdateまたはFLDMetadataInfoの場合に必要。

オプションのサービス・パラメータ

- dpTriggerValue: プロファイルのロードに使用されるトリガー値を示します。

結果

- ResultSets:

- DisplayFieldInfo: 個々のカスタム・メタデータ・フィールドに関する情報が含まれます。次の列を保持します。

- fieldName: フィールドの名前。

- fieldType: フィールドのタイプ。例: Text、BigText、Memo、Data、Int、Decimal、File。

- fieldLabel: フィールドの表示ラベル。

- isHidden: フィールドを非表示のフォーム・フィールドにする必要があるかどうかを示します。

- isReadOnly: フィールドを非入力フォーム・フィールドにする必要があるかどうかを示します。

- isRequired: フィールドを必須のフォーム・フィールドにする必要があるかどうかを示します。

- defaultValue: フィールドのデフォルト値。

- displayValue: 該当するデフォルト値に使用される表示値。

- isOptionList: これがドロップダウンオプションリストかどうかを示します。

- optionList: isOptionListが1に設定された場合に、この列にはオプションを含んだ追加の結果セットの名前が含まれ、ドロップダウン・リストを作成するために使用する必要があります。

- optionListType: オプション・リストのタイプ。例: choice、chunval、combo、multi2およびmulti。

- isDependent: フィールドがDCLに含まれるかどうかを示します。このフィールドの値は、他のフィールドに依存します。

- dependentOnField: このフィールドの値を取得するフィールドの名前を示します。

- isPadMultiselectStorage: multi*タイプのオプション・リストによって使用されます。

- multiselectDisplaySeparator: multi*タイプのオプション・リストによって使用されます。

- multiselectStorageSeparator: multi*タイプのオプション・リストによって使用されます。

- isStoreSelectionPath: 動的ツリーによって使用されます(詳細は、動的ツリーを参照)。

- treeNodeDisplaySeparator: 動的ツリーによって使用されます。

- treeNodeStorageSeparator: 動的ツリーによって使用されます。

- order : フィールドの順序。

- decimalScale

- isError: フィールドに関する情報の取得時にエラーが発生したかどうかを示します。

- errorMsg: エラー・メッセージ。

- DisplayGroupInfo: 特定のカスタム・メタデータ・フィールドをグループにまとめる必要があるかどうかを示します。次の列を保持します。

- parentField: グループで最初に表示される必要があるフィールドの名前。

- groupFieldList: 親フィールドと一緒に表示される必要があるフィールドのリスト。

- groupHeader: グループの名前。

- defaultHide: デフォルトでグループを縮小する必要があるかどうかを示します。

- xFieldName.options: 特定のフィールドにドロップダウン・リストを作成するために使用するオプションが含まれます。

- dOption: オプションの内部値。

- dDescription: オプションの表示値。

サポートされるdpActionリスト

- CheckinNew: CHECKIN_NEW_FORMへのマップ。

- CheckinSet: CHECKIN_SEL_FORMへのマップ。

- CheckinSimilar: CHECKIN_SIMILAR_FORMへのマップ。

- Info: DOC_INFOへのマップ。

- Update: GET_UPDATE_FORMへのマップ。

- Search: GET_SEARCH_FORMへのマップ。

- FLDMetadataUpdate: FLD_EDIT_METADATA_RULES_FORMへのマップ。

- FLDMetadataInfo: FLD_GET_METADATA_RULESへのマップ。

Dynamic Choice List

GET_DISPLAY_FIELDSサービスでは、Dynamic Choice List (DCL)を生成するサポートも提供しています。次のパラメータが使用されます。

- dFieldName: (必須)DCLフィールドの名前。

- dParentValue: (オプション)ドロップダウン・オプションを絞り込むために使用される親の値。
dParentValueを使用しない場合、いずれのオプション・リスト・フィールドにもすべてのオプションが返されます。

DisplayFieldInfo ResultSetのisDependentおよびdependentOnField列は、DCLを生成するために使用されます。これらの列は、フィールドが他のフィールドに依存するかどうか、および依存先のフィールドを指定します。

たとえば、CityフィールドがStateフィールドに依存し、StateフィールドがCountryフィールドに依存する場合、GET_DISPLAY_FIELDSサービスはCountryのすべてのオプションを返しますが、StateとCityのオプションは返しません。StateおよびCityが、依存フィールドであるとDisplayFieldInfo ResultSetで示すのみです。ResultSetでは、isDependentがStateとCityの両方に対して1に設定され、dependentOnFieldは、Stateに対してCountryおよびCityに対してStateと設定されます。

たとえば、Stateに対する依存値を取得する場合は、dFieldNameパラメータをStateに設定し、dParentValueパラメータをCountryの値に設定してGET_DISPLAY_FIELDSをコールします。StateおよびCountryに渡されたすべてのオプションが返されます。

動的ツリー

GET_DISPLAY_FIELDSサービスでは、動的ツリーを生成するサポートも提供しています。次のパラメータが使用されます。

- dFieldName: (必須)DCLフィールドの名前。

- dParentValue: (オプション)ドロップダウン・オプションを絞り込むために使用される親の値。

ツリー・オプション・リストを使用しているフィールドでは、DisplayFieldInfo ResultSetのoptionListType列にtree://が格納されます。レスポンス・バインダには、xTreeField.optionsなどのfieldName.optionsを持つその他のResultSetが含まれます。

xTreeField.options ResultSetには、ツリーの最初のレベルを表すオプションが含まれます。

ツリーの任意のレベルのオプションを取得するには、GET_DISPLAY_FIELDSをdFieldNameおよび該当するdParentValueパラメータを使用してコールします。

GET_DISPLAY_FIELDSから返されたDisplayFieldInfo ResultSetには次の4つの新しい列も含まれます。

- isShowSelectionPath: フルパスで表示するかどうかを示します。このフルパスはInfoページに表示されます。

- isStoreSelectionPath: データベースにフルパスを格納するかどうかを示します。

- treeNodeDisplaySeparator: 区切り文字を表示するために使用する必要がある記号を示します。

- treeNodeStorageSeparator: パスをデータベースに保存するときに区切り文字として使用する必要がある記号を示します。

Search

dpActionがSearchの値でGET_DISPLAY_FIELDSがコールされる場合、レスポンス・バインダに追加情報が加えられます。

- DisplayFieldInfo ResultSetには2つの追加の列が含まれます。

- defaultOperator: フィールドのデフォルト演算子を示します。

- searchOperatorsRSName: このフィールドに適用可能なすべての検索演算子を含むResultSetの名前を示します。

また、このサービスは、レスポンス・バインダに追加のResultSetsを加えます。これらのResultSetには、各種フィールド・タイプの検索演算子が含まれます。

- SearchTextField: Text、Big TextおよびMemoフィールドの検索演算子が含まれます。

- SearchDateField: Dateフィールドの検索演算子が含まれます。

- SearchIntegerField: Integerフィールドの検索演算子が含まれます。

- SearchBooleanField: Booleanフィールドの検索演算子が含まれます。通常は存在しません。

これらのResultSetには次の列も含まれます。

- dOperator: 演算子の名前。

- dOperatorDisplay: 演算子のローカライズされた表示の文字列。

- dOperatorExpression: 問合せテキストを作成するために使用する必要がある構文。

4.8.6 GET_DOC_METADATA_INFO

DocMetaDefinition表からのカスタム・メタデータ・フィールドのリスト、および結果セットとして使用可能なDocTypesの情報のリストを返すサービス。ユーザーがアクセス可能なリストのみを表示するためにフィルタされる、SecurityGroupsおよびAccountに使用可能な値の2つのオプション・リストも返します。SOAP取得およびその他のリモート・アプリケーションとともに使用されます。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

場所: IdcHomeDir/resources/core/tables/std_services.htm

結果

- ResultSets:

- DocMetaDefinition (DocMetaDefinitionデータベース表からのすべての行およびフィールド)

- Doctypes (DocTypesデータベース表からのすべての行およびフィールド)

- オプション・リスト:

- SecurityGroups(ユーザーの権限に基づいてフィルタされたセキュリティ・グループのオプション・リスト)

- Accounts(ユーザーの権限に基づいてフィルタされたアカウントのオプション・リスト)

- ローカル・データ:

- isAutoNumber

- useAccounts

次が使用

- その他: SoapCustom:Wsdl:MetaData:Services

4.8.7 GET_OPTION_LIST

すべてのオプション・リストの表を返すサービス。一般的なキー値、オプションの値および各オプション・リストの順序を返します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.8.8 GET_USER_METADATA_INFO

ユーザーのメタデータ情報を返すサービス。SOAP取得とともに使用されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.8.9 MOVE_METADEF

リストのメタデータ・フィールドを上下に移動するために構成マネージャで使用されるサービス。リストでメタデータを移動すると、「チェックイン」、「更新」、「情報」、「検索」ページで表示されるデフォルトの順序が変更されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dName: 移動するメタデータ・フィールドの名前。

オプションのサービス・パラメータ

- isMoveUp: デフォルトはfalseです。trueに設定すると、フィールドを下ではなく、上に移動します。

4.8.10 UPDATE_ADVANCED_SEARCH_OPTIONS

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.8.11 UPDATE_USER_META

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.8.12 UPDATE_USER_META_TABLE

データベースのユーザー情報フィールドを更新するサービス。このサービスは、列を追加、変更および削除することによって、データベースを変更します。

- デフォルトで、フィールドは追加または変更のみ可能です。削除することはできません。ユーザー情報フィールドを削除するには、オプション・パラメータMetaFieldsToDeleteで明記する必要があります。

- このサービスは、「ユーザー管理」アプレットのユーザー情報フィールドを追加または削除し、「データベース設計の更新」ボタンをクリックするときに実行されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

注意:

列が削除される場合は、データが消失する可能性があります。このサービスは注意深く使用してください。

オプションのサービス・パラメータ

- MetaFieldsToDelete: 削除するデータベース列のカンマ区切りのリストを指定します。

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=UPDATE_USER_META_TABLE

- HDA形式(データベースから2つのフィールドを削除します):

@Properties LocalData
IdcService=UPDATE_USER_META_TABLE
MetaFieldsToDelete=xUserLocation,xDivision
@end

4.8.13 UPDATE_META_TABLE

データベースのメタデータ・フィールドを更新するサービス。

このサービスは、DocMetaDefinition表に準拠するためにDocMeta表の列を追加、変更および削除することによってデータベースを変更します。デフォルトで、フィールドは追加または変更のみ可能です。削除することはできません。メタデータ・フィールドを削除するには、オプション・パラメータMetaFieldsToDeleteで明記する必要があります。

このサービスは、「構成マネージャ」アプレットのメタデータ・フィールドを追加または削除し、「データベース設計の更新」ボタンをクリックするときに実行されます。

注意:

列が削除される場合は、データが消失する可能性があります。このサービスは注意深く使用してください。

オプションのサービス・パラメータ

- MetaFieldsToDelete: DocMeta表から削除するためにデータベース列のカンマ区切りのリストを指定します。

例

- IdcCommandコマンド・ファイル・フォーマット:

# Synchronize the DocMeta table with the design in the DocMetaDefinition table
IdcService=UPDATE_META_TABLE

- HDA形式(データベースから2つのフィールドを削除します):

@Properties LocalData
IdcService=UPDATE_META_TABLE
MetaFieldsToDelete=xInteger,xMemo
@end

4.8.14 UPDATE_OPTION_LIST

メタデータ・フィールドのオプション・リストを追加または更新するサービス。OptionListsデータベース表のオプション・リストを更新または追加します。

注意:

OptionListStringパラメータで指定されたオプション・リスト値は既存の値を置き換えます。既存の値を保持するには、新しい値とともに既存の値を含める必要があります。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dKey: オプション・リスト・キー。

- OptionListString: \nエスケープ・シーケンスで区切られるオプションのリスト。

例

- IdcCommandコマンド・ファイル・フォーマット:

# Add the new options list 'LocationList' and
# Add values Madrid, Tokyo, London, Washington
IdcService=UPDATE_OPTION_LIST
dKey=LocationList
OptionListString=Madrid\nTokyo\nLondon\nWashington

- HDA形式(Madrid、Tokyo、London、Washingtonの値でオプション・リストLocationListを追加します):

@Properties LocalData
IdcService=UPDATE_OPTION_LIST
dKey=LocationList
OptionListString=Madrid\nTokyo\nLondon\nWashington
@end

4.9 その他のサービス(コアContent Server)

この項のサービスは、バッチ・ロードの使用、ページの取得、アップロード用ファイルのチャンク化など、様々なタスクに使用されます。この項では、次のサービスについて説明します。

- CHUNKED_UPLOAD

- DOWNLOAD_LISTBOX_ITEMS

- LOAD_USER_LOCALIZATION

4.9.1 CHUNKED_UPLOAD

このサービスでは、非常に大きなContent Serverサービスをコールするためのサポートを追加します。このサービスはリクエストをチャンク化します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.9.2 DOWNLOAD_LISTBOX_ITEMS

UsersまたはAlias表に先行入力機能を提供するSelectUserアプレットで使用されるサービス。このサービスは、問合せの結果を含む結果セットListBoxServiceItemsを返します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dataSource: 使用するデータソースの名前(たとえば、問合せスタブの選択)。

オプションのサービス・パラメータ

- limit: ダウンロードするアイテム数。デフォルトは100です。

- op: WHERE句を作成する際に使用する演算子。

4.9.3 LOAD_USER_LOCALIZATION

ユーザーのローカライズ情報をロードするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.10 ページ・ハンドラ/ページ・リクエスト・サービス(コアContent Server)

ページ・リクエスト・サービスはHTMLページを取得します。ページ・ハンドラ・サービスは、Webレイアウト・エディタによって作成されるライブラリWebページを管理します。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

この項では、次のサービスについて説明します。

- DELETE_RESULT_TEMPLATE

- *GET_ADMIN_PAGE

- *GET_DOC_PAGE

- *GET_DYNAMIC_PAGE

- GET_PERSONALIZED_JAVASCRIPT

- GET_PORTAL_PAGE

- *GET_SECURE_PAGE

- LOAD_GLOBALINCLUDES

- PAGE_HANDLER

- PNE_SAVE_QUERY

- PNE_UPDATE_PERSONAL_URLS

- PNE_UPDATE_PORTAL_INFO

- SAVE_GLOBALINCLUDES

- UPDATE_RESULT_TEMPLATE

4.10.1 DELETE_RESULT_TEMPLATE

既存の検索結果テンプレートを削除するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- name: 検索結果テンプレート名。

例

IdcService=DELETE_RESULT_TEMPLATE
name=test_template

4.10.2 GET_ADMIN_PAGE

ブラウザで「管理」ページを返すサービス。このサービスは、サーバーの構成をロードしません。ユーザーが「管理者」ロールを割り当てられない場合、このサービスはエラー・メッセージを返します。

アクセス・レベル: N/A (0)

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- PageName: ページ・テンプレートの名前。

オプションのサービス・パラメータ

- Action: 実行するアクション。通常GetTemplatePageに設定されます。

結果

- ローカル・データ:

- TemplateType

- TemplateClass

- TemplateFilePath

- レスポンス・テンプレート: Pageパラメータの値として渡されたテンプレートを返します。標準の使用では、これはADMIN_LINKS (admin.htm)です。

次が使用

- リソース・インクルード:

- pne_nav_admin_links

- std_admin_pages

- テンプレート:

- ADMIN_LINKS (admin.htm)

- IDC_ADMIN_PAGE (idc_admin_page.htm)

- std_home_page.htm

- 標準ナビゲーション: commonNav.js

例

標準の管理ページを取得するには:

IdcService=GET_ADMIN_PAGE
Page=ADMIN_LINKS
Action=GetTemplatePage

4.10.3 GET_DOC_PAGE

HTMLページ・リクエストを実行するサービス。このサービスは通常、ブラウザ・インタフェースからコールされます。LOAD_DOC_ENVIRONMENTサブサービスを実行します。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

サブサービスのコール: LOAD_DOC_ENVIRONMENT

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- PageName: ページ・テンプレートの名前。

オプションのサービス・パラメータ

- Action: 実行するアクション。通常GetTemplatePageに設定されます。

結果

- ResultSets:

- DocFormats (DocFormatsデータベース表のすべての行およびフィールド)

- DocTypes (DocTypesデータベース表のすべての行およびフィールド)

- ローカル・データ:

- TemplateClass

- TemplateFilePath

- TemplateType

- レスポンス・テンプレート: Pageパラメータの値として渡されたテンプレートを返します。

次が使用

- リソース・インクルード:

- calculate_doc_profile_urls

- determine_wf_review_rendition_url

- home_page_static_content

- pne_nav_bookmark_links

- pne_nav_shared_links

- search_template_user_info_settings

- std_js_bootstrap_vars

- std_main_page_begin

- std_query_page_link_args

- xui_searchapi_results_action_form

- テンプレート:

- PNE_PORTAL_DOC_PROFILES_PAGE (pne_portal_doc_profiles_page.htm)

- PNE_PORTAL_PERSONAL_URLS_PAGE (pne_portal_personal_urls_page.htm)

- PNE_PORTAL_SAVED_QUERIES_PAGE (pne_portal_saved_queries_page.htm)

- PNE_PORTAL_SYSTEM_LINKS_PAGE (pne_portal_system_links_page.htm)

- PREVIEW_FRAMES (preview_frames.htm)

- USER_INFO (user_info.htm)

- Standard Navigation:

- commonNav.js

- Trays/layout.js

- Trays/search_tray_tabs.htm

- その他:
リダイレクト・サービスの対象: SUBMIT_HTML_FORM、LOGIN, EDIT_USER_PROFILE、CONTINUE_SUBMIT_HTML_FORM,、UPLOAD_NEW_COMPONENT、CANCEL_COMPONENT_INSTALL、UPDATE_COMPONENT_CONFIG、UNINSTALL_COMPONENT、SAVE_USER_TOPICS、PUBLISH_SCHEMA、EDIT_SCHEMA_VIEW_VALUES

例

- ホーム・ページを取得するには、パラメータは次のとおりです。

IdcService=GET_DOC_PAGE
Page=HOME_PAGE
Action=GetTemplatePage

- 標準の問合せページを取得するには、パラメータは次のとおりです。

IdcService=GET_DOC_PAGE
Page=STANDARD_QUERY_PAGE
Action=GetTemplatePage

4.10.4 GET_DYNAMIC_PAGE

動的アセンブリのライブラリ・ページを返すサービス。このサービスは、次の2通りの方法で使用できます。

- Content Serverシステムで直接表示するために、ライブラリ・ページをロードする。

- ライブラリ・ツリー表示でノードを動的に生成または更新するために非表示フレームでバックグラウンドで使用される。

DIRECTORY_PAGEサービス(dir_page.htm)で使用されるデフォルトのテンプレートは、サービスの2つの使用法の一方または他方を実行するために、lmXMLの値に基づいてブランチされます。lmXMLが1 (true)に設定される場合、テンプレートはHTMLページではなく、XMLオブジェクトを生成し、libraryNodeLoadSequenceを起動して、ライブラリ・ナビゲーション・ツリーを更新します。

アクセス・レベル: 読取り、スクリプト作成可能(33)

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- PageName: ページ・テンプレートの名前。

結果

- ResultSets:

- PageMap(このライブラリ・ノード内に含まれるローカル・ページを含む結果セット。フィールド: PageName、PageParent)

- LinkList(このライブラリ・ノード内に含まれるリンクのリストを含む結果セット。フィールド: LinkType、LinkData、LinkTitle、LinkDescription)

- ローカル・データ:

- dSecurityGroup

- HeaderText

- LinkSelectedIndex

- LocationInfo

- OutOfDate

- PageFunction

- PageLastChanged

- PageName

- PageParent

- PageTitle

- PageType

- PageUrl

- restrictByGroup

- TemplatePage

- レスポンス・テンプレート: null(サービスの実行中に、TemplatePageの値がDIRECTORY_PAGE (dir_page.htm)に設定されます)。

次が使用

- アプレット: インストーラ

- リソース・インクルード:

- calculate_all_doc_profile_urls

- home_page_static_content

- pne_nav_shared_links

- std_main_page_begin

- std_page_nav_bar

- 標準ナビゲーション: commonNav.js

例

索引ページを取得するには、必須パラメータは次のとおりです。

IdcService=GET_DYNAMIC_PAGE
PageName=index
Action=GetTemplatePage

4.10.5 GET_PERSONALIZED_JAVASCRIPT

特定のユーザーのページのナビゲーション情報を配信するサービス。ブラウザが最適にJavaScriptをキャッシュする場合、これにより、ブラウザはすべてのページ・ロード時にURLをリクエストできなくなります。ナビゲーション・データが変更される場合、URLの最後に追加される数値IDは変更され、ブラウザはそのページを再ロードします。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.10.6 GET_PORTAL_PAGE

「ポータル・デザイン」ページを表示するサービス。最も発生しがちなエラーは、構成情報のロード中、オプション・リストの取得中や参照されるHTMLページが見つからない場合にエラーが発生することです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- Action: 実行するアクション。通常GetTemplatePage。

- PageName: ページ・テンプレートの名前。次の標準ページは、このパラメータを使用して表示されます。

- 「ポータル・デザイン」ページ PNE_PORTAL_DESIGN_PAGE

- 「システム・リンク」ページ PNE_PORTAL_SYSTEM_LINKS_PAGE

- 「保存済問合せ」ページ PNE_PORTAL_SAVED_QUERIES_PAGE

- 「パーソナルURL」ページ PNE_PORTAL_PERSONAL_URLS_PAGE

例

- 「ポータル・デザイン」ページを取得するには、パラメータは次のとおりです。

IdcService=GET_PORTAL_PAGE
Action=GetTemplatePage
Page=PNE_PORTAL_DESIGN_PAGE

- 「保存済問合せ」ページを取得するには、パラメータは次のとおりです。

IdcService=GET_PORTAL_PAGE
Action=GetTemplatePage
Page=PNE_PORTAL_SAVED_QUERIES_PAGE

4.10.7 GET_SECURE_PAGE

セキュアなHTMLページ・リクエストを実行するサービス。このサービスは通常、ブラウザ・インタフェースからコールされ、少なくとも1つのグループに対する書込み権限を持つユーザーに制限されます。最も発生しがちなエラーは、参照されるHTMLページが見つからないことです。

このサービスは、このサービスが少なくとも1つのセキュリティ・グループへの書込み権限が必要な場合を除いて、GET_DOC_PAGEでは読取りアクセス権のみが必要です。

このサービスはLOAD_DOC_ENVIRONMENTサブサービスを実行します。

アクセス・レベル: 書込み、グローバル、スクリプト作成可能(50)

サブサービスのコール: LOAD_DOC_ENVIRONMENT

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- Page: ページ・テンプレートの名前。

オプションのサービス・パラメータ

- Action: 実行するアクション。通常は、GetTemplatePage。

結果

- ResultSets:

- DocFormats (DocFormatsデータベース表のすべての行およびフィールド)

- DocTypes (DocTypesデータベース表のすべての行およびフィールド)

- ローカル・データ:

- TemplateClass

- TemplateFilePath

- TemplateType

- レスポンス・テンプレート: Pageパラメータの値として渡されたテンプレートを返します。

次が使用

- リソース・インクルード: pne_nav_management_links

- テンプレート: std_home_page.htm

例

コンテンツ管理ページを取得するには、パラメータは次のとおりです。

IdcService=GET_SECURE_PAGE
Page=DOC_MANAGEMENT_LINKS
Action=GetTemplatePage

4.10.8 LOAD_GLOBALINCLUDES

ポータル・ページ・コンテンツを返すサービス。このサービスは動的ページのページ・アセンブリ・プロセス中に使用されます。「Webレイアウト・エディタ」アプレットを使用して、「オプション」→「ポータルの更新」を選択します。この画面に表示されるコンテンツは、このサービスを実行する場合に、Content Serverから返されるコンテンツです。

場所: IdcHomeDir/resources/core/templates//std_services.htm

4.10.9 PAGE_HANDLER

Webレイアウト・エディタで定義される静的Webレイアウト構造を再構築するサービス。HDA形式でページ・リスト全体を返します。このサービスは非同期であり、アクションは、バックグラウンド・スレッドで実行されます。このサービスは、Content Serverインスタンスのコンテキストでのみ実行することができ、Content Serverインスタンスに接続された場合にのみ正常に完了します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IsRebuild: 再構築を有効にします。

- Webレイアウト・ページを再構築するには、サーバーに対してtrue (1)に設定する必要があります。

- デフォルトはfalse (0)です。

- PageFunction: GetPageListに設定する必要があります。

例

- IdcCommandコマンド・ファイル形式(Webレイアウト・ページを再構築):

# Rebuild the entire search index
IdcService=PAGE_HANDLER
PageFunction=GetPageList
IsRebuild=1

- HDA形式(Webレイアウト・ページを再構築):

@Properties LocalData
IdcService=PAGE_HANDLER
PageFunction=GetPageList
IsRebuild=1
@end

4.10.10 PNE_SAVE_QUERY

現在のユーザーのユーザー・プロファイルに検索問合せを保存するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

このパラメータは動的HTML定義query_save_for_personalization_list_form_common_fieldsのstd_page.htmで示されます。パラメータは次のとおりです。

- queryText

- queryTitle

- sortField

- ResultCount

4.10.11 PNE_UPDATE_PERSONAL_URLS

現在のユーザーのユーザー・プロファイルで個人用URLを更新するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- Action: 実行するアクション。通常GetTemplatePageに設定されます。

- Page: ページ・テンプレートの名前。

- titleEd: ポータル・ナビゲーション・バーに表示されるリンク名。

- websiteEd: リンクとして保存されるURL。

例

IdcService=PNE_UPDATE_PERSONAL_URLS
Page=PNE_PORTAL_PERSONAL_URLS_PAGE
Action=GetTemplatePage
titleEd=Company
websiteEd=http://www.example.com

4.10.12 PNE_UPDATE_PORTAL_INFO

現在のユーザーのユーザー・プロファイルでシステム・リンクを更新するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- Action: 実行するアクション。通常GetTemplatePageに設定されます。

- PageName: ページ・テンプレートの名前。

例

IdcService=PNE_UPDATE_PORTAL_INFO
Page=PNE_PORTAL_DESIGN_PAGE
Action=GetTemplatePage

4.10.13 SAVE_GLOBALINCLUDES

動的ページのページ・アセンブリ・プロセス中に使用されるすべてのグローバル・インクルードを保存するサービス。このサービスは、Webレイアウト・エディタからポータル・ページを更新する際に実行されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IsRebuild: ポータル・ページの再構築を有効にします。

- ポータル・ページを更新するには、Content Serverシステムに対して1 (true)に設定する必要があります。

- デフォルトは0 falseです。

- PageFunction: GetPageListに設定する必要があります。

例

IdcService=SAVE_GLOBALINCLUDES
PageFunction=GetPageList
IsRebuild=1

4.10.14 UPDATE_RESULT_TEMPLATE

検索結果テンプレートを更新するサービス。

「Webレイアウト・エディタ」アプレットを起動して、「オプション」→「問合せ結果ページ」を選択し、「追加」、「削除」または「編集」をクリックし、テンプレート情報を入力して、「OK」をクリックすると、このサービスが実行されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

注意:

HDA形式で新しい問合せ結果テンプレートを追加するために必要なエントリの次の例を参照してください。

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=UPDATE_RESULT_TEMPLATE

- HDAファイル形式(my_research_templateと呼ばれる新しい問合せ結果テンプレートを追加します)。

@Properties LocalData
IdcService=UPDATE_RESULT_TEMPLATE
@end
@ResultSet ResultPageUpdates
6
name
formtype
filename
outfilename
flexdata
description
my_research_template
ResultsPage

Text2<$dDocAuthor$><$dSecurityGroup$>Text1<$dDocTitle$>
testing the update template sevice
@end

重要:

ResultsPageエントリとText2エントリ間に2つの空行があることに注意してください。これは、filenameおよびoutfilenameに値がないため必要です(空行は空の値を定義します)。

4.11 プロバイダ・マネージャ・サービス(コアContent Server)

プロバイダ・マネージャ・サービスは、外部エンティティへの接続を確立するプロバイダを処理します。この項では、次のサービスについて説明します。

- ADD_EDIT_PROVIDER

- APPEND_DATABASE_AUDIT_INFO

- DELETE_PROVIDER

- ENABLE_DISABLE_PROVIDER

- GET_ADD_EDIT_PROVIDER_FORM

- GET_ALL_PROVIDERS

- GET_PROVIDER_INFO

- NOTIFY_CHANGE

- REQUEST_SECURITYINFO

- TEST_PROVIDER

4.11.1 ADD_EDIT_PROVIDER

新しいプロバイダを作成するサービス。最も発生しがちなエラーは、プロバイダ名が一意でないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- pName: プロバイダ名。

- ProviderClass: プロバイダ・クラス。

- pDescription: プロバイダの説明。

- pType: プロバイダのタイプ。

- データベース: 接続および通信用のAPIを提供する情報リポジトリ・サーバー。これは、情報を取得し、情報をデータベースで変更できるようにします。このタイプの例は、システム・データベースおよびLDAPです。

- 受信: ブラウザまたはクライアント・アプリケーションのような、外部エンティティから開始された接続。サーバーはリスニングを行い、受信接続を認識します。

- 送信: 外部エンティティに対して開始された接続。このタイプを使用して、コンテンツ・サーバー・インスタンス間の通信ができます。

- プレビュー: DTM server for HTML PreviewとContent Categorizerのように、Content Serverとプレビュー・テクノロジ間の接続を確立するAPI。

- LDAP: Lightweight Directory Access Protocol。

例

IdcService=ADD_EDIT_PROVIDER
pName=admin_provider
pType=Database
pDescription=provider description
ProviderClass=providerclass

4.11.2 APPEND_DATABASE_AUDIT_INFO

「システム監査情報」ページの情報を返すためにGET_SYSTEM_AUDIT_INFOで使用されるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.11.3 DELETE_PROVIDER

既存のプロバイダを削除するサービス。最も発生しがちなエラーは、プロバイダ名がシステムに存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- pName: プロバイダ名。

例

IdcService=DELETE_PROVIDE
pName=Proxied_2_on_test13

4.11.4 ENABLE_DISABLE_PROVIDER

既存のプロバイダの状態の有効化/無効化を元に戻すサービス。プロバイダが有効な場合、サービスはその状態を無効にします。プロバイダが無効な場合、サービスはその状態を有効にします。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- pName: プロバイダ名。

- pDescription: プロバイダの説明。

- pType: プロバイダのタイプを作成するために使用されます。どのコンポーネントもその独自のプロバイダ・タイプを追加できます。現在、次のタイプが承認されています。

- データベース: 接続および通信用のAPIを提供する情報リポジトリ・サーバー。これは、情報を取得し、情報をデータベースで変更できるようにします。このタイプの例は、システム・データベースおよびLDAPです。

- 受信: ブラウザまたはクライアント・アプリケーションのような、外部エンティティから開始された接続。サーバーはリスニングを行い、受信接続を認識します。

- 送信: 外部エンティティに対して開始された接続。このタイプを使用して、コンテンツ・サーバー・インスタンス間の通信ができます。

- プレビュー: DTM server for HTML PreviewとContent Categorizerのように、Content Serverとプレビュー・テクノロジ間の接続を確立するAPI。

- LDAP: Lightweight Directory Access Protocol。

オプションのサービス・パラメータ

- IsEnabled: プロバイダの必要な状態、trueまたはfalse。

例

IdcService=ENABLE_DISABLE_PROVIDER
pName=Proxied_2_on_test13
pType=outgoing

4.11.5 GET_ADD_EDIT_PROVIDER_FORM

ブラウザでプロバイダを追加または編集するためのフォームを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- isEdit: 1 (true): 既存のプロバイダが編集されます。0 (false): 新しいプロバイダが追加されます。

- pName: プロバイダ名。プロバイダを編集する場合にのみ必要。

- pType: プロバイダのタイプ。

- データベース: 接続および通信用のAPIを提供する情報リポジトリ・サーバー。これは、情報を取得し、情報をデータベースで変更できるようにします。このタイプの例は、システム・データベースおよびLDAPです。

- 受信: ブラウザまたはクライアント・アプリケーションのような、外部エンティティから開始された接続。サーバーはリスニングを行い、受信接続を認識します。

- 送信: 外部エンティティに対して開始された接続。このタイプを使用して、コンテンツ・サーバー・インスタンス間の通信ができます。

- プレビュー: DTM server for HTML PreviewとContent CategorizerのようにContent Serverとプレビュー・テクノロジ間の接続を確立するAPI。

- LDAP: Lightweight Directory Access Protocol。

- ResourceTemplate: フォームのリソース・テンプレート。プロバイダを追加する場合にのみ必要。

例

- プロバイダを追加する場合は、渡すパラメータは次のようになります。

IdcService=GET_ADD_EDIT_PROVIDER_FORM
pType=preview
ResourceTemplate=PROVIDER_ADD_PREVIEW
isEdit=0

- プロバイダを編集する場合は、渡すパラメータは次のようになります。

IdcService=GET_ADD_EDIT_PROVIDER_FORM
pType=outgoing
pName=Proxied_2_on_server02
isEdit=1

4.11.6 GET_ALL_PROVIDERS

すべてのプロバイダのリストを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.11.7 GET_PROVIDER_INFO

プロバイダに関する情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- pName: プロバイダ名。

- ResourceTemplate: ページ表示のリソース・テンプレート。ブラウザ・インタフェースからサービスを実行する場合にのみ必要。例:

ResourceTemplate=DATABASE_PROVIDER_INFO

例

IdcService=GET_PROVIDER_INFO
pName=SystemDatabase

4.11.8 NOTIFY_CHANGE

送信プロバイダ経由で変更のContent Serverインスタンスを別のContent Serverインスタンスに通知するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: 通知されるContent Serverインスタンスの名前。

例

IdcService=NOTIFY_CHANGE
IDC_Name=Master_on_server01

4.11.9 REQUEST_SECURITYINFO

Content Serverインスタンスからすべてのセキュリティおよびユーザー情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.11.10 TEST_PROVIDER

プロバイダをテストするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- pName: プロバイダ名。

例

IdcService=TEST_PROVIDER
pName=provider22

4.12 スキーマ・サービス(コアContent Server)

これらのサービスは、オプション・リストなど、データベース表のJavaScriptファイルのサーバー側の公開を管理します。この項では、次のサービスについて説明します。

- ADD_SCHEMA_FIELD

- ADD_SCHEMA_RELATION

- ADD_SCHEMA_VIEW

- ADDOREDIT_SCHEMA_TABLE

- CONTROL_SCHEMA

- DELETE_SCHEMA_FIELD

- DELETE_SCHEMA_RELATION

- DELETE_SCHEMA_TABLE

- DELETE_SCHEMA_VIEW

- EDIT_SCHEMA_FIELD

- EDIT_SCHEMA_NODE

- EDIT_SCHEMA_RELATION

- EDIT_SCHEMA_VIEW

- EDIT_SCHEMA_VIEW_VALUES

- GET_SCHEMA_FIELD_INFO

- GET_SCHEMA_FIELDS

- GET_SCHEMA_RELATIONS

- GET_SCHEMA_STATS

- GET_SCHEMA_TABLE_INFO

- GET_SCHEMA_TABLES

- GET_SCHEMA_VIEW_EDIT_INFO

- GET_SCHEMA_VIEW_FRAGMENT

- GET_SCHEMA_VIEW_INFO

- GET_SCHEMA_VIEW_VALUES

- GET_SCHEMA_VIEWS

- PUBLISH_SCHEMA

4.12.1 ADD_SCHEMA_FIELD

スキーマ表にフィールドを追加するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schFieldName: 含めるフィールドの名前。

4.12.2 ADD_SCHEMA_RELATION

既存のスキーマにリレーションを追加するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schRelationName: 含めるリレーションの名前。

4.12.3 ADD_SCHEMA_VIEW

スキーマに新しいビューを追加するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schViewName: 追加されるビューの名前。

- schViewType: 追加されるスキーマ・ビューのタイプ。

- schTableName: ビューを関連付ける表の名前。

4.12.4 ADDOREDIT_SCHEMA_TABLE

スキーマで使用される表を追加または編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.12.5 CONTROL_SCHEMA

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.12.6 DELETE_SCHEMA_FIELD

スキーマ表からフィールドを削除するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schFieldName: 削除されるフィールドの名前。

4.12.7 DELETE_SCHEMA_RELATION

スキーマからリレーションを削除するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schRelationName: 削除されるリレーションの名前。

4.12.8 DELETE_SCHEMA_TABLE

スキーマから表を削除するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schTableName: 削除されるリレーションの名前。

4.12.9 DELETE_SCHEMA_VIEW

スキーマからビューを削除するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schViewName: 削除されるビューの名前。

4.12.10 EDIT_SCHEMA_FIELD

スキーマでフィールドを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schFieldName: 編集されるフィールドの名前。

4.12.11 EDIT_SCHEMA_NODE

スキーマでノードを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- editViewValueAction: ノードに使用されるアクション。

- schViewName: ノードに使用されるビューの名前。

4.12.12 EDIT_SCHEMA_RELATION

スキーマ・リレーションを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schRelationName: 編集されるリレーションの名前。

- schTablenTable: リレーションに使用される表の番号(たとえば、Table1、Table2)。この値が提供されない場合、リレーションの表は使用されません。

4.12.13 EDIT_SCHEMA_VIEW

スキーマ・ビューを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schViewType: 編集されるビューのタイプ。

- schViewName: 編集されるビューの名前。

- schTableName: スキーマに関連付けられている表の名前。

4.12.14 EDIT_SCHEMA_VIEW_VALUES

スキーマ・ビューで値を編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schViewName: 使用されるビューの名前。

4.12.15 GET_SCHEMA_FIELD_INFO

特定のスキーマ・フィールドに関する情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schFieldName: 使用されるフィールドの名前。

4.12.16 GET_SCHEMA_FIELDS

スキーマで使用されるフィールドに関する情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.12.17 GET_SCHEMA_RELATIONS

スキーマとともに使用されるリレーションに関する情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.12.18 GET_SCHEMA_STATS

「システム監査情報」ページの「アクティブなコンソール出力トレース・レポートの編集」スキーマの使用に関する統計を収集するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.12.19 GET_SCHEMA_TABLE_INFO

スキーマで使用されるすべての表に関する情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.12.20 GET_SCHEMA_TABLES

表に関する情報およびスキーマで使用される表の情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.12.21 GET_SCHEMA_VIEW_EDIT_INFO

スキーマ・ビューの編集可能な情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schViewName: 使用されるビューの名前。

4.12.22 GET_SCHEMA_VIEW_FRAGMENT

スキーマベースのオプション・リストのフラグメントを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schViewName: 使用されるビューの名前。

オプションのサービス・パラメータ

- schRelationName: このフィールドがDependent Choice List (DCL)である場合、これはリスト結果をフィルタするために使用されるスキーマ・リレーションの名前です。

- schParentValue: このフィールドがDCLである場合、これはリストをフィルタするために使用される親フィールドの値です。

4.12.23 GET_SCHEMA_VIEW_INFO

指定されたビューの表および他の情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schViewName: 使用されるビューの名前。

4.12.24 GET_SCHEMA_VIEW_VALUES

指定されたビューで値を表示するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- schViewName: 使用されるビューの名前。

4.12.25 GET_SCHEMA_VIEWS

すべての定義されたスキーマ・ビューを取得するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.12.26 PUBLISH_SCHEMA

すべてのスキーマのパブリッシュを開始するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.13 Search Services (Core Content Server)

検索サービスは、Content Serverシステム内の検索を管理するために使用されます。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

この項では、次のサービスについて説明します。

- APPEND_SEARCH_AUDIT_INFO

- GET_EXTERNAL_DOC_INFO

- GET_EXTERNAL_HIGHLIGHT_INFO

- GET_EXTERNAL_XML_HIGHLIGHT_INFO

- GET_HIGHLIGHT_INFO

- *GET_SEARCH_RESULTS

- GET_SEARCH_RESULTS_FORCELOGIN

- GET_XML_HIGHLIGHT_INFO

- PNE_GET_SEARCH_RESULTS

- VIEW_DOC

4.13.1 APPEND_SEARCH_AUDIT_INFO

「システム監査情報」ページの情報を返すためにGET_SYSTEM_AUDIT_INFOで使用されるサブサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.13.2 GET_EXTERNAL_DOC_INFO

外部Verityコレクションからのコンテンツ情報を取得するサービス。LightlyManagedContentコンポーネントとともに使用されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- sCollectionID: コレクションを検索するために、Content Serverシステムによって使用されるコレクションID。

例

IdcService=GET_EXTERNAL_DOC_INFO
dDocName=adminform113

4.13.3 GET_EXTERNAL_HIGHLIGHT_INFO

外部コレクションのコンテンツ・アイテムのPDFまたはHTML強調表示情報を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- HighlightType: 強調表示のタイプ。

- PDFの場合は、PdfHighlightを使用します。

- HTMLの場合は、HtmlHighlightを使用します。

- QueryText: 全文検索表現。

- SortField: ソートの基準となるメタデータ・フィールドの名前。

- 例: dInDate、dOutDate、alternateFile。

- デフォルトはDocIdです。

- SortOrder: ソート順序。使用できる値は、ASC(昇順)およびDESC(降順)です。

例

IdcService=GET_EXTERNAL_HIGHLIGHT_INFO
dDocName=test113
HighlightType=PdfHighlight
QueryText=test
SortField=dInDate
SortOrder=Desc

4.13.4 GET_EXTERNAL_XML_HIGHLIGHT_INFO

外部コレクションのコンテンツ・アイテムのXML強調表示情報を返すサービス。このサービスは、ユーザーがブラウザ環境でPDFドキュメントの全文検索を実行している場合にコールされます。これは、ユーザーが結果ページのPDFのリンクを選択し、PDFで強調表示された単語を表示する場合に行われます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- HighlightType: 強調表示のタイプ。

- PDFの場合は、PdfHighlightを使用します。

- HTMLの場合は、HtmlHighlightを使用します。

- QueryText: 全文検索表現。

- SortField: ソートの基準となるメタデータ・フィールドの名前。

- 例: dInDate、dOutDate、alternateFile。

- デフォルトはDocIdです。

- SortOrder: ソート順序。使用できる値は、ASC(昇順)およびDESC(降順)です。

例

IdcService=GET_EXTERNAL_XML_HIGHLIGHT_INFO
dDocName=test113
HighlightType=PdfHighlight
QueryText=test
SortField=dInDate
SortOrder=Desc

4.13.5 GET_HIGHLIGHT_INFO

コンテンツ・アイテムのPDFまたはHTML強調表示情報を返すサービス。

このサービスは、全文検索を実行し、検索結果ページでコンテンツIDまたはサムネイルをクリックする場合にブラウザ・インタフェースから実行されます。表示されたページで、検索した単語が強調表示されます。HTMLドキュメントの場合、単語は太字で表示され、PDFドキュメントの場合、単語は強調表示されます。

最も発生しがちなエラーは、そのコンテンツ・アイテムがすでにシステムに存在していないか、ユーザーがセキュリティ・チェックに失敗することです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- QueryText: 全文検索表現。

- SortField: ソートの基準となるメタデータ・フィールドの名前。

- 例: dInDate、dOutDate、alternateFile。

- デフォルトはDocIdです。

- SortOrder: ソート順序。使用できる値は、ASC(昇順)およびDESC(降順)です。

オプションのサービス・パラメータ

- dWebExtension: Web表示可能コンテンツのファイル拡張子。例: html、pdf、またはtxt。

- HighlightType: 強調表示のタイプ。

- PDFの場合は、PdfHighlightを使用します。

- HTMLの場合は、HtmlHighlightを使用します。

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=GET_HIGHLIGHT_INFO
dDocName=test_000043
QueryText=service
SortField=dInDate
SortOrder=Desc

- 任意のパラメータを持つHDA形式:

@Properties LocalData
IdcService=GET_HIGHLIGHT_INFO
dDocName=test_000043
QueryText=service
SortField=dInDate
SortOrder=Desc
HighlightType=HtmlHighlight
dWebExtension=html
@end

4.13.6 GET_SEARCH_RESULTS

特定の検索条件に一致するコンテンツ・アイテムのリストを返すサービス。

アクセス・レベル: 読取り(1)

サブサービスのコール: SUB

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- QueryText: 全文検索表現。

QueryTextパラメータにTitleやContent IDなどの値を添付して、このサービスで返される結果を絞り込むことができます。

オプションのサービス・パラメータ

- ResultCount: 返される結果の数。デフォルトは25です。

- SearchEngineName: 使用される検索エンジンの名前。デフォルトは、config/config.cfgファイルで指定された値です。
値は、databasefulltextまたはdatabaseを指定できます。databaseまたはdatabasefulltextに設定される場合、この例のように、QueryTextパラメータでSQLを渡す必要があります。

dDocTitle like 'test'

これは、Verity問合せと同等です。

dDocTitle <substring> 'test'

- SortField: ソートの基準となるメタデータ・フィールドの名前。

- 例: dInDate、dDocTitle、Score。

- デフォルトはdInDateです。

- SortOrder: ソート順序。使用できる値は、ASC(昇順)およびDESC(降順)です。

- SortSpec: 複数のフィールドのソートを可能にします。このパラメータを次の順序に設定します。

<sort field> <sort order> <sort field> <sort order>...

例: SortSpec=dDocTitle ASC dInDate DESC。

- StartRow: 検索結果表示を開始する行。たとえば、ResultCount=25の場合、StartRow=26に設定すると、結果の2番目のページが表示されます。

- EndRow: 検索結果表示を終了する行。

- vcrContentType: 検索可能なコンテンツ・タイプの名前。サーバーは、そのタイプのドキュメントに結果を制限するために、検索の問合せテキストを変更します。たとえば、指定されたコンテンツ・タイプがプロファイルを記述するタイプである場合、プロファイル・トリガー値がそのプロファイルの値と一致するユーザーに返されるドキュメントに制限するために、検索の問合せが変更されます。

- vcrAppendObjectClassInfo: trueに設定される場合、サーバーはvcrObjectClassというSearchResults ResultSetに列を追加します。この列は、結果の各ドキュメントに関連付けられているコンテンツ・タイプをリストします。デフォルトはtrueです。

例

IdcService=GET_SEARCH_RESULTS
QueryText=benefits

4.13.7 GET_SEARCH_RESULTS_FORCELOGIN

検索結果を取得する前に、ユーザーを強制的にログインさせるサービス。このサービスはGET_SEARCH_RESULTSと同じです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.13.8 GET_XML_HIGHLIGHT_INFO

コンテンツ・アイテムのXML強調表示情報を返すサービス。

このサービスは、ユーザーがブラウザ環境でPDFドキュメントの全文検索を実行している場合にコールされます。ユーザーが結果ページのPDFのリンクを選択し、PDFで強調表示された単語を表示する場合。

最も発生しがちなエラーは、コンテンツ・アイテム名が存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

- HighlightType: 強調表示のタイプ。

- PDFの場合は、PdfHighlightを使用します。

- HTMLの場合は、HtmlHighlightを使用します。

- QueryText: 全文検索表現。

- SortField: ソートの基準となるメタデータ・フィールドの名前。

- 例: dInDate、dOutDate、alternateFile。

- デフォルトはDocIdです。

- SortOrder: ソート順序。使用できる値は、ASC(昇順)およびDESC(降順)です。

例

IdcService=GET_XML_HIGHLIGHT_INFO
dDocName=test13
QueryText=service
SortField=dInDate
SortOrder=Desc
dDocName=TEST13
HighlightType=PdfHighlight

4.13.9 PNE_GET_SEARCH_RESULTS

検索結果を取得するために使用されるサービス。その表示は、ユーザーの環境設定(つまり、PNE設定)によって制御されます。

このサービスのQueryTextは、定義された検索エンジンを対象としており、そういうものとして、GET_SEARCH_RESULTSサービスに利用可能なすべてのパラメータを使用できます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- QueryText: 全文検索表現。

例

IdcService=PNE_GET_SEARCH_RESULTS
QueryText=benefits

4.13.10 VIEW_DOC

強調表示情報を返すサービス。

- コンテンツ・アイテム名が指定されると、このサービスはセキュリティ情報を評価し、コンテンツ・アイテム強調表示情報を表示します。

- 通常、このサービスは、Content Server検索コレクションではなく外部コレクションを持つ場合に使用されます。ただし、いずれの場合も、検索コレクションはVerity検索エンジンによって作成される必要があります。たとえば、外部コレクションで検索を実行する場合、コレクションがContent Serverインスタンスによって検索できるように、VdkVgwKeyおよびsCollectionIDパラメータを提供する必要があります。

- 通常、VdkVgwKeyはdDocNameです。Verityは各コンテンツ・アイテムに一意のIDを提供し、Content ServerシステムはそのVerity ID (VdkVgwKey)をdDocName (Content ID)とともにマップします。

- 場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- QueryText: 全文検索表現。

- sCollectionID: コレクションを検索するために、Content Serverシステムによって使用されるコレクションID。

- SortField: ソートの基準となるメタデータ・フィールドの名前。

- 例: dInDate、dOutDate、alternateFile。

- デフォルトはdocIDです。

- SortOrder: ソート順序。使用できる値は、Asc(昇順)およびDesc(降順)です。

オプションのサービス・パラメータ

- ViewType: 表示形式。このパラメータが定義されていない場合、ViewTextがデフォルトで使用されます。

- ViewTextに設定すると、Textとして表示されます。

- ViewHtmlに設定すると、HTMLとして表示されます。

例

IdcService=VIEW_DOC
IsCollectionID=external
SortField=dInDate
SortOrder=Desc
QueryText=test
ViewType=ViewText

4.14 ユーザー・サービス(コアContent Server)

ユーザー・サービスは、アカウント、エイリアス、ロールを追加するなど、ユーザー関連のアクティビティの管理を支援します。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

この項では、次のサービスについて説明します。

- ADD_ALIAS

- ADD_GROUP

- ADD_ROLE

- ADD_USER

- CHANGE_USER_AUTH_TYPE

- *CHECK_USER_CREDENTIALS

- DELETE_ALIAS

- DELETE_GROUP

- DELETE_ROLE

- DELETE_USER

- EDIT_ALIAS

- EDIT_GROUP

- EDIT_ROLE

- EDIT_USER

- *EDIT_USER_PROFILE

- GET_ALIASES

- GET_FILTER_ADMIN_PAGE

- GET_SELF_REGISTER_PAGE

- GET_USERDOCPROFILES

- *GET_USER_INFO

- GET_USERS

- LOAD_PNE_PORTAL

- *LOAD_USER_TOPIC

- QUERY_GROUP

- QUERY_USER_ATTRIBUTES

- REGISTER_USER

- *SAVE_USER_TOPICS

- UPDATE_FILTER_INFO

- UPDATE_USEROPTION_LIST

4.14.1 ADD_ALIAS

新しいエイリアスを作成するために使用されます。最も発生しがちなエラーは、パラメータに不整合があること、ユーザーまたはエイリアスがシステムにすでに存在することです。

「ユーザー管理」アプレットを使用してエイリアスを追加する場合、少なくとも1人のユーザーを追加する必要があります。ただし、IdcCommandまたはIdcCommandXを使用してユーザーを追加する必要はありません。IdcCommandまたはIdcCommandXを使用してユーザーを追加するには、オプション・パラメータAliasUsersStringを含む必要があります。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dAlias: エイリアス。

- dAliasDescription: エイリアスの説明。

オプションのサービス・パラメータ

- AliasUsersString: エイリアスまたはユーザー。複数のユーザーを追加するには:

- HDA形式で: この例のようにHDA形式を使用する場合は、各ユーザー名の間に\nエスケープ・シーケンスを使用します。

- AliasUsersString=sysadmin\nuser1

- SOAP形式を使用する場合は、エンコードされていない行送りをXMLに直接挿入するか、または行送りを(&#10;)としてエンコードします。

例

- エイリアスを作成し、ユーザーを追加するには、必須パラメータは次のとおりです。

IdcService=ADD_ALIAS
dAlias=my_alias
dAliasDescription=admin users
AliasUsersString=sysadmin

- HDA形式で、AliasUsersStringパラメータを指定してユーザーを追加します。

@Properties LocalData
IdcService=ADD_ALIAS
dAlias=my_alias
dAliasDescription=admin users
AliasUsersString=sysadmin
@end

- HDA形式で、AliasUserMapおよびAlias結果セットを指定してユーザーを追加します。

@Properties LocalData
IdcService=ADD_ALIAS
changedSubjects=aliases,1008291537850
dAliasDescription=Test Alias
refreshSubjects=
blFieldTypes=StatusMessage message
blDateFormat=M/d{/yy} {h:mm[:ss] {aa}[zzz]}!tAmerica/Chicago!mAM,PM
loadedUserAttributes=1
dUser=sysadmin
IsJava=1
changedMonikers=
refreshSubMonikers=
refreshMonikers=
dAlias=NewAlias
@end
@ResultSet AliasUserMap
2
dAlias 6 30
dUserName 6 50
YourAlias
Gillian
@end
@ResultSet Alias
2
dAlias 6 30
dAliasDescription 6 50
MyAlias
This is a test of adding an alias
NewAlias
Test Alias
YourAlias
Test Alias
@end

4.14.2 ADD_GROUP

新しいセキュリティ・グループを作成するサービス。最も発生しがちなエラーは、セキュリティ・グループ名が一意でないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dGroupName: セキュリティ・グループ名。

- dDescription: セキュリティ・グループの説明。

- dPrivilege: 権限の設定。
この値が0に設定され、管理者ロールがセキュリティ・グループに対してRWDA権限を持つ場合、他のロールはそのセキュリティ・グループにアクセスできません。値が15に設定される場合、すべてのロールがセキュリティ・グループに対するRWDA権限を取得します。権限のナンバリングの詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentの管理』を参照してください。

例

IdcService=ADD_GROUP
dGroupName=NEW_GROUP
dPrivilege=15
dDescription=admin privileges

4.14.3 ADD_ROLE

新しいロールを作成するサービス。ロールは、各セキュリティ・グループに対する一連の権限(読取り、書込み、削除、管理者)です。

このサービスは、すべての既存のセキュリティ・グループのRoleDefinition表に行を追加します。最も発生しがちなエラーは、ロール名が一意でないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dRoleName: ロール名。

- dPrivilege: 権限の設定。
この値が0に設定される場合、管理者ロールのみがセキュリティ・グループに対するRWDA権限を持ちます。他のロールはセキュリティ・グループにアクセスできません。値が15に設定される場合、すべてのロールがセキュリティ・グループに対するRWDA権限を取得します。権限のナンバリングの詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentの管理』を参照してください。

例

IdcService=ADD_ROLE
dRoleName=specialuser
dPrivilege=15

4.14.4 ADD_USER

新しいユーザーを作成するために使用されるサービス。最も発生しがちなエラーは、ユーザー名が一意でないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dName: ユーザー名。

- dUserAuthType: ユーザーの認可タイプ。この値は、LocalまたはGlobalのいずれかに設定する必要があります。

オプションのサービス・パラメータ

- dFullName: ユーザーのフルネーム。

- dPassword: ユーザーのパスワード。

- dEmail: ユーザーの電子メール・アドレス。

オプションの属性情報

オプションの属性情報は、ユーザーの属性情報を含み、ユーザーが属するロールおよびユーザーがアクセス権を持つアカウントを参照する結果セットで指定されます。属性情報は、3つのカンマ区切りの文字列のリストで構成されます。最初の文字列は、属性のタイプを示し、2番目の文字列は属性の名前を示し、3番目の文字列はアカウントのアクセス番号またはロールのデフォルトのエントリを示します。

重要:

ユーザー属性情報は、事前定義されていません。デフォルトでは、新しいユーザーはロールまたはアカウントに属さず、システム内のゲストになります。

- 属性のタイプ: ロールを定義するとき、最初の文字列ではこれがrole属性であることを指定し、2番目の文字列はロールの名前、3番目の文字列はデフォルト・エントリの15になります。
アカウントを定義するとき、最初の文字列ではこれがaccount属性であることを指定し、2番目の文字列はアカウントの名前、3番目の文字列はアクセス・レベルになります。

- role属性の場合、情報は次のようなフォームになります。

- role,contributor,15

- account属性の場合、情報は次のようなフォームになります。

- account,books,1

- 属性名: ユーザーは、複数のロールおよびアカウントに属することができます。そのため、属性情報列に、カンマで区切られた複数のロールおよびアカウント情報文字列が存在する可能性があります。ユーザーが管理者ロールを持つようにする場合、ユーザー属性情報は次のとおり定義します。

@ResultSet UserAttribInfo
2
dUserName
AttributeInfo
jsmith
role,contributor,15
@end

ユーザーがコントリビュータとエディタの両方のロールに属し、かつ会計帳簿の読取り権限を持つようにする場合、ユーザー属性情報は次のように定義します。

@ResultSet UserAttribInfo
2
dUserName
AttributeInfo
jsmith
role,contributor,15,role,editor,15,account,books,1
@end

- アクセス番号: ユーザーに次のアクセス番号を割り当てることができます。

- 1: 読取り専用

- 3: 読取りと書込み

- 7: 読取り、書込み、削除

- 15: 管理者権限

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=ADD_USER
dName=specialuser
dUserAuthType=LOCAL

- 任意のパラメータを持つHDA形式:

@Properties LocalData
IdcService=ADD_USER
dName=jsmith
dUserAuthType=LOCAL
dFullName=Jennifer Smith
dPassword=password
dEmail=jsmith@example.com
@end
@ResultSet UserAttribInfo
2
dUserName
AttributeInfo
jsmith
role,admin,15,role,contributor,15
@end

4.14.5 CHANGE_USER_AUTH_TYPE

ユーザーの認可タイプ(グローバル、ローカルまたは外部)を変更するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- curUserAuthType: 現在のユーザーの認可タイプ。

- dUserAuthType: 新しいユーザーの認可タイプ。

4.14.6 CHECK_USER_CREDENTIALS

ユーザーの資格証明をチェックするサービス。このサービスを使用して、ユーザーに関する情報(たとえば、ロールやアカウント)を取得し、それを使用してユーザー/パスワードのペアをチェックし、それらが一致することを確認できます。このサービスは認可プロセス中にコールされます。データはキャッシュされ、すべてのサービス・リクエストに対してコールされないようにします。

このサービスは、Content ServerインスタンスがADSIを使用するように構成される場合は、Microsoft Active Directory管理対象ユーザー用のユーザー・データを返しません。ローカル・ユーザーおよび外部LDAP管理対象ユーザー用のユーザー・データを返します。

アクセス・レベル: N/A (0)

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- userName: ユーザー名

オプションのサービス・パラメータ

- getUserInfo: 0 (false): 拡張されたユーザー情報を取得しません。1 (true): 拡張されたユーザー情報を取得します(フルネーム、電子メール・アドレス、ロケールおよびユーザー・タイプ)

- hasSecurityInfo: 0 (false): ユーザー・アカウントを取得します。1 (true): ユーザー・アカウントを取得しません。

- authenticateUser: 0 (false): ユーザーを認可しません(ユーザー/パスワードのペアが一致することを検証します)。1 (true): ユーザーを認可します(ユーザー/パスワードのペアが一致することを検証します)。この場合、userPasswordパラメータを指定する必要があります。

- userPassword: 指定したユーザー名のパスワード。authenticateUserパラメータが含まれ、1 (true)に設定される場合、userPasswordパラメータを指定する必要があります。

- userExtendedInfo: このパラメータは、getUserInfoパラメータと組み合せて、データ・バインダにユーザーのアカウントとグループを返します。0 (false): 情報を取得しません。1 (true): 情報を取得します。

結果

- ローカル・データ:

- extendedInfo: ユーザー情報フィールドを含むHDAエンコード文字列(ndUserLocale、nblFieldTypes、ndEmail、nblDateFormat、ndFullName、ndUserType、ndUserAuthType、ndUserChangeDate、ndUserTimeZoneおよびndUserArriveDate)。オプション・パラメータ「getUserInfo」が1 (true)の場合にのみ返されます。

- accounts: ユーザーのアカウントのカンマ区切りリスト。オプション・パラメータhasSecurityInfoが0 (false)の場合にのみ返されます。

- roles: ユーザーのロールのカンマ区切りリスト。オプション・パラメータhasSecurityInfoが0 (false)の場合にのみ返されます。

- hasSecurtyInfo: セキュリティ情報がレスポンスに存在する場合は、1 (true)を返します。

- isAuthenticated: オプション・パラメータauthenticateUserが1 (true)に設定され、オプション・パラメータuserPasswordがuserNameに対応するパスワードに一致する場合は、1 (true)を返します。

- isPromptLogin: userPasswordがuserNameに対応しない場合は1 (true)を返します。この状況では他のデータは返されません。

例

次は、ユーザーに関する情報を取得するためのCHECK_USER_CREDENTIALSサービス・コールの例です。

@Properties LocalData
IdcService=CHECK_USER_CREDENTIALS
userName=user1
getUserInfo=1
@end

次は、ユーザー情報を取得するためにこのサービス・コールによって返される結果の例です(アカウントが返されることに注意してください)。

Content-type: text/plain
<?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?>
@Properties LocalData
dUser=user1
blFieldTypes=
dUserOrgPath=
refreshSubMonikers=
accounts=#none,prj(RWD)
blDateFormat='{ts' ''yyyy-MM-dd HH:mm:ss'''}'!tAmerica/Chicago
StatusCode=0
dUserSourceOrgPath=
hasSecurityInfo=1
roles=contributor
refreshSubjects=
changedSubjects=
dName=user1
refreshMonikers=
changedMonikers=
extendedInfo=\@Properties LocalData\nu9=\nu8=\nu7=\ndUserArriveDate=
{ts '2003-02-11 08:34:35'}\nu6=\ndUserTimeZone=\nu5=\nu4=\nu3=\nu2=
\ndUserAuthType=LOCAL\nu1=\ndUserType=\ndUserChangeDate={ts '2003-04-03 11:57:29'}
\nuPhone=\nuCompany=\ndUserLocale=English-US\nblFieldTypes=\nu24=\nu23=\nu22=
\nu21=\nu20=\ndFullName=user1\nblDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS}
{aa}}!tAmerica/Chicago\ndEmail=\nu19=\nu18=\nu17=\nu16=\nu15=\nu14=\nu13=\nu12=
\nu11=\nu10=\n\@end\n\n
@end

次は、ユーザー情報を取得するためにこのサービス・コールによって返される結果の例です(アカウントが返されないことに注意してください)。

Content-type: text/plain
<?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?>
@Properties LocalData
dUser=user1
blFieldTypes=
refreshSubMonikers=
blDateFormat='{ts' ''yyyy-MM-dd HH:mm:ss'''}'!tAmerica/Chicago
StatusCode=0
changedSubjects=
refreshSubjects=
dName=user1
changedMonikers=
refreshMonikers=
extendedInfo=\@Properties LocalData\nu9=\nu8=\nu7=\ndUserArriveDate=
{ts '2003-02-11 08:34:35'}\nu6=\ndUserTimeZone=\nu5=\nu4=\nu3=\nu2=
\ndUserAuthType=LOCAL\nu1=\ndUserType=\ndUserChangeDate={ts '2003-04-03
11:57:29'}\nuPhone=\nuCompany=\ndUserLocale=English-US\nblFieldTypes=\nu24=\nu23=
\nu22=\nu21=\nu20=\ndFullName=user1\nblDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS}
{aa}}!tAmerica/Chicago\ndEmail=\nu19=\nu18=\nu17=\nu16=\nu15=\nu14=\nu13=\nu12=
\nu11=\nu10=\n\@end\n\n
@end

次は、ユーザー名/パスワードのペアが一致するかどうかを確認するためのCHECK_USER_CREDENTIALSサービス・コールの例です。

@Properties LocalData
IdcService=CHECK_USER_CREDENTIALS
userName=user1
authenticateUser=1
userPassword=idc
@end

次は、ユーザー名/パスワードのペアが一致するかどうかを確認するためにこのサービス・コールによって返される結果の例です(ユーザー名およびパスワードが一致していること、キーの戻り値がisAuthenticated=1であることに注意してください)。

Content-type: text/plain
<?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?>
@Properties LocalData
dUser=user1
blFieldTypes=
refreshSubMonikers=
blDateFormat='{ts' ''yyyy-MM-dd HH:mm:ss'''}'!tAmerica/Chicago
StatusCode=0
changedSubjects=
refreshSubjects=
dName=user1
changedMonikers=
refreshMonikers=
isAuthenticated=1
@end

次は、ユーザー名/パスワードのペアが一致するかどうかを確認するためのCHECK_USER_CREDENTIALSサービス・コールの別の例です。

@Properties LocalData
IdcService=CHECK_USER_CREDENTIALS
userName=user1
authenticateUser=1
userPassword=pppp
@end

次は、ユーザー名/パスワードのペアが一致するかどうかを確認するためにこのサービス・コールによって返される結果の例です(ユーザー名およびパスワードが一致していないこと、isAuthenticated=1ではなく、isPromptLogin=1が返されることに注意してください)。

Content-type: text/plain
<?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?>
@Properties LocalData
dUser=user1
blFieldTypes=
refreshSubMonikers=
blDateFormat='{ts' ''yyyy-MM-dd HH:mm:ss'''}'!tAmerica/Chicago
StatusCode=0
isPromptLogin=1
changedSubjects=
refreshSubjects=
dName=user1
changedMonikers=
refreshMonikers=
@end

4.14.7 DELETE_ALIAS

既存のエイリアスを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があること、エイリアスがワークフローで使用されないこと、またはシステムがエイリアスまたはユーザーを削除できないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dAlias: エイリアス。

例

IdcService=DELETE_ALIAS
dAlias=admin_alias

4.14.8 DELETE_GROUP

既存のセキュリティ・グループを削除するサービス。最も発生しがちなエラーは、このグループに関連付けられているコンテンツ・アイテムまたはワークフローがシステムに存在することです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dGroupName: セキュリティ・グループ名。

例

IdcService=DELETE_GROUP
dGroupName=admingroup

4.14.9 DELETE_ROLE

既存のロールを削除するサービス。最も発生しがちなエラーは、指定されたロールが存在しないか、ユーザーがこのロールを割り当てられていることです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dRoleName: ロール名。

例

IdcService=DELETE_ROLE
dRoleName=test_role

4.14.10 DELETE_USER

既存のユーザーを削除するサービス。最も発生しがちなエラーは、ユーザーがエイリアスに割り当てられていることです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dName: ユーザー名。

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=DELETE_USER
dName=jsmith

- HDA形式:

@Properties LocalData
IdcService=DELETE_USER
dName=jsmith
@end

4.14.11 EDIT_ALIAS

既存のエイリアスを変更するサービス。ユーザーを編集および追加するには、AliasUsersStringパラメータを含める必要があります。

場所: IdcHomeDir/resources/core/tables/std_services.htm

注意:

エイリアスを編集すると、エイリアスからすべての既存のデータ(説明およびユーザー)が削除されます。既存のデータを保持するには、新しいデータとともに既存のデータを含める必要があります。

追加の必須サービス・パラメータ

- dAlias: エイリアス。

- dAliasDescription: エイリアスの説明。

- AliasUsersString: エイリアスまたはユーザー。複数のユーザーを追加するには:

- HDA形式で: この例のようにHDA形式を使用する場合は、各ユーザー名の間に\nエスケープ・シーケンスを使用します。

AliasUsersString=sysadmin\nuser1

- SOAP形式を使用する場合は、エンコードされていない行送りをXMLに直接挿入するか、または行送りを(&#10;)としてエンコードします。

例

- エイリアスの編集:

IdcService=EDIT_ALIAS
dAlias=my_alias
dAliasDescription=new user
AliasUsersString=sysadmin\nuser1

- HDA形式では、AliasUsersStringパラメータを指定してユーザーを追加します。

@Properties LocalData
monitoredTopics=appcommongui,1000382277000
IdcService=EDIT_ALIAS
dAliasDescription=Test Alias
blFieldTypes=
blDateFormat=M/d{/yy} {h:mm[:ss] {aa}[zzz]}!tAmerica/Chicago!mAM,PM
watchedMonikers=
monitoredSubjects=usermetaoptlists,1008541017549,aliases,1008541017549,
userlist,1008541017549,users,1008541017549,metadata,1008541017549,config,100854
1017549,accounts,1008541017549
AliasUsersString=Gillian\nMonique\nsysadmin\n
dAlias=YourAlias
@end

- HDA形式では、AliasUserMapおよびAlias結果セットを指定してユーザーを追加します。

@Properties LocalData
refreshMonikers=
IsJava=1
refreshSubMonikers=
refreshSubjects=aliases,1008541017551
dAlias=YourAlias
refreshTopics=
AliasUsersString=Gillian\nMonique\nsysadmin\n
ClientEncoding=Cp1252
dUser=sysadmin
blDateFormat=M/d{/yy} {h:mm[:ss] {aa}[zzz]}!tAmerica/Chicago!mAM,PM
monitoredSubjects=usermetaoptlists,1008541017549,aliases,1008541017549,
userlist,1008541017549,users,1008541017549,metadata,1008541017549,config,
1008541017549,accounts,1008541017549
loadedUserAttributes=1
dUserName=sysadmin
watchedMonikers=
IdcService=EDIT_ALIAS
blFieldTypes=StatusMessage message
changedMonikers=
dAliasDescription=Test Alias
changedSubjects=
monitoredTopics=appcommongui,1000382277000
@end
@ResultSet AliasUserMap
2
dAlias 6 30
dUserName 6 50
YourAlias
Gillian
YourAlias
Monique
YourAlias
sysadmin
@end
@ResultSet UpdatedUserTopics
3
topicName
topicValue
topicTS
@end
@ResultSet Alias
2
dAlias 6 30
dAliasDescription 6 50
MyAlias
This is a test of adding an alias
NewAlias
Test Alias
YourAlias
Test Alias
@end

4.14.12 EDIT_GROUP

既存のセキュリティ・グループを変更するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dGroupName: セキュリティ・グループ名。

- dDescription: セキュリティ・グループの説明。

- dPrivilege: 権限の設定。
この値が0に設定される場合、管理者ロールのみがグループに対するRWDA権限を持ちます。他のロールはグループにアクセスできません。値が15に設定される場合、すべてのロールがグループにおけるRWDA権限を取得します。

例

IdcService=EDIT_GROUP
dGroupName=MY_GROUP
dPrivilege=0
dDescription=admin privileges

4.14.13 EDIT_ROLE

既存のロールを変更するサービス。ロールは、各セキュリティ・グループに対する一連の権限(読取り、書込み、削除、管理者)です。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dRoleName: 既存のロール名。

- dGroupName: セキュリティ・グループの名前。

オプションのサービス・パラメータ

- dPrivilege: 権限の設定。
この値が0に設定される場合、管理者ロールのみがグループに対するRWDA権限を持ちます。他のロールはグループにアクセスできません。値が15に設定される場合、すべてのロールがグループにおけるRWDA権限を取得します。権限のナンバリングの詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentの管理』を参照してください。

例

IdcService=EDIT_ROLE
dRoleName=test_role
dGroupName=MY_GROUP
dPrivilege=15

4.14.14 EDIT_USER

既存のユーザーを変更するサービス。最も発生しがちなエラーは、ユーザーがこのアクションを実行するためのセキュリティ・レベルを持っていないこと、またはユーザーが存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

注意:

ユーザーを編集すると、すべての既存のユーザー属性(ロールおよびアカウント権限)が削除されます。既存の属性を保持するには、新しいデータまたは変更したデータとともに既存の属性を含める必要があります。ユーザー属性が定義されていない場合、ユーザーは、ロールまたはアカウントに属さず、システム内のゲストになります。

注意:

指定されたユーザーが存在しない場合、Content Serverはユーザーを追加します。

追加の必須サービス・パラメータ

- dName: ユーザー名。

- dUserAuthType: ユーザーの認可タイプ。この値は、LocalまたはGlobalのいずれかに設定する必要があります。

オプションのサービス・パラメータ

- dFullName: ユーザーのフルネーム。

- dPassword: ユーザーのパスワード。

- dEmail: ユーザーの電子メール・アドレス。

- dUserLocale: ロケールの指定(English-US、English-UK、Deutsche、FrançaisまたはEspañol)。

- dUserType: ユーザーのタイプ。

オプションの属性情報

オプションの属性は、ユーザーの属性情報を含み、ユーザーが属するロールおよびユーザーがアクセス権を持つアカウントを指定する結果セットとして指定されます。属性情報は、3つのカンマ区切りの文字列のリストで構成されます。最初の文字列は、属性のタイプを示し、2番目の文字列は属性の名前を示し、3番目の文字列はアカウントのアクセス番号またはロールのデフォルトのエントリを示します。

- 属性のタイプ: ロールを定義するとき、最初の文字列はこれがrole属性であることを指定し、2番目の文字列はロールの名前、3番目の文字列はデフォルトのエントリ15になります。アカウントを定義するとき、最初の文字列ではこれがaccount属性であることを指定し、2番目の文字列はアカウントの名前、3番目の文字列はアクセス・レベルになります。

- role属性の場合、情報は次のようなフォームになります。
role,contributor,15

- account属性の場合、情報は次のようなフォームになります。
account,books,1

- 属性名: ユーザーは、複数のロールおよびアカウントに属することができます。そのため、属性情報列に、カンマで区切られた複数のロールおよびアカウント情報文字列が存在する可能性があります。ユーザーが管理者ロールを持つようにする場合、ユーザー属性情報は次のように定義します。

@ResultSet UserAttribInfo
2
dUserName
AttributeInfo
jsmith
role,contributor,15
@end

ユーザーがコントリビュータとエディタの両方のロールに属し、かつ会計帳簿の読取り権限を持つようにする場合、ユーザー属性情報は次のように定義します。

@ResultSet UserAttribInfo
2
dUserName
AttributeInfo
jsmith
role,contributor,15,role,editor,15,account,books,1
@end

- アクセス番号: ユーザーに次のアクセス番号を割り当てることができます。

- 1: 読取り専用

- 3: 読取りと書込み

- 7: 読取り、書込み、削除

- 15: 管理者権限

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=EDIT_USER
dName=user20
dUserAuthType=Local

- 任意のパラメータおよび属性情報を持つHDA形式:

@Properties LocalData
IdcService=EDIT_USER
dName=jsmith
dFullName=Jennifer Smith
dUserAuthType=Local
dPassword=password
dEmail=jsmith@example.com
dUserType=MKT
dUserLocale=English-US
@end

@ResultSet UserAttribInfo
2
dUserName
AttributeInfo
jsmith
role,admin,15,role,contributor,15
@end

4.14.15 EDIT_USER_PROFILE

既存のユーザーのユーザー・プロファイルを変更し、プロファイル設定を保存するサービス。これはユーザーのセキュリティ資格証明を変更するために使用することはできません。

アクセス・レベル: 読取り、グローバル(17)

場所: IdcHomeDir/resources/core/tables/std_services.htm

- Users表のフィールドはいずれも(dNameを除く)このサービスによって更新できます。

- このサービスを使用して、データベースに格納されていないパーソナライズ情報を編集できます。ユーザーの情報の一部はデータベースに格納され、一部はパーソナライズ・データ.hdaファイルに格納されます。

- データベースの情報については、単に対応するフィールド名と値が渡され、フィールドが更新されます。

- パーソナライズ・データについては、エンコードされたトピック文字列を使用する必要があります(たとえば、topicString1=updateKeys:pne_portal:lm_Layout:Trays)。

- パスワード値はプロキシ・ユーザーに対して更新することはできません。

- このサービスが失敗する最も発生しがちなエラーは、ユーザー(dName)がシステムで見つからないこと、dNameで渡されたユーザー名が現在のユーザーに一致しないことです。

追加の必須サービス・パラメータ

- dName: ユーザー名。

オプションのサービス・パラメータ

- dFullName: ユーザーのフルネーム。

- dPassword: ユーザーのパスワード。

- dEmail: ユーザーの電子メール・アドレス。

- dUserLocale: ロケールの指定(English-US、English-UK、Deutsche、FrançaisまたはEspañol)。

- dUserType: ユーザーのタイプ。

- emailFormatList: HTMLベースの電子メールの場合は、HTMLに設定し、テキストベースの電子メールの場合は、textに設定します。

- numTopics: このリクエストの追加のパーソナライズ・トピックの数。

- topicString1: 更新するパーソナライズ・トピックのエンコードされた文字列。

- numTopics: 渡されるトピック文字列の合計数。

- User表からのすべてのフィールド(dNameを除く): dFullName、dEmail、dPasswordEncoding、dPassword、dUserType、dUserAuthType、dUserOrgPath、dUserSourceOrgPath、dUserSourceFlags、dUserArriveDate、dUserChangeDate、dUserLocale、dUserTimeZone。

- topicString1: パーソナライズ・トピック編集オペレーションを定義するためにエンコードされた文字列数。

- RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。

Content Serverバージョン7.0以降のオプション・パラメータ:

- レイアウト: 使用するAPI(たとえば、トップ・メニュー、トレイ)。

- スキン: 使用するスキン(たとえば、ウィンドウ)。

- XuiSearchTemplate: ユーザーのパーソナライズされた「検索結果」ページに使用するテンプレート。

結果

- ResultSets: UserTopicEdits(パーソナライズ・データが編集された場合にのみ返されます。トピックの編集が実行された内容に関する情報が含まれます。topicName、topicEditAction、topicKey、topicValueというフィールドがあります。topicValueはHDAエンコード文字列であることに注意してください。)

- ローカル・データ:

- changedSubjects

- dUser

- レスポンス・テンプレート:

- REDIRECT_TEMPLATE (redirect_template.htm)

- デフォルトのリダイレクト・サービス: GET_DOC_PAGE (Page=HOME_PAGE)

次が使用

- リソース・インクルード: user_info_submit_form

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=EDIT_USER_PROFILE
dName=sysadmin

- 任意のパラメータを持つHDA形式:

@Properties LocalData
IdcService=EDIT_USER_PROFILE
dName=jsmith
dFullName=Jennifer Smith
dPassword=password
dEmail=jsmith@example.com
dUserType=MKT
dUserLocale=English-US
@end

4.14.16 GET_ALIASES

すべてのエイリアスのリストを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.14.17 GET_FILTER_ADMIN_PAGE

ブラウザで「Webサーバー・フィルタの構成」ページを取得するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.14.18 GET_SELF_REGISTER_PAGE

「自己登録」ページを返し、自己登録ユーザーのユーザー情報をロードするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.14.19 GET_USERDOCPROFILES

現在のユーザーが使用可能なチェックインおよび検索プロファイルを返します。ユーザーが標準検索/チェックイン情報を使用できる場合、それらの情報も含められます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

結果

- ResultSets:

- SearchProfiles: 結果セットと検索プロファイル情報。この結果セットには5つの列が含まれます。

- dpName: プロファイル名

- dpDescription: プロファイルの説明

- dpTriggerValue: プロファイルのトリガー値

- dpDisplayLabel: プロファイルの表示ラベル

- dpdDocClass: プロファイルに関連付けられたドキュメント・クラス

- CheckInProfiles: 結果セットとチェックイン・プロファイル情報。この結果セットには5つの列が含まれます。

- dpName: プロファイル名

- dpDescription: プロファイルの説明

- dpTriggerValue: プロファイルのトリガー値

- dpDisplayLabel: プロファイルの表示ラベル

- dpdDocClass: プロファイルに関連付けられたドキュメント・クラス

4.14.20 GET_USER_INFO

現在のユーザーの「ユーザー・プロファイル」ページを返すサービス。CHECK_USER_CREDENTIALSを使用して、ユーザーのロールおよびアカウントを検証します。

このサービスはパラメータをとらず、dUserサーバー変数の値に基づいた情報を導出します。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

実行される問合せ: Quser

場所: IdcHomeDir/resources/core/tables/std_services.htm

結果:

- ResultSets:

- USER_INFO(現在のユーザーのUsersデータベース表からのフィールド)

- dName: ユーザーの名前。

- dFullName: ユーザーのフルネーム。

- dEmail: ユーザーの電子メール。

- dUserTimeZone: ユーザータイムゾーン。

- dUserLocale: ユーザーのユーザー・ロケール

- dUserLanguageId: ユーザーのユーザー言語ID

- UserLocaleLanguageMap(ユーザーが使用可能なロケール)

- lcLocaleID: ロケールID

- lcLanguageID: ロケールIDに対応する言語ID

- UserMetaDefinition(データ・ディレクトリのusermeta.hdaファイルのコンテンツに一致する、ユーザー・メタ・フィールドのプロパティを定義する結果セット)

- LmLayouts(使用可能なレイアウトの名前のリスト、フィールド: レイアウト)

- LmLayout(すべての使用可能なレイアウト/スキンの組合せのリスト、フィールド: レイアウト、スキン)

- 返されるオプション・リスト: Users_UserLocaleList

- ローカル・データ:

- dName

- dUser

- レスポンス・テンプレート: USER_INFO (user_info.htm)

次が使用

- リソース・インクルード: pne_nav_userprofile_links

- テンプレート:

- MY_VIEW_FORM (my_view_form.htm)

- PNE_PORTAL_DESIGN_PAGE (pne_portal_design_page.htm)

- PNE_PORTAL_DOC_PROFILES_PAGE (pne_portal_doc_profiles_page.htm)

- PNE_PORTAL_PERSONAL_URLS_PAGE(pne_portal_personal_urls_page.htm)

- PNE_PORTAL_SAVED_QUERIES_PAGE (pne_portal_saved_queries_page.htm)

- PNE_PORTAL_SYSTEM_LINKS_PAGE (pne_portal_system_links_page.htm)

- std_home_page.htm

- SUBSCRIPTION_LIST (subscription_list.htm)

- 標準ナビゲーション: commonNav.js

4.14.21 GET_USERS

すべてのユーザーおよびその属性のリストを返すサービス。プライマリ属性(ユーザー名、フル・ネーム、パスワード、電子メール・アドレス、ディレクトリ、タイプ、パスワード・エンコーディング)とともにシステムに登録されているすべてのユーザーのリストを返します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.14.22 LOAD_PNE_PORTAL

ユーザーの保存済問合せの標準パーソナライズ・プロパティおよび結果セット、カスタム・パーソナライズ・データを含む、ユーザーのPNEファイル(pne_portal.htm)からのすべてのデータをロードします。これはユーザーのパーソナライズ設定を取得するために、リモート・アプリケーションによって使用されます。

これはリモート・アプリケーション・サービスとして使用されます。これは関連したテンプレート表示を使用しない生データ・サービスです。

アクセス・レベル: 読取り、スクリプト作成可能(33)

場所: IdcHomeDir/resources/core/tables/std_services.htm

結果

- ResultSets: ユーザーのpne_portal.htmファイルからのすべての結果セット。通常、これには、パーソナルURLおよび保存済問合せが含まれますが、特定の実装で使用されるカスタム・パーソナライズ結果セットも含めることができます。

- ローカル・データ: ユーザーのpne_portal.hdaファイルからのすべてLocalDataプロパティ。これには、標準のパーソナライズ・プロパティ(XuiSearchTemplate、showDefaultQuery、defaultQueryRows、lm_Skin lm、Layout、portalDesignLink、quickSearchLink、defaultQuery、searchFormType、emailFormat)が含まれますが、特定の実装で使用されるカスタム・パーソナライズ・プロパティも含めることができます。

次が使用

- その他: SoapCustom:Wsdl:PortalInfo:Services

4.14.23 LOAD_USER_TOPIC

選択したトピックに基づいたパーソナライズ・データをロードします。これらのトピックは、データは、DomainHome/ucm/cs/data/users/profiles/ディレクトリのHDAファイルに対応します。

これはリモート・アプリケーション・サービスとして使用されます。これは関連したテンプレート表示を使用しない生データ・サービスです。

アクセス・レベル: 読取り、スクリプト作成可能(33)

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- userTopic: pne_portalやwf_in_queueなど、ユーザー・トピックの名前。

結果

- ResultSets: 指定されたトピック・ファイルのすべての結果セット。

- ローカル・データ: 指定されたトピック・ファイルのすべてのLocalDataプロパティ。

4.14.24 QUERY_GROUP

セキュリティ・グループの説明を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dGroupName: セキュリティ・グループ名。

例

IdcService=QUERY_GROUP
dGroupName=Public

4.14.25 QUERY_USER_ATTRIBUTES

特定のユーザーのユーザー属性を返すサービス。

このサービスは、Content ServerインスタンスがADSIを使用するように構成される場合は、Microsoft Active Directory管理対象ユーザー用のユーザー・データを返しません。ローカル・ユーザーおよび外部LDAP管理対象ユーザー用のユーザー・データを返します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dName: ユーザー名。

例

IdcService=QUERY_USER_ATTRIBUTES
dName=jsmith

4.14.26 REGISTER_USER

ユーザーを登録するサービス。ユーザー名パラメータ(dName)のみが提供される場合、新しいユーザーはゲスト・ロールと空のパスワードを持つローカル・ユーザーです。

最も発生しがちなエラーは、ユーザー名が一意ではないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dName: ユーザー名。

オプションのサービス・パラメータ

- dFullName: ユーザーのフルネーム。

- dPassword: ユーザーのパスワード。

- dEmail: ユーザーの電子メール・アドレス。

- dUserLocale: ロケールの指定(English-US、English-UK、Deutsche、FrançaisまたはEspañol)。

- dUserType: ユーザーの認可タイプローカルまたはグローバルのいずれか。

例

IdcService=REGISTER_USER
dName=user20

4.14.27 SAVE_USER_TOPICS

ユーザーのパーソナライズ情報を保存するために使用されるサービス。このサービスでは、7つのアクションを実行できます。このサービスの必須パラメータは、実行されるアクションによって異なります。

データの複雑さ、追加の必須パラメータ数のため、このサービス・リクエストを送信するには通常フォームを使用します。

アクセス・レベル: 読取り、グローバル(17)

場所: IdcHomeDir/resources/core/tables/std_services.htm

アクション

次のアクションはtopicStringパラメータとともに使用されます。

- updateKeys: 単一のLocalDataキー変数を更新します。topicStringパラメータは4つの値をとります: 最初の3つの必須の値、およびキー変数で配置されるリテラル文字列値を含む4番目の値です。

- updateKeyByName: このアクションは、Content Serverバージョン10gR1の新機能です。updateKeysのように、このアクションは単一のLocalDataキー変数を更新します。これは、4つのtopicString値もとります。リテラル文字列を含むのではなく、4番目の値には、更新で使用される値を含む追加のフィールド/パラメータの名前が含まれます。

- deleteKeys: 単一のキー変数を削除します。topicStringパラメータは、3つの必須の値のみをとります。

- updateRows: このアクションは、単一のトピック文字列を使用して、1つ以上の結果セット行を追加または更新するために使用されます。topicStringパラメータは5つの値をとります: 最初の3つの必須の値、正しい順序のすべての結果セット列名のカンマ区切りリストを含む4番目の値、更新/追加される行の総数を示す数値を含む5番目の値。
列名に対応する名前を持つ追加のフィールド/パラメータのセットを、topicStringの5番目の値に示された行数に基づいて各データ行に対して提供する必要があります。ある行で開始し、topicStringで提供される総行数で終了する各行のデータ・セットのフィールドの列名に連番接尾辞が追加される必要があります(これらがいずれもない場合は、Content Serverがエラーをスルーします)。

更新データ行の最初の列の値(一意のキー)が結果セットの既存の行の値と一致する場合、既存の行が更新されます。それ以外の場合は、新しい行が結果セットの一番下に追加されます。

- addMruRow: 名前の"Mru"はmost-recenly-usedの頭文字です。このアクションは、結果セットの一番上に単一行を追加します。結果セットの行数は、指定した最大値を超えることはできません。行の最大数をすでに含む結果セットに行が追加される場合、新しい行が追加されると同時に最後の行が削除されます(本質的に結果セットの最近使用したN行のみを保持します)。
行の最大数は、オプションのmruNumberパラメータを使用して指定できます。mruNumberパラメータが提供されない場合、最大のデフォルト値は10です。

topicStringパラメータは4つの値をとります: 最初の3つの必須の値、正しい順序のすべての結果セット列名のカンマ区切りリストを含む4番目の値。updateRowsと同様に、列名に対応する追加のフィールド/パラメータのセットを提供する必要がありますが、一度に1行のみ追加/更新されるため、名前に数値接尾辞は必要ありません。

最初の列の値(一意のキー)が既存の行の値と一致する場合、その行は新しい行を追加するのではなく、結果セットの一番上に更新されて移動されます。行数が変更されず、影響を受けた行は最近使用した行とみなされます。

- deleteRows: 結果セットから1つ以上の行を削除します。topicStringパラメータは4つの値をとります: 最初の3つは必須の値で、4番目の値は、指定された結果セットの既存の行の最初の列のDATA VALUE(一意のキー)に対応する文字列のカンマ区切りのリストを含みます。

- deleteSets: トピック・ファイルから1つ以上の結果セットを削除します。topicStringパラメータは3つの値のみをとりますが、この場合、3番目の値は単一のtopicStringを使用して削除される複数の結果セットを許可して、単一のキー名ではなく名前のカンマ区切りのリストとすることができます。

オプションのサービス・パラメータ

- numTopics: 想定されるtopicStringsの数をサービスに伝えます。

- topicKeys: 名前別にトピック文字列パラメータを識別します。トピック文字列を含むフィールドまたはパラメータに対応する1つ以上の名前のコロン区切りリストで構成されます。numTopics値は、トピック文字列値を識別する列挙メソッドを使用しない場合にも、このパラメータが使用されるときに存在している必要があります。(numTopicsにはすべての値を使用できます。)

- topicStringn: コロンで区切られた、3つから5つの値で構成されます。トピック文字列の数は、numTopicsの値によって異なります。たとえば、numTopicsが2の場合、topicString1とtopicStringが必要です。
値は次のとおりです。

- 最初の値は、サービスによって実行されるアクションです。

- 2番目の値は使用されるトピック・ファイルの名前です。

- 3番目の値は変更されるアイテムのキー名です(LocalDataキー変数の名前かトピック・ファイルの結果セットの名前のいずれか)。

- 4番目の値には、追加または更新アクションのデータ情報が含まれます。データ文字列自体を含むか、またはデータ値を含む追加のフィールドまたはパラメータをポイントするかのいずれかです。

- 5番目の値は、送信されるデータの行数を示すためにupdateRowsアクションでのみ使用されます。

更新アクションのすべてが、指定された名前のキーが指定されたトピック・ファイルに見つからない場合に「追加」操作を実行します。2番目の値に指定される名前に一致するトピック・ファイルが存在するが、3番目の値に指定されるキー名に一致するキー(変数または結果セット)が含まれない場合、新しい変数または結果セットが更新操作のために提供されるデータを使用して作成されます。トピック・ファイル自体が見つからない場合は、それも作成されます。

- RedirectUrl: 別のページを表示するために使用されます。省略される場合、ユーザーはContent Serverのホーム・ページにリダイレクトされます。

- mruNumber: addMruRow - 「最近使用した行の追加」アクションを使用する際に、結果セットの最大行数を指定するために使用されます。

結果

- ResultSets: UserTopicEdits(行は、サービス・コールによって実行された各トピックの編集内容が示されます。行にはtopicName、topicEditAction、topicKey、topicValueというフィールドが含まれます。)

- レスポンス・テンプレート:

- REDIRECT_TEMPLATE (redirect_template.htm)

- デフォルトのリダイレクト・サービス: GET_DOC_PAGE: HOME_PAGE

次が使用

- リソース・インクルード: xui_searchapi_results_action_form

- テンプレート:

- MY_VIEW_FORM (my_view_form.htm)

- PNE_PORTAL_DOC_PROFILES_PAGE (pne_portal_doc_profiles_page.htm)

- PNE_PORTAL_PERSONAL_URLS_PAGE (pne_portal_personal_urls_page.htm)

- PNE_PORTAL_SAVED_QUERIES_PAGE (pne_portal_saved_queries_page.htm)

- PNE_PORTAL_SYSTEM_LINKS_PAGE (pne_portal_system_links_page.htm)

- WF_INQUEUE_LIST (workflow_queue.htm)

例

注意:

次の例は、Content Serverインスタンスのコア構成ではありません。これはカスタム機能の拡張で、Consulting Services、または当社のDeveloper Support Token Programをご購入いただくことによりサポートされます。すべてのカスタマイズと同様に、ソフトウェアをアップグレードする際には、カスタムの変更がオーバーライドされる可能性があります。

パーソナルURLを追加するには、次のパラメータおよび値を使用します。

numTopics=1
topicString1=updateRows:pne_portal:PersonalURLS:title,website:1

これらの値はpne_portal.hdaユーザー・トピックのPersonalURLS ResultSetに行を追加します。ResultSetの列はtitleとwebsiteで、トピック文字列の4番目の値から取得されます。最後の値(1)は、1行のデータが送信されることをサービスに伝えます。

行データを指定するために、サービスに追加のパラメータを使用する必要があります。これらのパラメータはtopicStringで指定されるtitleとwebsite列の名前から取得されます。複数の行データを指定できるため、サービスのパラメータ名を形成するために、数値接尾辞が各列名に追加されます。最初の行にはtitle1およびwebsite1パラメータが必要で、2番目の行にはtitle2およびwebsite2パラメータが必要です。

ホーム・ページへのリンクであるデータ行を追加するには、title1およびwebsite1パラメータの値をホームページおよびhttp://www.example.comに設定します。これらの値は、ブラウザのアドレス・バーのURLに直接追加する場合にはURLエンコードされる必要があります。データを送信するためにWebページのフォームを使用する場合は、エンコードが処理されます。フォームを使用した完全なサービス仕様は次のとおりです。

<FORM name='addPersonalUrlForm' method='POST'
action='<$HttpCgiPath$>'>
<INPUT type='hidden' name='IdcService' value='SAVE_USER_TOPICS'>
<INPUT type='hidden' name='numTopics' value='1'>
<INPUT type='hidden' name='topicString1'
value='updateRows:pne_portal:PersonalURLS:title,website:1'>
<INPUT type='hidden' name='title1' value='Company Home Page'>
<INPUT type='hidden' name='website1' value='http://www.example.com'>
<INPUT type='submit' value='Submit'>
</FORM>

4.14.28 UPDATE_FILTER_INFO

Webサーバー・フィルタ設定を更新するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.14.29 UPDATE_USEROPTION_LIST

ユーザー情報フィールドのオプション・リストを追加または更新するサービス。

注意:

OptionListStringパラメータで指定されるオプション・リスト値は既存の値を置き換えます。既存の値を保持するには、新しい値とともに既存の値を含める必要があります。

「ユーザー・タイプ」フィールドおよびすべてのカスタム・ユーザー・フィールドのオプション・リストはデータベースに格納されますが、useroptions.hdaファイルでは、通常DomainHome/ucm/cs/data/users/config/ディレクトリにあります。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dKey: オプション・リスト・キー。

- OptionListString: \nエスケープ・シーケンスで区切られるオプションのリスト。

例

- IdcCommandコマンド・ファイル・フォーマット:

# Add values NY, DC, CA to UserTypeList
IdcService=UPDATE_USEROPTION_LIST
dKey=Users_UserTypeList
OptionListString=NY\nDC\nCA

- HDA形式(NY、DCおよびCAの値をUserTypeListに追加します):

@Properties LocalData
IdcService=UPDATE_USEROPTION_LIST
dKey=Users_UserTypeList
OptionListString=NY\nDC\nCA
@end

4.15 コラボレーション・サービス(コアContent Server)

次のコラボレーション・サービスはコアContent Serverソフトウェアとともに出荷されます。

- ADD_COLLABORATION

- ADD_COLLABORATION_FORM

- DELETE_COLLABORATION

- EDIT_CLBRA_ACCESS_LIST

- EDIT_CLBRA_ACCESS_LIST_FORM

- EDIT_COLLABORATION

- EDIT_COLLABORATION_FORM

- GET_CLBRA_DOCUMENTS

- GET_CLBRA_INFO

- GET_COLLABORATION_LIST

- GET_USER_CLBRA_LIST

注意:

dClbraTypeは多数のサービスに対する必須パラメータです。このとき、basicはこのパラメータに対して唯一許容される値です。

4.15.1 ADD_COLLABORATION

ADD_COLLABORATION_FORM.からコールされるサービス。このサービスは、コラボレーション・プロジェクトを追加するためにADD_COLLABORATION_SUBをコールします。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dClbraName: プロジェクト名。

- dClbraType: コラボレーション・プロジェクトのタイプ。

4.15.2 ADD_COLLABORATION_FORM

コラボレーションを追加するため、ユーザーにフォームを提供するために使用されるサービス。このフォームを送信した後で、ADD_COLLABORATIONサービスがコールされます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.15.3 DELETE_COLLABORATION

コラボレーション・プロジェクトを削除するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dClbraName: プロジェクト名。

4.15.4 EDIT_CLBRA_ACCESS_LIST

コラボレーション・プロジェクトのメンバーを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dClbraName: プロジェクト名。

- dClbraType: コラボレーション・プロジェクトのタイプ。

4.15.5 EDIT_CLBRA_ACCESS_LIST_FORM

コラボレーション・プロジェクトのメンバーを編集するために使用されるフォームを提供するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dClbraName: プロジェクト名。

4.15.6 EDIT_COLLABORATION

既存のプロジェクト情報を更新するためにEDIT_COLLABORATION_SUBをコールするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dClbraName: プロジェクト名。

- dClbraType: コラボレーション・プロジェクトのタイプ。

4.15.7 EDIT_COLLABORATION_FORM

コラボレーション・プロジェクトを編集するために使用されるフォームを提供するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dClbraName: プロジェクト名。

4.15.8 GET_CLBRA_DOCUMENTS

コラボレーション・プロジェクト内のコンテンツを取得するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dClbraName: プロジェクト名。

4.15.9 GET_CLBRA_INFO

特定のコラボレーション・プロジェクトに関する情報を取得するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- dClbraName: プロジェクト名。

4.15.10 GET_COLLABORATION_LIST

すべてのコラボレーション・プロジェクトのリストを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

4.15.11 GET_USER_CLBRA_LIST

すべてのコラボレーション・プロジェクトのユーザーのリストを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

5 ワークフロー・サービス

この章では、Oracle WebCenter Content Serverワークフローを使用およびカスタマイズする際に使用可能なサービス、およびIdcHomeDir/resources/core/templates/ディレクトリのworkflow.htmファイルに格納される他のサービスについて説明します。

この章の内容は、次のとおりです。

- 第5.1項「ワークフロー・サービスについて」

- 第5.2項「ドキュメント・サービスと一般サービス(ワークフロー)」

- 第5.3項「ワークフロー・テンプレート・サービス」

- 第5.4項「ワークフロー・サービス」

5.1 ワークフロー・サービスについて

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

特定のワークフロー・サービスの場所は、各サービス内にリスト表示されています。

注意:

最も一般的に使用されるサービスには、より広範囲な説明があります。

重要:

すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。

5.2 ドキュメント・サービスと一般サービス(ワークフロー)

ドキュメント・サービスは、ドキュメントを管理および操作するために使用されるサービスで、ドキュメントに関する情報を提供します。一般サービスは通常またはデフォルトのサービスです。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

この項では、次のサービスについて説明します。

- ADD_PROBLEMREPORT

- DELETE_PROBLEMREPORT

- GET_CRITERIA_WORKFLOWS_FOR_GROUP

- GET_DOCUMENT_PROBLEMREPORTS

- GET_PROBLEMREPORTS_SEARCH_FORM

- GET_PROBLEMREPORTS_SEARCH_RESULTS

- GET_UPDATE_PROBLEMREPORT_FORM

- GET_WORKFLOWDOCUMENTS

- GET_WORKFLOWS_FOR_ALL

- *LOAD_WORKFLOW_QUEUE

- NOTIFY_CONTRIBUTOR

- PROBLEMREPORT_INFO

- RESEND_PROBLEMREPORT

- REVIEW_WORKFLOW_DOC

- UPDATE_PROBLEMREPORT

- WORKFLOW_CHECKIN_SUB

- WORKFLOW_EDIT_REV

- WORKFLOW_NEW_REV

- WORKFLOW_REJECT_FORM

5.2.1 ADD_PROBLEMREPORT

コンテンツ・アイテムに問題レポートを追加するサービス。

最も発生しがちなエラーは、パラメータに不整合があること、システムがコンテンツ・アイテムに問題レポートを追加できないこと、またはコンテンツ・アイテムがシステムに存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムの識別子(コンテンツID)。

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dPrCaption: 問題レポートのキャプション。

- dPrSeverity: Critical、Moderate、Minorなどの、問題レポートの重大度。このオプションは問題レポートがワークフロー・プロセス内で処理される方法に影響は及ぼしません。

- dPrState: Open、Closed、Fixedなどの、問題レポートの状態。

注意:

コンテンツID (dDocName)と内部のコンテンツ・アイテム・リビジョン識別子(dID)を混同しないでください。dID値は、コンテンツ・アイテムの特定のレンディションへの、生成済の参照です。

例

IdcService=ADD_PROBLEMREPORT
dPrCaption=Problem report for this content.
dDocName=PublicDoc1_ia3c488971
dID=67
dPrState=OPEN
dPrSeverity=MINOR

5.2.2 DELETE_PROBLEMREPORT

既存の問題レポートを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があること、またはコンテンツ・アイテムがシステムに存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dPrID: 問題レポートID。

例

IdcService=DELETE_PROBLEMREPORT
dPrID=1

5.2.3 GET_CRITERIA_WORKFLOWS_FOR_GROUP

特定のセキュリティ・グループの基準ワークフローおよびワークフロー・ステップのリストを返すサービス。

WorkflowsForGroupおよびWorkflowStepsForGroup結果セットを返します。

- WorkflowsForGroupでは、このグループに対するすべてのワークフローがリストされます(dWfID、dWfName)。

- WorkflowStepsForGroupでは、このグループに対するすべてのワークフローのすべてのステップがリストされます(dWfID、dWfName、dWfStepID、dWfStepName)。

- 最も発生しがちなエラーは、セキュリティ・グループが存在しないか、ユーザーがセキュリティ・チェックに失敗することです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

例

- IdcCommandコマンド・ファイル・フォーマット:

# Retrieves criteria workflow information
IdcService=GET_CRITERIA_WORKFLOWS_FOR_GROUP
dSecurityGroup=Public

- HDA形式:

@Properties LocalData
IdcService=GET_CRITERIA_WORKFLOWS_FOR_GROUP
dSecurityGroup=Public
@end

5.2.4 GET_DOCUMENT_PROBLEMREPORTS

特定のコンテンツ・アイテムに関するすべての問題レポートを返すサービス。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムのコンテンツID。

例

IdcService=GET_DOCUMENT_PROBLEMREPORTS
dDocName=security_000015

5.2.5 GET_PROBLEMREPORTS_SEARCH_FORM

問題レポート検索フォームを返すサービス。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.2.6 GET_PROBLEMREPORTS_SEARCH_RESULTS

「問題レポート」検索ページで指定された検索条件に一致する問題レポートのリストを返すサービス。検索条件は、問題レポートの表で指定される列のいずれかにすることができます。

使用される検索条件は、問題レポートの表で指定される列のいずれかをとることができます。このサービスは名前/値のペアで渡され、次にデータベース問合せのWHERE句に変換されます。

問題レポートのデータソースは(resource.htm fileで指定される)は、名前/値のペアで生成されるWHERE句とともに問合せの構築に使用されます。この問合せの結果はプレゼンテーション用に渡されます。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

オプションのサービス・パラメータ

- dPrSeverity: Critical、Moderate、Minorなどの、問題レポートの重大度。このオプションは問題レポートがワークフロー・プロセス内で処理される方法に影響は及ぼしません。

- dPrAuthor: 問題レポートの作成者。

- dPrCaption: 問題レポートのキャプション。

- dPrState: Open、Closed、Fixedなどの、問題レポートの状態。

- dDocTitle: コンテンツ・アイテムのタイトル。

- dDocName: コンテンツ・アイテムのコンテンツID。

5.2.7 GET_UPDATE_PROBLEMREPORT_FORM

問題レポートの更新フォームを返すサービス。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dPrID: 問題レポートID。

例

IdcService=GET_UPDATE_PROBLEMREPORT_FORM
dPrID=1

5.2.8 GET_WORKFLOWDOCUMENTS

特定のワークフローにあるコンテンツ・アイテムのリビジョンのリストを返すサービス。

このサービスは、ワークフローのすべてのコンテンツ・アイテムのリストを提供し、ワークフローにあるコンテンツ・アイテムのステータス(状態とステップ)を追跡するためにシステム・サーバーによって更新されます。

最も発生しがちなエラーは、ワークフロー名が存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- IdcService: GET_WORKFLOWDOCUMENTSに設定する必要があります。

- dWfName: ワークフロー名。

例

IdcService=GET_WORKFLOWDOCUMENTS
dWfName=mktg_review

5.2.9 GET_WORKFLOWS_FOR_ALL

すべてのワークフローおよびそのステップに関する情報を戻すためにワークフロー・アプレットで使用されるサービス。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.2.10 LOAD_WORKFLOW_QUEUE

アクションを要求するワークフローにコンテンツ・アイテムのリストが含まれる、ユーザーのパーソナライズ・データを返すサービス。データは、DomainHome/ucm/cs/data/users/profilesディレクトリにあるwf_in_queue.hdaファイルから取得されます。

これは、リモート・アプリケーション・サービスであることを意図しています。それは、関連した表示テンプレートを使用しない生データ・サービスであるためです。

サービス・クラス: ユーザー・サービス

アクセス・レベル: 読取り、スクリプト作成可能(33)

場所: IdcHomeDir/resources/core/tables/std_services.htm

結果

- 結果セット: WorkflowInQueue

次が使用

- その他: SoapCustom:Wsdl:Workflow:Services

5.2.11 NOTIFY_CONTRIBUTOR

指定されたコンテンツ・アイテムに関する問題レポートをコントリビュータに通知するサービス。最も発生しがちなエラーは、コンテンツ・アイテムがシステムに存在しないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

例

IdcService=NOTIFY_CONTRIBUTOR
dID=55

5.2.12 PROBLEMREPORT_INFO

問題レポートに関するすべての情報を返すサービス。問題レポートの情報は、ファイル・システムおよびデータベース内にあります。このサービスにより、ユーザーに(コンテキストで使用される場合)「問題レポート情報」ページが表示されます。これにより、ユーザー・インタフェースからユーザーが問題レポートを再送信、削除または更新できるようになります。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dPrID: 問題レポートの一意のID。

例

IdcService=PROBLEMREPORT_INFO
dPrID=1

5.2.13 RESEND_PROBLEMREPORT

アクティビティに関して通知対象のすべての関心あるユーザーに電子メールを再送信するサービス。このサービスは「問題レポート」ページからアクセスできます。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dPrID: 問題レポートID。

例

IdcService=RESEND_PROBLEMREPORT
dPrID=1

5.2.14 REVIEW_WORKFLOW_DOC

ユーザーがワークフロー内のドキュメントをレビューできるようにするページを生成するサービス。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

5.2.15 UPDATE_PROBLEMREPORT

問題レポート情報を更新するサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dPrID: 問題レポートID。

- dPrState: Open、Closed、Fixedなどの、問題レポートの状態。

オプションのサービス・パラメータ

- dPrCaption: 問題レポートのキャプション。

- dPrSeverity: Critical、Moderate、Minorなどの、問題レポートの重大度。このオプションは問題レポートがワークフロー・プロセス内で処理される方法に影響は及ぼしません。

- prMessage: 問題レポートのメッセージ。

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=UPDATE_PROBLEMREPORT
dPrID=1
dPrState=OPEN

- 任意のパラメータを持つHDAファイル形式:

@Properties LocalData
IdcService=UPDATE_PROBLEMREPORT
dPrID=1
dPrState=OPEN
prMessage=Description is stored in hda file.
dPrCaption=change this caption
dPrSeverity=SERIOUS
@end

5.2.16 WORKFLOW_CHECKIN_SUB

コンテンツ・アイテムがすでに存在し、ワークフロー内にある場合に、そのコンテンツ・アイテムをチェックインするサブサービス。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.2.17 WORKFLOW_EDIT_REV

実行されるワークフロー・チェックのタイプを決定するために、WORKFLOW_CHECKIN_SUBサブサービスで使用されるサブサービス。このサービスは、ワークフローのリビジョンを適切に編集します。ワークフロー設計が評価されると、WORKFLOW_EDIT_REVとWORKFLOW_NEW_REVのいずれを使用するかが決定されます。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.2.18 WORKFLOW_NEW_REV

実行されるワークフロー・チェックインのタイプを決定するために、WORKFLOW_CHECKINサービスで使用されるサブサービス。このサービスは、ワークフロー・ドキュメントの新しいリビジョンを作成します。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.2.19 WORKFLOW_REJECT_FORM

却下されたワークフローのリビジョンの却下フォームを返すサービス。このサービスは、レビューアがワークフロー・ステップのコンテンツを却下した場合(レビューアが「却下」をクリックした場合)に実行されます。

このサービスは通常、JavaScriptを使用して値を割り当てるブラウザ環境で実行されます。ブラウザ環境で渡されるパラメータを、次のサブセクションに示します。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dWfName: ワークフロー名。

例

IdcService=WORKFLOW_REJECT_FORM
dWfName=mktg_review
dID=44

5.3 ワークフロー・テンプレート・サービス

ワークフロー・テンプレート・サービスは、ワークフロー・テンプレートの管理または変更に使用されます。ここにリストされるすべてのサービスは、ワークフロー・テンプレート・サービスのサービス・クラスを持ちます。この項では、次のサービスについて説明します。

- ADD_WF_TEMPLATE

- DELETE_WF_TEMPLATE

- EDIT_WF_TEMPLATE

- GET_WF_TEMPLATE

- GET_WF_TEMPLATES

5.3.1 ADD_WF_TEMPLATE

新しいワークフロー・テンプレートを作成するサービス。最も発生しがちなエラーは、ワークフロー・テンプレート名が一意でないこと、またはシステムがワークフロー・テンプレート・リストを取得できないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfTemplateName: ワークフロー・テンプレート名。

- dWfTemplateDescription: ワークフロー・テンプレートの説明。

例

IdcService=ADD_WF_TEMPLATE
dWfTemplateName=mark_temp
dWfTemplateDescription=marketing template

5.3.2 DELETE_WF_TEMPLATE

既存のワークフロー・テンプレートを削除するサービス。最も発生しがちなエラーは、システムがワークフロー・テンプレートを取得できないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfTemplateName: ワークフロー・テンプレート名。

例

IdcService=DELETE_WF_TEMPLATE
dWfTemplateName=wf_template_10

5.3.3 EDIT_WF_TEMPLATE

既存のワークフロー・テンプレートを変更するサービス。このサービスは、ワークフロー・テンプレートのステップがあるため、EDIT_WORKFLOWSTEPと似ています。ただし、このサービスでは、テンプレートの複数のステップや他の部分の編集が可能です。

場所 IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dAliases: /nエスケープ・シーケンスで区切られるエイリアス・ユーザーのリスト。

- 例: dAliases=subadmins/nservices。

- dWfStepDescription: ステップの説明。

- dWfStepHasWeight: 制限されたレビューア・オプションを有効にします。

- 1 (true)に設定し、dWfStepWeightパラメータでレビューア数を定義します。

- dWfStepIsAllが有効な場合は、0 (false)に設定します。

- dWfStepIsAll: すべてのレビューア・オプションを有効にします。

- ワークフローが次のステップに移る前に、ステップに割り当てられているすべてのユーザーがリビジョンを承認する必要がある場合は、1 (true)に設定します。

- dWfStepHasWeightが有効な場合は、0 (false)に設定します。

- dWfStepName: ワークフロー・ステップ名。通常、これはレビューのタイプ(初期レビューや整理編集など)またはレビューアの職務(マネージャやコピー・エディタなど)になります。

- dWfStepType: ワークフロー・ステップ・タイプ

- レビューア: リビジョンを承認または拒否します。

- レビューア/コントリビュータ: リビジョンを編集、承認および拒否できます。

- dWfStepWeight: 制限されたレビューア・オプションのレビューア数を定義します。

- レビューア数に数値を入力します。指定したユーザー数がリビジョンを承認するとすぐに、ワークフローは次のステップに移ります。

- このフィールドにゼロ(0)を入力すると、リビジョンがステップに到達したときに、レビューアに通知されますが、そのステップではリビジョンの承認、拒否、編集はできません。ワークフローは自動的に次のステップに進みます。

- dWfTemplateDescription: ワークフロー・テンプレートの説明。

- dWfTemplateName: ワークフロー・テンプレート名。

例

次は、EDIT_WF_TEMPLATEサービス・コールの例です。

@Properties LocalData
dUser=fradiche
dWfStepIsAll=0
watchedMonikers=
blFieldTypes=StatusMessage message
monitoredTopics=appcommongui,1060430685890
dAliases=fradiche*09user*09user1*09user
monitoredSubjects=collaborations,1061386025875,config,1061386026266,metadata,
1061386026216,metaoptlists,1061386026236,wftemplates,1061386026267,projects,
1061386026586,users,1061386026216,workflows,1061386026296,aliases,
1061386026266,wfscripts,1061386026266,usermetaoptlists,1061386026256,
doctypes,1061386026216,accounts,1061386026216
refreshSubMonikers=
dWfStepID=
dWfStepHasWeight=1
wfExitScript=
wfUpdateScript=
ClientEncoding=Cp1252
dWfStepDescription=
wfUpdateScriptSummary=
dWfStepType=Reviewer
dWfID=
HasAdditionalExitCondition=0
IsTemplateScript=1
dWfStepName=s1
IsJava=1
wfExitConditionSummary=
dAliasType=user
ConditionKeys=HasAdditionalExitCondition,wfAdditionalExitCondition
dWfTemplateDescription=test
dWfTemplateName=test
blDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS} {aa}}!tAmerica/Chicago
IdcService=EDIT_WF_TEMPLATE
dAlias=user1
dWfStepWeight=1
wfEntryScriptSummary=
wfExitScriptSummary=
wfEntryScript=
@end
@ResultSet WorkflowSteps
9
dWfStepName
dWfStepID
dWfID
dWfStepType
dWfStepIsAll
dWfStepWeight
dWfStepDescription
dAliases
dWfStepHasWeight
s1

Reviewer
0
1

fradiche*09user*09user1*09user
1
@end
@ResultSet WorkflowStepEvents
4
dWfStepName
wfEntryScript
wfExitScript
wfUpdateScript
s1

@end
@ResultSet UpdatedUserTopics
3
topicName
topicValue
topicTS
@end

次は、返される結果の例です。

Content-type: text/plain

Content-Length: 2446

<?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?>

@Properties LocalData
wfUpdateScript=
dUser=sysadmin
refreshSubMonikers=
refreshTopics=appcommongui,1040486396000
dWfTemplateDescription=test
dAlias=user1
wfExitConditionSummary=
monitoredSubjects=collaborations,1061386025875,config,1061386026266,metadata,
1061386026216,metaoptlists,1061386026236,wftemplates,1061386026267,projects,
1061386026586,users,1061386026216,workflows,1061386026296,aliases,
1061386026266,wfscripts,1061386026266,usermetaoptlists,1061386026256,
doctypes,1061386026216,accounts,1061386026216
wfExitScript=
ConditionKeys=HasAdditionalExitCondition,wfAdditionalExitCondition
dWfStepDescription=
dAliases=fradiche*09user*09user1*09user
dWfStepType=Reviewer
watchedMonikers=
HasAdditionalExitCondition=0
changedMonikers=
changedSubjects=
blFieldTypes=StatusMessage message
IdcService=EDIT_WF_TEMPLATE
wfExitScriptSummary=
dWfStepHasWeight=1
wfEntryScript=
wfUpdateScriptSummary=
dAliasType=user
dWfStepName=s1
dWfStepWeight=1
wfEntryScriptSummary=
dWfStepID=
refreshMonikers=
blDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS} {aa}}!tAmerica/Chicago
ClientEncoding=Cp1252
IsJava=1
dWfStepIsAll=0
IsTemplateScript=1
refreshSubjects=wftemplates,1061386026272
dWfTemplateName=test
monitoredTopics=appcommongui,1060430685890
dWfID=
@end
@ResultSet WorkflowSteps
9
dWfStepName
dWfStepID
dWfID
dWfStepType
dWfStepIsAll
dWfStepWeight
dWfStepDescription
dAliases
dWfStepHasWeight
s1

Reviewer
0
1

fradiche*09user*09user1*09user
1
@end
@ResultSet WorkflowStepEvents
4
dWfStepName
wfEntryScript
wfExitScript
wfUpdateScript
s1

@end
@ResultSet UpdatedUserTopics
3
topicName
topicValue
topicTS
appcommongui
\@Properties LocalData\nblFieldTypes=\nblDateFormat=M/d{/yy} {h:mm{:ss.SSSS}
{aa}[zzz]}!tAmerica/Chicago\n\@end\n\@ResultSet
UserSelectView:filter\n3\nfilterColumn\nfilterValue\nisEnabled\ndUserAuthType
\nLOCAL\ntrue\n\@end\n\@ResultSet UserView:filter\n3\nfilterColumn
\nfilterValue\nisEnabled\ndUserAuthType\nLOCAL\ntrue\n\@end\n\@ResultSet
DocView:filter\n3\nfilterColumn\nfilterValue\nisEnabled\ndProcessingState
\nM\nfalse\ndIsCheckedOut\n1\nfalse\ndStatus\nGENWWW\ntrue\ndDocTitle
\nCanceled:%\nfalse\ndReleaseState\nN\nfalse\nisLatestRev\n\ntrue
\ndSecurityGroup\ntest\nfalse\ndDocType\ntest\nfalse\n\@end\n\n
1040486396000
@end
@ResultSet WfTemplates
2
dWfTemplateName
dWfTemplateDescription
collaboration_template
Basic Collaboration template
test
test
@end

5.3.4 GET_WF_TEMPLATE

特定のワークフロー・テンプレートの説明を返すサービス。最も発生しがちなエラーは、ワークフロー・テンプレート名が存在しないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfTemplateName: ワークフロー・テンプレート名。

例

IdcService=GET_WF_TEMPLATE
dWfTemplateName=servicestemplate

5.3.5 GET_WF_TEMPLATES

すべてのワークフロー・テンプレートとその説明のリストを返すサービス。最も発生しがちなエラーは、ワークフロー名が存在しないことです。

サービス・クラス: ワークフロー・テンプレート・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.4 ワークフロー・サービス

ワークフロー・サービスは、ワークフローの追加、トークンの追加、ワークフローの有効化または無効化を含む、ワークフローの管理に使用されるサービスです。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

これらのサービスはすべて、ワークフロー・サービスのサービス・クラスを持ちます。

この項では、次のサービスについて説明します。

- ADD_WORKFLOW

- ADD_WORKFLOW_SCRIPT

- ADD_WORKFLOW_TOKEN

- ADD_WORKFLOWALIASES

- ADD_WORKFLOWDOCUMENT

- ADD_WORKFLOWDOCUMENT_SUB

- ADD_WORKFLOWDOCUMENTS

- ADD_WORKFLOWSTEP

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_DISABLE_SUB

- CRITERIAWORKFLOW_ENABLE

- DELETE_WFCONTRIBUTORS

- DELETE_WORKFLOW

- DELETE_WORKFLOW_SCRIPT

- DELETE_WORKFLOW_TOKEN

- DELETE_WORKFLOWCRITERIA

- DELETE_WORKFLOWDOCUMENTS

- DELETE_WORKFLOWSTEP

- EDIT_WORKFLOW

- EDIT_WORKFLOW_SCRIPT

- EDIT_WORKFLOW_TOKEN

- EDIT_WORKFLOWCRITERIA

- EDIT_WORKFLOWSTEP

- *GET_ACTIVE_WORKFLOWS

- GET_ALL_WORKFLOWDOCREVISIONS

- GET_CRITERIA_WORKFLOWS_FOR_GROUP

- GET_WF_COMPANION_INFO

- GET_WORKFLOW

- *GET_WORKFLOW_INFO

- *GET_WORKFLOW_INFO_BYNAME

- GET_WORKFLOW_SCRIPT

- *GET_WORKFLOWDOCREVISIONS

- GET_WORKFLOW_INFO

- GET_WORKFLOWS

- TEST_WORKFLOW_SCRIPT

- WORKFLOW_APPROVE

- WORKFLOW_CANCEL

- *WORKFLOW_CHECKIN

- WORKFLOW_EDIT_APPROVE

- *WORKFLOW_REJECT

- WORKFLOW_START

5.4.1 ADD_WORKFLOW

新しいワークフローを作成するサービス。このサービスは「ワークフロー管理」アプレットにより実行されます。「ワークフロー管理」管理アプレットから、ワークフローおよびサブワークフローを追加、編集、有効化、無効化および削除できます。

最も発生しがちなエラーは、ワークフロー名が一意でないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

- dWfDescription: ワークフローの説明。

- dWfType: 基本や基準などのワークフロー・タイプ。

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

- dWfCriteriaName: ワークフロー基準フィールド。

- dWfCriteriaOperator: ワークフロー基準演算子(matches)。

- dWfCriteriaValue: ワークフロー基準値。

例

IdcService=ADD_WORKFLOW
dWfName=test_workflow
dSecurityGroup=Public
dWfType=Criteria
dWfCriteriaName=dDocAuthor
dWfCriteriaOperator=matches
dWfCriteriaValue=sysadmin
dWfDescription=testing workflow

5.4.2 ADD_WORKFLOW_SCRIPT

ワークフローにスクリプト・テンプレートを追加するために使用されるサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- wfScriptName: 使用されるスクリプト・テンプレートの名前。

- wfScriptDescription: スクリプトに使用される説明。

5.4.3 ADD_WORKFLOW_TOKEN

ワークフローにトークンを追加するために使用されるサービス。

サービス・クラス: ワークフロー・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- wfToken: 新しいトークンを作成するために使用されるデフォルト・トークン。

- wfTokenName: 追加される新しいトークンの名前。

- wfTokenDescription: トークンに使用される説明。

5.4.4 ADD_WORKFLOWALIASES

ワークフロー・ステップにユーザーまたはエイリアスを追加するサービス。ユーザーを追加するには、dAliasTypeパラメータをuserに設定します。エイリアスを追加するには、dAliasTypeパラメータをaliasに設定します。最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

注意:

エイリアスがここで定義されていません。エイリアスはすでに存在している必要があります。エイリアスは通常、UserAdminアプレットを使用して作成されます。

サービス・クラス: ワークフロー・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- aliases: エイリアス。

- dAliasType: 割り当てられたエイリアスのタイプ。値はaliasまたはuserを指定できます。

- dWfID: ワークフローID。

- dWfName: ワークフロー名。

- dWfStepID: ワークフロー・コントリビューション・ステージID。自動生成される値はデータベース表から取得できます。Content Serverシステムはそのコントリビューション・ステージのdWfStepIDを自動的に割り当てます。

例

IdcService=ADD_WORKFLOWALIASES
dWfName=mktg_review
dWfID=12
dAliasType=user
aliases=sammy
dWfStepID=26

5.4.5 ADD_WORKFLOWDOCUMENT

基本ワークフローに新しいコンテンツ・アイテムを追加するサービス。dDocNameで指定されたコンテンツ・アイテムはシステムに存在する必要はありません。

このサービスは、基本ワークフローを作成し、「コンテンツ」セクションの「新規」をクリックすることで、「ワークフロー管理」アプレットからコールされます。このサービスはADD_WORKFLOWDOCUMENT_SUBサブサービスを実行します。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

- dDocName: コンテンツ・アイテムのコンテンツID。

例

IdcService=ADD_WORKFLOWDOCUMENT
dWfName=mktg_review
dDocName=test1234

5.4.6 ADD_WORKFLOWDOCUMENT_SUB

コンテンツ・アイテムを基本ワークフローに追加するためにADD_WORKFLOWDOCUMENTSおよびADD_WORKFLOWDOCUMENTによってコールされるサブサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.4.7 ADD_WORKFLOWDOCUMENTS

基本ワークフローに選択したコンテンツ・アイテムを追加するサービス。追加するアイテムのリストは、dDocNameパラメータで指定されます。

このサービスは、基本ワークフローを作成し、「コンテンツ」セクションの「選択」をクリックすることで、「ワークフロー管理」アプレットからコールされます。

このサービスはADD_WORKFLOWDOCUMENT_SUBサブサービスを実行します。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

- dDocName: 追加されるコンテンツ・アイテムのコンテンツID。複数のアイテムが追加される場合は、タブ区切りリストを使用します。

例

IdcService=ADD_WORKFLOWDOCUMENTS
dWfName=mktg_review
dDocName=test_000035
dataSource=Documents
resultName=DOCUMENTS
dWfType=Basic
whereClause=dSubscriptionType='test'
dWfDirectory=public

5.4.8 ADD_WORKFLOWSTEP

新しいワークフロー・ステップを作成するサービス。

- これらのパラメータは、「ワークフロー管理」アプレットを使用して、ブラウザ環境で実行できます。たとえば、dWfStepName、dWfStepDescriptionおよびdWfStepTypeエントリは「ワークフロー管理」アプレットの「ステップ レビューアの編集」画面の名前エントリ、「説明」フィールド、「タイプ」ドロップダウン・リストに相当します。

- dWfStepWeightを数値に設定すると、「ワークフロー管理」アプレットの「ワークフロー・ステップ」の「レビューアの最低必要人数」オプションに関連付けられているフィールドに値を入力するのと同じになります。定義されている場合、dWfStepWeightで指定されたユーザー数がリビジョンを承認するとすぐに、ワークフローは次のステップに移ります。

- dWfStepIsAllを1 (true)に設定すると、「ワークフロー管理」アプレットの「ワークフロー・ステップ」の「すべてのレビューア」オプションを有効にするのと同じになります。trueに設定した場合、ワークフローが次のステップに移る前に、ステップに割り当てられているすべてのユーザーがリビジョンを承認する必要があります。

- 最も発生しがちなエラーは、指定されたワークフローが存在しないか、指定されたステップが一意ではないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

- dWfStepName: ワークフロー・ステップ名。

- dWfStepDescription: ステップの説明。

- dWfStepType: ワークフロー・ステップ・タイプ

- レビューア: リビジョンを承認または拒否します。

- レビューア/コントリビュータ: リビジョンを編集、承認および拒否できます。

- dWfStepIsAll:

- 1 (true): ワークフローが次のステップに移る前に、ステップに割り当てられているすべてのユーザーがリビジョンを承認する必要があります。

- 0 (false): 必要な承認数がdWfStepWeightパラメータによって指定されます。

- dWfStepWeight: ワークフローが次のステップに移る前に、リビジョンを承認する必要があるレビューアの数。

- dWfStepIsAllが1 (true)の場合、このパラメータは無視されます。dWfStepIsAllが0 (false)の場合、このパラメータは有効になります。

- このパラメータを0 (ゼロ)に設定すると、リビジョンがステップに到達したときに、レビューアに通知されますが、そのステップではリビジョンの承認、却下、編集はできません。ワークフローは自動的に次のステップに進みます。

オプションのサービス・パラメータ

- wfEntryScript: ステップ・エントリのスクリプト。

- wfExitScript: ステップ終了スクリプト。

- wfUpdateScript: ステップ更新スクリプト。

注意:

スクリプトは、<$および$>デリミタ内に配置される必要があります。For example: <$if ConditionExpression$>

5.4.9 CRITERIAWORKFLOW_DISABLE

基準ワークフローを無効にするサービス。最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

例

IdcService=CRITERIAWORKFLOW_DISABLE
dWfName=mktg_review

5.4.10 CRITERIAWORKFLOW_DISABLE_SUB

基準ワークフロー内のサブワークフローを無効にするサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.4.11 CRITERIAWORKFLOW_ENABLE

基準ワークフローを有効にするサービス。最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。

例

IdcService=CRITERIAWORKFLOW_ENABLE
dWfName=mktg_review

5.4.12 DELETE_WFCONTRIBUTORS

基本ワークフローの初期ステップ(コントリビューション・ステップ)からユーザーおよびエイリアスを削除するために使用されるサービス。最も発生しがちなエラーは、パラメータに不整合があるか、指定されたワークフローまたはエイリアスが存在しないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- aliases: 基本ワークフローから削除されるエイリアスおよびユーザー。複数のエイリアスが削除される場合は、タブ区切りリストを使用します。

- dWfName: ワークフロー名。

- dWfStepID: ワークフロー・コントリビューション・ステップID。自動生成される値はデータベース表から取得できます。

例

IdcService=DELETE_WFCONTRIBUTORS
dWfName=mktg_review
dWfStepID=26
aliases=user20

5.4.13 DELETE_WORKFLOW

既存の基本ワークフローを削除するサービス。最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

例

IdcService=DELETE_WORKFLOW
dWfName=mktg_review

5.4.14 DELETE_WORKFLOW_SCRIPT

ワークフロー・スクリプトを削除するサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- wfScriptName: 使用されるスクリプト・テンプレートの名前。

- wfScriptDescription: スクリプトに使用される説明。

5.4.15 DELETE_WORKFLOW_TOKEN

ワークフロー・トークンを削除するサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- wfTokenName: 削除するトークンの名前。

5.4.16 DELETE_WORKFLOWCRITERIA

既存の基準ワークフローを削除するサービス。ワークフローがアクティブな場合、このアクションにより、このワークフロー内のすべてのコンテンツ・アイテムがワークフローを終了する旨がユーザーに通知されます。最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

例

IdcService=DELETE_WORKFLOWCRITERIA
dWfName=mktg_review

5.4.17 DELETE_WORKFLOWDOCUMENTS

基本ワークフローからコンテンツ・アイテムを削除するサービス。このサービスは「ワークフロー管理」アプレットにより実行されます。

最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: 基本ワークフロー名。

- docNames: 削除されるドキュメントのコンテンツ・アイテム名。複数のアイテムが削除される場合は、タブ区切りリストを使用します。

注意:

docNamesパラメータおよびdDocNameパラメータの両方を含めることをお薦めします。このサービスの実行には、両方のパラメータが使用されるためです。

例

次は、DELETE_WORKFLOWDOCUMENTSサービス・コールの例です。

@Properties LocalData
IdcService=DELETE_WORKFLOWDOCUMENTS
dWfName=w3
docNames=rr
dDocName=rr
@end

次は、返される結果の例です。

Content-type: text/plain

Content-Length: 931

<?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?>

@Properties LocalData
dUser=sysadmin
blFieldTypes=xThreadParentDocName bigtext,xCollectionID int,xMailType
text,xZoomLevel int,dCompletionDate date,xTargetCompression int,xTemplateType
text,xEmailFrom bigtext,xEmailCC memo,dMessage message2,xHidden text,
xClbraAliasList memo,xWebsiteID int,StatusMessage message,xComments memo,
xEmailDate date,xWebsiteObjectType text,xCollectionInhibitUpdateMeta text,
xClbraUserList memo,xFileFormat bigtext,dReleaseDate date,xMessageID
text,dInDate date,xDiscussionType text,dCreateDate date,dOutDate
date,xDiscussionCount int,xReadOnly text
docNames=rr
refreshSubMonikers=
blDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS} {aa}}!tAmerica/Chicago
dWfName=w3
refreshSubjects=
changedSubjects=workflows,1061386026294
dDocName=rr
refreshMonikers=
changedMonikers=
dWfDocState=INIT
IdcService=DELETE_WORKFLOWDOCUMENTS
IsJava=1
@end

5.4.18 DELETE_WORKFLOWSTEP

ワークフローから指定されたステップを削除するサービス。このサービスは、「ワークフロー」アプレットから使用されます。ユーザーはステップを選択し、「ステップの削除」ボタンをクリックします。このサービスがアプレット外で実行される場合、制御アプリケーションはワークフロー・ステップを指定する必要があります。ステップIDおよび名前はワークフロー設計情報の一部としてデータベースに格納され、使用するためにそのデータベースから取得できます。

最も発生しがちなエラーは、指定されたワークフローまたはワークフロー・ステップが存在しないか、ワークフローがアクティブなことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

- dWfStepName: ワークフロー・ステップ名。

- dWfStepID: ワークフロー・コントリビューション・ステージID。

例

IdcService=DELETE_WORKFLOWSTEP
dWfName=c2
dWfStepID=12
dWfStepName=edit

5.4.19 EDIT_WORKFLOW

既存のワークフローを変更するサービス。このサービスは「ワークフロー管理」アプレットにより実行されます。最も発生しがちなエラーは、ワークフロー名が存在しないかユーザーがセキュリティ・チェックに失敗することです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

オプションのサービス・パラメータ

- dWfCriteriaName: ワークフロー基準名。

- dWfCriteriaOperator: Matches、Starts、Endsなどのワークフロー基準演算子。

- dWfCriteriaValue: ワークフロー基準値。

- dWfDescription: ワークフローの説明。

- dWfType: 基本や基準などのワークフロー・タイプ。

例

- IdcCommandコマンド・ファイル・フォーマット:

IdcService=EDIT_WORKFLOW
dWfName=c2
dSecurityGroup=Public

- 任意のパラメータを持つHDA形式:

@Properties LocalData
IdcService=EDIT_WORKFLOW
dWfName=test_workflow
dSecurityGroup=Public
dWfType=Criteria
dWfCriteriaName=dDocAuthor
dWfCriteriaOperator=matches
dWfCriteriaValue=sysadmin
dWfDescription=testing workflow
@end

5.4.20 EDIT_WORKFLOW_SCRIPT

ワークフロー・スクリプトを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- wfScriptName: 使用されるスクリプト・テンプレートの名前。

- wfScriptDescription: スクリプトに使用される説明。

5.4.21 EDIT_WORKFLOW_TOKEN

ワークフロー・トークンを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- wfTokenName: 編集されるトークンの名前。

5.4.22 EDIT_WORKFLOWCRITERIA

既存の基準ワークフローの基準を変更するサービス。基準の編集にはプロジェクトやコラボレーション・ワークフローへのワークフローの変更またはコンテンツ・アイテムをワークフローに入れるために満たす必要があるメタデータ条件の変更が含まれる場合があります。

次の2種類の基準ワークフローが存在します: メタデータ条件を必要とするワークフローであるcriteriaおよびメタデータ条件を持たないsubworkflow。2種類のワークフローがあるので、dWfTypeは、使用される基準ワークフローのタイプを指定するための必須パラメータです。

このサービスは「ワークフロー管理」アプレットにより実行されます。最も発生しがちなエラーは、ワークフロー名が存在しないかユーザーがセキュリティ・チェックに失敗することです。

サービス・クラス: ワークフロー・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

- dWfType: ワークフロー・タイプ

- dWfCriteriaName: ワークフロー基準名。

- dWfCriteriaOperator: Matches、Starts、Endsなどのワークフロー基準演算子。

- dWfCriteriaValue: ワークフロー基準値。

オプションのサービス・パラメータ

- dWfDescription: ワークフローの説明。

例

IdcService=EDIT_WORKFLOWCRITERIA
dWfName=c2
dSecurityGroup=Public
dWfType=Criteria
dWfCriteriaName=dDocType
dWfCriteriaOperator=matches
dWfCriteriaValue=ADACCT

5.4.23 EDIT_WORKFLOWSTEP

既存のワークフロー・ステップを変更するサービス。

これらのパラメータは、「ワークフロー管理」アプレットを使用して、ブラウザ環境で実行できます。たとえば、dWfStepName、dWfStepDescriptionおよびdWfStepTypeエントリは「ワークフロー管理」アプレットの「ステップ レビューアの編集」画面の名前エントリ、「説明」フィールド、「タイプ」ドロップダウン・リストに相当します。

dWfStepWeightを数値に設定すると、「ワークフロー管理」アプレットの「ワークフロー・ステップ」の「レビューアの最低必要人数」オプションに関連付けられているフィールドに値を入力するのと同じになります。定義されている場合、dWfStepWeightで指定されたユーザー数がリビジョンを承認するとすぐに、ワークフローは次のステップに移ります。

dWfStepIsAllを1 (true)に設定すると、「ワークフロー管理」アプレットの「ワークフロー・ステップ」の「すべてのレビューア」オプションを有効にするのと同じになります。trueに設定した場合、ワークフローが次のステップに移る前に、ステップに割り当てられているすべてのユーザーがリビジョンを承認する必要があります。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

- dWfStepName: ワークフロー・ステップ名。

- dAliases: ステップに使用されるエイリアスおよびユーザーのタブ区切りのリスト。このパラメータの形式は、(alias/user)\t(alias/user type)\t(alias/user)\t(alias/user type)です。

- dWfStepDescription: ステップの説明。

- dWfStepType: ワークフロー・ステップ・タイプ

- レビューア: リビジョンを承認または拒否します。

- レビューア/コントリビュータ: リビジョンを編集、承認および拒否できます。

- dWfStepIsAll:

- 1 (true): ワークフローが次のステップに移る前に、ステップに割り当てられているすべてのユーザーがリビジョンを承認する必要があります。

- 0 (false): 必要な承認数がdWfStepWeightパラメータによって指定されます。

- dWfStepWeight: ワークフローが次のステップに移る前に、リビジョンを承認する必要があるレビューアの数。

- dWfStepIsAllが1 (true)の場合、このパラメータは無視されます。dWfStepIsAllが0 (false)の場合、このパラメータは有効になります。

- このパラメータを0 (ゼロ)に設定すると、リビジョンがステップに到達したときに、レビューアに通知されますが、そのステップではリビジョンの承認、却下、編集はできません。ワークフローは自動的に次のステップに進みます。

オプションのサービス・パラメータ

- wfEntryScript: ステップ・エントリのスクリプト。

- wfExitScript: ステップ終了スクリプト。

- wfUpdateScript: ステップ更新スクリプト。

注意:

スクリプトは、<$および$>デリミタ内に配置される必要があります。例: <$if ConditionExpression$>。

例

次の例では、表記規則\tがタブ区切リを示していることに注意してください。

IdcService=EDIT_WORKFLOWSTEP
dWfName=test_workflow
dWfStepName=edit
dWfStepType=Reviewer/Contributor
dWfStepDescription=copy edit step
dAliases=AllUsers\taliases\tsysadmin\tuser
dWfStepIsAll=0
dWfStepWeight=2
wfEntryScript=
wfExitScript=
wfUpdateScript=

5.4.24 GET_ACTIVE_WORKFLOWS

ユーザーがワークフローを選択し、ワークフロー内のすべてのドキュメントを表示可能な「アクティブなワークフロー」ページを返すサービス。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

場所: IdcHomeDir/resources/core/templates/workflow.htm

結果

- ResultSets:

- StdWorkflows (dWfName、dWfID、dWfDescription、dCompletionDate、dSecurityGroup、dWfStatus、dWfType、dIsCollaboration)

- ClbraWorkflows (StdWorkflowsと同じフィールド)

- ClbraAccessList (dClbraName、userList、aliasList)

- レスポンス・テンプレート: WORKFLOW_LIST (workflow_list.htm)

次が使用

- リソース・インクルード:

- pne_nav_management_links

- std_doc_man_pages

- テンプレート:

- WORKFLOW_REJECT_FORM (reject_doc.htm)

- ALL_WORKFLOW_DOCS (workflow_all_docs_list.htm)

- WORKFLOW_DOCS (workflow_docs_list.htm)

- WORKFLOW_INFO (workflow_info.htm)

- WF_INQUEUE_LIST (workflow_queue.htm)

- WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

- 標準ナビゲーション: commonNav.js

5.4.25 GET_ALL_WORKFLOWDOCREVISIONS

ワークフロー内のドキュメントの結果セットとそのリビジョン情報を返すサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.4.26 GET_CRITERIA_WORKFLOWS_FOR_GROUP

指定されたセキュリティ・グループのワークフローを返すワークフロー・アプレットで使用されるサービス。このサービスは、返されたワークフローのステップ情報を返します。最も発生しがちなエラーは、セキュリティ・グループが存在しないか、ユーザーがセキュリティ・チェックに失敗することです。

WorkflowsForGroupおよびWorkflowStepsForGroup結果セットを返します。

- WorkflowsForGroupでは、このグループに対するすべてのワークフローがリストされます(dWfID、dWfName)。

- WorkflowStepsForGroupでは、このグループに対するすべてのワークフローのすべてのステップがリストされます(dWfID、dWfName、dWfStepID、dWfStepName)。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

例

- IdcCommandコマンド・ファイル・フォーマット:

# Retrieves criteria workflow information
IdcService=GET_CRITERIA_WORKFLOWS_FOR_GROUP
dSecurityGroup=Public

- HDA形式:

@Properties LocalData
IdcService=GET_CRITERIA_WORKFLOWS_FOR_GROUP
dSecurityGroup=Public
@end

5.4.27 GET_WF_COMPANION_INFO

ワークフロー内のドキュメントのコンパニオン情報ファイルを返します。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dDocName: ワークフロー内のドキュメントの名前。

- dWfName: ワークフロー名。

5.4.28 GET_WORKFLOW

特定のワークフローに関する情報を返すサービス。最も発生しがちなエラーは、ワークフロー名が存在しないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

例

IdcService=GET_WORKFLOW
dWfName=mktg_review

5.4.29 GET_WORKFLOW_INFO

コンテンツ・アイテムのワークフロー・ステップ情報を返すサービス。このサービスは、PNEリンクから「アクティブなワークフロー」を選択し、ワークフロー名をクリックしてから、ステップ名のリンクをクリックすることにより、ブラウザ・インタフェースで実行されます。

最も発生しがちなエラーは、コンテンツ・アイテムまたはワークフロー名が存在しないことです。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

実行される問合せ: QdocInfo、QworkflowDocument、QworkflowForID、QwfDocState、QworkflowSteps

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dWfStepID: ワークフロー・コントリビューション・ステージID。自動生成される値はデータベース表から取得できます。

結果

- ResultSets:

- WorkflowSteps(指定されたワークフローのWorkflowSteps DB表のすべての行からの全フィールド)

- WorkflowSteps(現在のステップのすべてのWorkflowStepsフィールドと、dUsersおよびdHasTokensフィールド)

- DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)

- WorkflowInfo(指定されたワークフローのWorkflows DB表からのすべてのフィールド)

- WorkflowState(指定されたコンテンツ・アイテムのWorkflowState DB表からのdUserNameフィールドのみ)

- WorkflowActionHistory (data\workflow\statesディレクトリの対応するHDAファイルからの結果セット)

- ローカル・データ:

- AuthorAddress

- dID

- dUser

- dWfCurrentStepID

- dWfName

- dWfStepID

- RemainingStepUsers

- レスポンス・テンプレート: WORKFLOW_INFO (workflow_info.htm)

次が使用

- リソース・インクルード: clbra_wf_doc_list

例

IdcService=GET_WORKFLOW_INFO
dID=61
dWfStepID=19

5.4.30 GET_WORKFLOW_INFO_BYNAME

ワークフローのドキュメントの名前に基づいたワークフローに関する情報を取得するために使用されるサービス。ドキュメントの履歴、ワークフローに残っているステップ、現在のワークフローのレビュー担当者をリストする、コンテンツ・アイテムの「ワークフロー情報」ページを返します。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

実行される問合せ:

- QdocNameMeta

- QworkflowDocument

- QworkflowForID

- QwfDocState

- QworkflowSteps

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dDocName: アクティブなワークフロー内のドキュメントの名前。

結果

- ResultSets:

- WorkflowSteps(指定されたワークフローのWorkflowSteps DB表のすべての行からの全フィールド)

- WorkflowSteps(現在のステップのすべてのWorkflowStepsフィールドと、dUsersおよびdHasTokensフィールド)

- DOC_INFO(指定されたコンテンツ・アイテムのRevisionsおよびDocMetaからのすべてのフィールド)

- WorkflowInfo(指定されたワークフローのWorkflows DB表からのすべてのフィールド)

- WorkflowState(指定されたコンテンツ・アイテムのWorkflowState DB表からのdUserNameフィールドのみ)

- WorkflowActionHistory (data\workflow\statesディレクトリの対応するHDAファイルからの結果セット)

- ローカル・データ:

- AuthorAddress

- dUser

- dWfName

- dWfStepID

- RemainingStepUsers

- レスポンス・テンプレート: WORKFLOW_INFO (workflow_info.htm)

次が使用

- リソース・インクルード:

- setup_workflow_action_popups

- wf_in_queue_display

- workflow_action_popup

- テンプレート:

- WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

- WORKFLOW_REVIEW_FRAMES (workflow_review_frames.htm)

- その他: SoapCustom:Wsdl:Workflow:Services

5.4.31 GET_WORKFLOW_SCRIPT

ワークフロー・スクリプトを取得するために使用されるサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- wfScriptName: 使用されるスクリプト・テンプレートの名前。

- wfScriptDescription: スクリプトに使用される説明。

5.4.32 GET_WORKFLOWDOCREVISIONS

特定のワークフローにあるコンテンツ・アイテムのリビジョンのリストを返すサービス。このサービスは、PNEリンクの「アクティブなワークフロー」を選択し、ワークフロー名をクリックすることにより、ブラウザ環境で実行されます。

最も発生しがちなエラーは、ワークフロー名が存在しないことです。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

実行される問合せ:

- Qworkflow

- QwfStates

- QworkflowDocuments

- QworkflowSteps

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

結果

- ResultSets:

- WorkflowSteps(指定されたワークフローのWorkflowSteps DB表のすべての行からの全フィールド、および追加フィールドdUsersとdHasTokens)

- WfDocuments(指定されたワークフローに属する各コンテンツ・アイテムに対応する行。各行にはWorkflowDocuments、RevisionsおよびDocMeta DB表からのすべてのフィールドが含まれます)

- WorkflowStates(指定されたワークフローのWorkflowStates DB表からのすべてのフィールド)

- WF_INFO(指定されたワークフローのWorkflows DB表からのすべてのフィールド)

- ローカル・データ:

- dUser

- dWfName

- isCollaboration

- レスポンス・テンプレート:

- WORKFLOW_DOCS (workflow_docs_list.htm)

次が使用

- リソース・インクルード:

- checkin_multiuploadapplet_processing_functions

- setup_active_standard_workflows_table_row

- legacy_active_collaboration_workflows_table

- legacy_active_standard_workflows_table

- wf_in_queue_display

- workflow_action_popup

- workflow_revisions_href

- テンプレート:

- CONTRIBUTOR_MAIL (contributor_mail.htm)

- PROJECT_INFO (project_info.htm)

- WF_REJECT_MAIL (reject_mail.htm)

- WORKFLOW_INFO (workflow_info.htm)

- WORKFLOW_REJECT_FORM (reject_doc.htm)

- WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

- その他: SoapCustom:Wsdl:Workflow:Services

- リダイレクト・サービスの対象: WORKFLOW_APPROVE、WORKFLOW_EDIT_APPROVE、WORKFLOW_REJECT、WORKFLOW_CHECKIN

例

IdcService=GET_WORKFLOW
dWfName=mktg_review

5.4.33 GET_WORKFLOWS

説明、セキュリティ・グループ、ステータスおよびタイプを含むすべてのワークフローのリストを取得するサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.4.34 TEST_WORKFLOW_SCRIPT

ワークフロー・スクリプトの妥当性をチェックするために使用されるサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- wfScriptName: 使用されるスクリプト・テンプレートの名前。

- wfScriptDescription: スクリプトに使用される説明。

- dDocName: テスト・シナリオに使用されるコンテンツ・アイテム。

5.4.35 WORKFLOW_APPROVE

ワークフロー内のコンテンツ・アイテムのリビジョンを承認するサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

例

IdcService=WORKFLOW_APPROVE
dID=81

5.4.36 WORKFLOW_CANCEL

基準ワークフローをキャンセルするサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

例

IdcService=WORKFLOW_CANCEL
dWfName=mktg_review

5.4.37 WORKFLOW_CHECKIN

ワークフロー内にあるコンテンツ・アイテムの新しいリビジョンをチェックインするサービス。最も発生しがちなエラーは、指定されたコンテンツ・アイテムまたはワークフローが存在しないことです。

このサービスはWORKFLOW_CHECKIN_SUBサブサービスを実行します。このサブサービスは、ワークフローにコンテンツ・アイテムのリビジョンをチェックインします。

アクセス・レベル: 読取り(1)

実行される問合せ: QdociInfo、Qrevisions

サブサービスのコール: WORKFLOW_CHECKIN_SUB

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテムの識別子(コンテンツID)。

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

- dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。

- primaryFile: Content Serverインスタンスから見た、ファイルの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。
プライマリ・ファイルは、メタデータのみをチェックインするのではないかぎり、指定する必要があります。プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリにより代替ファイルが変換されます。それ以外の場合、プライマリ・ファイルが変換されます。

- プライマリ・ファイルが指定されない場合、そのかわりにメタファイルを使用できます。ただし、各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。

- プライマリと代替の両方のファイルを指定する場合、それらの拡張子は異なっている必要があります。

オプションのサービス・パラメータ

- isFinished: 却下されたコンテンツ・アイテムに対する編集が終了したことを示します。

- 1 (true): リビジョンがチェックインされ承認されます。 |

- 0 (false): リビジョンがチェックインされますが、承認される必要があります。

- doFileCopy:

- 1 (true): ファイルはチェックイン後にハード・ドライブから削除されません。

- 0 (false): ファイルはチェックイン後にハード・ドライブから削除されます。

- alternateFile

- RedirectUrl

結果

- ローカル・データ:

- Content Server:

- alternateFile

- changedSubjects

- CurRevID

- dAction

- dActionDate

- dCheckoutUser

- dClbraName

- dConversion

- dCreateDate

- dDocAccount

- dDocAuthor

- dDocID

- dDocName

- dDocTitle

- dDocType

- dExtension

- dFileSize

- dFormat

- dID

- dInDate

- dIsPrimary

- dIsWebFormat

- dlsCheckedOut

- doFileCopy

- dLocation

- dOriginalName

- dOutDate

- dpAction

- dpEvent

- dProcessingState

- dPublishState

- dPublishType

- dRawDocID

- dReleaseState

- dRevClassID

- dRevisionID

- dRevLabel

- dRevRank

- dSecurityGroup

- dStatus

- dUser

- dUserName

- isCheckin

- isCurRevEmpty

- isDocProfileUsed

- isEditMode

- isInfoOnly

- isNew

- IsNotLatestRev

- isStatusChanged

- IsUpdate

- IsWorkflow

- latestID

- oldName

- prevID

- prevReleaseState

- primaryFile

- VaultfilePath

- WebfilePath

- ワークフロー:

- dWfComputed

- dWfCurrentStepID

- dWfDirectory

- dWfDocState

- dWfEntry

- dWfID

- dWfName

- dWfStatus

- dWfStepID

- dWfStepDescription

- dWfStepIsAll

- dWfStepName

- dWfStepType

- dWfStepWeight

- dWfType

- dWorkflowState

- entryCount

- wfAction

- wfCurrentStepPrefix

- WfEditFinished

- wfMessage

- wfStepCheckinType

- レスポンス・テンプレート:

- REDIRECT_TEMPLATE (redirect_template.htm)

- デフォルト・リダイレクト・サービス(branched): GET_WORKFLOWDOCREVISIONSまたはGET_PORTAL_PAGE (Page=WF_INQUEUE_LIST)

例

IdcService=WORKFLOW_CHECKIN
dID=92
dDocName=test_00063
dWfID=4
dSecurityGroup=Public
dDocAccount=mainaccount
dWfType=Criteria
dWfName=mktg_review
primaryFile=c:/hello_hello.txt
dRevLabel=2
doFileCopy=1
isFinished=1

5.4.38 WORKFLOW_EDIT_APPROVE

チェックイン/チェックアウト・プロセスを経ないで、ドキュメントを承認する機能を必要とするクライアント・アプリケーションに使用される(つまり、コアContent Serverソフトウェアによって使用されない)サービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.4.39 WORKFLOW_REJECT

ワークフロー内のコンテンツ・アイテムのリビジョンを拒否するサービス。

現在のステップのレビューアとして定義されている場合を除き、システム管理者はワークフローのコンテンツ・アイテムを承認または拒否することはできません。したがって、IdcCommandのこのサービスをユーザーsysadminとして実行する場合、sysadminがレビューアとして定義されている場合を除き、コンテンツ・アイテムを拒否することはできません。

アクセス・レベル: 読取り(1)

実行される問合せ:

- QdocInfo

- IworkflowDocHistory

- UrevisionStatus

- UworkflowDocStep

- UrevisionStatus

- DworkflowDocState

- QwfDocInformation

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- wfRejectMessage: 拒否メッセージ。

オプションのサービス・パラメータ

- RedirectUrl

結果

- ローカル・データ:

- Content Server:

- changedSubjects

- dActionDate

- dClbraName

- dDocAuthor

- dDocName

- dDocTitle

- dExtension

- dID

- dPublishState

- dReleaseState

- dRevClassID

- dStatus

- dUser

- isCurRevEmpty

- IsWorkflow

- prevReleaseState

- ワークフロー:

- dAction

- dOriginalName

- dWfCompute

- dWfCurrentStepID

- dWfDirectory

- dWfDocState

- dWfID

- dWfName

- dWfStatus

- dWfStepDescription

- dWfStepID

- dWfStepIsAll

- dWfStepName

- dWfStepType

- dWfStepWeight

- dWfType

- dWorkflowState

- entryCount

- wfAction

- wfCurrentStepPrefix

- WfEditFinished

- wfMailSubject

- wfMailTemplate

- wfMessage

- wfRejectMessage

- wfStepCheckinType

- wfUsers

- レスポンス・テンプレート:

- REDIRECT_TEMPLATE (redirect_template.htm)

- デフォルト・リダイレクト・サービス(branched): GET_WORKFLOWDOCREVISIONSまたはGET_PORTAL_PAGE (Page=WF_INQUEUE_LIST)

参照

- アプレット: リポジトリ・マネージャ

- テンプレート: WORKFLOW_REJECT_FORM (reject_doc.htm)

- その他: SoapCustomer:Wsdl:Workflow:Services

例

IdcService=WORKFLOW_REJECT
dID=95
wfRejectMessage=Please Revise

5.4.40 WORKFLOW_START

サービス・クラス: ワークフロー・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

- dWfName: ワークフロー名。

- dSecurityGroup: PublicやSecureなどのセキュリティ・グループ。

オプションのサービス・パラメータ

- wfMessage: 「ワークフロー開始の通知」電子メールに記載されているメッセージ。

例

IdcService=WORKFLOW_START
dWfName=mktg_review
dSecurityGroup=Public
wfMessage=Please check in this content item

6 アーカイブ・サービス

この章では、Oracle WebCenter Content Serverアーカイブを使用およびカスタマイズする際に使用可能なサービスについて説明します。

この章の内容は、次のとおりです。

- 第6.1項「アーカイブ・サービスについて」

- 第6.2項「アーカイブ・サービス」

6.1 アーカイブ・サービスについて

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

特定のアーカイブ・サービスの場所は、各サービス内にリスト表示されています。

注意:

最も一般的に使用されるサービスには、より広範囲な説明があります。

重要:

すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。

重要:

ほとんどのアーカイブ・サービスはEDIT_ARCHIVEDATAで使用される基礎となるメソッドを使用するため、その結果として、適切な値に設定されるEditItemsパラメータが必要です。ユーザー・インタフェースは、通常、このパラメータに含める内容を制御します。必要に応じて、ユーザーは値の設定方法を決定するため、Filter Debugフラグを有効にしたユーザー・インタフェースからアーカイブ・サービスを実行する必要があります。Filter Debugフラグを使用することにより、サーバーに送信されるリクエストをそのままキャプチャすることができます。

6.2 アーカイブ・サービス

特記しないかぎり、ここにリストされているすべてのサービスは、ArchiveServiceサービス・クラスです。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

この項では、次のサービスについて説明します。

- ADD_ARCHIVE

- ADD_COLLECTION

- ADD_PROXIEDCOLLECTION

- CANCEL_ARCHIVE

- *CHECKIN_ARCHIVE

- COPY_ARCHIVE

- DELETE_ARCHIVE

- DELETE_BATCH_FILE

- DELETE_BATCH_FILE_DOCUMENTS

- DELETE_BATCH_FILE_TABLES

- EDIT_ARCHIVE

- EDIT_ARCHIVEDATA

- EDIT_EXPORTERS

- EDIT_TRANSFEROPTIONS

- EXECUTE_BATCH

- EXPORT_ARCHIVE

- GET_ARCHIVECOLLECTIONS

- GET_ARCHIVETABLECONTENT

- GET_ARCHIVED_FILE

- GET_ARCHIVES

- GET_ARCHIVERELATIONQUERY

- GET_BATCH_FILE_DOCUMENTS

- GET_BATCH_PROPERTIES

- GET_BATCH_SCHEMA

- GET_BATCH_VALUES

- GET_BATCHFILES

- GET_PROXIED_ARCHIVECOLLECTIONS

- GET_PROXIEDSERVERS

- GET_REPLICATION_DATA

- GET_TABLECOLUMNLIST

- GET_TARGET_INFO

- GET_TARGET_TRANSFER_STATUS

- GET_TRANSFER_SOURCE_INFO

- IMPORT_ARCHIVE

- IMPORT_ARCHIVE_START_AUTOMATED

- IMPORT_BATCHFILE

- IMPORT_DOCUMENT

- IMPORT_TABLE_ENTRY

- INSERT_NATIVE

- INSERT_NEW

- REGISTER_IMPORTER

- REMOVE_COLLECTION

- REMOVE_EXPORTER

- REMOVE_IMPORTER

- REMOVE_PROXIEDTRANSFER

- REMOVE_QUEUED_IMPORT

- REMOVE_TRANSFER

- REQUEST_TRANSFER

- TRANSFER_ARCHIVE

- UPDATE_TARGET_TOTALS

- UPDATE_TRANSFER_STATUS

- UPLOAD_ARCHIVE_TRANSFER

6.2.1 ADD_ARCHIVE

アーカイブ・コレクションにアーカイブを追加するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、アーカイブ名が一意ではないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- aArchiveDescription: Content Serverインスタンスのメニュー・ラベル(インタフェースで使用)。たとえば、Master_on_server01。

例

マスターContent Serverインスタンスにアーカイブを追加するには、必須パラメータは次のとおりです。

IdcService=ADD_ARCHIVE
IDC_Name=Master_on_server01
aArchiveName=archive_test
aArchiveDescription=this is an archive test

6.2.2 ADD_COLLECTION

新しいアーカイブ・コレクションを作成するサービス。最も発生しがちなエラーは、インスタンス・メニュー・ラベルが一意ではないことです。

注意:

重複するIDC_Nameコレクション名を使用すると、データが破損します。アーカイバを使用して、同じIDC_Nameを共有する2つのコレクション間でデータを移動またはコピーできません。これを行うと、ターゲット・システムのデータが破損します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。

- aCollectionLocation: コレクションの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。

- aVaultDir: vaultディレクトリへの絶対パス。ファイルの区切り文字としてスラッシュを使用します。

- aWeblayoutDir: weblayoutディレクトリへの絶対パス。ファイルの区切り文字としてスラッシュを使用します。

例

IdcService=ADD_COLLECTION
IDC_Name=new_collection
aCollectionLocation=c:/oracle/archives
aVaultDir=c:/oracle/vault
aWeblayoutDir=c:/oracle/weblayout

6.2.3 ADD_PROXIEDCOLLECTION

別のサーバーからアーカイブ・コレクションを追加するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- psIDC_Name: プロバイダ(プロキシ接続)の名前。

- IDC_Name: アーカイブ・コレクションの名前。

6.2.4 CANCEL_ARCHIVE

現在のアーカイブ・リクエストをキャンセルするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

6.2.5 CHECKIN_ARCHIVE

アーカイブにコンテンツ・アイテムのリビジョンをチェックインするサービス。

アクセス・レベル: 管理者(8)

場所: IdcHomeDir/resources/core/tables/std_services.htm

- このサービスは、パラメータおよび条件変数に基づいて、次のサブサービスのいずれかを実行します。

- DELETE_BYREV: アクション・パラメータがDeleteで、コンテンツ・アイテムのリビジョンがシステムに存在する場合。

- DELETE_BYCLASS: アクション・パラメータがDeleteで、コンテンツ・アイテムのリビジョンがシステムに存在しない場合。

- CHECKIN_NEW_SUB: コンテンツ・アイテムがシステムに存在しない場合、アクション・パラメータはDeleteではなく、条件変数IsPublishはtrueに設定されます。

- INSERT_NEW: コンテンツ・アイテムがシステムに存在しない場合、アクション・パラメータはDeleteではなく、条件変数IsPublishはfalseに設定されるか、または指定されません。

- UPDATE_DOCINFO_BYREV: アクション・パラメータがDeleteではなく、primaryFileパラメータが空でない場合。また、条件変数IsPublishは、trueであるか、またはコンテンツ・アイテムのリビジョンがシステムに存在している必要があります。

- UPDATE_BYREV: アクション・パラメータがDeleteではなく、primaryFileパラメータが空である場合。また、条件変数IsPublishは、trueであるか、またはコンテンツ・アイテムのリビジョンがシステムに存在している必要があります。

重要:

IsPublish変数は、ワークフローまたはプロジェクトが登録解除されている場合にサーバーによって設定されます。この値はこのサービスのパラメータとして、または構成エントリとして設定できません。

- IsNativeパラメータがtrueに設定される場合、サービスは次のサブサービスのいずれかを実行します。

- DELETE_BYREV: コンテンツ・アイテムがリビジョン表に存在し、アクション・パラメータがDeleteである場合。

- UPDATE_BYREV: コンテンツ・アイテムがリビジョン表に存在し、コンテンツが削除されておらず、アクション・パラメータがUpdateである場合。

- INSERT_NATIVE: コンテンツ・アイテムがサーバーに存在せず、アクション・パラメータがDeleteではない場合。

- コンテンツ・アイテムがシステムにすでに存在し、削除されていない場合、サーバーはエントリを更新または挿入できず、エラーがスローされます。

- 最も発生しがちなエラーは、コンテンツ・アイテム名が一意でないこと、またはサービスが、指定されたファイルをチェックインできないことです。

- プライマリ・ファイルが必要です。プライマリ・ファイルをチェックインしないでメタデータのみをチェックインする場合は、追加のパラメータを含む必要があり、また、構成エントリをContent Serverインスタンスに追加する必要があります。

- 必要な追加パラメータ(メタデータ・チェックイン):

createPrimaryMetaFile=true

- 必要なContent Server構成エントリ(メタデータ・チェックイン):

AllowPrimaryMetaFile=true
Example:
IdcService=CHECKIN_ARCHIVE
Action=insert
dDocTitle=my_test
dDocAuthor=sysadmin
dDocType=ADACCT
dSecurityGroup=Public
createPrimaryMetaFile=true

追加の必須サービス・パラメータ

- Action: 前に指定された値に設定する必要があります。

- dDocName: コンテンツ・アイテムのコンテンツID。

- コンテンツID自動生成が有効な場合、このパラメータは必要ありません。dDocNameが定義されている場合、自動生成されたコンテンツIDをオーバーライドします。

- コンテンツIDに、スペースまたは無効な文字(/ \?:@&=+"#%<>*~|[ ])を含めることはできません。

- dDocAuthor: コンテンツ・アイテムの作成者(コントリビュータ)。

- dDocTitle: コンテンツ・アイテムのタイトル。

- dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

- dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。

- primaryFile: サーバーから見た、ファイルの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。
プライマリ・ファイルは、メタデータのみをチェックインするのではないかぎり、指定する必要があります。プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリにより代替ファイルが変換されます。それ以外の場合、プライマリ・ファイルが変換されます。

- プライマリ・ファイルが指定されない場合、そのかわりにメタファイルを使用できます。ただし、各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。

- プライマリと代替の両方のファイルを指定する場合、それらの拡張子は異なっている必要があります。

- doFileCopy: 1 (true): ファイルはチェックイン後にハード・ドライブから削除されません。0 (false): ファイルはチェックイン後にハード・ドライブから削除されます。

- 必須カスタム・フィールド: 必須のカスタム・メタデータ・フィールドも指定する必要があります。

オプションのサービス・パラメータ

- alternateFile: 変換のための代替ファイル。

- ただし、各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。

- プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリにより代替ファイルが変換されます。それ以外の場合、プライマリ・ファイルが変換されます。

- dCreateDate: コンテンツ・アイテムが作成された日付。デフォルトでは、これは現在の日付です。

- dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。設定されている場合は、このラベルを使用して、指定されたリビジョンを検索します。

- doDocSecurityCheck: ドキュメントのセキュリティ・チェックを有効にします。デフォルトで、このエントリはfalseです。

- dPublishState: パブリッシュ状態。コンテンツ・アイテムがシステムに存在している場合、このパラメータは空である必要があります。

- dReleaseState: リリース状態(リビジョンのWeb状態を示すために使用されます)。

- IsNative: これは構成エントリですが、パラメータとして指定できます。

- IsNativeパラメータがtrueで、コンテンツがシステムに存在する場合、指定されたコンテンツID (dDocName)はデータベースのコンテンツ名と一致する必要があります。それ以外の場合、コマンドはネイティブではなく、サービスによりIsNativeパラメータがfalseであると判断されます。

- IsNativeパラメータがtrueで、アクション・パラメータがDeleteの場合、コンテンツ・アイテムはシステムに存在している必要があります。それ以外の場合、コマンドはネイティブではなく、サービスによりIsNativeパラメータがfalseであると判断されます。

- webViewableFile: コンテンツがWeb表示可能とマークされる場合、ファイル形式はパラメータwebViewableFile:formatで決定され、拡張子はパラメータdWebExtensionで決定されます。それ以外の場合、拡張子およびファイル形式はそれぞれ、パラメータdExtensionおよびdFormatで決定されます。ユーザーはこれらのパラメータをオーバーライドすることにより、ファイル形式および拡張子をオーバーライドできます。

- オプションのカスタム・フィールド: 必須ではないカスタム・メタデータ・フィールドも指定できます。

結果

- ローカル・データ:

- アクション

- dRevClassID

- dRevisionID

- dRendition2

- dRendition1

- dDocAuthor

- DocExists

- isCheckin

- StatusMessage

- primaryFile

- dStatus

- dRevLabel

- dWorkflowState

- dDocTitle

- StatusCode

- dpEvent

- isNew

- dUser

- isEditMode

- dDocName

次が使用

- アプレット: バッチ・ローダー

例

IdcService=CHECKIN_ARCHIVE
Action=insert
dDocAuthor=user1
dDocName=test
dDocTitle=new content
dSecurityGroup=Public
primaryFile=c:/test.txt
doFileCopy=true

6.2.6 COPY_ARCHIVE

コレクションにアーカイブをコピーするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IdcService: COPY_ARCHIVEに設定する必要があります。

- InstanceMenuLabel: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

例

IdcService=COPY_ARCHIVE
InstanceMenuLabel=Master_on_server01

6.2.7 DELETE_ARCHIVE

コレクションから既存のアーカイブを削除するサービス。最も発生しがちなエラーは、指定されたアーカイブがシステムに存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IdcService: DELETE_ARCHIVEに設定する必要があります。

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

例

IdcService=DELETE_ARCHIVE
IDC_Name=Master_on_server01
aArchiveName=archive_test

6.2.8 DELETE_BATCH_FILE

アーカイブからバッチ・ファイルを削除するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- aBatchFile: バッチ・ファイルのサブディレクトリおよびHDAファイル名。

例

IdcService=DELETE_BATCH_FILE
IDC_Name=Master_on_server01
aArchiveName=archive_test
aBatchFile=02-jan-16_12.02.06_184/0216120206~1.hda

6.2.9 DELETE_BATCH_FILE_DOCUMENTS

バッチ・ファイルの編集中に使用されるサービス。アーカイバ/一般/バッチ・ファイルの表示/編集のダイアログを使用している場合に使用できます。このダイアログを使用して、ユーザーはバッチ・ファイルの選択したエントリを削除できます。

ユーザーが編集を完了し、「OK」をクリックすると、変更がサーバーに送信されます。ダイアログ操作中に実行される削除アクションは、このサービスで処理されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- aBatchFile: バッチ・ファイルのサブディレクトリおよびHDAファイル名。

- DeletedRows: 削除するアイテムが含まれている結果セット。

例

IdcService=DELETE_BATCH_FILE_DOCUMENTS
IDC_Name=Master_on_server01
aArchiveName=archive_test
aBatchFile=02-jan-16_16.53.02_289/0216165302~1.hda

6.2.10 DELETE_BATCH_FILE_TABLES

エクスポートされた表データで使用されることを除き、DELETE_BATCH_FILE_DOCUMENTSに類似したサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

6.2.11 EDIT_ARCHIVE

アーカイブの説明が作成された後で、それを変更するために使用されるサービス。説明にアクセスするには、アーカイブ・リストのアーカイブをダブルクリックします。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

例

IdcService=EDIT_ARCHIVE
IDC_Name=Master_on_server01

6.2.12 EDIT_ARCHIVEDATA

EditItemsパラメータで指定されているようにデータを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

重要:

ほとんどのアーカイブ・サービスはEDIT_ARCHIVEDATAで使用される基礎となるメソッドを使用するため、EditItemsパラメータを適切な値に設定する必要があります。ユーザー・インタフェースは、通常、このパラメータに含める内容を制御します。必要に応じて、ユーザーは値の設定方法を決定するため、Filter Debugフラグを有効にしたユーザー・インタフェースからこれらのサービスを実行する必要があります。Filter Debugフラグを使用することにより、サーバーに送信されるリクエストをそのままキャプチャすることができます。

追加の必須サービス・パラメータ

- EditItems: アーカイブを定義するために使用されるキーをカンマで区切ったリスト。使用される任意のキーが、パラメータとして指定される必要もあります。たとえば、EditItems=aValueMapsの場合、aValueMapsはこのサービスに対する必須パラメータです。

- KeyValue: EditItemパラメータのキーの値。

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

例

IdcService=EDIT_ARCHIVEDATA
IDC_Name=Master_on_server01

6.2.13 EDIT_EXPORTERS

指定されたアーカイブのアーカイブ・データを編集するサービス。指定される場合、アーカイブを登録するか、または登録解除します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- EditItems: 承認される唯一の値はaIsAutomatedExportおよびaRegisteredExportersです。
EditItemsを設定することにより、次のパラメータも必須になります。

- aIsAutomatedExport

- aRegisteredExporters

6.2.14 EDIT_TRANSFEROPTIONS

アーカイブ・プロセスの転送オプションを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

6.2.15 EXECUTE_BATCH

アーカイブのバッチ操作を実行するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- aBatchFile: 実行するバッチ・ファイルのパスおよびファイル名。

6.2.16 EXPORT_ARCHIVE

アーカイブをエクスポートするサービス。

- エクスポートではアーカイブの定義ファイルが読み込まれ、指定されているエクスポート・ルールに従います。これには、エクスポート問合せの指定、ユーザーまたはドキュメントの構成情報(またはその両方)をエクスポートするかどうかおよび前のバッチ・ファイルを削除するかどうかが含まれます。

- Content Serverはこのサービスを非同期的に実行します。サービスが実行されるには、サーバーが稼働している必要があります。また、IdcCommandは成功を伝えて終了し、実際にすべてが終了すると、サーバーはアクションを実行するように指示されます。

注意:

EXPORT_ARCHIVEサービスはアーカイブ・エクスポートのみを開始し、エクスポートを開始するリクエストが行われたことを確認します。ステータスまたはアーカイブ・エクスポートの完了に関する通知は送信されません。カスタム・コンポーネントは、ステータスまたはアーカイブ・エクスポート完了の通知を提供するために作成できます。

- Content Serverは、一度に1つのアーカイブのみをエクスポートできます。複数のエクスポートを使用するバッチ・ファイルは、最初のコマンドでの成功および最初のコマンドが終了するまでのすべての後続のコマンドでの失敗を宣言します。バッチ・ファイルは1つのエクスポートのみを使用する必要があり、一部の外部プロセスは、別のエクスポート・コマンドを発行する前にアクションが完了していることを確認する必要があります。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- dataSource: RevisionIDsに設定する必要があります。これは、エクスポート問合せとともに、エクスポートするリビジョンのリストを作成するために使用される問合せスタブです。

オプションのサービス・パラメータ

- aDoDelete:

- 1 (true): エクスポートの正常終了後、リビジョンは削除されます。

- 0 (false): エクスポート後、リビジョンは削除されません。

例

- IdcCommandコマンド・ファイル形式(コレクションMaster_on_server01のアーカイブarchive_testをエクスポート):

# To export an archive
IdcService=EXPORT_ARCHIVE
aArchiveName=archive_test
IDC_Name=Master_on_server01
dataSource=RevisionIDs

- 任意のパラメータを持つHDA形式:

@Properties LocalData
IdcService=EXPORT_ARCHIVE
aArchiveName=archive_test
IDC_Name=Master_on_server01
dataSource=RevisionIDs
aDoDelete=1
@end

6.2.17 GET_ARCHIVECOLLECTIONS

すべてのアーカイブ・コレクションのリストを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

6.2.18 GET_ARCHIVETABLECONTENT

エクスポートされる表データをプレビューするために使用されるサービス。アーカイバ/データのエクスポート/表/プレビューのダイアログで使用されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- resultName: 表の内容の結果セット名。

6.2.19 GET_ARCHIVED_FILE

アーカイブからアーカイブ済コンテンツ・アイテムのリビジョンの特定のレンディションを返すサービス。

dID、またはdDocNameとRevisionSelectionMethodパラメータの場合、このサービスは、そのリビジョンの特定のレンディションのファイル名を決定し、そのファイルをクライアントに返します。

最も発生しがちなエラーは、パラメータに不整合があるか、存在しないリビジョンまたはレンディションに対するリクエストであることです。

注意:

リクエスタがdDocNameを認識している場合、dDocNameがコンテンツ・アイテムのすべてのリクエストに含まれるようにすることをお薦めします。Content Serverシステムのエラー・メッセージは、フォームなど、他の機能と同様に、これが存在しているということを想定しています。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

重要:

コンテンツ・アイテムのリビジョンID (dID)が指定されているか、コンテンツID (dDocName)とRevisionSelectionMethodパラメータが定義されている必要があります。

オプションのサービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

- dIDが指定されない場合、dDocNameおよびRevisionSelectionMethodを指定する必要があります。

- このIDを持つコンテンツ・アイテムのリビジョンのレンディションが存在し、かつRevisionSelectionMethodパラメータが存在しないか、その値がSpecificである場合は、そのレンディションが返されます。

- dDocName: コンテンツ・アイテムの識別子(コンテンツID)。

- dDocNameが存在しない場合は、dIDが存在しなければならず、RevisionSelectionMethodが存在してはなりません。

- RevisionSelectionMethodが指定された場合、その名前を持つコンテンツ・アイテムのリビジョンのレンディションが返されます(存在する場合)。RevisionSelectionMethodが指定されない場合、エラー・メッセージにdDocNameが示されます。

- RevisionSelectionMethod: リビジョン選択メソッド。

- これが指定された場合は、dDocNameも指定する必要があります。この変数の値は、指定されたdDocNameからdIDを計算するために使用されるメソッドです。このパラメータで設定可能な値は、Specific、LatestまたはLatestReleasedです。

- 値がSpecificである場合、dDocNameは無視され、dIDが要求され、これを使用してレンディションが取得されます。値がLatestである場合、コンテンツ・アイテムの最新リビジョンを使用してdIDが計算されます。値がLatestReleasedである場合、コンテンツ・アイテムの最新リリースのリビジョンを使用してdIDが計算されます。

- Rendition: コンテンツ・アイテムのレンディション。このパラメータは、コンテンツ・アイテムのレンディションを指定するもので、Primary、WebまたはAlternateに設定できます。Renditionが指定されない場合、デフォルトでPrimaryが設定されます。

- 値がPrimaryである場合、選択されたリビジョンのプライマリ・レンディションが返されます。

- 値がWebである場合、選択されたリビジョンのWeb表示可能レンディションが返されます。

- 値がAlternateである場合、選択されたリビジョンの代替レンディションが返されます。

例

IdcService=GET_ARCHIVED_FILE
dDocName=notice
RevisionSelectionMethod=LatestReleased
Rendition=web

6.2.20 GET_ARCHIVES

コレクションのすべてのアーカイブのリストを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

例

IdcService=GET_ARCHIVES
IDC_Name=Master_on_server01

6.2.21 GET_ARCHIVERELATIONQUERY

エクスポートされる表間の確立された関係を問い合せるために使用されるサービス。すべてのパラメータはユーザー・インタフェースにより提供され、アーカイブの定義に由来します。アーカイブ・エクスポート定義に従って、GET_ARCHIVETABLECONTENTを実行する前にこのサービスをコールする必要があります。

場所: IdcHomeDir/resources/core/tables/std_services.htm

6.2.22 GET_BATCH_FILE_DOCUMENTS

すべてのバッチ・ファイルのコンテンツ・アイテムを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- aBatchFile: バッチ・ファイルのサブディレクトリおよびHDAファイル名。

例

IdcService=GET_BATCH_FILE_DOCUMENTS
IDC_Name=Master_on_server01
aArchiveName=latest_archive
aBatchFile=02-jan-18_09.34.41_430/0218093441~1.hda

6.2.23 GET_BATCH_PROPERTIES

指定されたバッチ・ファイルのプロパティを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- aBatchFile: バッチ・ファイルのサブディレクトリおよびHDAファイル名。

6.2.24 GET_BATCH_SCHEMA

バッチ・スキーマを返すサービス。スキーマ情報は、データベースに格納されるオブジェクトのクラスを記述します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- aBatchFile: バッチ・ファイルのサブディレクトリおよびHDAファイル名。

例

IdcService=GET_BATCH_SCHEMA
IDC_Name=Master_on_server01
aArchiveName=latest_archive
aBatchFile=02-jan-18_09.34.41_430/0218093441~1.hda

6.2.25 GET_BATCH_VALUES

バッチのメタデータ・フィールド値を返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- aBatchFile: バッチ・ファイルのサブディレクトリおよびHDAファイル名。

例

IdcService=GET_BATCH_VALUES
IDC_Name=Master_on_server01
aArchiveName=latest_archive
aBatchFile=02-jan-18_09.34.41_430/0218093441~1.hda

6.2.26 GET_BATCHFILES

指定されたアーカイブのバッチ・ファイルを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

必須のサービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

例

IdcService=GET_BATCHFILES
IDC_Name=Master_on_server01
aArchiveName=latest_archive

6.2.27 GET_PROXIED_ARCHIVECOLLECTIONS

プロキシContent Serverインスタンス上のすべてのアーカイブ・コレクションのリストを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- psIDC_Name: プロキシContent Serverインスタンスの名前。

例

IdcService=GET_PROXIED_ARCHIVECOLLECTIONS
psIDC_Name=Proxied_2_on_test13

6.2.28 GET_PROXIEDSERVERS

送信プロバイダのリストを返すサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

6.2.29 GET_REPLICATION_DATA

レプリケーション・データを返すサービス。最も発生しがちなエラーは、アーカイブの場所が正しくないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

例

IdcService=GET_REPLICATION_DATA
IDC_Name=Master_on_server01

6.2.30 GET_TABLECOLUMNLIST

指定された表に関する列情報を取得するサービス。列の名前、タイプおよび長さを返します。このサービスを実行するには、コール元にADMIN権限が必要です。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- tableName: カンマで区切られた表名のリスト。

6.2.31 GET_TARGET_INFO

ターゲットのステータス・チェックを実行するサービス。ターゲットがターゲット化可能であり、ターゲットが存在するかどうかを判断するために初期ステータス・チェックを実行します。

このサービスは外部で使用することを目的としていません。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- TargetCollection: ターゲットにされるコレクションの名前。

- TargetArchive: ターゲット・コレクション内のアーカイブの名前。

- aTransferOwner: 転送を開始しているユーザーの名前。

6.2.32 GET_TARGET_TRANSFER_STATUS

転送ステータスを判別するために転送中に使用されるサービス。TransferMonitorはこれを使用して、転送が完了したかまたは進行中であるかどうかを判別します。

外部で使用することを目的としていません。

場所: IdcHomeDir/resources/core/tables/std_services.htm

6.2.33 GET_TRANSFER_SOURCE_INFO

実行される必要がある作業を確立するためにプル転送中に使用されるサービス。転送用ソース・アーカイバがプロキシ・サーバー上にあり、転送所有者がどの作業を実行する必要があるかどうか(ある場合)を決定する必要があるときに使用されます。

外部で使用することを目的としていません。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- SourceArchive: ターゲットのソースとして使用されるアーカイブ。

- aTransferOwner: 転送を開始しているユーザーの名前。

- aArchiveName: アーカイブ名。

6.2.34 IMPORT_ARCHIVE

アーカイブをインポートするサービス。

- インポートではアーカイブの定義ファイルが読み込まれ、指定されているインポート・ルールに従います。

- Content Serverシステムはこのサービスを非同期的に実行します。サービスが実行されるには、Content Serverインスタンスが稼働していて、サービスが正常に実行されたときではなく、サービスがリクエストされたときにただちにIdcCommandコマンドが成功を通知する必要があります。

注意:

IMPORT_ARCHIVEサービスのみがアーカイブ・インポートを開始し、インポートを開始するリクエストが行われたことを確認します。アーカイブ・インポートのステータスまたは完了に関する通知は送信されません。カスタム・コンポーネントは、アーカイブ・インポートのステータスおよび完了の通知を提供するために作成できます。

- サーバーは、一度に1つのアーカイブのみインポートできます。複数のインポートを使用するバッチ・ファイルは、最初のコマンドでの成功および最初のコマンドが終了するまでのすべての後続のコマンドでの失敗を宣言します。バッチ・ファイルは1つのインポートのみを使用する必要があり、一部の外部プロセスは、別のインポート・コマンドを発行する前にアクションが完了していることを確認する必要があります。

- 最も発生しがちなエラーは、アーカイブ名が存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

注意:

追加のサービス・パラメータの少なくとも1つはこのサービスを正常に実行するために設定される必要があります。

追加のサービス・パラメータ

- aImportDocuments: trueに設定されると、サービスはコンテンツ・アイテムのリビジョンをインポートします。

- aImportDocConfig: trueに設定されると、サービスはドキュメント構成情報をインポートします。

- aImportUsers: trueに設定されると、サービスはユーザー情報をインポートします。

重要:

ユーザーがエクスポートされていない場合に、aImportUsersがtrueに設定されると、サービスは失敗します。ドキュメント構成がエクスポートされていない場合に、このパラメータがtrueに設定されると、サービスは失敗します。

例

- IdcCommandコマンド・ファイル形式(Master_on_server01コレクションからarchive_testアーカイブのリビジョンをインポート):

# To import an archive
IdcService=IMPORT_ARCHIVE
aArchiveName=archive_test
IDC_Name=Master_on_server01
aImportDocuments=true

- HDA形式:

@Properties LocalData
IdcService=IMPORT_ARCHIVE
aArchiveName=archive_test
IDC_Name=Master_on_server01
aImportDocuments=true
@end

6.2.35 IMPORT_ARCHIVE_START_AUTOMATED

インポート用のキュー待機アーカイブを登録するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

6.2.36 IMPORT_BATCHFILE

「バッチ・ファイルの表示」ダイアログからの選択に従って、指定されたバッチ・ファイルのコンテンツ・アイテムをContent Serverインスタンス内にインポートするサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

6.2.37 IMPORT_DOCUMENT

指定されたドキュメント(通常は「バッチ・ファイルの表示」ダイアログから選択される)をContent Serverインスタンス内にインポートするサービス。

最も発生しがちなエラーは、コンテンツ・アイテム名が存在しないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- dDocName: コンテンツ・アイテムのコンテンツID。

例

IdcService=IMPORT_DOCUMENT
IDC_Name=Master_on_server01
aArchiveName=JAN_22_02
dDocName=billing_00004

6.2.38 IMPORT_TABLE_ENTRY

アーカイブの表にエントリを追加るために使用されるサービス。このサービスはIMPORT_DOCUMENTと同じです。エクスポートされたコンテンツ・アイテムではなく、エクスポートされた表アイテム上で機能します。「バッチ・ファイルの表示」ダイアログからアクセス可能で、指定された表アイテムをインポートするために使用されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- aBatchFile: 表が格納されるバッチ・ファイルのパスおよびファイル名。

6.2.39 INSERT_NATIVE

INSERT_NEWの実行時に作成されるIDをリカバリするためにアーカイバで使用されるサブサービス。このサービスは新しいIDを生成しません。エクスポート中に格納されるIDを再使用します。このサブサービスは、管理者がエクスポートの作成元のシステムにアーカイブしているときにのみ使用されます。アーカイバがINSERT_NATIVEを使用するのは、エクスポータとインポータが同じインスタンス名(IDC_name)を持ち、システムがコンテンツ・アイテムを完全にリカバリしようとしているときです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1

6.2.40 INSERT_NEW

指定されたdDocNameを持つ前のアイテムがシステムで検出されなかったときに、CHECKIN_ARCHIVEの実行中に使用されるサブサービス。このサブサービスは、バッチ・ロード中およびアーカイブのインポート操作中に使用されます。これは新しいコンテンツ・アイテムをシステムに追加し、その新しいID (dID、dRevClassIDなど)を作成します。

場所: IdcHomeDir/resources/core/tables/std_services.htm

空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1

6.2.41 REGISTER_IMPORTER

アーカイブのインポータを登録または登録解除するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、正しくないインスタンス・メニュー・ラベルまたはアーカイブ名があることです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

- EditItems: aRegisteredImporter,aImportLogonUserに設定する必要があります。

- IsRegister: 登録設定を定義します。

- 1 (true): 現在のインスタンスを登録

- 0 (false): 登録解除

例

現在のContent Serverインスタンスをインポータとして登録します。

IdcService=REGISTER_IMPORTER
IDC_Name=Master_on_server01
aArchiveName=JAN_22_02
IsRegister=1
EditItems=aRegisteredImporter,aImportLogonUser

6.2.42 REMOVE_COLLECTION

アーカイブ・コレクションを削除するサービス。デフォルトのアーカイブ・コレクションは削除できません。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。

例

IdcService=REMOVE_COLLECTION
IDC_Name=new_collection

6.2.43 REMOVE_EXPORTER

アーカイブからエクスポータを削除するサービス。最も発生しがちなエラーは、アーカイブの場所が正しくないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- aArchiveName: アーカイブ名。

- IDC_Name: エクスポータの名前。

- 例

IdcService=REMOVE_EXPORTER
IDC_Name=Master_on_server02
aArchiveName=archive_02

6.2.44 REMOVE_IMPORTER

アーカイブからインポータを削除するサービス。最も発生しがちなエラーは、アーカイブの場所が正しくないことです。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: インポータの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- aArchiveName: アーカイブ名。

例

IdcService=REMOVE_IMPORTER
IDC_Name=Master_on_server01
aArchiveName=my_archive_test

6.2.45 REMOVE_PROXIEDTRANSFER

アーカイブの転送設定を削除するときにコールされるが、アクティビティを実行しているContent Serverインスタンスが、アーカイブを所有するContent Serverインスタンスではない(つまり、転送がプロキシされている)サービス。転送を削除または停止するには、リクエストをこのプロキシ・サーバーに送信する必要があります。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- aArchiveLocation: アーカイブの場所。

- IDC_Name: 転送の所有者の名前。

6.2.46 REMOVE_QUEUED_IMPORT

ユーザーがキュー・インポートを削除できるサービス。これは、「アーカイバ・オプション」→「自動化の詳細を表示する」→「キューに入っている自動インポート」をクリックすることによりアクセス可能な「自動化」ダイアログから使用されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: インポータの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

6.2.47 REMOVE_TRANSFER

ユーザーが自動転送を削除または停止できるサービス。これは、「アーカイバ・オプション」→「自動化の詳細を表示する」をクリックすることによりアクセス可能な「自動化」ダイアログから使用されます。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- aArchiveLocation: アーカイブの場所。

- IDC_Name: インポータの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

6.2.48 REQUEST_TRANSFER

転送リクエストを開始するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- aArchiveName: アーカイブ名。

- IDC_Name: エクスポータの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

6.2.49 TRANSFER_ARCHIVE

指定された手動転送を開始するサービス。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- aArchiveName: アーカイブ名。

- IDC_Name: エクスポータの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

6.2.50 UPDATE_TARGET_TOTALS

アーカイバがアーカイブ定義ファイルで完了した作業量を更新するサービス。このサービスは外部で使用することを目的としていません。これは、自動転送を監視したり、手動または自動転送の完了時にデータを更新したりする役割を担う転送エンジンの一部です。

場所: IdcHomeDir/resources/core/tables/std_services.htm

6.2.51 UPDATE_TRANSFER_STATUS

転送の進捗に関する更新情報を送信するためにTransferMonitorで使用されるサービス。クライアント・アプリケーションで使用することを目的としていません。

場所: IdcHomeDir/resources/core/tables/std_services.htm

6.2.52 UPLOAD_ARCHIVE_TRANSFER

ターゲットにエクスポート・バッチ・ファイルをアップロードするために使用されるサービス。このサービスは、外部で使用するために拡張されていません。アーカイバの転送エンジンを構成するサービスの一部です。

場所: IdcHomeDir/resources/core/tables/std_services.htm

追加の必須サービス・パラメータ

- IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。

- TargetCollection: ターゲットにされるコレクションの名前。

- TargetArchive: ターゲット・コレクション内のアーカイブの名前。

- SourceCollection: 転送に使用されるコレクションの名前。

- SourceArchive: ターゲットのソースとして使用されるアーカイブ。

- aBatchFile: 転送で使用されるバッチ・ファイルの名前。

- ZipFile:path: アップロードされる転送のzipファイルへパス名。

7 コントリビューション・フォルダ・サービス

この章では、コントリビューション・フォルダ・サービスを使用およびカスタマイズする際に使用可能なOracle WebCenter Contentサービスについて説明します。

この章の内容は、次のとおりです。

- 第7.1項「コントリビューション・フォルダ・サービスについて」

- 第7.2項「コントリビューション・フォルダ・サービス」

7.1 コントリビューション・フォルダ・サービスについて

コントリビューション・フォルダは、Folders_g機能と呼ばれた前のリリースのWebCenter Contentに与えれた名前です。コントリビューション・フォルダはWebCenter ContentのFolders_gコンポーネントによりサポートされます。コントリビューション・フォルダ・サービスは、現在のフォルダ機能で使用できません(第8章を参照)。

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

特定のコントリビューション・フォルダ・サービスの場所とサービス・タイプは、各サービス内にリスト表示されています。

注意:

最も一般的に使用されるサービスには、より広範囲な説明があります。

7.2 コントリビューション・フォルダ・サービス

この項では、次のサービスについて説明します。

- COLLECTION_ADD

- COLLECTION_ADD_LINK

- COLLECTION_BROWSE

- COLLECTION_CHECKIN_NEW

- COLLECTION_CHECKIN_REVISION

- COLLECTION_CHECKIN_SEL_SUB

- COLLECTION_COPY_ALL

- COLLECTION_COPY_COLLECTION

- COLLECTION_COPY_ITEM

- COLLECTION_COPY_LOT

- COLLECTION_DELETE

- COLLECTION_DELETE_ALL

- COLLECTION_DELETE_COLLECTION

- COLLECTION_DELETE_ITEM

- COLLECTION_DELETE_LOT

- COLLECTION_DISPLAY

- COLLECTION_EDIT

- COLLECTION_GET_ADMIN_CONFIG

- COLLECTION_GET_ADMIN_INHERIT_CONFIG

- COLLECTION_GET_ADMIN_MARKED_CONFIG

- COLLECTION_GET_ADMIN_META_CONFIG

- COLLECTION_GET_ADMIN_METADATA_DEFAULTS

- COLLECTION_GET_ADMIN_MOUNTED_CONFIG

- COLLECTION_GET_ARCHIVE

- COLLECTION_GET_BRANCH

- COLLECTION_GET_COLLECTION

- COLLECTION_GET_COLLECTIONS

- COLLECTION_GET_CONTENT_FILE

- COLLECTION_GET_CONTENTS

- COLLECTION_GET_FILE

- COLLECTION_GET_INFO

- COLLECTION_GET_LINKS

- COLLECTION_GET_META_MAPPING

- COLLECTION_GET_PROFILE_METADATA_DEFAULTS

- COLLECTION_GET_PROFILE_METADATA_REVISION_DEFAULTS

- COLLECTION_GET_REFERENCE

- COLLECTION_GET_SEARCH_FORM

- COLLECTION_GET_SYSTEM_FILE

- COLLECTION_GET_USER_CONFIG

- COLLECTION_INFO

- COLLECTION_ISVALID_META

- COLLECTION_LOCK

- COLLECTION_MOVE_ALL

- COLLECTION_MOVE_COLLECTION

- COLLECTION_MOVE_ITEM

- COLLECTION_MOVE_LOT

- COLLECTION_NEW

- COLLECTION_PROFILE_UPDATE_COLUMNS

- COLLECTION_RESTORE_COLLECTION

- COLLECTION_RESTORE_ITEM

- COLLECTION_SEARCH_CONTENT

- COLLECTION_SEARCH_RESULTS

- COLLECTION_SET_ARCHIVE

- COLLECTION_SET_USER_CONFIG

- COLLECTION_UNLOCK

- COLLECTION_UPDATE

- COLLECTION_UPDATE_ADMIN_CONFIG

- COLLECTION_UPDATE_ADMIN_INHERIT_CONFIG

- COLLECTION_UPDATE_ADMIN_METADATA_DEFAULTS

- COLLECTION_UPDATE_ALL

- COLLECTION_UPDATE_ITEM

- COLLECTION_UPDATE_META

- COLLECTION_UPDATE_META_TABLE

- COLLECTION_UPDATE_PROFILE_METADATA_DEFAULTS

- COLLECTION_UPDATE_PROFILE_METADATA_REVISION_DEFAULTS

- COLLECTION_UPDATE_STRUCTURE

- COLLECTION_VERIFY_FOLDER_NAME

- FOLDERSLOCAL_BUILD_MOUNT

- FOLDERSLOCAL_CREATE_MOUNT

- FOLDERSLOCAL_DELETE_MOUNT

- FOLDERSLOCAL_UPDATE_MOUNT

- GET_FOLDER_HISTORY_REPORT

- GET_OPTION_LISTS

- GOTO_COLLECTION

- GOTO_ROOT_COLLECTION

7.2.1 COLLECTION_ADD

コントリビューション・フォルダを作成するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

- dCollectionName: 作成するコントリビューション・フォルダの名前。

親コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- hasParentCollectionID: (Boolean) 親コントリビューション・フォルダIDを識別するためにdParentCollectionIDパラメータを使用するかどうかを指定します。
dParentCollectionID: 親コントリビューション・フォルダID。

- hasParentCollectionPath: (Boolean) 親コントリビューション・フォルダへのパスを識別するためにdParentCollectionPathパラメータを使用するかどうかを指定します。
dParentCollectionPath: 親コントリビューション・フォルダへのパス。

- hasParentCollection GUID: (Boolean) dParentCollectionGUIDパラメータを使用して、親コントリビューション・フォルダのGUIDを識別することを指定します。
dParentCollectionGUID: 親コントリビューション・フォルダGUID。

オプションのサービス・パラメータ

- dCollectionOwner: コントリビューション・フォルダ所有者。xForceFolderSecurity=TRUEの場合、コントリビューション・フォルダ所有者は親コントリビューション・フォルダの所有者と同じです。それ以外の場合、デフォルトは現在のユーザーです。
この設定により、コレクション所有者として設定されたユーザーがオーバーライドされます。所有者は、他のセキュリティ基準が設定されていても、コントリビューション・フォルダにアクセスしたり、コントリビューション・フォルダを変更したりすることが可能です。

- dCollectionCreator: コントリビューション・フォルダ作成者として設定されたユーザーをオーバーライドします。デフォルト値は現在のユーザーです。

- dCollectionModifier: 最後のコントリビューション・フォルダ変更者として設定されたユーザーをオーバーライドします。デフォルト値は現在のユーザーです。

- ignoreMaxFolderLimit: 親コントリビューション・フォルダに追加するサブフォルダ数を現在設定されている最大制限数より多くすることができます。デフォルト値はfalseです。

- mark: コントリビューション・フォルダのdCollectionMarkを設定します。dCollectionMarkが設定されたコントリビューション・フォルダは、falseに設定されているCollectionReadOnlyMarkedFoldersを使用しないで変更することはできません(デフォルトのケースではない)。これらのマークされたコントリビューション・フォルダおよびその有効化/無効化状態は、「システム・フォルダの構成」ページで表示できます。「コントリビューション・フォルダ」および「ごみ箱」はマークされたフォルダです。

- force: ルート・コントリビューション・フォルダの下にコントリビューション・フォルダを作成します(dParentCollectionID=-1)。デフォルト値はfalseです。

- 任意のシステムまたはカスタム・メタデータ・フィールド: 指定されたフィールドおよび値はコントリビューション・フォルダ用に設定され、コントリビューション・フォルダ内で作成されたコンテンツとコントリビューション・フォルダのデフォルト値として使用されます。

例

IdcService=COLLECTION_ADD
hasParentCollectionID=true
dCollectionName=Products
dParentCollectionID=1
dCollectionOwner=bsmith

7.2.2 COLLECTION_ADD_LINK

コントリビューション・フォルダまたはコントリビューション・フォルダ内のコンテンツにショートカットを追加するサービス。ショートカットでは、コントリビューション・フォルダID、コントリビューション・フォルダへの実際のパスまたはコントリビューション・フォルダGUIDのいずれかを使用して、コントリビューション・フォルダを参照します。

最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_services.htm

追加の必須サービス・パラメータ

- 作成済ショートカットの宛先親コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダIDを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: ショートカットが参照するコントリビューション・フォルダID。

- tohasCollectionPath: (Boolean)コントリビューション・フォルダへのパスを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: ショートカットが参照するコントリビューション・フォルダへのパス。

- tohasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: ショートカットが参照するコントリビューション・フォルダのGUID。

- dLinkName: 作成するショートカットの名前。

- dLinkType: 作成するショートカットのタイプ。COLLECTIONまたはCONTENTである必要があります。

- COLLECTIONが指定される場合、hasdCollectionIDを指定する必要があります。
hasdCollectionID: (Boolean)コントリビューション・フォルダがコレクションIDを使用して参照されるかどうかを指定します。

dCollectionID: ショートカットによって参照される親コントリビューション・フォルダのコントリビューション・フォルダID。

- CONTENTが指定される場合、dRevClassIDを指定する必要があります。
dRevClassID: ショートカットがポイントするコンテンツ・アイテムのリビジョン・クラスID。

例

IdcService=COLLECTION_ADD_LINK
tohasCollectionID=true
todCollectionID=999999999999000633
dLinkName=Shortcut
dLinkType=COLLECTION
hasdCollectionID=true
dCollectionID=999999999999004533

7.2.3 COLLECTION_BROWSE

定義済コントリビューション・フォルダ・メタデータおよびコントリビューション・フォルダのパスをロードするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_interface_service.htm

追加の必須サービス・パラメータ

- dCollectionID: ショートカットによって参照される親コントリビューション・フォルダのコントリビューション・フォルダID(たとえば、="+id+")。

- hasCollectionID: (Boolean)コントリビューション・フォルダに割当て済のコレクションIDがあるかどうかを指定します。

- changeToUser: コントリビューション・フォルダを別のユーザーに再割り当てします。

例

IdcService=COLLECTION_BROWSE
dCollectionID="+id+"
hasCollectionID=true
changeToUser=bsmith

7.2.4 COLLECTION_CHECKIN_NEW

コントリビューション・フォルダに新しいコンテンツをチェックインするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.5 COLLECTION_CHECKIN_REVISION

既存のコントリビューション・フォルダへのリビジョンをチェックインするサービス。

このサービスは、ブラウザまたは「リポジトリ・マネージャ」アプリケーションを介したチェックイン時にコールされる同じサブサービスである、次のサブサービスのいずれかにチェックイン・リクエストを送信します。(これらのサブサービスは、バッチ・ローダーまたはアーカイブのインポート中にはコールされません。)

- COLLECTION_CHECKIN_SEL_SUB

- CHECKIN_SEL_FORM

- COLLECTION_SEARCH_CONTENT

- CHECKOUT_BY_NAMENULL

- COLLECTION_LOCKNULL

- DELETE_REVNULL

このサービスは、セキュリティをチェックして、ユーザーがコントリビューション・フォルダのチェックインを実行するための十分な権限を持っているかどうかを判断します。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folder/resources/folders_service.htm

7.2.6 COLLECTION_CHECKIN_SEL_SUB

特定の条件下で、既存のコントリビューション・フォルダへのリビジョンをチェックインするサービス。コントリビューション・フォルダがシステムに存在するが有効なリビジョンが指定されていないか、またはコンテンツ・アイテムがチェックアウトされた(しかし、ワークフロー内にない)場合に使用されます。

最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.7 COLLECTION_COPY_ALL

指定されたコントリビューション・フォルダにあるすべてのコンテンツを宛先コントリビューション・フォルダにコピーするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.8 COLLECTION_COPY_COLLECTION

指定されたコントリビューション・フォルダをコピーし、そのコピーを異なるコントリビューション・フォルダに配置するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

コピー済コントリビューション・フォルダの宛先親コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダIDを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先親コントリビューション・フォルダID。

- tohasCollectionPath: (Boolean)宛先親コントリビューション・フォルダへのパスを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先親コントリビューション・フォルダへのパス。

- tohasCollection GUID: (Boolean) 宛先親コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先親コントリビューション・フォルダGUID。

コピーされるソース・コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- fromhasCollectionID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionIDパラメータを使用するかどうかを指定します。
fromdCollectionID: ソース・コントリビューション・フォルダID。

- fromhasCollectionPath: (Boolean)ソース・コントリビューション・フォルダへのパスを識別するためにfromdCollectionPathパラメータを使用するかどうかを指定します。
fromdCollectionPath: ソース・コントリビューション・フォルダへのパス。

- fromhasCollectionGUID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionGUIDパラメータを使用するかどうかを指定します。
fromdCollectionGUID: ソース・コントリビューション・フォルダGUID。

- fromisLink: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdLinkIDパラメータを使用するかどうかを指定します。
fromdLinkID: ソース・コントリビューション・フォルダのコントリビューション・フォルダ・ショートカットID。

- fromCollectionislink: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionLinkIDパラメータを使用するかどうかを指定します。
fromdCollectionLinkID: ソース・コントリビューション・フォルダのコレクション・ショートカットID。

例

IdcService=COLLECTION_COPY_COLLECTION
tohasCollectionID=true
todCollectionID=999999999999000633
fromhasCollectionID=true
fromdCollectionID=999999999999000633

7.2.9 COLLECTION_COPY_ITEM

コントリビューション・フォルダの単一のコンテンツ・アイテムをコピーし、それを宛先コントリビューション・フォルダに配置するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: ファイル・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

- dDocName: コピーするコンテンツ・アイテムのコンテンツID。

宛先コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- tohasCollectionID: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先コントリビューション・フォルダのID。

- tohasCollectionPath: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先コントリビューション・フォルダへのパス。

- tohasCollectionGUID: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先コントリビューション・フォルダのGUID。

- tolevel0: 宛先親コントリビューション・フォルダのパスのベースの値を指定します(たとえば、/Contribution Folders)。
tolevel1: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、/t4)。

tolevel2: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、/1)。

例

IdcService=COLLECTION_COPY_ITEM
tohasCollectionPath=true
todCollectionPath=/Contribution Folders/t4/1
dDocName=000660

7.2.10 COLLECTION_COPY_LOT

コンテンツ・アイテム、コントリビューション・フォルダ、コンテンツ・アイテムへのショートカット、コントリビューション・フォルダへのショートカットを含むアイテムのセットをコピーするサービス。コピーされたアイテムは単一の指定されたコントリビューション・フォルダに配置されます。

最も発生しがちなエラーは、パラメータに不整合があるか、指定のコントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

コピー済アイテムの宛先親コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先親コントリビューション・フォルダID。

- tohasCollectionPath: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先親コントリビューション・フォルダへのパス。

- tohasCollection GUID: (Boolean) 宛先親コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先親コントリビューション・フォルダGUID。

コンテンツ・アイテムを指定するパラメータ(ここで{n}は、コピーするアイテムに固有のパラメータを、コピーする他のアイテムと区別するために使用される整数です)。

- contentselect{n}: (Boolean)コンテンツ・アイテムをコピーするかどうかを指定します。コンテンツ・アイテムをコピーするには、値はtrueである必要があります。

- fromContentisLink{n}: (Boolean)これがコンテンツ・アイテムであるか、ショートカットであるかどうかを指定します。コンテンツ・アイテムを指定するには、値は0である必要があります。

- fromdDocName{n}: コピーするコンテンツ・アイテムのコンテンツID。

コンテンツ・アイテムへのショートカットを指定するパラメータ(ここで{n}は、コピーするアイテムに固有のパラメータを、コピーする他のアイテムと区別するために使用される整数です)。

- contentselect{n}: (Boolean)コンテンツ・アイテムをコピーするかどうかを指定します。コンテンツ・アイテムをコピーするには、値はtrueである必要があります。

- fromContentisLink{n}: (Boolean)これがコンテンツ・アイテムであるか、ショートカットであるかどうかを指定します。ショートカットを指定するには、値は1である必要があります。

- fromdDocName{n}: ショートカットによってポイントされるコンテンツ・アイテムのコンテンツID。

コントリビューション・フォルダを指定するパラメータ(ここで{n}は、コピーするアイテムに固有のパラメータを、コピーする他のアイテムと区別するために使用される整数です)。

- collectionselect{n}: (Boolean)コントリビューション・フォルダをコピーするかどうかを指定します。コントリビューション・フォルダをコピーするには、値はtrueである必要があります。

- fromCollectionisLink{n}: (Boolean)これがコントリビューション・フォルダであるか、ショートカットであるかどうかを指定します。コントリビューション・フォルダを指定するには、値は0である必要があります。

- fromdCollectionID{n}: コピーされるコントリビューション・フォルダのdCollectionID。

- fromhasCollectionID{n}: コントリビューション・フォルダをコピーするには、値は1である必要があります。

コントリビューション・フォルダへのショートカットを指定するパラメータ(ここで{n}は、コピーするアイテムに固有のパラメータを、コピーする他のアイテムと区別するために使用される整数です)。

- collectionselect{n}: (Boolean)コントリビューション・フォルダへのショートカットをコピーするかどうかを指定します。ショートカットをコピーするには、値はtrueである必要があります。

- fromCollectionisLink{n}: (Boolean)これがコントリビューション・フォルダであるか、ショートカットであるかどうかを指定します。ショートカットを指定するには、値は1である必要があります。

- fromCollectiondLinkID{n}: コピーされるショートカットのリンクID。

- fromdCollectionID{n}: ショートカットによってポイントされるコントリビューション・フォルダのdCollectionID。

- fromhasCollectionID{n}: コントリビューション・フォルダへのショートカットをコピーするには、値は1である必要があります。

例

IdcService=COLLECTION_COPY_LOT
tohasdCollectionID=true
todCollectionID=999999999999000633
contentselect=true
fromContentisLink=0
fromdDocName=PHL11GX010033

7.2.11 COLLECTION_DELETE

コントリビューション・フォルダを削除するサービス。「ごみ箱」が有効な場合、コントリビューション・フォルダは「ごみ箱」に移動され、直接削除されません。

最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用することを指定します。
dCollectionID: 削除するコントリビューション・フォルダのコントリビューション・フォルダID。

- hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用することを指定します。
dCollectionPath: 削除するコントリビューション・フォルダのパス。

- hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用することを指定します。
dCollectionGUID: 削除するコントリビューション・フォルダのGUID。

例

IdcService=COLLECTION_DELETE
hasCollectionPath=true
dCollectionPath=/Contribution Folders/dept/hr

7.2.12 COLLECTION_DELETE_ALL

コントリビューション・フォルダにあるすべてのコンテンツを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.13 COLLECTION_DELETE_COLLECTION

指定されたコントリビューション・フォルダを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.14 COLLECTION_DELETE_ITEM

コントリビューション・フォルダの単一のコンテンツ・アイテムを削除するサービス。「ごみ箱」が有効な場合、アイテムは「ごみ箱」コントリビューション・フォルダに移動され、直接削除されません。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

- dDocName: 削除されるコンテンツ・アイテムのコンテンツID。

例

IdcService=COLLECTION_DELETE_ITEM
dDocName=000660

7.2.15 COLLECTION_DELETE_LOT

コンテンツ・アイテム、コントリビューション・フォルダ、コンテンツ・アイテムへのショートカット、コントリビューション・フォルダへのショートカットを含むアイテムのセットを削除するサービス。「ごみ箱」が有効な場合、アイテムは「ごみ箱」に移動され、直接削除されません。

最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

コンテンツ・アイテムを指定するパラメータ(ここで{n}は、削除するアイテムに固有のパラメータを、削除する他のアイテムと区別するために使用される整数です)。

- contentselect{n}: (Boolean)コンテンツ・アイテムを削除するかどうかを指定します。コンテンツ・アイテムをコピーするには、値はtrueである必要があります。

- fromContentisLink{n}: (Boolean)これがコンテンツ・アイテムであるか、ショートカットであるかどうかを指定します。コンテンツ・アイテムを指定するには、値は0である必要があります。

- fromdDocName{n}: 削除するコンテンツ・アイテムのコンテンツID。

コンテンツ・アイテムへのショートカットを指定するパラメータ(ここで{n}は、削除するアイテムに固有のパラメータを、削除する他のアイテムと区別するために使用される整数です)。

- contentselect{n}: (Boolean)ショートカットを削除するかどうかを指定します。ショートカットを削除するには、値はtrueである必要があります。

- fromContentisLink{n}: (Boolean)これがコンテンツ・アイテムであるか、ショートカットであるかどうかを指定します。ショートカットを指定するには、値は1である必要があります。

- fromContentdLinkID{n}: ショートカットのリンクID。

- fromdDocName{n}: ショートカットによってポイントされるコンテンツ・アイテムのコンテンツID。

コントリビューション・フォルダを指定するパラメータ(ここで{n}は、削除するアイテムに固有のパラメータを、削除する他のアイテムと区別するために使用される整数です)。

- collectionselect{n}: (Boolean)コントリビューション・フォルダを削除するかどうかを指定します。コントリビューション・フォルダを削除するには、値はtrueである必要があります。

- fromCollectionisLink{n}: (Boolean)これがコントリビューション・フォルダであるか、ショートカットであるかどうかを指定します。コントリビューション・フォルダを指定するには、値は0である必要があります。

- fromdCollectionID{n}: 削除するコントリビューション・フォルダのdCollectionID。

- fromhasCollectionID{n}: コントリビューション・フォルダを削除するには、値は1である必要があります。

コントリビューション・フォルダへのショートカットを指定するパラメータ(ここで{n}は、削除するアイテムに固有のパラメータを、削除する他のアイテムと区別するために使用される整数です)。

- collectionselect{n}: (Boolean)コントリビューション・フォルダへのショートカットを削除するかどうかを指定します。ショートカットを削除するには、値はtrueである必要があります。

- fromCollectionisLink{n}: (Boolean)これがコントリビューション・フォルダであるか、ショートカットであるかどうかを指定します。ショートカットを指定するには、値は1である必要があります。

- fromCollectiondLinkID{n}: 削除するショートカットのリンクID。

- fromdCollectionID{n}: ショートカットによってポイントされるコントリビューション・フォルダのdCollectionID。

- fromhasCollectionID{n}: コントリビューション・フォルダへのショートカットを削除するには、値は1である必要があります。

例

IdcService=COLLECTION_DELETE_LOT
collectionselect=true
fromCollectionisLink=0
fromdCollectionID=999999999999004955
fromhasCollectionID=1

7.2.16 COLLECTION_DISPLAY

コンテンツ・アイテム、コントリビューション・フォルダおよびショートカットを含む、コントリビューション・フォルダ内に格納されているアイテムのリストを返すサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_interface_service.htm

追加の必須サービス・パラメータ

コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用することを指定します。
dCollectionID: コントリビューション・フォルダのコレクションID。

- hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用することを指定します。
dCollectionPath: コントリビューション・フォルダのパス。

- hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIGUIDパラメータを使用することを指定します。
dCollectionGUID: コントリビューション・フォルダのコレクションGUID。

オプションのサービス・パラメータ

- CollectionDisplayResultSetSize: COLLECTIONSおよびCONTENTS ResultSetsで返されるアイテム数を制限し、ページ・サイズを確立します。

- showCollections: COLLECTIONS ResultSetを表示するように、Web UIプレゼンテーションに知らせるフラグ。これは、CollectionDisplayResultSetSizeおよびPageNumberを使用している場合に有効です。

- showContent: CONTENTS ResultSetを表示するように、Web UIプレゼンテーションに知らせるフラグ。これは、CollectionDisplayResultSetSizeおよびPageNumberを使用している場合に有効です。

- PageNumber: 整数値1以上の場合は、CONTENTSまたはCOLLECTIONS ResultSetsからデータの正しいページ・サイズ・サブセットを表示します。ページ・サイズはCollectionDisplayResultSetSizeにより設定されます。

結果

- ResultSets: (コントリビューション・フォルダへのショートカットを含む、コントリビューション・フォルダによって直接格納されている各コントリビューション・フォルダ・アイテムのコントリビューション・フォルダ・メタデータを持つ行を含む)

- CONTENTS

- COLLECTIONS

- METAMAPPING

- COLUMNS

- Fields

- METADATA_OVERRIDE

- PATH

- metadata

例

IdcService=COLLECTION_DISPLAY
hasCollectionPath=true
dCollectionPath=%2fContent%20Server%20Folders%2f

7.2.17 COLLECTION_EDIT

コントリビューション・フォルダを編集するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・タイプ: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

- hasCollectionID: (Boolean)コントリビューション・フォルダに割当て済のコレクションIDがあるかどうかを指定します。trueに設定される場合、dCollectionIDが定義される必要があります。

- dCollectionID: 親コントリビューション・フォルダのコントリビューション・フォルダID。

7.2.18 COLLECTION_GET_ADMIN_CONFIG

コントリビューション・フォルダ階層に対して定義された現在のグローバル値を取得するサービス。特定のコレクションは渡されません。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.19 COLLECTION_GET_ADMIN_INHERIT_CONFIG

要求されるときに伝搬される現在のメタデータ・フィールドを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.20 COLLECTION_GET_ADMIN_MARKED_CONFIG

特別なコントリビューション・フォルダおよびその無効/有効ステータスを取得するサービス。無効なコントリビューション・フォルダは階層で表示されません。有効なコントリビューション・フォルダにはアクセスできます。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.21 COLLECTION_GET_ADMIN_META_CONFIG

定義されたコントリビューション・フォルダの管理メタデータResultSetからフィールドを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.22 COLLECTION_GET_ADMIN_METADATA_DEFAULTS

カスタム・フィールド、デフォルト・メタデータおよびコントリビューション・フォルダ構成の管理メタデータのオプション・リストを取得するサービス(フィールドのデフォルト値を取得)。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.23 COLLECTION_GET_ADMIN_MOUNTED_CONFIG

ローカル・コントリビューション・フォルダのコントリビューション・フォルダ・システム構成を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm

7.2.24 COLLECTION_GET_ARCHIVE

指定されたコントリビューション・フォルダのアーカイブ済コントリビューション・フォルダ構造をダウンロードするサービス。このサービスは、コントリビューション・フォルダのコンテンツをダウンロードしません。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ファイル・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.25 COLLECTION_GET_BRANCH

指定されたコントリビューション・フォルダおよびそのサブフォルダの構造を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.26 COLLECTION_GET_COLLECTION

指定されたコントリビューション・フォルダのすべてのサブフォルダを取得するサービス。COLLECTION_GET_COLLECTIONSと比較してください。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.27 COLLECTION_GET_COLLECTIONS

コントリビューション・フォルダを取得するサービス。COLLECTION_GET_COLLECTIONと比較してください。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

例

階層コレクションのリストを取得するには、必須パラメータは次のとおりです。

hasCollectionID=1
dCollectionID=collectionnumber

7.2.28 COLLECTION_GET_CONTENT_FILE

(リビジョンを除き)渡されたアイテムのメタデータに一致する、指定されたコントリビューション・フォルダ・コレクションの最初のコンテンツ・アイテムをダウンロードするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ファイル・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.29 COLLECTION_GET_CONTENTS

指定されたコントリビューション・フォルダに直接格納されているコンテンツ・アイテムの情報を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用することを指定します。
dCollectionID: コントリビューション・フォルダのコントリビューション・フォルダID。

- hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用することを指定します。
dCollectionPath: コントリビューション・フォルダのパス。

- hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用することを指定します。
dCollectionGUID: コントリビューション・フォルダのGUID。

結果

- ResultSets:

- CONTENTS(コントリビューション・フォルダに格納されている各コンテンツ・アイテムのコンテンツ・メタデータを持つ行を含む)

例

IdcService=COLLECTION_GET_CONTENTS
hasCollectionID=true
dCollectionID=999999999999000633

7.2.30 COLLECTION_GET_FILE

指定されたアイテムのタイプを判断し、そのコンテンツをダウンロードするサービス。このアイテムはコンテンツ・アイテムの場合もあれば、そうでない場合もあります。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ファイル・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.31 COLLECTION_GET_INFO

ローカル・コントリビューション・フォルダのコントリビューション・フォルダ情報を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用するかどうかを指定します。
dCollectionID: コントリビューション・フォルダのコントリビューション・フォルダID。

- hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用するかどうかを指定します。
dCollectionPath: コントリビューション・フォルダのパス。

- hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用することを指定します。
dCollectionGUID: コントリビューション・フォルダのGUID。

結果

- ResultSets:

- PATH (コントリビューション・フォルダのパスの各コントリビューション・フォルダのコントリビューション・フォルダ・メタデータを持つ行を含む)

例

IdcService=COLLECTION_GET_INFO
hasCollectionID=true
dCollectionID=999999999999000633

7.2.32 COLLECTION_GET_LINKS

コンテンツ・アイテムまたはコントリビューション・フォルダへの、指定されたショートカット(dLinkID)に関する情報を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、アイテムまたはコントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

- dLinkID: コンテンツ・アイテムまたはコントリビューション・フォルダへのショートカットのリンクID。

オプションのサービス・パラメータ

- resultSetName: 返されたResultSetの名前を設定します。デフォルト値はLINKSです。

結果

- ResultSets:

- $resultSetName$ (コンテンツ・アイテムまたはコントリビューション・フォルダのショートカット情報を含むResultSet)

7.2.33 COLLECTION_GET_META_MAPPING

指定されたコントリビューション・フォルダの、WebDAV等価のプロパティを取得するために使用されるサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.34 COLLECTION_GET_PROFILE_METADATA_DEFAULTS

特定のユーザーのデフォルト情報のフィールド構成を取得するために使用されるサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.35 COLLECTION_GET_PROFILE_METADATA_REVISION_DEFAULTS

特定のユーザーのリビジョン情報のフィールド構成の値を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.36 COLLECTION_GET_REFERENCE

コントリビューション・フォルダ階層内のアイテムが存在するかどうか、およびそのアイテムが存在する場合は、それがコントリビューション・フォルダ、コンテンツ・アイテムまたはショートカットであるかどうかを判断するために使用されるサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

パスを識別するには、次のパラメータ・セットのいずれかが必要です。

- hasCollectionPath: (Boolean)親コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用するかどうかを指定します。
dCollectionPath: 親コントリビューション・フォルダのパス。

- level0: 親コントリビューション・フォルダのプライマリ・レベル。
level1: 親コントリビューション・フォルダのセカンダリ・レベル。

level2: コントリビューション・フォルダ内のコンテンツ・アイテム。

オプションのサービス・パラメータ

- RevisionHistory: (Boolean)コンテンツ・アイテムが選択されている場合に、REVISION_HISTORY結果セットを含むかどうかを指定します。デフォルト値はfalseです。

結果

- isCollection: (Boolean)参照されるパスがコントリビューション・フォルダを表している場合はtrueです。

- isContent: (Boolean)参照されるパスがコンテンツ・アイテムを表している場合はtrueです。isCollectionとisContentの両方がfalseの場合、アイテムは指定されたパスに存在しません。

- isLink: (Boolean)参照されるパスがショートカットを表している場合はtrueです。指定されない場合は、falseとみなされます。

- ResultSets:

- REVISION_HISTORY (RevisionHistoryおよびisContentパラメータがtrueの場合にのみ含まれます)

バインダのローカル・データの参照アイテムの部分アイテム情報が返されます(ドキュメント情報またはコントリビューション・フォルダ情報)。

7.2.37 COLLECTION_GET_SEARCH_FORM

コントリビューション・フォルダ固有の検索フォームを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

検索タイプ: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.38 COLLECTION_GET_SYSTEM_FILE

通常、リクエスト時に動的に構築され、システム上に対応するものがないファイルを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ファイル・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.39 COLLECTION_GET_USER_CONFIG

コントリビューション・フォルダ構造の表示および動作に対するユーザー固有の構成を取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所; IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.40 COLLECTION_INFO

この特定のコントリビューション・フォルダに関連したメタデータを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用するかどうかを指定します。
dCollectionID: ショートカットによって参照されるコントリビューション・フォルダのコントリビューション・フォルダID。

- hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用するかどうかを指定します。
dCollectionPath: コントリビューション・フォルダのパス。

- hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用するかどうかを指定します。
dCollectionGUID: コントリビューション・フォルダのGUID。

結果

- canReadCollection: (Boolean)コントリビューション・フォルダのリクエスト・ユーザーが読取り権限を持っている場合はtrueです。

- canWriteCollection: (Boolean)コントリビューション・フォルダのリクエスト・ユーザーが書込み権限を持っている場合はtrueです。

- canAdminCollection: (Boolean)コントリビューション・フォルダのリクエスト・ユーザーが管理者権限を持っている場合はtrueです。

- ResultSets:

- PATH (コントリビューション・フォルダのパスのすべてのコントリビューション・フォルダのコントリビューション・フォルダ情報を持つ行を含む)

- DocFormats

- ClbraProjectsAccessLists

- DocTypes

- metadata

7.2.41 COLLECTION_ISVALID_META

コントリビューション・フォルダを指定されたメタデータのアイテムによって追加できることを確認するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.42 COLLECTION_LOCK

名前(dDocName)別にコントリビューション・フォルダをチェックアウトし、コントリビューション・フォルダをロックするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.43 COLLECTION_MOVE_ALL

指定されたコントリビューション・フォルダのすべてのコンテンツを別のコントリビューション・フォルダに移動するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

移動するアイテムの現在のソース・コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- fromhasCollectionID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionIDパラメータを使用するかどうかを指定します。
fromdCollectionID: ソース・コントリビューション・フォルダID。

- fromhasCollectionPath: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionPathパラメータを使用するかどうかを指定します。
fromdCollectionPath: ソース・コントリビューション・フォルダへのパス。

- fromhasCollectionGUID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionGUIDパラメータを使用するかどうかを指定します。
fromdCollectionGUID: ソース・コントリビューション・フォルダGUID。

宛先コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先親コントリビューション・フォルダのID。

- tohasCollectionPath: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先親コントリビューション・フォルダへのパス。

- tohasCollectionGUID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先親コントリビューション・フォルダのGUID。

- tolevel0: 宛先親コントリビューション・フォルダのパスのベースの値を指定します(たとえば、/Contribution Folders)。
tolevel1: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、/t4)。

tolevel2: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、/1)。

例

IdcService=COLLECTION_MOVE_ALL
fromhasCollectionPath=true
fromdCollectionPath=/Contribution Folders/B/1
tohasCollectionPath=true
todCollectionPath=/Contribution Folders/t4/1

7.2.44 COLLECTION_MOVE_COLLECTION

フォルダを別のコントリビューション・フォルダに移動するサービス。COLLECTION_MOVE_ALLと比較してください。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

移動するコントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- fromhasCollectionID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionIDパラメータを使用することを指定します。
fromdCollectionID: ソース・コントリビューション・フォルダID。

- fromhasCollectionPath: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionPathパラメータを使用するかどうかを指定します。
fromdCollectionPath: ソース・コントリビューション・フォルダへのパス。

- fromhasCollectionGUID: (Boolean)ソース・コントリビューション・フォルダを識別するためにfromdCollectionGUIDパラメータを使用するかどうかを指定します。
fromdCollectionGUID: ソース・コントリビューション・フォルダGUID。

宛先親コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先親コントリビューション・フォルダのID。

- tohasCollectionPath: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先親コントリビューション・フォルダへのパス。

- tohasCollectionGUID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先親コントリビューション・フォルダのGUID。

- tolevel0: 宛先親コントリビューション・フォルダのパスのベースの値を指定します(たとえば、/Contribution Folders)。
tolevel1: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、/t4)。

tolevel2: 宛先親コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、/1)。

例

IdcService=COLLECTION_MOVE_COLLECTION
fromhasCollectionID=true
fromdCollectionID=257
tohasCollectionID=true
todCollectionID=218

7.2.45 COLLECTION_MOVE_ITEM

指定されたコントリビューション・フォルダから宛先コントリビューション・フォルダに、単一のコンテンツ・アイテム(またはリンク)を移動するサービス。同じファイル名のアイテムがターゲット・コントリビューション・フォルダに存在する場合、移動は失敗します。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

- 宛先コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- tohasCollectionID: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: 宛先コントリビューション・フォルダのID。

- tohasCollectionPath: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先コントリビューション・フォルダへのパス。

- tohasCollectionGUID: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionGUIIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先コントリビューション・フォルダのGUID。

- tolevel0: 宛先コントリビューション・フォルダのパスの最初の値を指定します(たとえば、/Contribution Folders)。
tolevel1: 宛先コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、/t4)。

tolevel2: 宛先コントリビューション・フォルダのパスの次のレベルの値を指定します(たとえば、/1)。

- 移動するコンテンツ・アイテムを識別するには、次のパラメータ・セットのいずれかが必要です。

- dDocName: コンテンツ・アイテムのコンテンツID。

- fromhasCollectionPath: (Boolean)コンテンツ・アイテムのコントリビューション・フォルダを識別するためにfromhasCollectionPathパラメータを使用するかどうかを指定します。
fromdCollectionPath: コンテンツ・アイテムのコントリビューション・フォルダへのパス。

- isLink: (Boolean)コンテンツ・アイテムへのショートカットを識別するためにdLinkIDパラメータを使用するかどうかを指定します。
dLinkID: コンテンツ・アイテムへのショートカットのリンクID。

オプションのサービス・パラメータ

- toContentName: 移動されたアイテムの新しいファイル名。

- destMustExist: 移動するアイテムまたはリンクの宛先が存在している必要があるかどうかを定義します(true/false)。このパラメータがfalseであるか存在せず、かつ宛先コントリビューション・フォルダが指定されていない場合、アイテムはその現在のコントリビューション・フォルダから削除されます(xCollectionIDが0に設定されます)。

例

IdcService=COLLECTION_MOVE_ITEM
tohasCollectionID=true
todCollectionID=218
dDocName=TG000570
toContentName=moved_name.txt

7.2.46 COLLECTION_MOVE_LOT

コントリビューション・フォルダ、コンテンツ・アイテム、コントリビューション・フォルダおよびコンテンツ・アイテムへのショートカットを含むアイテムのセットを単一の宛先コントリビューション・フォルダに移動するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

移動済アイテムの宛先親コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- tohasCollectionID: (Boolean)宛先親コントリビューション・フォルダを識別するためにtodCollectionIDパラメータを使用するかどうかを指定します。
todCollectionID: コントリビューション・フォルダ・コレクションID。

- tohasCollectionPath: (Boolean)宛先コントリビューション・フォルダへのパスを識別するためにtodCollectionPathパラメータを使用するかどうかを指定します。
todCollectionPath: 宛先コントリビューション・フォルダへのパス。

- tohasCollectionGUID: (Boolean)宛先コントリビューション・フォルダを識別するためにtodCollectionGUIDパラメータを使用するかどうかを指定します。
todCollectionGUID: 宛先コントリビューション・フォルダのGUID。

コンテンツ・アイテムを指定するために必要なパラメータ。{n}は、移動するアイテムに固有のパラメータを、移動する他のアイテムと区別するために使用される整数です。

- contentselect{n}: (Boolean)コンテンツ・アイテムを移動するかどうかを指定します。アイテムを移動するには、値は(true)である必要があります。

- fromContentisLink{n}: (Boolean)アイテムがコンテンツ・アイテムで、ショートカットではない場合、値は0である必要があります。

- fromdDocName{n}: 移動するアイテムのコンテンツID。

コンテンツ・アイテムへのショートカットを指定するために必要なパラメータ。{n}は、移動するアイテムに固有のパラメータを、移動する他のアイテムと区別するために使用される整数です。

- contentselect{n}: (Boolean)ショートカットを移動するかどうかを指定します。ショートカットを移動するには、値はtrueである必要があります。

- fromContentisLink{n}: (Boolean)これがショートカットであり、コンテンツ・アイテムでないかどうかを指定します。アイテムがショートカットである場合、値は1である必要があります。

- fromContentdLinkID{n}: 移動するショートカットのリンクID。

- fromdDocName{n}: ショートカットによってポイントされるコンテンツ・アイテムのコンテンツID。

コントリビューション・フォルダを指定するために必要なパラメータ。{n}は、移動するアイテムに固有のパラメータを、移動する他のアイテムと区別するために使用される整数です。

- collectionselect{n}: (Boolean)コントリビューション・フォルダを移動するかどうかを指定します。ショートカットを移動するには、値はtrueである必要があります。

- fromCollectionisLink{n}: (Boolean)これがコントリビューション・フォルダであり、ショートカットではないかどうかを指定します。これがコントリビューション・フォルダである場合、値が0である必要があります。

- fromdCollectionID{n}: 移動するコントリビューション・フォルダのdCollectionID。

- fromhasCollectionID{n}: コントリビューション・フォルダを移動するには、値が1である必要があります。

コントリビューション・フォルダへのショートカットを指定するために必要なパラメータ。{n}は、移動するアイテムに固有のパラメータを、移動する他のアイテムと区別するために使用される整数です。

- collectionselect{n}: (Boolean)ショートカットを移動するかどうかを指定します。ショートカットを移動するには、値はtrueである必要があります。

- fromCollectionisLink{n}: (Boolean)これがショートカットであり、コントリビューション・フォルダではないかどうかを指定します。これがショートカットである場合、値が1である必要があります。

- fromdCollectiondLinkID{n}: = 移動するショートカットのリンクID。

- fromdCollectionID{n}: ショートカットによってポイントされるコントリビューション・フォルダのdCollectionID。

- fromhasCollectionID{n}: コントリビューション・フォルダ・ショートカットを移動するには、値が1である必要があります。

例

IdcService=COLLECTION_MOVE_LOT
tohasCollectionID=true
docCollectionID=999999999999000633
contentselect1=true
fromContentisLink1=0
fromdDocName1=PHL11GX010033

7.2.47 COLLECTION_NEW

新しいコントリビューション・フォルダを作成するために使用されるサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

- hasParentCollectionID: (Boolean)コントリビューション・フォルダが親コントリビューション・フォルダとして追加されるかどうかを指定します。trueに設定される場合、dParentCollectionIDが定義される必要があります。

- dParentCollectionID: (Boolean)親コントリビューション・フォルダのコントリビューション・フォルダIDであるかどうかを指定します。hasParentCollectionIDがtrueに設定されている場合に使用されます。

- dCollectionInherit: (Boolean)コントリビューション・フォルダ・メタデータを継承するかどうかを指定します。

例

IdcService=COLLECTION_NEW
hasParentCollectionID=true
dParentCollectionID=1
dCollectionInherit=0

7.2.48 COLLECTION_PROFILE_GET_COLUMNS

ユーザー階層列情報およびメタデータ・フィールド情報を返すサービス。パラメータはありません。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

返されるデータ

- ResultSets:

- COLUMNS(ユーザー固有の列セット。)リクエスト・ユーザーが列を選択していない場合は、返されるデフォルト列は次のとおりです。

- dFileSize

- dDocType

- dDocAuthor

- dSecurityGroup

- metadata(システムおよびカスタム・メタデータ・フィールドに関する情報)

7.2.49 COLLECTION_PROFILE_UPDATE_COLUMNS

ユーザー階層列を更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.50 COLLECTION_RESTORE_COLLECTION

現在「ごみ箱」フォルダにあるコントリビューション・フォルダをその元の場所にリストアするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.51 COLLECTION_RESTORE_ITEM

現在「ごみ箱」フォルダにあるアイテムをその元の場所にリストアするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.52 COLLECTION_SEARCH_CONTENT

コンテンツ・アイテムに対して渡されるメタデータのすべてに一致するすべてのコンテンツを取得するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.53 COLLECTION_SEARCH_RESULTS

検索基準を満たすコントリビューション・フォルダの検索結果を表示するサービス。検索オペランドに使用されるフィールドは、COLMETAおよびCOLLECTIONS表のフィールドです。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加のオプション・サービス・パラメータ

- ResultCount: SearchResuls結果セットに返されるアイテム数を制限します。デフォルトは25です。

- SortField: ソート・キーとして使用されるフィールド。デフォルトはdCollectionNameです。

- SortOrder: ソート方向。デフォルトはASC(昇順)です。

- fieldname: 文字列検索条件の一部として使用されるフィールドの名前。例: dSecurityGroup=true

- opfieldname: 文字列検索条件で使用される、名前フィールドに対して相対的な演算子。例: opdSecurityGroup=hasAsSubstring

- comparefieldname: 文字列検索条件で使用される、名前フィールドに対して相対的な値。例: comparedSecurityGroup=public

- fieldnameLEまたはfieldnameGE: 日付検索条件で使用されるフィールドおよび値。例: dCreateDatedateLE=2008-03-01 00:01:00

結果

- ResultSets:

- SearchResults(検索条件に一致するメタデータを持つコントリビューション・フォルダのリスト)

例

- startsWith search:

dCollectionName=true&opdCollectionName=beginsWith&comparedCollectionName=a

- endsWith search:

dCollectionName=true&opdCollectionName=endsWith&comparedCollectionName=12

- exact string match search:

dCollectionName=true&opdCollectionName=equals&comparedCollectionName=A-EZ-9

- field not empty search:

dDocTitle=true&opdDocTitle=hasAsSubstring&comparedDocTitle=%

- boolean field search:

xBooleanTestField=true&opxBooleanTestField=equals&comparexBooleanTestField=1

- later than search:

dCreateDatedateGE=2009-10-01 00:01:00

- earlier than search

dCreateDatedateLE=2008-03-01 00:01:00

7.2.54 COLLECTION_SET_ARCHIVE

アップロードされたアーカイブを取得し、それをシステムに適用するサービス。このサービスはアーカイブと競合しているコントリビューション・フォルダを削除します。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/olders_service.htm

7.2.55 COLLECTION_SET_USER_CONFIG

フォルダ構造の表示および動作のユーザー構成を設定するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.56 COLLECTION_UNLOCK

コンテンツ・アイテムのチェックアウトを元に戻し、それを使用可能にするサービス。このサービスはCOLLECTION_LOCK後にコンテンツを解放します。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.57 COLLECTION_UPDATE

コントリビューション・フォルダのフィールド・データを変更するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用するかどうかを指定します。
dCollectionID: コントリビューション・フォルダID。

- hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用するかどうかを指定します。
dCollectionPath: コントリビューション・フォルダのパス。

- hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用するかどうかを指定します。
dCollectionGUID: コントリビューション・フォルダのGUID。

オプションのサービス・パラメータ

- dCollectionName: コントリビューション・フォルダのコレクションID。

- dCollectionMark:

- dCollectionEnabled:

- dPromptForMetadata:

- dCreateDate: コンテンツ・アイテムが作成された日付。

- dInDate: コンテンツのリリース日。

- dOutDate: コンテンツの有効期限。

- dReleaseDate: リリース状態(リビジョンのWeb状態を示すために使用されます)。

- dLastModifiedDate: コンテンツ・アイテムに対して最後に変更が行われた日付。

- dDocName: コンテンツ・アイテムのコンテンツID。

- dDocType: コンテンツ・アイテムのタイプ。

- dDocTitle: コンテンツ・アイテムのタイトル。

- dDocAuthor: コンテンツ・アイテムの作成者

- dRevLabel: コンテンツ・アイテムのリビジョン・ラベル。設定された場合、このラベルを使用して、指定されたリビジョンを検索します。

- dSecurityGroup: PublicやSecureなどのセキュリティ・グループ。

- dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。

- dCollectionOwner: コントリビューション・フォルダ所有者。

- dCollectionCreator: コントリビューション・フォルダ作成者として設定されたユーザーをオーバーライドします。デフォルト値は現在のユーザーです。

- dCollectionModifier: 最後のコントリビューション・フォルダ変更者として設定されたユーザーをオーバーライドします。デフォルト値は現在のユーザーです。

- x?????: DocMetaのカスタム・メタデータ・フィールドに正確に一致する必要がある、ColMeta表で定義されるフィールドのすべて。

例

IdcService=COLLECTION_UPDATE
dCollectionName=Products
dParentCollectionID=1
dCollectionOwner=bsmith

7.2.58 COLLECTION_UPDATE_ADMIN_CONFIG

コントリビューション・フォルダのシステム構成設定を更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.59 COLLECTION_UPDATE_ADMIN_INHERIT_CONFIG

(メタデータが伝搬される)既存のコントリビューション・フォルダからメタデータを継承することにより、コントリビューション・フォルダ・システム構成設定を更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.60 COLLECTION_UPDATE_ADMIN_METADATA_DEFAULTS

コントリビューション・フォルダのシステム・メタデータ・フィールドのデフォルト・システム設定を更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.61 COLLECTION_UPDATE_ALL

コレクションのすべてのアイテムを更新し、定義されたメタデータを変更するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.62 COLLECTION_UPDATE_ITEM

コレクションの特定のアイテムを更新し、定義されたメタデータを変更するサービス。コントリビューション・フォルダ関連サービス(表Folders_Services)。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.63 COLLECTION_UPDATE_META

コントリビューション・フォルダから、すべての基礎となるコントリビューション・フォルダおよびコンテンツにメタデータ値を伝搬するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。返されるデータはありません。

サービス・クラス: メタサービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- hasCollectionID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionIDパラメータを使用することを指定します。
dCollectionID: 親コントリビューション・フォルダのコントリビューション・フォルダID。

- hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用することを指定します。
dCollectionPath: 親コントリビューション・フォルダのパス。

- hasCollectionGUID: (Boolean)コントリビューション・フォルダを識別するためにdCollectionGUIDパラメータを使用することを指定します。
dCollectionGUID: 親コントリビューション・フォルダのGUID。

例

IdcService=COLLECTION_UPDATE_META
hasCollectionGUID=true
dCollectionGUID=5A2E5617-7F95-7356-D923-F6DA894D489C

7.2.64 COLLECTION_UPDATE_META_TABLE

コントリビューション・フォルダのメタデータ表を更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: メタサービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.65 COLLECTION_UPDATE_PROFILE_METADATA_DEFAULTS

プロファイル・メタデータ・フィールドのデフォルトを更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.66 COLLECTION_UPDATE_PROFILE_METADATA_REVISION_DEFAULTS

リビジョンのプロファイル・メタデータ・フィールドのデフォルトを更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources//folders_service.htm

7.2.67 COLLECTION_UPDATE_STRUCTURE

コントリビューション・フォルダ・キャッシュを更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: メタサービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.68 COLLECTION_VERIFY_FOLDER_NAME

指定されたコントリビューション・フォルダ名がコントリビューション・フォルダの有効な名前であることを検証するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

コントリビューション・フォルダを識別するには、次のパラメータ・セットのいずれかが必要です。

- dCollectionName: コントリビューション・フォルダのコレクションID。

- hasCollectionPath: (Boolean)コントリビューション・フォルダを識別するためにdCollectionPathパラメータを使用することを指定します。
dCollectionPath: 親コントリビューション・フォルダのパス。

オプションのサービス・パラメータ

- CollectionSkipIllegalFolderValidation: csCollectionFolderHasNoNameを除いて、すべての検証をスキップすることができます。デフォルトは、falseです。

構成パラメータ

- CollectionIllegalFolderCharacters: フォルダ名に使用する無効な文字を含む文字列。デフォルトは/\:*?"<>¦です。

- dCollectionNameSize: コントリビューション・フォルダ名の最大文字数。デフォルトは100です。

- CollectionIllegalFolderPattern_1: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトは\\..*です。

- CollectionIllegalFolderPattern_2: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトは.*\\.です。

- CollectionIllegalFolderPattern_3: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトはcom[\\d]です。

- CollectionIllegalFolderPattern_4: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトはpt[\\d]です。

- CollectionIllegalFolderPattern_5: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトはconです。

- CollectionIllegalFolderPattern_6: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトはnulです。

- CollectionIllegalFolderPattern_7: 正規表現。式がコントリビューション・フォルダ名と一致する場合、検証は失敗します。デフォルトはprnです。

追加のCollectionIllegalFolderPattern_{n}変数を追加できます。順序どおりであるかぎり、サービス別に評価されます。

結果

- ResultSets:

- SUCCESS

- FAILED (csCollectionFolderHasNoName)

- FAILED (csCollectionInvalidCharacter:pos=最初の無効な文字の位置)

- FAILED (csCollectionNameTooLong:フォルダ名,余分な文字数)

- FAILED (csCollectionIllegalPatternMatch:フォルダ名,無効なフォルダ・パターン)

例

IdcService=COLLECTION_VERIFY_FOLDER_NAME
hasCollectionPath=true
dCollectionPath=/Contribution Folders/dept/hr
CollectionSkipIllegalFolderValidation=true
dCollectionNameSize=90

7.2.69 FOLDERSLOCAL_BUILD_MOUNT

指定されたローカル・コントリビューション・フォルダのファイルをリライトするサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm

7.2.70 FOLDERSLOCAL_CREATE_MOUNT

コントリビューション・フォルダをローカル・ファイル・システムにマップするサービス。コントリビューション・フォルダが変更される場合には常に、マップされたディレクトリが更新されます。

このディレクトリにセキュリティはありません。

最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: SearchService

場所: IdcHomeDir/components/Folders/resources/folders_mounted_service.htm

7.2.71 FOLDERSLOCAL_DELETE_MOUNT

指定されたローカル・コントリビューション・フォルダを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm

7.2.72 FOLDERSLOCAL_UPDATE_MOUNT

指定されたローカル・コントリビューション・フォルダのファイルを更新するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: 検索サービス

場所: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm

7.2.73 GET_FOLDER_HISTORY_REPORT

コントリビューション・フォルダの履歴データを取得するサービス。リクエスト・ユーザーには管理ロールが必要です。

サービス・クラス: DocService

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

追加の必須サービス・パラメータ

- actionDateGreaterThan: ODBC形式のデータ。この時間の2分前およびそれ以降のすべての履歴データが返されます。2分は負荷分散サーバー用のマージンです。デフォルト値は、現在の時間の5分前です。

結果

- ResultSets

- HistoryReport: 各行には、コントリビューション・フォルダ履歴イベントに関する情報(名前の変更、更新、移動、削除)が含まれます。

例

IdcService=GET_FOLDER_HISTORY_REPORT
actionDateGreaterThan={ts '2010-09-09 18:04:06.293'}

7.2.74 GET_OPTION_LISTS

オプション・リストを取得するコントリビューション・フォルダ関連のサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.75 GOTO_COLLECTION

コントリビューション・フォルダを表示するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.76 GOTO_ROOT_COLLECTION

ルート・コントリビューション・フォルダを表示するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、コントリビューション・フォルダが存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/components/folders_g/resources/folders_service.htm

8 フォルダ・サービス

この章では、フォルダ・サービスの使用時およびカスタマイズ時に利用できるOracle WebCenter Contentサービスについて説明します。

この章の内容は、次のとおりです。

- 第8.1項「フォルダ・サービスについて」

- 第8.2項「フォルダ・サービス」

8.1 フォルダ・サービスについて

フォルダは、従来のファイル・システムと同様に、Content Serverリポジトリ内の一部またはすべてのコンテンツを編成および検索するための階層フォルダ・インタフェースを提供する現在のWebCenter Content機能の名前です。この機能は、WebCenter ContentのFrameworkFoldersコンポーネントによってサポートされています。コントリビューション・フォルダと呼ばれる、以前のバージョンのフォルダで使用されるサービス(WebCenter ContentのFolders_gコンポーネントでサポートされているサービス)の詳細は、第7章を参照してください。

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

個々のフォルダ・サービスの場所は、それぞれのサービスの説明の中で示します。

注意:

最も一般的に使用されるサービスには、より広範囲な説明があります。

8.2 フォルダ・サービス

個々のフォルダ・サービスの説明では、そのフォルダ・サービスのタイプについて示します。この項では、次のサービスについて説明します。

- FLD_BROWSE

- FLD_BROWSE_POPUP

- FLD_COPY

- FLD_CREATE_FILE

- FLD_CREATE_FILE_FORM

- FLD_CREATE_FOLDER

- FLD_CREATE_FOLDER_FORM

- FLD_DELETE

- FLD_EDIT_FILE

- FLD_EDIT_FILE_FORM

- FLD_EDIT_FOLDER

- FLD_EDIT_FOLDER_FORM

- FLD_EDIT_METADATA_RULES

- FLD_EDIT_METADATA_RULES_FORM

- FLD_FOLDER_MIGRATION_STATUS

- FLD_FOLDER_SEARCH

- FLD_FOLDER_SEARCH_FORM

- FLD_GET_CHOOSE_DESTINATION_DIALOG

- FLD_GET_CREATE_LINK_DIALOG

- FLD_GET_CREATE_SHORTCUT_DIALOG

- FLD_GET_RENAME_FILE_DIALOG

- FLD_GET_RENAME_FOLDER_DIALOG

- FLD_INFO

- FLD_LOAD_SOFT_LINKS_FOR_DOCUMENT

- FLD_MIGRATION_FOLDER_DATA

- FLD_MOVE

- FLD_PRE_CHECKIN

- FLD_PROPAGATE

- FLD_PROPAGATE_FORM

- FLD_REINDEX_FOLDER_CONTENTS

- FLD_RETRIEVE_CHILD_FILES

- FLD_RETRIEVE_CHILD_FOLDERS

- FLD_SUBSCRIBE

- FLD_TEST_USER_CAPABILITIES

- FLD_UNFILE

- FLD_UNSUBSCRIBE

8.2.1 FLD_BROWSE

フォルダ構造の参照に使用されるサービス。次の参照モードでのフォルダ構造のページ区切りに使用できます。

- フォルダとファイル、それぞれの単独のページング(デフォルトの動作)

- フォルダとファイルを結合したページング(doCombinedBrowse=trueを設定する必要があります)

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- item: (fFolderGUID、pathおよびitemsをいずれも指定していない場合は必須。)参照対象のアイテム。path:path to itemの形式で指定するか、またはfFolderGUIDを指定する場合はfFolderGUID:GUID of itemの形式で指定します。どちらの参照モードでも使用できます。

- items: (fFolderGUID、pathおよびitemをいずれも指定していない場合は必須。)参照対象の各アイテム。path:path to itemまたはfFolderGUID:GUID of itemの形式で指定した識別子のカンマ区切りリストの形式で指定します。どちらの参照モードでも使用できます。

- path: (lFolderGUIDを指定していない場合は必須。)現在のフォルダのフルパス。どちらの参照モードでも使用できます。

- fFolderGUID: (pathを指定していない場合は必須。)現在のフォルダを参照するパスのかわりに使用できます。どちらの参照モードでも使用できます。

オプションのサービス・パラメータ

- fldapp: ユーザーが参照している場所のフォルダ・アプリケーションを指定します。どちらの参照モードでも使用できます。

- doCombinedBrowse: (整数)設定された場合、結合されたページ区切りモードでこのサービスが実行されます。デフォルトは0 (ゼロ)です。

- foldersFirst: (整数)設定された場合、結合されたページ区切りモードでファイルの前にフォルダがリストされます。デフォルトは1です。

- folderCount: (整数)返すフォルダの数。デフォルトは50です。単独参照モードで使用できます。

- folderStartRow: (整数)データを返す最初の行番号。ページ区切りに使用されます。デフォルトは0 (ゼロ)です。単独参照モードで使用できます。

- fileCount: (整数)返すファイルの数。デフォルトは50です。単独参照モードで使用できます。

- fileStartRow: (整数)データを返す最初の行番号。ページ区切りに使用されます。デフォルトは0 (ゼロ)です。単独参照モードで使用できます。

- combinedCount: (整数)返すアイテム(フォルダとファイル)の数。デフォルトは100です。結合された参照モードで使用できます。

- combinedStartRow: (整数)データを返す最初の行番号。ページ区切りに使用されます。デフォルトは0 (ゼロ)です。結合された参照モードで使用できます。

- doRetrieveTargetInfo: (整数)設定された場合、ChildTargetFolders ResultSetで取得されたすべてのショートカットのターゲット・フォルダの情報を返します。デフォルトは0 (ゼロ)です。どちらの参照モードでも使用できます。

- doMarkFavorites: (整数)設定された場合、フォルダまたはファイルがお気に入りかどうかを示すfIsFavoriteをResultSetに追加します。お気に入りフォルダにそれらへのショートカットがある場合はお気に入りです。デフォルトは0 (ゼロ)です。どちらの参照モードでも使用できます。

- doRetrieveDocumentURL: (整数)設定された場合、ResultSetファイルに、Webでのドキュメントの絶対位置であるURLフィールドを追加します。デフォルトは0 (ゼロ)です。どちらの参照モードでも使用できます。

- doRetrieveUniqueLinks: (整数)設定された場合、結果セットが一意のリンクのみを返すように後処理されます。たとえば、フォルダのショートカットとそのフォルダの本体がResultSetにある場合、フォルダ本体のみが返されます。ファイルの場合も同様です。デフォルトは0 (ゼロ)です。どちらの参照モードでも使用できます。

- foldersFilterParams: 参照のフィルタ・パラメータのカンマ区切りのリスト。たとえば、foldersFilterParams=fIsContribution&fIsContribution=1では、fIsContribution=1のフォルダが返されます。どちらの参照モードでも使用できます。

- foldersFilterQuery: フォルダをフィルタするための標準の問合せ。この問合せは、FolderFolders表について、DATABASEエンジンのフォーマットで記述します。例、foldersFilterQuery=fFolderName<substring>`test`。どちらの参照モードでも使用できます。

- filesFilterQuery: ファイルをフィルタするための標準の問合せ。この問合せは、FolderFiles表についてDATABASEエンジンのフォーマットで記述します。例、filesFilterQuery=fFileName<substring>`test`。どちらの参照モードでも使用できます。

- foldersSortField: レコードをソートする、FolderFolders表内のフィールド名。どちらの参照モードでも使用できます。

- foldersSortOrder: 昇順でソートする場合はAsc、降順でソートする場合はDescを指定します。どちらの参照モードでも使用できます。

- $fieldName: foldersFilterParamsおよびfilesFilterParamsパラメータで指定したフィールドの値。どちらの参照モードでも使用できます。

- filesFilterParams: 参照のフィルタ・パラメータのカンマ区切りのリスト。たとえば、filesFilterParams=fOwner&fOwner=sysadminでは、fOwner=sysadminのフォルダが返されます。どちらの参照モードでも使用できます。

- filterFavorites: Foldersに設定された場合、結果にはお気に入りのフォルダのみが含められます。Filesに設定された場合、お気に入りのファイルのみにフィルタされます。1に設定された場合、お気に入りのフォルダとファイルにフィルタされます。デフォルトでは、このフィルタは適用されません。どちらの参照モードでも使用できます。

- filterFollows: Foldersに設定された場合、結果にはフォローされたフォルダのみが含められます。Filesに設定された場合、フォローされたファイルのみにフィルタされます。1に設定された場合、フォローされたフォルダとファイルにフィルタされます。デフォルトでは、このフィルタは適用されません。どちらの参照モードでも使用できます。

結果

- ResultSets:

- FolderInfo: ユーザーが現在参照しているフォルダに関する情報。

- ChildFolders: このフォルダ内に存在するすべてのフォルダに関する情報。

- ChildTargetFolders: ChildFolders ResultSet内のショートカットのすべてのターゲット・フォルダに関する情報。

- ChildFiles: このフォルダ内に存在するすべてのファイルに関する情報。

- numFolders: (文字列)ChildFolders ResultSet内のフォルダ数。

- hasMoreChildFolders: (ブール)リクエストですべての子のフォルダが返されたわけではない場合、これはtrueです。これはfolderCount値に到達したときに発生します。返すことができる追加のフォルダがあった可能性があります。

- numFiles: (整数)ChildFiles ResultSet内のファイル数。

- TotalChildFoldersCount: (整数)親フォルダ内のアイテム(フォルダおよびファイル)の合計数。

- TotalChildFilesCount: (整数)親フォルダ内のファイルの合計数。

- TotalChildItemsCount: (整数)親フォルダ内のアイテム(フォルダおよびファイル)の合計数。

- hasMoreChildFiles: (ブール)リクエストですべての子のファイルが返されたわけではない場合、これはtrueです。これはfileCount値に到達したときに発生します。返すことができる追加のドキュメントがあった可能性があります。

- hasMoreChildItems: (ブール)リクエストですべての子のアイテム(フォルダおよびファイル)が返されたわけではない場合、これはtrueです。これはカウントに到達したときに発生します。返すことができる追加のアイテムがあった可能性があります。

8.2.2 FLD_BROWSE_POPUP

ツリー・コントロールを含む小さなポップアップを準備するサービス。このツリー・コントロールを使用して、フォルダ構造を参照し、ドキュメントまたはフォルダを選択できます。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- target: ユーザーがこのポップアップでターゲットとするエンティティ・タイプ。ユーザーが選択を許可されているものに応じて、fileまたはfolderに設定できます。

結果

- ResultSets:

- ChildFolders: ルート・アイテムの子のフォルダ。

- ChildFiles: ルート・アイテムの子のファイル。targetがfileに設定されていない場合はnullになります。

8.2.3 FLD_COPY

フォルダでユーザーがある場所から別の場所にアイテムをコピーできるようにするサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- destination: すべてのアイテムのコピー先。この識別子は、path:$PATH'またはfFolderGUID:$FOLDER_GUIDの形式にする必要があります。

- item1: コピー対象のアイテム。この操作で複数のアイテムをコピーする場合は、item2, item3,などのように指定できます。これらのアイテムをIDまたはフルパスのどちらかで指定します。各アイテムは、path:$PATH、fFolderGUID:$FOLDER_GUIDまたはfFileGUID:$FILE_GUIDの形式にする必要があります。

オプションのサービス・パラメータ

- overwrite: 1に設定すると、ネーミングの競合が発生した場合に既存のコピー先が上書きされます。上書きされたアイテムはごみ箱に移動されます。

- copyOwnerFilesToNewFiles: 1に設定すると、タイプがownerのすべてのファイルが新しい所有者ファイルにコピーされます。このアクションによって、コピー対象の各所有者ファイルに対して新しいチェックインが発生します。デフォルトでは、所有者ファイルのコピーは、ソース・ドキュメントを指すソフト・ファイルです。

- copySoftFilesToNewFiles: 1に設定すると、コピー対象のすべてのソフト・ファイルの新しいコンテンツ・アイテムが作成されます。デフォルトでは、ソフト・ファイルのコピーは同じコンテンツ・アイテムを指す別のソフト・ファイルです。

- constructDialog: これを1に設定すると、コピー・アクションの結果、またはコピー・アクションが失敗した可能性がある場合はその理由に関する情報を示すHTMLダイアログがサーバーによって自動的に構成されます。

結果

- ResultSets:

- ItemsRequiringOverwrite: overwriteフラグが設定されていないときに、コピー先に競合するアイテムが存在する場合、このResultSetによって、どのような競合が存在するかが示されます。競合がある場合は、どのアイテムも移動されません。この戻りによって、競合の可能性に対する迅速なサーバー・レスポンスが可能になり、クライアント・アプリケーションが上書きに関する確認をユーザーに求めることができます。

- TaskList: 実行された各タスクと、どのタスクが正常に実行されたかを示す情報

- didBackgroundTask: (文字列)一部またはすべてのタスクがバックグラウンドで実行された場合は、このパラメータが1に設定されます。

- mainTasksComplete: (文字列)サービスがバックグラウンドで実行されたときも含めて、メイン・タスクが完了した場合は、このパラメータが1に設定されます。これは、コピー後のチェックはまだ完了していなくても、アイテムのコピーは完了していることを知るために役立ちます。

- dialogMarkup: (文字列)ダイアログのHTML。

- dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。

8.2.4 FLD_CREATE_FILE

フォルダ内のドキュメントへのリンクを作成するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fParentGUID: 新しいリンクの作成場所とする親フォルダのGUID。

オプションのサービス・パラメータ

- $fileMeta: リンクに割り当てるメタデータ。

ファイル名の制限

- ファイル名の先頭と末尾には空白は使用できません。

- ファイル名は250文字以内にする必要があります。

- 制限付き文字

表8-1 ファイル名の制限付き文字

文字

説明

/

スラッシュ

\

円記号

*

アスタリスクまたはスター

"

引用符

<

より小さい

>

より大きい

|

縦線またはOR

?

疑問符

:

コロン

- 制限付き文字列:

表8-2 ファイル名の制限付き文字列

文字列

Users

/

_shortcuts

_REAL_ITEMS

(空白または連続する空白)

.

..

CON

PRN

AUX

CLOCK

NUL

NULL

COM0

COM1

COM2

COM3

COM4

COM5

COM6

COM7

COM8

COM9

LPT0

LPT1

LPT2

LPT3

LPT4

LPT5

LPT6

LPT7

LPT8

LPT9

8.2.5 FLD_CREATE_FILE_FORM

ドキュメントを指す新しいリンク・オブジェクトを作成するためのフォルダ・フォームを表示するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fParentGUID: 新しいリンクの作成場所とする親フォルダのGUID。

- fFileType: 作成するリンクのタイプ。

- dDocName: リンクのターゲットのドキュメント名。

オプションのサービス・パラメータ

- fApplication: フォルダを作成するフォルダ・アプリケーション。デフォルトはframeworkです。

- $fileMeta: リンクのデフォルトのメタデータ値。

結果

- ResultSets:

- ParentInfo: 親フォルダに関する情報。

- parentPath: (文字列)親フォルダのフルパス。

8.2.6 FLD_CREATE_FOLDER

フォルダ内にフォルダを作成するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fParentGUID: 新しいフォルダの作成場所とする親フォルダのGUID。

オプションのサービス・パラメータ

- $folderMeta: フォルダに割り当てるメタデータ。

フォルダ名の制限

- フォルダ名の先頭と末尾には空白は使用できません。

- フォルダ名は250文字以内にする必要があります。

- 制限付き文字

表8-3 フォルダ名の制限付き文字

文字

説明

/

スラッシュ

\

円記号

*

アスタリスクまたはスター

"

引用符

<

より小さい

>

より大きい

|

縦線またはOR

?

疑問符

:

コロン

- 制限付き文字列:

表8-4 フォルダ名の制限付き文字列

文字列

Users

/

_shortcuts

_REAL_ITEMS

(空白または連続する空白)

.

..

CON

PRN

AUX

CLOCK

NUL

NULL

COM0

COM1

COM2

COM3

COM4

COM5

COM6

COM7

COM8

COM9

LPT0

LPT1

LPT2

LPT3

LPT4

LPT5

LPT6

LPT7

LPT8

LPT9

8.2.7 FLD_CREATE_FOLDER_FORM

新しいフォルダの作成用にフォルダを表示するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fParentGUID: 新しいフォルダの作成場所とする親フォルダのGUID。

オプションのサービス・パラメータ

- fApplication: フォルダを作成するフォルダ・アプリケーション。デフォルトはframeworkです。

- fFolderType: 作成するフォルダのタイプ。デフォルトはownerです。

- $folderMeta: フォルダのデフォルトのメタデータ値。

- fTargetGUID: fFolderType値がsoftの場合、これはターゲット・フォルダのGUIDにする必要があります。

結果

- ResultSets:

- ParentInfo: 親フォルダに関する情報。

- TargetInfo: ターゲット・フォルダに関する情報(ターゲット・フォルダがある場合)。

- parentPath: (文字列)親フォルダのフルパス。

- targetPath: (文字列)ターゲットのフルパス(ターゲットがある場合)。

8.2.8 FLD_DELETE

ユーザーがFramerwork Folders階層から1つ以上のアイテムを削除できるようにするサービス。これによって、ごみ箱にまだ移動されていないアイテムでもただちに削除されます。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- item1: 削除対象のアイテム。この操作で複数のアイテムを削除する場合は、item2, item3,などのように指定できます。これらのアイテムはIDまたはフルパスとして指定できます。各アイテムは次のいずれかの形式で指定する必要があります。

- path:$PATH

- fFolderGUID:$FOLDER_GUID

- fFileGUID:$FILE_GUID

オプションのサービス・パラメータ

- constructDialog: (ブール値)FLD_DELETE操作の結果、またはこの操作が失敗した可能性がある場合にはその理由に関する情報を示すHTMLダイアログがサーバーによって自動的に構成されるようにするには、このパラメータを1に設定します。

結果

- ResultSets:

- TaskList: 実行された各タスクと、どのタスクが正常に実行されたかを示す情報。

- didBackgroundTask: (ブール)一部またはすべてのタスクがバックグラウンドで実行された場合は1に設定されます。

- dialogMarkup: (文字列)ダイアログのHTML。

- dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。

- mainTasksComplete: (ブール)サービスがバックグラウンドで実行されたときも含めて、メイン・タスクが完了した場合は1に設定されます。これは、削除後のチェックはまだ完了していなくても、アイテムの削除は完了していることを知るために役立ちます。

8.2.9 FLD_EDIT_FILE

フォルダ内のドキュメントへのリンクを編集するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fFileGUID: 編集対象のリンクのID。

オプションのサービス・パラメータ

- $fileMeta: 編集対象のリンクに割り当てるメタデータ。

8.2.10 FLD_EDIT_FILE_FORM

フォルダ内のドキュメントへのリンクを編集するためのフォームを表示するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fFileGUID: 編集対象のリンクのGUID。

結果

- $fileMeta: 編集対象のリンクに現在割り当てられているメタデータ値。

- folderPath: (文字列)編集対象のリンクのフルパス。

8.2.11 FLD_EDIT_FOLDER

フォルダ内のフォルダを編集するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fFolderGUID: 編集対象のフォルダのID。

オプションのサービス・パラメータ

- $folderMeta: 編集対象のフォルダに割り当てるメタデータ。

8.2.12 FLD_EDIT_FOLDER_FORM

フォルダ内のフォルダを編集するためのフォームを表示するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fFolderGUID: 編集対象のフォルダのGUID。

結果

- ResultSets:

- $folderMeta: 編集対象のフォルダに現在割り当てられているメタデータ値。

- folderPath: (文字列)編集対象のフォルダのフルパス。

- targetPath: (文字列)ターゲットのフルパス(編集対象のフォルダがショートカットの場合)。

- TargetInfo: ターゲットに関する情報(編集対象のフォルダがショートカットの場合)。

8.2.13 FLD_EDIT_METADATA_RULES

フォルダ内のフォルダに割り当てられたメタデータ・ルールを編集するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fFolderGUID: 編集対象のフォルダのGUID。

- $fieldName: 指定フィールドの値。

オプションのサービス・パラメータ

- $fieldName:isDefault: (ブール)指定フィールドを編集対象のフォルダのすべての子に強制する場合は1に設定します。

- $fieldName:isForced: (ブール)指定フィールドを編集対象のフォルダのすべての子に強制する場合は1に設定します。

- $fieldName:isRecursiveForced: (ブール)指定フィールドを編集対象のフォルダのすべての子、さらにその子に強制する場合は1に設定します。

- $fieldName:inhibitPropagation: (ブール)指定フィールドを編集対象のフォルダの子に伝播可能にする場合は1に設定します。

8.2.14 FLD_EDIT_METADATA_RULES_FORM

フォルダ内のフォルダに割り当てられたコンテンツ・メタデータ・デフォルトを編集するためのフォームを表示するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fFolderGUID: 編集対象のフォルダのGUID。

結果

- ResultSets:

- FolderInfo: 編集されたフォルダに関する情報。

- $fieldName: (文字列)指定フィールドの値。

- $fieldName:isDefault: (ブール)指定フィールドにデフォルト値が関連付けられている場合は1に設定されます。

- $fieldName:isForced: (ブール)指定フィールドがフォルダのすべての子に強制される場合は1に設定されます。

- $fieldName:isRecursiveForced: (ブール) 指定フィールドがフォルダのすべての子、さらにその子に強制される場合は1に設定されます。

- $fieldName:inhibitPropagation: (ブール)指定フィールドがフォルダの子に伝播可能な場合は1に設定されます。

- folderPath: (文字列)フォルダのフルパス。

- dpTriggerField: (文字列)プロファイル・トリガー・フィールド(存在する場合)。

- dpTriggerValue: (文字列)現在のプロファイル・トリガー値(存在する場合)。

- dpDisplayLabel: (文字列)現在のプロファイル表示ラベル(存在する場合)。

8.2.15 FLD_FOLDER_MIGRATION_STATUS

Folders_gレガシー・フォルダ・データをFrameworkFoldersデータ構造に移行するためのダイアログを表示するサービス。移行の履歴と、現在進行中の移行のステータスが表示されます。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

8.2.16 FLD_FOLDER_SEARCH

フォルダ内のフォルダを検索し、結果を返すサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- QueryTest: 検索問合せのテキスト。

- SortField: 検索結果をソートするフィールド。

- SortOrder: 検索結果のソート順。次のいずれかを使用します。

- asc

- desc

結果

- ResultSets:

- SEARCH_RESULTS: 検索の結果。

8.2.17 FLD_FOLDER_SEARCH_FORM

フォルダ内のフォルダを検索するためのフォームを表示するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

8.2.18 FLD_GET_CHOOSE_DESTINATION_DIALOG

フォルダでの移動またはコピー操作時に移動またはコピー先を選択するためのダイアログを表示するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- action: 実行するアクションに応じてmoveまたはcopyに設定します。

- item1: コピー対象のアイテム。この操作で複数のアイテムを処理する場合は、item5, item3,などのように指定できます。これらのアイテムはIDまたはフルパスとして指定できます。各アイテムは次のいずれかの形式で指定する必要があります。

- path:$PATH

- fFolderGUID:$FOLDER_GUID

- fFileGUID:$FILE_GUID

結果

- dialogMarkup: (文字列)ダイアログのHTML。

- dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。

8.2.19 FLD_GET_CREATE_LINK_DIALOG

フォルダ内の既存のコンテンツ・アイテムへのリンクを作成するためのダイアログを表示するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fParentGUID: リンクの作成場所とするフォルダのGUID。これかまたはdDocNameのいずれかを設定する必要があります。

- dDocName: 新しいリンクのターゲット・ドキュメント。これかまたはfParentGUIDを設定する必要があります。

- fFileName: 作成するリンクのタイプ。

結果

- dialogMarkup: (文字列)ダイアログのHTML。

- dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。

8.2.20 FLD_GET_CREATE_SHORTCUT_DIALOG

フォルダ内の既存のフォルダへのショートカットを作成するためのダイアログを表示するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fTargetGUID: ショートカットのターゲット・ドキュメントID。

- fParentGUID: ショートカットの作成場所とする親フォルダのID。

結果

- dialogMarkup: (文字列)ダイアログのHTML。

- dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。

8.2.21 FLD_GET_RENAME_FILE_DIALOG

フォルダ内のファイルの名前変更に使用されるダイアログを取得するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fFileGUID: 名前を変更するファイルのGUID。

結果

- dialogMarkup: (文字列)ダイアログのHTML。

- dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。

8.2.22 FLD_GET_RENAME_FOLDER_DIALOG

フォルダ内のフォルダの名前変更に使用されるダイアログを取得するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fFolderGUID: 名前を変更するフォルダのGUID。

結果

- dialogMarkup: (文字列)ダイアログのHTML。

- dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。

8.2.23 FLD_INFO

フォルダ内の特定のフォルダまたはファイルに関する情報を返すサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- path: 情報のリクエスト対象のフォルダまたはファイルのパス。fFolderGUIDまたはfFileGUIDパラメータをいずれも指定していない場合は、このパラメータを指定する必要があります。

- fFolderGUID: 情報のリクエスト対象のフォルダのGUID。pathまたはfFileGUIDパラメータをいずれも指定していない場合は、このパラメータを指定する必要があります。

- fFileGUID: 情報のリクエスト対象のファイルのGUID。pathまたはfFolderGUIDパラメータをいずれも指定していない場合は、このパラメータを指定する必要があります。

結果

- ResultSets:

- FileInfo: ドキュメント(ファイル)へのリンクに関する情報。また、ドキュメント自体に関連付けられたメタデータ。

- FolderInfo: フォルダに関する情報。

- TargetInfo: ターゲット(ショートカット)に関する情報。

- filePath: (文字列)アイテムのフルパス(アイテムがドキュメント・リンクの場合)。

- folderPath: (文字列)アイテムのフルパス(アイテムがフォルダの場合)。

- targetPath: (文字列)ターゲット・アイテムのフルパス(アイテムがショートカットの場合)。

8.2.24 FLD_LOAD_SOFT_LINKS_FOR_DOCUMENT

フォルダ内の特定のコンテンツ・アイテムを参照するすべてのソフト・リンクをロードするサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- dDocName: コンテンツ・アイテムの名前。

- dID: コンテンツ・アイテムの識別子。

オプションのサービス・パラメータ

- constructSoftLinkTableRows: (ブール)ソフト・リンク表の行のHTMLを構成するかどうか。デフォルトは1 (TRUE)です。

結果

- ResultSets:

- softLinks: コンテンツ・アイテムのソフト・リンク。

- softLinkTableRows: (文字列)ソフト・リンク表の行を表示するHTML。

8.2.25 FLD_MIGRATION_FOLDER_DATA

Folders_gレガシー・フォルダ・データをFrameworkFoldersデータ構造に移行するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

8.2.26 FLD_MOVE

フォルダで1つ以上のコンテンツ・アイテムをフォルダ内の別の場所に移動するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- destination: すべてのアイテムの移動先。移動先が既存のフォルダである場合は、移動対象のすべてのアイテムがそのフォルダに移動されます。単一ファイルを移動する場合は、ファイルの移動先の場所(新しいファイル名を含む)を指すことができます。この識別子は、path:$PATHまたはfFolderGUID:$FOLDER_GUIDの形式で指定します。

- item1: 移動対象のアイテム。この操作で複数のアイテムを移動する場合は、item2, item3,などのように指定できます。これらのアイテムはIDまたはフルパスとして指定できます。次のいずれかの形式にする必要があります。

- path:$PATH

- fFolderGUID:$FOLDER_GUID

- fFileGUID:$FILE_GUID

オプションのサービス・パラメータ

- overwrite: (ブール) 1に設定すると、ネーミングの競合が発生した場合に既存の移動先が上書きされます。上書きされたアイテムはごみ箱に移動されます。

- constructDialog: (ブール) 1に設定すると、移動操作の結果、または移動が失敗した可能性がある場合はその理由に関する情報を示すHTMLダイアログがサーバーによって自動的に構成されます。

結果

- ResultSets:

- ItemsRequiringOverwrite: overwriteフラグが設定されていないときに、移動先に競合するアイテムが存在する場合、このResultSetが返され、どのような競合が存在するかが示されます。競合がある場合は、どのアイテムも移動されません。これによって、競合の可能性に対する迅速なサーバー・レスポンスが可能になり、クライアント・アプリケーションが上書きに関する確認をユーザーに求めることができます。

- TaskList: 実行された各タスクと、どのタスクが正常に実行されたかを示す情報。

- dialogMarkup: (文字列)ダイアログのHTML。

- dialogScript: (文字列)ダイアログを表示するために必要なJavaScript。

- didBackgroundTask: (文字列)一部またはすべてのタスクがバックグラウンドで実行された場合は、これが1に設定されます。

- mainTasksComplete: (文字列)サービスがバックグラウンドで実行されたときも含めて、メイン・タスクが完了した場合は、これが1に設定されます。これは、移動後の健全性チェックはまだ完了していなくても、アイテムの移動は完了していることを知るために役立ちます。

8.2.27 FLD_PRE_CHECKIN

コンテンツ・アイテムのチェックイン前にメタデータ入力ダイアログをユーザーに表示する必要があるかどうかをリクエスト元のクライアントが判断できるようにするための情報を提供するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fFolderGUID: CONTENTSのアイテムのベース・フォルダID。fFolderPATHを設定していない場合は、このパラメータを使用する必要があります。

- fFolderPath: CONTENTSのアイテムのベース・フォルダ・パス。fFolderGUIDを設定していない場合は、このパラメータを使用する必要があります。

- CONTENTS: (ResultSet)ベース・フォルダを基準にした、フォルダおよびコンテンツ・アイテムの相対パスのセット。指定したパスの末尾が/ (スラッシュ)文字の場合、パスはフォルダを表すとみなされます。それ以外の場合はコンテンツ・アイテムを表すとみなされます。

- EXTRA_INFO_FIELDS: (ResultSet)アイテムごとに返す追加情報フィールドのリスト。追加情報フィールドのデータは既存のコンテンツ・アイテムの場合にのみ移入されます。リクエスト可能な有効フィールドは、REVISIONS、DOCMETAまたはDOCUMENTS表のいずれかの列か、getcontentlength、getcontenttype、getlastmodifiedまたはcreationdateフィールド(WebDAVの場合など)です。

オプションのサービス・パラメータ

- allowPromptForExistingItem: (ブール) 1に設定すると、クライアント・リクエストで2番目のリビジョンに対してプロンプトを表示できるようになります。通常、プロンプトは最初のリビジョンに対してのみ発生します。

結果

- ResultSet: REQUIRES_METADATA_PROMPT: 返されたこのResultSetには、CONTENTSの各行に対応した次のフィールドが含まれています。

- FLAGフィールド: {flag1}{flag2}の2つのフラグ文字。flag1が1に設定されている場合、指定したパスがすでに存在します。1でない場合は存在しません。flag2が1に設定されている場合、クライアントは、このアイテムのメタデータの入力を求めるプロンプト・ダイアログを表示するようになります。

- DP_TRIGGER_VALUE: このアイテム用に使用されたドキュメント・プロファイル。これには、EXTRA_INFO_FIELDSパラメータで指定したフィールドごとに1つの列が表示されます。

8.2.28 FLD_PROPAGATE

フォルダのフォルダ構造の下層にメタデータを伝播するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- $fieldName:isSelected: 1に設定すると、指定したフィールドが伝播されます。

- $fieldName: 伝播対象のフォールドの値

オプションのサービス・パラメータ

- propagateThroughSoftLinks: (ブール) 1に設定すると、ソフト・リンクが指すドキュメントにメタデータが伝播されます。

8.2.29 FLD_PROPAGATE_FORM

ユーザーがフォルダ内のフォルダのすべての子にメタデータを伝播できるようにするフォームを表示するサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fFolderGUID: フォルダのID。

結果

- ResultSets:

- FolderInfo: フォルダに関する情報。

- folderPath: フォルダのフルパス。

- $fieldName: 伝播されるフィールドのデフォルト値。この値はメタデータ・ルールから取得されるか、またはフォルダ自体のメタデータから取得されます。

- dpTriggerField: プロファイル・トリガー・フィールド(存在する場合)。

8.2.30 FLD_REINDEX_FOLDER_CONTENTS

フォルダ内の特定のフォルダに含まれている、現在索引付けされているすべてのドキュメントの再索引付けを実行するサービス。このサービスはシステム管理者のみがコールできます。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fFolderGUID: フォルダのGUID。

8.2.31 FLD_RETRIEVE_CHILD_FILES

フォルダのFLD_BROWSEサービスによって返された子のドキュメントの容易なページングを可能にするサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- path: 現在のフォルダのフルパス。folderGUIDパラメータを指定していない場合は、このパラメータを使用する必要があります。

- fFolderGUID: フォルダのGUID。現在のフォルダを参照するパスのかわりにこのパラメータを指定できます。

オプションのサービス・パラメータ

- fldapp: 参照対象の場所のフォルダ・アプリケーション。

- folderCount: 返すフォルダの数。デフォルトは50です。

- folderStartRow: データを返す最初の行番号。レスポンスのページングに使用されます。デフォルトは0です。

- constructListingMarkup: 追加フォルダのマークアップを返すかどうかを指定します。このパラメータは、このリクエストをAJAX環境で実行するときに役立ちます。デフォルトは1 (TRUE)です。

結果

- ResultSets:

- FolderInfo: 現在参照しているフォルダに関する情報。

- ChildFolders: このフォルダ内に存在するすべてのフォルダに関する情報。

- FileListingHTML: 追加ドキュメントの表示に使用できるHTML。constructListingMarkupを1 (true)に設定したときにのみ返されます。

- FileListingScript: 追加ドキュメントを表示するために実行する必要があるJavaScript。constructListingMarkupを1 (true)に設定したときにのみ返されます。

- numFolders: ChildFolders ResultSet内のフォルダ数。

- hasMoreChildFiles: リクエストですべての子のファイルが返されたわけではない場合、これは1 (true)です。これはfileCountに到達したときに発生します。返すことができる追加のドキュメントがあった可能性があります。

8.2.32 FLD_RETRIEVE_CHILD_FOLDERS

フォルダのFLD_BROWSEサービスによって返された子のフォルダの容易なページ区切りを可能にするサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- path: 現在のフォルダのフルパス。folderGUIDパラメータを指定していない場合は、このパラメータを使用する必要があります。

- fFolderGUID: フォルダのGUID。現在のフォルダを参照するパスのかわりにこのパラメータを指定できます。

オプションのサービス・パラメータ

- fldapp: 参照対象の場所のフォルダ・アプリケーション。

- folderCount: 返すフォルダの数。デフォルトは50です。

- folderStartRow: データを返す最初の行番号。レスポンスのページングに使用されます。デフォルトは0です。

- constructListingMarkup: 追加フォルダのマークアップを返すかどうかを指定します。このパラメータは、このリクエストをAJAX環境で実行するときに役立ちます。デフォルトは1 (TRUE)です。

結果

- ResultSets:

- FolderInfo: 現在参照しているフォルダに関する情報。

- ChildFolders: このフォルダ内に存在するすべてのフォルダに関する情報。

- FolderListingHTML: 追加フォルダの表示に使用できるHTML。constructListingMarkupを1 (true)に設定したときにのみ返されます。

- FolderListingScript: 追加フォルダを表示するために実行する必要があるJavaScript。constructListingMarkupを1 (true)に設定したときにのみ返されます。

- numFolders: ChildFolders ResultSet内のフォルダ数。

- hasMoreChildFolders: リクエストですべての子のフォルダが返されたわけではない場合、これは1 (true)です。これはfileCountに到達したときに発生します。返すことができる追加のフォルダがあった可能性があります。

8.2.33 FLD_SUBSCRIBE

フォルダへのユーザーのサブスクライブを可能にするサービス。サブスクリプション通知は、プロファイルに指定されたユーザーの電子メールに送信されます。プロファイルの電子メール・アドレスまたはdSubscriptionEmail設定のいずれも指定されていない場合、レスポンス・バインダにisNoSubscriptionNotificationSent=1のフラグが設定されます。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fParentGUID: ユーザーがサブスクライブするフォルダのID。

オプションのサービス・パラメータ

- dSubscriptionEmail: サブスクライバの電子メール・アドレス。空でない値を指定した場合、その値を使用してプロファイル内のユーザーの電子メールの値が更新されます。

- constructDialog: (Boolean)サブスクリプションの結果、またはサブスクリプションが失敗した可能性がある場合にはその理由に関する情報を示すHTMLダイアログがサーバーによって自動的に構成されるようにするには、このパラメータを1 (true)に設定します。

結果

- dialogMarkup: ダイアログのHTML。

- dialogScript: ダイアログを表示するために必要なJavaScript。

8.2.34 FLD_TEST_USER_CAPABILITIES

ドキュメント、フォルダまたはライブラリに対して操作を実行するユーザーの機能を、次に基づいてテストするサービス。

- ユーザーの認可

- アイテムのアクセス制御ポリシー

- アイテムの状態

- 有効化されたWebCenter Contentコンポーネント

サービス・クラス: intradoc.folders.FoldersServices

場所: IdcHomeDir/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- testedItems: テストするアイテムのリスト。各アイテムのタイプとIDは、testedItemsの文字列で、Type1:ID1,Type2:ID2,Type3:ID3の形式で指定します。
次のタイプがあります。

- フォルダの場合fFolderGUID

- ファイルの場合fFileGUID

- ドキュメントの場合dDocName

- ドキュメント・リビジョンの場合dID

IDはこれらのフィールドの値です。

例:

fFolderGUID:folder001,dDocName:doc001,fFolderGUID:folder002,
fFileGUID:file001,dID:docRevision001

- testedCapabilities: カンマで区切られた機能のリスト(例: MOVE,COPY,DELETE)。テスト可能なすべての機能を次に示します。

- CREATE_CHILD_FOLDER

- CREATE_CHILD_DOCUMENT

- FILE_DOCUMENT

- UNFILE_DOCUMENT

- UPDATE_METADATA

- UPDATE_ACCESS_CONTROL

- LATEST_REVISION

- MOVE

- COPY

- DELETE

- PROPAGATE_METADATA

- CHECK_OUT

- CANCEL_CHECK_OUT

- CHECK_IN_NEW_REVISION

- DELETE_REVISION

- RESTORE_REVISION

- SHARE_PERSONAL_FOLDER

- FOLLOW

- UNFOLLOW

テスト用にサポートされている機能

表8-5

機能

フォルダの所有者リンク(fFolderGUID)

フォルダのソフト・リンク(fFolderGUID)

ファイルの所有者リンク(fFileGUID)

ファイルのソフト・リンク(fFileGUID)

ドキュメント(dDocName)

リビジョン(dID)

説明

CREATE_CHILD_FOLDER

TEST

ユーザーがこのフォルダに新しいサブフォルダを作成できるか。

CREATE_CHILD_DOCUMENT

TEST

ユーザーがこのフォルダに新しいドキュメントを作成できるか。

FILE_DOCUMENT

TEST

ユーザーがこのドキュメントに所有者のリンクを作成できるか。

UNFILE_DOCUMENT

TEST

TEST(2)

ユーザーがこの所有者のリンクを(ドキュメントを削除することなく)削除できるか。

UPDATE_METADATA

TEST

TEST

TEST

TEST

TEST

ユーザーがこのアイテムのメタデータを更新できるか。

UPDATE_ACCESS_CONTROL

TEST

TEST

ユーザーがこのフォルダまたはファイルのアクセス制御フィールドを変更できるか。

LATEST_REVISION

TEST

これがドキュメントの最新リビジョンか。

MOVE

TEST

TEST

TEST

TEST

TEST(2)

ユーザーがこのフォルダ、ドキュメントまたはショートカットを変更できるか。

COPY

TEST

TEST

TEST

TEST

TEST(2)

ユーザーがこのフォルダ、ドキュメントまたはショートカットをコピーできるか。

DELETE

TEST

TEST

TEST(1)

TEST

TEST

ユーザーがこのフォルダ、ドキュメントまたはショートカットを削除できるか。

PROPAGATE_METADATA

TEST

ユーザーがこのフォルダのメタデータ・フィールドを伝播できるか。個人ライブラリ/フォルダの場合、falseを返します(LibraryType=4)。

CHECK_OUT

TEST

ユーザーがこのドキュメントをチェックアウトできるか。個人ライブラリ/フォルダ内のドキュメントの場合、falseを返します。

CANCEL_CHECK_OUT

TEST

ユーザーがこのドキュメントのチェックアウトをキャンセルできるか。

CHECK_IN_NEW_REVISION

TEST

ユーザーがこのドキュメントの新しいリビジョンをチェックインできるか。ドキュメントが、現在のユーザーによってチェックアウトされているか、チェックアウトはされていないがユーザーに自動チェックアウトおよびチェックイン・サイクルを実行する権限がある場合に、TRUEが返されます。

DELETE_REVISION

TEST

ユーザーがこのドキュメントのこのリビジョンを削除できるか。

RESTORE_REVISION

TEST

ユーザーがこのドキュメントの新しいリビジョンをこのリビジョンのコピーとして作成できるか。

SHARE_PERSONAL_FOLDER

TEST(3)

ユーザーがこの個人ライブラリまたは個人フォルダを共有できるか。

FOLLOW

TEST

TEST

ユーザーがこのフォルダ、ドキュメントまたはバージョンをフォローできるか。ドキュメントまたはフォルダが直接サブスクライブされている場合は、フォローされていると見なされます。

UNFOLLOW

TEST

TEST

ユーザーがこのフォルダ、ドキュメントまたはバージョンのフォローを解除できるか。

注意

(1) ターゲットのリビジョンの削除をテストするのと同じです。

(2) fFileGUIDが不明なまま機能をテストできる必要があります。

(3) 個人ライブラリまたは個人フォルダは、次の各条件が成立する場合のみ共有可能です: (a)上位の個人ライブラリが共有されていない(個人フォルダの場合)。(b)上位の個人フォルダが共有されていない(個人フォルダの場合)。(c)下位の個人フォルダが共有されていない。これらの条件の1つ以上が真でない場合、ユーザーは該当する機能を持っておらず、FLD_TEST_USER_CAPABILITIESサービスが個人ライブラリまたはサービスが共有されるのを防ぐために、ライブラリまたはフォルダのfFolderGUIDを返します。

結果

ResultSet:

- TestResults: 次のテスト結果となります。

- 1はTrueを意味し、現在のユーザーにはその機能があります。

- 0はFalseを意味します。

- -1はN/A(該当なし)を意味します。

- 共有された上位/下位フォルダが存在するためSHARE_PERSONAL_FOLDER機能のテストに失敗した場合、共有されている上位または下位フォルダの文字列が返されます。

- ユーザーにアイテムの共有の権限がないためSHARE_PERSONAL_FOLDERが失敗した場合、0が返されます。

8.2.35 FLD_UNSUBSCRIBE

フォルダへのユーザーのサブスクライブを解除できるサービス。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- fParentGUID: ユーザーがサブスクライブを解除するフォルダのID。

オプションのサービス・パラメータ

- constructDialog: (Boolean)サブスクリプション解除の結果、またはサブスクリプション解除が失敗した可能性がある場合にはその理由に関する情報を示すHTMLダイアログがサーバーによって自動的に構成されるようにするには、このパラメータを1 (true)に設定します。

結果

- dialogMarkup: ダイアログのHTML。

- dialogScript: ダイアログを表示するために必要なJavaScript。

8.2.36 FLD_UNFILE

ユーザーがフォルダ階層から1つ以上のアイテムのファイリングを解除できるようにするサービス。これによって、ターゲット・ドキュメントにいかなる影響も及ぼすことなく、リンク・オブジェクトがただちに削除されます。

サービス・クラス: intradoc.folders.FoldersService

場所: IdcHomeDir/components/frameworkfolders/resources/frameworkfolders_service.htm

必須のサービス・パラメータ

- item1: ファイリング解除対象のアイテム。この操作で複数のアイテムのファイリングを解除する場合は、item2, item3,などのように指定できます。これらのアイテムはIDまたはフルパスとして指定できます。各アイテムは、path:$PATHまたはfFileGUID:$FILE_GUIDの形式にする必要があります。

オプションのサービス・パラメータ

- constructDialog: ファイリング解除の結果、またはファイリング解除が失敗した可能性がある場合にはその理由に関する情報を示すHTMLダイアログがサーバーによって自動的に構成されるようにするには、このパラメータを1に設定します。

結果

- ResultSets:

- TaskList: 実行された各タスクと、どのタスクが正常に実行されたかを示す情報。

- didBackgroundTask: 一部またはすべてのタスクがバックグラウンドで実行された場合は、これが1に設定されます。

- mainTasksComplete: サービスがバックグラウンドで実行されたときも含めて、メイン・タスクが完了した場合は、これが1に設定されます。これは、ファイリング解除後のチェックはまだ完了していなくても、アイテムのファイリング解除は完了していることを知るために役立ちます。

- dialogMarkup: ダイアログのHTML。

- dialogScript: ダイアログを表示するために必要なJavaScript。

9 レコード・サービス

この章では、Oracle WebCenter Content: Recordsサービスの使用時およびカスタマイズ時に利用できるサービスについて説明します。

この章の内容は、次のとおりです。

- 第9.1項「レコード・サービスについて」

- 第9.2項「レコード・サービス」

9.1 レコード・サービスについて

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

個々のレコード・サービスの場所は、それぞれのサービスの説明の中で示します。

注意:

最も一般的に使用されるサービスには、より広範囲な説明があります。

重要:

すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。

9.2 レコード・サービス

レコード機能では次のサービスが使用されます。

- ACTIVATE_SERVICE

- APPROVE_DELETE_SERVICE

- BROWSE_CATEGORY_FORM

- BROWSE_FOLDER_FORM

- BROWSE_SERIES_FORM

- CHECKIN_NEW_REVISION_SERVICE

- CHECKIN_SIMILAR_FORM

- CLEAR_FOLDER_CANCELLED_DATE

- CLEAR_FOLDER_EXPIRATION_DATE

- CLEAR_FOLDER_OSBOLETE_DATE

- CLEAR_FOLDER_RESCINDED_DATE

- CLEAR_FOLDER_REVIEW_DATE

- CLEAR_RECORD_CANCELLED_DATE

- CLEAR_RECORD_EXPIRATION_DATE

- CLEAR_RECORD_OBSOLETE_DATE

- CLOSE_FOLDER

- CREATE_FOLDER

- CREATE_FOLDER_FORM

- DELETE_ALL_BUT_LAST_N_REVISIONS_ SERVICE

- DELETE_FOLDER

- DELETE_REVISION_SERVICE

- EDIT_FOLDER

- EDIT_FOLDER_FORM

- FREEZE_FOLDER

- FREEZE_RECORD

- INFO_CATEGORY_FORM

- INFO_FOLDER_FORM

- INFO_FOLDER_LIFECYCLE

- INFO_FOLDER_METADATA_HISTORY

- INFO_FOLDER_REVIEW_HISTORY

- INFO_RECORD_LIFECYCLE

- INFO_RECORD_METADATA_HISTORY

- INFO_RECORD_REVIEW_HISTORY

- INFO_SERIES_FORM

- MARK_FOLDER_ACTIVATION_DATE

- MARK_FOLDER_CANCELLED_DATE

- MARK_FOLDER_EXPIRATION_DATE

- MARK_FOLDER_OBSOLETE_DATE

- MARK_FOLDER_RESCINDED_DATE

- MARK_FOLDER_REVIEW_DATE

- MARK_FOLDER_REVIEW_DATE_ RECURSIVE

- MARK_RECORD_CANCELLED_DATE

- MARK_RECORD_EXPIRATION_DATE

- MARK_RECORD_OBSOLETE_DATE

- MARK_RECORD_RESCINDED_DATE

- MARK_RECORD_REVIEW_DATE

- MOVE_FOLDER

- PREVIEW_RECORD_LIFECYCLE

- RMA_CLOSE_SERVICE

- RMA_CUTOFF_SERVICE

- RMA_DESTROY_SERVICE

- RMA_EXPORT_ARCHIVE_SERVICE

- RMA_EXPORT_SERVICE

- RMA_MARK_COMPLETED

- RMA_NO_ACTION_SERVICE

- RMA_OBSOLETE_SERVICE

- RMA_SCRUB_SERVICE

- RMA_SUPERSEDE_SERVICE

- UNCLOSE_FOLDER

- UNFREEZE_FOLDER

- UNFREEZE_RECORD

9.2.1 ACTIVATE_SERVICE

このサービスは、「アクティブ化」処理アクション日の設定に使用されます。

追加の必須サービス・パラメータ

- dDispositionID: 処理対象の処理アクションの一意の識別子。

9.2.2 APPROVE_DELETE_SERVICE

このサービスは、「削除の承認」処理アクション日の設定に使用されます。

追加の必須サービス・パラメータ

- dDispositionID: 処理対象の処理アクションの一意の識別子。

9.2.3 BROWSE_CATEGORY_FORM

このサービスは、保存スケジュール内の保存カテゴリのコンテンツの参照に使用されるページを取得するために使用されます。

追加の必須サービス・パラメータ

- dCategoryID: 取得する保存カテゴリの一意の識別子。

9.2.4 BROWSE_FOLDER_FORM

このサービスは、保存スケジュール内のレコード・フォルダのコンテンツの参照に使用されるページを取得するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: 取得するレコード・フォルダの一意の識別子。

9.2.5 BROWSE_SERIES_FORM

このサービスは、保存スケジュール内のシリーズのコンテンツの参照に使用されるページを取得するために使用されます。

追加の必須サービス・パラメータ

- dSeriesID: 取得するシリーズの一意の識別子。

9.2.6 CHECKIN_NEW_REVISION_SERVICE

このサービスは、コンテンツ・アイテムの最新のリビジョンを新規リビジョンとしてチェックインするために使用されます。通常、これはワークフローをトリガーするために使用されます。

9.2.7 CHECKIN_SIMILAR_FORM

このサービスは、「類似をチェックイン」ページを取得するために使用されます。これは、前のコンテンツ・アイテムのチェックインに基づいてメタデータ・フィールドにすでにデータが入力されているチェックイン・ページです。

追加の必須サービス・パラメータ

- dID: すでにチェックインされているアイテムの一意のコンテンツID。

9.2.8 CLEAR_FOLDER_CANCELLED_DATE

このサービスは、取り消されたレコード・フォルダの日付を消去するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

9.2.9 CLEAR_FOLDER_EXPIRATION_DATE

このサービスは、取り消されたレコード・フォルダの有効期限を消去するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

9.2.10 CLEAR_FOLDER_OSBOLETE_DATE

このサービスは、レコード・フォルダが廃止される日付を消去するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

9.2.11 CLEAR_FOLDER_RESCINDED_DATE

このサービスは、レコード・フォルダが廃棄される日付を消去するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

9.2.12 CLEAR_FOLDER_REVIEW_DATE

このサービスは、レコード・フォルダが最後にレビューされた日付を消去するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

9.2.13 CLEAR_RECORD_CANCELLED_DATE

このサービスは、コンテンツ・アイテムが取り消された日付を消去するために使用されます。

追加の必須サービス・パラメータ

- dID: 処理対象のコンテンツの一意の識別子。

9.2.14 CLEAR_RECORD_EXPIRATION_DATE

このサービスは、アイテムが期限切れになった日付を消去するために使用されます。

追加の必須サービス・パラメータ

- dID: 処理対象のアイテムの一意の識別子。

9.2.15 CLEAR_RECORD_OBSOLETE_DATE

このサービスは、アイテムが廃止される日付を消去するために使用されます。

追加の必須サービス・パラメータ

- dID: 処理対象のアイテムの一意の識別子。

9.2.16 CLOSE_FOLDER

このサービスは、保存スケジュール内の既存のレコード・フォルダを閉じるするために使用されます。閉じたレコード・フォルダまたはそのサブフォルダへのコンテンツ・アイテムの追加チェックインは、ユーザーがフォルダの「開く/閉じる」権限を保有しているか、閉じたフォルダの作成者である場合にのみ可能です。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

9.2.17 CREATE_FOLDER

このサービスは、保存スケジュール内に新規レコード・フォルダを作成するために使用されます。このサービスは、通常、CREATE_FOLDER_FORMページからコールされます。

追加の必須サービス・パラメータ

- dFolderID: 新規レコード・フォルダの一意の識別子。

- dFolderName: 新規レコード・フォルダの名前。

- dSecurityGroup: 新規レコード・フォルダに関連付けるセキュリティ・グループ。

- dDocAuthor: 新規レコード・フォルダの作成者。

- dCategoryID: レコード・フォルダに関連付ける保存カテゴリの一意の識別子。

9.2.18 CREATE_FOLDER_FORM

このサービスは、保存スケジュール内に新規レコード・フォルダを作成するCREATE_FOLDERをコールするために使用されます。

9.2.19 DELETE_ALL_BUT_LAST_N_REVISIONS_ SERVICE

このサービスは、最後のN個以外の全リビジョンの削除処理アクションを処理するために使用されます。変数nは、管理者が設定します。

追加の必須サービス・パラメータ

- dDispositionID: 処理対象の処理アクションの一意の識別子。

9.2.20 DELETE_FOLDER

このサービスは、保存スケジュールから既存のレコード・フォルダを削除するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

9.2.21 DELETE_REVISION_SERVICE

このサービスは、コンテンツ・アイテムの最新バージョンを削除するために使用されます。

追加の必須サービス・パラメータ

- dDispositionID: 処理対象の処理アクションの一意の識別子。

9.2.22 EDIT_FOLDER

このサービスは、保存スケジュール内の既存のレコード・フォルダの(変更された)プロパティを更新するために、EDIT_FOLDER_FORMによってコールされます。

追加の必須サービス・パラメータ

- dFolderID: 編集するレコード・フォルダの一意の識別子。

- dFolderName: 編集するレコード・フォルダの名前。

- dSecurityGroup: レコード・フォルダに関連付けられているセキュリティ・グループ。

- dDocAuthor: レコード・フォルダの所有者。

9.2.23 EDIT_FOLDER_FORM

このサービスは、保存スケジュール内のフォルダを編集するEDIT_FOLDERをコールするために使用されます。

追加の必須サービス・パラメータ

- dFolderID: 編集するレコード・フォルダの一意の識別子。

9.2.24 FREEZE_FOLDER

このサービスは、保存スケジュール内の既存のレコード・フォルダを凍結するために使用されます。フォルダを凍結すると、UNFREEZE_FOLDERサービスがコールされるまで、そのフォルダに関連付けられている処理ルールの処理が一時的に停止されます。

追加の必須サービス・パラメータ

- dFolderID: 凍結するレコード・フォルダの一意の識別子。

- dCategoryID: レコード・フォルダに関連付けられている保存カテゴリの一意の識別子。

- auditComments: 凍結名。

- auditComments2: 凍結理由。

9.2.25 FREEZE_RECORD

このサービスは、既存のコンテンツ・アイテムを凍結するために使用されます。コンテンツ・アイテムを凍結すると、UNFREEZE_RECORDサービスがコールされるまで、そのコンテンツ・アイテムに関連付けられている処理ルールの処理が一時的に停止されます。

追加の必須サービス・パラメータ

- dID: 凍結するコンテンツ・アイテムのコンテンツID。

- auditComments: 凍結名。

- auditComments2: 凍結理由。

9.2.26 INFO_CATEGORY_FORM

このサービスは、保存カテゴリの情報ページを取得するために使用されます。

追加の必須サービス・パラメータ

- dCategoryID: 取得する保存カテゴリの一意の識別子。

9.2.27 INFO_FOLDER_FORM

このサービスは、保存スケジュール内のレコード・フォルダのメタデータ情報ページおよび関連コンテンツを取得するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: 取得するレコード・フォルダの一意の識別子。

9.2.28 INFO_FOLDER_LIFECYCLE

このサービスは、レコード・フォルダのライフサイクル情報ページを取得するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: レコード・フォルダの一意の識別子。

9.2.29 INFO_FOLDER_METADATA_HISTORY

このサービスは、レコード・フォルダのメタデータ履歴を取得するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: レコード・フォルダの一意の識別子。

9.2.30 INFO_FOLDER_REVIEW_HISTORY

このサービスは、レコード・フォルダのレビュー履歴を取得するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: レコード・フォルダの一意の識別子。

9.2.31 INFO_RECORD_LIFECYCLE

このサービスは、コンテンツ・アイテムのライフサイクル情報ページを取得するために使用されます。

追加の必須サービス・パラメータ

- dID: アイテムのコンテンツID。

- dCategoryID: アイテムに関連付けられている保存カテゴリの一意の識別子。

9.2.32 INFO_RECORD_METADATA_HISTORY

このサービスは、コンテンツ・アイテムのメタデータ履歴を取得するために使用されます。

追加の必須サービス・パラメータ

- dID: コンテンツ・アイテムのコンテンツID。

9.2.33 INFO_RECORD_REVIEW_HISTORY

このサービスは、コンテンツ・アイテムのレビュー履歴を取得するために使用されます。

追加の必須サービス・パラメータ

- dID: コンテンツ・アイテムのコンテンツID。

9.2.34 INFO_SERIES_FORM

このサービスは、保存スケジュール内のシリーズの情報ページを取得するために使用されます。

追加の必須サービス・パラメータ

- dSeriesID: シリーズの一意の識別子。

9.2.35 MARK_FOLDER_ACTIVATION_DATE

このサービスは、レコード・フォルダをアクティブ化する日付とする現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

- currentDate: アクティブ化に使用する日付。

9.2.36 MARK_FOLDER_CANCELLED_DATE

このサービスは、レコード・フォルダを取り消す日付とする現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

- currentDate: 取消に使用する日付。

9.2.37 MARK_FOLDER_EXPIRATION_DATE

このサービスは、レコード・フォルダの有効期限とする現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

- currentDate: 期限切れに使用する日付。

9.2.38 MARK_FOLDER_OBSOLETE_DATE

このサービスは、レコード・フォルダを廃止する日付とする現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

- currentDate: 廃止日として使用する日付。

9.2.39 MARK_FOLDER_RESCINDED_DATE

このサービスは、レコード・フォルダを廃棄する日付とする現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

- currentDate: 廃棄日として使用する日付。

9.2.40 MARK_FOLDER_REVIEW_DATE

このサービスは、レコード・フォルダのレビューを行う日付とする現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

- currentDate: レビュー日として使用する日付。

9.2.41 MARK_FOLDER_REVIEW_DATE_ RECURSIVE

このサービスは、レコード・フォルダおよびそのすべての子のフォルダのレビューを行う日付とする現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

- currentDate: レビュー日として使用する日付。

9.2.42 MARK_RECORD_CANCELLED_DATE

このサービスは、コンテンツを取り消す日付とする現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dID: 処理対象のコンテンツ・アイテムのコンテンツID。

- currentDate: 取消日として使用する日付。

9.2.43 MARK_RECORD_EXPIRATION_DATE

このサービスは、アイテムが期限切れになる日付とする現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dID: 処理対象のアイテムのコンテンツID。

- currentDate: 有効期限として使用する日付。

9.2.44 MARK_RECORD_OBSOLETE_DATE

このサービスは、アイテムを廃止するために使用する現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dID: 処理対象のアイテムのコンテンツID。

- currentDate: 廃止日として使用する日付。

9.2.45 MARK_RECORD_RESCINDED_DATE

このサービスは、アイテムを廃棄する日付とする現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dID: 処理対象のアイテムのコンテンツID。

- currentDate: 廃棄日として使用する日付。

9.2.46 MARK_RECORD_REVIEW_DATE

このサービスは、コンテンツ・アイテムのレビューを行う日付とする現在の日付の設定に使用されます。

追加の必須サービス・パラメータ

- dID: 処理対象のコンテンツ・アイテムのコンテンツID。

- currentDate: レビュー日として使用する日付。

9.2.47 MOVE_FOLDER

このサービスは、保存スケジュール内のレコード・フォルダを別の場所に移動するために使用されます。

追加の必須サービス・パラメータ

- dFolderID: 処理対象のフォルダのフォルダID。

- dCategoryID: フォルダのカテゴリ。

9.2.48 PREVIEW_RECORD_LIFECYCLE

このサービスは、コンテンツ・アイテムのライフサイクル・プレビューを取得するために使用されます。

追加の必須サービス・パラメータ

- dID: 処理対象のコンテンツ・アイテムのコンテンツID。

9.2.49 RMA_CLOSE_SERVICE

このサービスは、フォルダに対する「閉じる」処理アクションを処理するために使用されます。このサービスはCLOSE_FOLDERサービスをコールします。

追加の必須サービス・パラメータ

- dDispositionID: 処理アクションの一意の識別子。

9.2.50 RMA_CUTOFF_SERVICE

このサービスは、「カットオフ」処理アクションを処理するために使用されます。

追加の必須サービス・パラメータ

- dDispositionID: 処理アクションの一意の識別子。

9.2.51 RMA_DESTROY_SERVICE

このサービスは、「破棄」処理アクションを処理するために使用されます。他の処理ルールが優先される場合を除いて、コンテンツまたはフォルダのすべてのリビジョンが破棄されます。

追加の必須サービス・パラメータ

- dDispositionID: 処理アクションの一意の識別子。

9.2.52 RMA_EXPORT_ARCHIVE_SERVICE

このサービスは、レコード・アーカイブをContent Serverアーカイブに追加するために使用されます。

追加の必須サービス・パラメータ

- dDispositionID: 処理アクションの一意の識別子。

9.2.53 RMA_EXPORT_SERVICE

このサービスは、zipアーカイブを作成するために使用されます。

追加の必須サービス・パラメータ

- dDispositionID: 処理アクションの一意の識別子。

9.2.54 RMA_MARK_COMPLETED

このサービスは、アクションの完了をマークするために使用されます。

追加の必須サービス・パラメータ

- dDispositionID: 処理アクションの一意の識別子。

9.2.55 RMA_NO_ACTION_SERVICE

このサービスは、「アクションなし」処理アクションを処理するために使用されます。

追加の必須サービス・パラメータ

- dDispositionID: 処理アクションの一意の識別子。

9.2.56 RMA_OBSOLETE_SERVICE

このサービスは、「廃止」処理アクションを処理するために使用されます。このサービスはMARK_FOLDER_OBSOLETE_DATEまたはMARK_RECORD_OBSOLETE_DATEをコールします。

追加の必須サービス・パラメータ

- dDispositionID: 処理アクションの一意の識別子。

9.2.57 RMA_SCRUB_SERVICE

このサービスは、レコード・フォルダまたはコンテンツ・アイテムを、リカバリできないように安全に削除するために使用されます。

追加の必須サービス・パラメータ

- dDispositionID: 処理アクションの一意の識別子。

9.2.58 RMA_SUPERSEDE_SERVICE

このサービスは、「差替え」処理アクションを処理するために使用されます。

追加の必須サービス・パラメータ

- dDispositionID: 処理アクションの一意の識別子。

9.2.59 UNCLOSE_FOLDER

このサービスは、保存スケジュール内の既存のレコード・フォルダの閉じたステータスを取り消すために使用されます。レコード・フォルダの閉じた状態を解除すると、そのフォルダおよびそのサブフォルダにコンテンツをチェックインできるようになります。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

9.2.60 UNFREEZE_FOLDER

このサービスは、保存スケジュール内の既存のレコード・フォルダの凍結を解除するために使用されます。フォルダの凍結を解除すると、関連付けられた処理ルールの処理に対してそのフォルダが解放されます。

追加の必須サービス・パラメータ

- dFolderID: 処理するレコード・フォルダの一意の識別子。

- auditComments: 凍結解除名。

- auditComments2: 凍結解除理由。

9.2.61 UNFREEZE_RECORD

このサービスは、既存のコンテンツ・アイテムの凍結を解除するために使用されます。凍結を解除すると、関連付けられた処理ルールの処理に対してコンテンツ・アイテムが解放されます。

追加の必須サービス・パラメータ

- dFolderID: 処理対象のコンテンツ・アイテムの一意の識別子。

- auditComments: 凍結解除名。

- auditComments2: 凍結解除理由。

10 物理コンテンツ管理サービス

この章では、Oracle WebCenter Content: Recordsに関連付けられた物理コンテンツ管理(PCM)の使用時およびカスタマイズ時に利用できるサービスについて説明します。

この章の内容は、次のとおりです。

- 第10.1項「物理コンテンツ管理サービスについて」

- 第10.2項「物理コンテンツ管理サービス」

10.1 物理コンテンツ管理サービスについて

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

個々のPCMサービスの場所は、それぞれのサービスの説明の中で示します。

PCMの詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentのマネージング』を参照してください。

注意:

最も一般的に使用されるサービスには、より広範囲な説明があります。

10.2 物理コンテンツ管理サービス

PCM機能では、次のサービスが使用されます。

- ADD_FUNCTION_BARCODE

- ADJUST_INVOICE

- ADJUST_INVOICE_FORM

- BARCODE_PROCESS

- BATCH_STORAGE_CREATION_FORM

- BLOCK_STORAGE

- BROWSE_CHARGE_INVOICES_FORM

- BROWSE_CHARGE_TRANSACTIONS_BY_INVOICE_FORM

- BROWSE_CHARGE_TRANSACTIONS_FORM

- BROWSE_CHARGE_TRANSACTIONS_WITH_NO_INVOICE_FORM

- BROWSE_RESERVATION_ITEMS_FORM

- BROWSE_STORAGE_FORM

- CHECKIN_EXTERNAL_ITEM

- CHECKOUT_EXTERNAL_ITEM

- CLEAN_UP_STORAGE

- CONFIG_CHARGE_BACKS

- CONFIG_CHARGE_BACKS_FORM

- CONFIGURE_CHARGE_BILLERS_FORM

- CONFIGURE_CHARGE_PAYMENT_TYPES_FORM

- CONFIGURE_CHARGE_TYPES_FORM

- CREATE_CHARGE_BILLER

- CREATE_CHARGE_BILLER_FORM

- CREATE_CHARGE_PAYMENT_TYPECREATE_CHARGE_PAYMENT_TYPE_FORM

- CREATE_CHARGE_TYPE

- CREATE_CHARGE_TYPE_FORM

- CREATE_CHARGE_TRANSACTION

- CREATE_CHARGE_TRANSACTION_FORM

- CREATE_CHARGE_TRANSACTION_MULTIPLE

- CREATE_EXTERNAL_ITEM

- CREATE_EXTERNAL_ITEM_FORM

- CREATE_EXTERNAL_ITEM_SIMILAR_FORM

- CREATE_MEDIA_TYPE

- CREATE_MEDIA_TYPE_FORM

- CREATE_OBJECT_TYPE

- CREATE_OBJECT_TYPE_FORM

- CREATE_RESERVATION

- CREATE_RESERVATION_FORM

- CREATE_STORAGE

- CREATE_STORAGE_FORM

- CREATE_STORAGE_TYPE

- CREATE_STORAGE_TYPE_FORM

- DELETE_CHARGE_BILLER

- DELETE_CHARGE_INVOICE

- DELETE_CHARGE_PAYMENT_TYPE

- DELETE_CHARGE_TRANSACTION

- DELETE_CHARGE_TYPE

- DELETE_COMPLETED_RESERVATIONS

- DELETE_EXTERNAL_ITEM

- DELETE_MEDIA_TYPE

- DELETE_OBJECT_TYPE

- DELETE_RESERVATION

- DELETE_RESERVATION_ITEM

- DELETE_STORAGE

- DELETE_STORAGE_TYPE

- EDIT_CHARGE_BILLER

- EDIT_CHARGE_BILLER_FORM

- EDIT_CHARGE_PAYMENT_TYPE

- EDIT_CHARGE_TYPE_FORM

- EDIT_EXTERNAL_ITEM

- EDIT_EXTERNAL_ITEM_FORM

- EDIT_MEDIA_TYPE

- EDIT_MEDIA_TYPE_FORM

- EDIT_OBJECT_TYPE

- EDIT_OBJECT_TYPE_FORM

- EDIT_OBJECT_TYPE_RELATIONSHIPS

- EDIT_OBJECT_TYPE_RELATIONSHIPS_FORM

- EDIT_RESERVATION

- EDIT_RESERVATION_FORM

- EDIT_RESERVATION_ITEM

- EDIT_RESERVATION_ITEM_FORM

- EDIT_RESERVATION_ITEM_STATUS

- EDIT_STORAGE

- EDIT_STORAGE_FORM

- EDIT_STORAGE_TYPE

- EDIT_STORAGE_TYPE_FORM

- GENERATE_CHARGE_INVOICE

- GET_EXPORT_INVOICES

- INFO_CHARGE_BILLER_FORM

- INFO_CHARGE_INVOICE_FORM

- INFO_CHARGE_PAYMENT_TYPE_FORM

- INFO_CHARGE_TRANSACTION_FORM

- INFO_CHARGE_TYPE_FORM

- INFO_EXTERNAL_ITEM_FORM

- INFO_MEDIA_TYPE_FORM

- INFO_OBJECT_TYPE_FORM

- INFO_RESERVATION_FORM

- INFO_RESERVATION_ITEM_FORM

- INFO_STORAGE_FORM

- INFO_STORAGE_TYPE_FORM

- MARK_INVOICE_PAID

- MARK_INVOICE_PAID_FORM

- MOVE_STORAGE

- NOTIFY_OVERDUE_USERS

- PROCESS_OVERDUE_REQUESTS

- PROCESS_STORAGE_SPACE_COUNTS

- RESERVE_STORAGE

- RUN_CHARGEBACK_REPORT

- RUN_CHARGEBACK_REPORT_MULTIPLE

- RUN_FUNCTION_BARCODE_LABEL

- RUN_RESERVATION_REPORT

- RUN_RESERVATION_SEARCH_RESULTS_REPORT

- RUN_STORAGE_BARCODE_LABEL

- RUN_STORAGE_REPORT

- RUN_USER_BARCODE_LABEL

- SCREEN_CHARGE_BACKS_ADVANCED_FORM

- SCREEN_CHARGE_BACKS_FORM

- SEARCH_EXTERNAL_ITEM_FORM

- UNRESERVE_STORAGE

- UPDATE_STORAGE_DEPTHS

- UPDATE_USERS_WITH_NO_BARCODES

10.2.1 ADD_FUNCTION_BARCODE

このサービスは、新規機能バーコードを作成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dFunctionValue: 作成する機能バーコードの一意の識別子。

- dFunctionName: 作成する機能バーコードの名前。

10.2.2 ADJUST_INVOICE

このサービスは、請求書を調整するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dInvoiceID: 調整する請求書の一意の識別子。

- dAmount: 請求書に対する加算または減算額。

10.2.3 ADJUST_INVOICE_FORM

このサービスは、請求書の調整に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dInvoiceID: 調整する請求書の一意の識別子。

- dInvoiceAmount: 請求書の現在の金額。

10.2.4 BARCODE_PROCESS

このサービスは、アップロードされたバーコード・ファイルを処理するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- barcodeFile: 処理対象のファイルのパス。

10.2.5 BATCH_STORAGE_CREATION_FORM

このサービスは、ストレージ作成ユーティリティ・フォームをペイントするために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.6 BLOCK_STORAGE

このサービスは、ストレージ・ロケーションをブロックするために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dObjectID: ブロック対象のストレージ・ロケーションの一意の識別子。

10.2.7 BROWSE_CHARGE_INVOICES_FORM

このサービスは、トランザクション請求書の参照に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.8 BROWSE_CHARGE_TRANSACTIONS_BY_INVOICE_FORM

このサービスは、指定した請求書に属するトランザクションの参照に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dInvoiceID: 取得するトランザクションの請求書の一意の識別子。

10.2.9 BROWSE_CHARGE_TRANSACTIONS_FORM

このサービスは、変更トランザクションの参照に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.10 BROWSE_CHARGE_TRANSACTIONS_WITH_NO_INVOICE_FORM

このサービスは、請求書にないトランザクションの参照に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.11 BROWSE_RESERVATION_ITEMS_FORM

このサービスは、指定したリクエストに属するアイテムの参照に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: 取得するアイテムのリクエストの一意の識別子。

10.2.12 BROWSE_STORAGE_FORM

このサービスは、ストレージ・アイテムの参照に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectID: 取得するストレージ・アイテムの一意の識別子。ルートが必要な場合は、0に設定します。

10.2.13 CHECKIN_EXTERNAL_ITEM

このサービスは、リクエスト内の外部アイテムをチェックインするために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: リクエストの一意の識別子。

- dID: チェックインする物理アイテムの一意の識別子。

10.2.14 CHECKOUT_EXTERNAL_ITEM

このサービスは、リクエスト内の外部アイテムをチェックアウトするために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: リクエストの一意の識別子。

- dID: チェックアウトする物理アイテムの一意の識別子。

10.2.15 CLEAN_UP_STORAGE

このサービスは、ストレージ表のロケーション値をクリーンアップするために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

10.2.16 CONFIG_CHARGE_BACKS

このサービスはチャージバック設定を保存するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.17 CONFIG_CHARGE_BACKS_FORM

このサービスは、チャージバック設定の構成に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.18 CONFIGURE_CHARGE_BILLERS_FORM

このサービスは、顧客の参照に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.19 CONFIGURE_CHARGE_PAYMENT_TYPES_FORM

このサービスは、支払タイプの参照に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.20 CONFIGURE_CHARGE_TYPES_FORM

このサービスは、チャージ・タイプの参照に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.21 CREATE_CHARGE_BILLER

このサービスは、支払タイプの顧客を作成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dBillerTypeID: 作成する顧客の一意の識別子。

- dBillerName: 作成する顧客の名前。

10.2.22 CREATE_CHARGE_BILLER_FORM

このサービスは、顧客の作成に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.23 CREATE_CHARGE_PAYMENT_TYPE

このサービスは、支払タイプを作成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dPaymentTypeID: 作成する支払タイプの一意の識別子。

- dPaymentTypeDesc: 作成する支払タイプの名前。

10.2.24 CREATE_CHARGE_PAYMENT_TYPE_FORM

このサービスは、支払タイプの作成に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.25 CREATE_CHARGE_TYPE

このサービスは、チャージ・タイプを作成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dChargeTypeID: 作成するチャージ・タイプの一意の識別子。

- dChargeTypeDesc: 作成するチャージ・タイプの名前。

- dChargeAction: チャージ・タイプに割り当てられたアクション。

- dChargeAmount: チャージ・タイプのアクションの金額。

- dExtObjectTypes: チャージ・タイプに関連付けられたオブジェクト・タイプ。

10.2.26 CREATE_CHARGE_TYPE_FORM

このサービスは、チャージ・タイプの作成に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.27 CREATE_CHARGE_TRANSACTION

このサービスは、トランザクションを作成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dChargeTypeID: トランザクションで使用するチャージ・タイプの一意の識別子。

- dChargeAction: トランザクションのチャージ・アクションのタイプ。

- dID、dDocName: チャージ外部アイテムの一意の識別子または名前(ストレージ・チャージ・アクションでない場合)。

- dChargeAmount: トランザクションの金額。

10.2.28 CREATE_CHARGE_TRANSACTION_FORM

このサービスは、トランザクションの作成に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.29 CREATE_CHARGE_TRANSACTION_MULTIPLE

このサービスは、トランザクションを作成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dIDList: トランザクションの作成対象のアイテムのdIDのカンマ区切りリスト。

- dChargeTypeID: トランザクションで使用するチャージ・タイプの一意の識別子。

- dChargeAction: トランザクションのチャージ・アクションのタイプ。

- dChargeAmount: トランザクションの金額。

10.2.30 CREATE_EXTERNAL_ITEM

このサービスは、物理アイテムを作成するために使用されます。

場所: IdcHomeDir/components/ExternalHelper/resources/erm_service.htm

追加の必須サービス・パラメータ

- dSource: 外部アイテムの作成対象のソース(例: Physical)。

- dDocTitle: 作成する外部アイテムのタイトル。

- その他: ユーザーが必須に設定する任意のフィールド。

10.2.31 CREATE_EXTERNAL_ITEM_FORM

このサービスは、物理アイテムの作成に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/ExternalHelper/resources/erm_service.htm

追加の必須サービス・パラメータ

- dSource: 外部アイテムの作成場所のソース(例: Physical)。

10.2.32 CREATE_EXTERNAL_ITEM_SIMILAR_FORM

このサービスは、別の外部アイテムと類似する物理アイテムの作成に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/ExternalHelper/resources/erm_service.htm

追加の必須サービス・パラメータ

- dSource: 外部アイテムの作成場所のソース(例: Physical)。

- dID: 類似アイテムの作成元の外部アイテムの一意の識別子。

10.2.33 CREATE_MEDIA_TYPE

このサービスは、メディア・タイプを作成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dMediaTypeID: 作成するメディア・タイプの一意の識別子。

- dMediaTypeName: メディア・タイプ・アイテムの名前。

10.2.34 CREATE_MEDIA_TYPE_FORM

このサービスは、メディア・タイプの作成に使用されるページを取得するために使用されます。

10.2.35 CREATE_OBJECT_TYPE

このサービスは、オブジェクト・タイプを作成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectTypeID: 作成するオブジェクト・タイプの一意の識別子。

- dObjectTypeName: オブジェクト・タイプ・アイテムの名前。

10.2.36 CREATE_OBJECT_TYPE_FORM

このサービスは、オブジェクト・タイプの作成に使用されるページを取得するために使用されます。

10.2.37 CREATE_RESERVATION

このサービスは、予約を作成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: 作成するリクエストの一意の識別子。

- dRequestName: リクエストの名前。

- dRequestDate: リクエストの日付。

- dRequestor: リクエストの作成対象のユーザー。

- dSecurityGroup: リクエストのセキュリティ・グループ。

- dTransferMethod: リクエストの転送方法。

- dRequestPriority: リクエストの配信優先度。

- dIDList: リクエストする物理アイテムのdID値のカンマ区切りリスト。

10.2.38 CREATE_RESERVATION_FORM

このサービスは、予約の作成に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dIDList: リクエストする物理アイテムのdID値のカンマ区切りリスト。

10.2.39 CREATE_STORAGE

このサービスは、ストレージ・ロケーションを作成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dParentID: 作成するストレージ・ロケーションの親ストレージ・ロケーションの一意の識別子。

- dObjectName: 作成するストレージ・ロケーションの名前。

- dStorageType: ストレージ・ロケーションに割り当てられたロケーション・タイプの一意の識別子。

10.2.40 CREATE_STORAGE_FORM

このサービスは、ストレージ・ロケーションの作成に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dParentID: 作成するストレージ・ロケーションの親ストレージ・ロケーションの一意の識別子。

10.2.41 CREATE_STORAGE_TYPE

このサービスは、ロケーション・タイプを作成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dStorageTypeID: 作成するロケーション・タイプの一意の識別子。

- dStorageTypeName: 作成するロケーション・タイプの名前。

- dOrder: ロケーション・タイプ内でのロケーション・タイプの配置順序。

- dStorageImage: ロケーション・タイプに関連付けるイメージの名前。

10.2.42 CREATE_STORAGE_TYPE_FORM

このサービスは、ロケーション・タイプの作成に使用されるページを取得するために使用されます。

10.2.43 DELETE_CHARGE_BILLER

このサービスは、顧客を削除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dBillerID: 削除する顧客の一意の識別子。

10.2.44 DELETE_CHARGE_INVOICE

このサービスは、請求書を削除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dInvoiceID: 削除する請求書の一意の識別子。

10.2.45 DELETE_CHARGE_PAYMENT_TYPE

このサービスは、支払タイプを削除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dPaymentTypeID: 削除する支払タイプの一意の識別子。

10.2.46 DELETE_CHARGE_TRANSACTION

このサービスは、トランザクションを削除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dTransactionID: 削除するトランザクションの一意の識別子。

10.2.47 DELETE_CHARGE_TYPE

このサービスは、チャージ・タイプを削除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dChargeTypeID: 削除するチャージ・タイプの一意の識別子。

10.2.48 DELETE_COMPLETED_RESERVATIONS

このサービスは、完了した予約をシステムから削除するために使用されます。

10.2.49 DELETE_EXTERNAL_ITEM

このサービスは、物理アイテムを削除するために使用されます。

場所: IdcHomeDir/components/ExternalHelper/resources/erm_service.htm

追加の必須サービス・パラメータ

- dSource: 削除対象の外部アイテムが含まれているソース(例: Physical)。

- dID: 外部アイテムの一意の識別子。

10.2.50 DELETE_MEDIA_TYPE

このサービスは、メディア・タイプを削除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dMediaTypeID: 削除するメディア・タイプの一意の識別子。

10.2.51 DELETE_OBJECT_TYPE

このサービスは、オブジェクト・タイプを削除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectTypeID: 削除するオブジェクト・タイプの一意の識別子。

10.2.52 DELETE_RESERVATION

このサービスは、予約を削除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: 削除する予約の一意の識別子。

10.2.53 DELETE_RESERVATION_ITEM

このサービスは、リクエストからアイテムを削除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: 削除するリクエスト済アイテムの一意のリクエスト識別子。

- dID: 削除するリクエスト済アイテムの一意の識別子。

10.2.54 DELETE_STORAGE

このサービスは、ストレージ・アイテムを削除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectID: 削除するストレージ・アイテムの一意の識別子。

10.2.55 DELETE_STORAGE_TYPE

このサービスは、ロケーション・タイプを削除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dStorageTypeID: 削除するロケーション・タイプの一意の識別子。

10.2.56 EDIT_CHARGE_BILLER

このサービスは、顧客を編集するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dBillerID: 作成する顧客の一意の識別子。

- dBillerName: 作成する顧客の名前。

10.2.57 EDIT_CHARGE_BILLER_FORM

このサービスは、顧客の編集に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.58 EDIT_CHARGE_PAYMENT_TYPE

このサービスは、支払タイプを編集するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dPaymentTypeID: 作成する支払タイプの一意の識別子。

- dPaymentTypeDesc: 作成する支払タイプの名前。

10.2.59 EDIT_CHARGE_TYPE_FORM

このサービスは、チャージ・タイプの編集に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.60 EDIT_EXTERNAL_ITEM

このサービスは、物理アイテムを編集するために使用されます。

場所: IdcHomeDir/components/ExternalHelper/resources/erm_service.htm

追加の必須サービス・パラメータ

- dSource: 外部アイテムの編集対象のソース(例: Physical)。

- dID: 外部アイテムの一意の識別子。

10.2.61 EDIT_EXTERNAL_ITEM_FORM

このサービスは、物理アイテムの編集に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/ExternalHelper/resources/erm_service.htm

追加の必須サービス・パラメータ

- dSource: 編集対象の外部アイテムが含まれているソース(例: Physical)。

- dID: 外部アイテムの一意の識別子。

10.2.62 EDIT_MEDIA_TYPE

このサービスは、メディア・タイプを編集するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dMediaTypeID: 編集するメディア・タイプの一意の識別子。

- dMediaTypeName: メディア・タイプ・アイテムの名前。

10.2.63 EDIT_MEDIA_TYPE_FORM

このサービスは、メディア・タイプの編集に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dMediaTypeID: 編集するメディア・タイプの一意の識別子。

10.2.64 EDIT_OBJECT_TYPE

このサービスは、オブジェクト・タイプを編集するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectTypeID: 作成するオブジェクト・タイプの一意の識別子。

- dObjectTypeName: オブジェクト・タイプ・アイテムの名前。

10.2.65 EDIT_OBJECT_TYPE_FORM

このサービスは、オブジェクト・タイプの編集に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectTypeID: 編集するオブジェクト・タイプの一意の識別子。

10.2.66 EDIT_OBJECT_TYPE_RELATIONSHIPS

このサービスは、オブジェクト・タイプのリレーションシップを編集するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectTypeID: 作成するオブジェクト・タイプの一意の識別子。

- SelectListValues: オブジェクト・タイプが含むことができるオブジェクト・タイプのリスト。

10.2.67 EDIT_OBJECT_TYPE_RELATIONSHIPS_FORM

このサービスは、オブジェクト・タイプ・リレーションシップの編集に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectTypeID: 編集するオブジェクト・タイプ・リレーションシップの一意の識別子。

10.2.68 EDIT_RESERVATION

このサービスは、リクエスト・データを編集するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: 編集するリクエストの一意の識別子。

- dRequestName: リクエストの名前。

- dRequestDate: リクエストの日付。

- dRequestor: リクエストの作成対象のユーザー。

- dSecurityGroup: リクエストのセキュリティ・グループ。

- dTransferMethod: リクエストの転送方法。

- dRequestPriority: リクエストの配信優先度。

10.2.69 EDIT_RESERVATION_FORM

このサービスは、リクエストの編集に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: 編集するリクエストの一意の識別子。

10.2.70 EDIT_RESERVATION_ITEM

このサービスは、リクエスト済アイテム・データを編集するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: 編集するリクエストの一意の識別子。

- dID: 編集するリクエスト済アイテムの一意の識別子。

- dRequestDate: リクエストの日付。

- dRequestStatus: リクエスト済アイテムの現在のステータス。

10.2.71 EDIT_RESERVATION_ITEM_FORM

このサービスは、特定のリクエスト済アイテムの編集に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: 編集するリクエストの一意の識別子。

- dID: 編集する物理アイテムの一意の識別子。

10.2.72 EDIT_RESERVATION_ITEM_STATUS

このサービスは、リクエスト済アイテムのステータスを編集するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: 編集するリクエストの一意の識別子。

- dID: 編集するリクエスト済アイテムの一意の識別子。

- dRequestStatusNew: リクエスト済アイテムの現在のステータス。

10.2.73 EDIT_STORAGE

このサービスは、ストレージ・ロケーションを編集するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dParentID: 作成するストレージ・ロケーションの親ストレージ・ロケーションの一意の識別子。

- dObjectID: 編集するストレージ・ロケ―ションの一意の識別子。

- dObjectName: 作成するストレージ・ロケーションの名前。

- dStorageType: ストレージ・ロケーションに割り当てられたロケーション・タイプの一意の識別子。

10.2.74 EDIT_STORAGE_FORM

このサービスは、ストレージ・ロケーションの作成に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectID: 編集するストレージ・ロケ―ションの一意の識別子。

10.2.75 EDIT_STORAGE_TYPE

このサービスは、ロケーション・タイプを編集するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dStorageTypeID: 編集するロケーション・タイプの一意の識別子。

- dStorageTypeName: 編集するロケーション・タイプの名前。

- dOrder: ロケーション・タイプ内でのロケーション・タイプの配置順序。

- dStorageImage: ロケーション・タイプに関連付けるイメージの名前。

10.2.76 EDIT_STORAGE_TYPE_FORM

このサービスは、ロケーション・タイプの編集に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dStorageTypeID: 編集するロケーション・タイプの一意の識別子。

10.2.77 GENERATE_CHARGE_INVOICE

このサービスは、請求書を生成するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.78 GET_EXPORT_INVOICES

このサービスは、請求書のエクスポート・ファイルを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.79 INFO_CHARGE_BILLER_FORM

このサービスは、指定したストレージ・タイプの顧客の情報の表示に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dBillerID: 作成するストレージ・タイプの一意の識別子。

10.2.80 INFO_CHARGE_INVOICE_FORM

このサービスは、指定した請求書の情報の表示に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dInvoiceID: 取得する請求書の一意の識別子。

10.2.81 INFO_CHARGE_PAYMENT_TYPE_FORM

このサービスは、指定した支払タイプの情報の表示に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dPaymentTypeID: 取得する支払タイプの一意の識別子。

10.2.82 INFO_CHARGE_TRANSACTION_FORM

このサービスは、指定したトランザクションの情報の表示に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dTransactionID: 取得するトランザクションの一意の識別子。

10.2.83 INFO_CHARGE_TYPE_FORM

このサービスは、指定したチャージ・タイプの情報の表示に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dChargeTypeID: 取得するチャージ・タイプの一意の識別子。

10.2.84 INFO_EXTERNAL_ITEM_FORM

このサービスは、物理アイテムの情報ページを取得するために使用されます。

場所: IdcHomeDir/components/ExternalHelper/resources/erm_service.htm

追加の必須サービス・パラメータ

- dSource: 外部アイテムのソース(例: Physical)。

- dID: 外部アイテムの一意の識別子。

10.2.85 INFO_MEDIA_TYPE_FORM

このサービスは、指定したメディア・タイプの情報の表示に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dMediaTypeID: 取得するメディア・タイプの一意の識別子。

10.2.86 INFO_OBJECT_TYPE_FORM

このサービスは、指定したオブジェクト・タイプの情報の表示に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectTypeID: 取得するオブジェクト・タイプの一意の識別子。

10.2.87 INFO_RESERVATION_FORM

このサービスは、指定したリクエストの情報の表示に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: 取得するリクエストの一意の識別子。

- dID: 取得する物理アイテムの一意の識別子。

10.2.88 INFO_RESERVATION_ITEM_FORM

このサービスは、指定したリクエスト済物理アイテムの情報を表示に使用されるページを取得するために使用されます。

追加の必須サービス・パラメータ

- dRequestID: 取得するリクエストの一意の識別子。

10.2.89 INFO_STORAGE_FORM

このサービスは、指定したストレージ・アイテムの情報の表示に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectID: 取得するストレージ・アイテムの一意の識別子。

10.2.90 INFO_STORAGE_TYPE_FORM

このサービスは、指定したストレージ・タイプの情報の表示に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dStorageTypeID: 取得するストレージ・アイテムの一意の識別子。

10.2.91 MARK_INVOICE_PAID

このサービスは、請求書を支払済としてマークするために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dInvoiceID: 支払済としてマークする請求書の一意の識別子。

- dPaymentType: 支払タイプの一意の識別子。

- dPaymentNumber: クレジット・カードまたは小切手の番号、あるいはその他の番号。

- dExpirationDate: クレジット・カードの有効期限(クレジット・カードを使用している場合)または空白。

- dAmount: 支払金額。

10.2.92 MARK_INVOICE_PAID_FORM

このサービスは、請求書を支払済としてマークするために使用されるページの取得に使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- dInvoiceID: 支払済としてマークする請求書の一意の識別子。

- dInvoiceAmount: 請求書の現在の金額。

10.2.93 MOVE_STORAGE

このサービスは、ストレージ・アイテムを別のアイテムに移動するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectID: 移動するストレージ・アイテムの一意の識別子。

- newParentID: 移動先のストレージ・アイテム(親ストレージ・アイテム)の一意の識別子。

10.2.94 NOTIFY_OVERDUE_USERS

このサービスは、期限切れリクエストについてユーザーに通知するために使用されます。

10.2.95 PROCESS_OVERDUE_REQUESTS

このサービスは、期限切れになったリクエストを更新するために使用されます。

10.2.96 PROCESS_STORAGE_SPACE_COUNTS

このサービスは、ストレージ・カウントを更新するために使用されます。つまり、このサービスでは、各レベルで使用されるスペース数が更新されます。

10.2.97 RESERVE_STORAGE

このサービスは、ストレージ・ロケーションを予約するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectID: 予約するストレージ・ロケーションの一意の識別子。

- dRequestor: ストレージの予約者のユーザーID。

10.2.98 RUN_CHARGEBACK_REPORT

このサービスは、請求書レポートを実行するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- rpReportTemplate: レポートに使用するレポート・テンプレート。

- rpReportType: 実行するレポートのレポート・タイプ。

10.2.99 RUN_CHARGEBACK_REPORT_MULTIPLE

このサービスは、請求書レポートを実行するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

追加の必須サービス・パラメータ

- rpReportTemplate: レポートに使用するレポート・テンプレート。

- rpReportType: 実行するレポートのレポート・タイプ。

- selectedDocList: レポート対象の請求書IDのカンマ区切りのリスト。

10.2.100 RUN_FUNCTION_BARCODE_LABEL

このサービスは、機能バーコード・レポートを実行するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

10.2.101 RUN_RESERVATION_REPORT

このサービスは、予約レポートを実行するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dRequestID: レポートの実行対象のリクエストの一意の識別子。

10.2.102 RUN_RESERVATION_SEARCH_RESULTS_REPORT

このサービスは、予約検索結果レポートを実行するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- QueryText: 予約を取得するために実行する問合せ。

10.2.103 RUN_STORAGE_BARCODE_LABEL

このサービスは、ストレージ・ラベル・レポートを実行するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectID: レポートの実行対象のストレージ・アイテムの一意の識別子。

10.2.104 RUN_STORAGE_REPORT

このサービスは、ストレージ・レポートを実行するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectID: レポートの実行対象のストレージ・アイテムの一意の識別子。

10.2.105 RUN_USER_BARCODE_LABEL

このサービスは、ユーザー・レポートを実行するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dSelectUser: レポートの実行対象のユーザーの一意の識別子。

- dPrintAllUsers: 特定のユーザーではなくすべてのユーザーに対して実行するかどうかを設定するフラグ。

10.2.106 SCREEN_CHARGE_BACKS_ADVANCED_FORM

このサービスは、詳細ページを使用して請求書を生成するためのページの取得に使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.107 SCREEN_CHARGE_BACKS_FORM

このサービスは、請求書の生成に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/chargebacks_service.htm

10.2.108 SEARCH_EXTERNAL_ITEM_FORM

このサービスは、物理アイテムの検索に使用されるページを取得するために使用されます。

場所: IdcHomeDir/components/ExternalHelper/resources/erm_service.htm

追加の必須サービス・パラメータ

- dSource: 外部アイテムの検索先のソース(例: Physical)。

10.2.109 UNRESERVE_STORAGE

このサービスは、ストレージ・ロケーションの予約を解除するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

追加の必須サービス・パラメータ

- dObjectID: 予約を解除するストレージ・ロケーションの一意の識別子。

10.2.110 UPDATE_STORAGE_DEPTHS

このサービスは、ストレージ・アイテムのdDepth値を更新するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

10.2.111 UPDATE_USERS_WITH_NO_BARCODES

このサービスは、バーコード値がないユーザーを更新するために使用されます。

場所: IdcHomeDir/components/PhysicalContentManager/resources/pcm_service.htm

11 拡張ユーザー属性サービス

この章では、拡張ユーザー属性コンポーネントの使用時およびカスタマイズ時に利用可能なOracle WebCenter Contentサービスについて説明します。

この章の内容は、次のとおりです。

- 第11.1項「拡張ユーザー属性サービスについて」

- 第11.2項「拡張ユーザー属性サービス」

11.1 拡張ユーザー属性サービスについて

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

個々の拡張ユーザー属性サービスの場所は、それぞれのサービスの説明の中で示します。

注意:

最も一般的に使用されるサービスには、より広範囲な説明があります。

11.2 拡張ユーザー属性サービス

Content Serverインスタンスのインストール時には、次の拡張ユーザー属性コンポーネント・サービスがインストールされます。

- ADD_EXTENDED_USER_ATTRIBUTES

- EDIT_EXTENDED_USER_ATTRIBUTES

- DELETE_EXTENDED_USER_ATTRIBUTES

- DELETE_EXTENDED_ATTRIBUTES_BY_APPLICATION

- DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_USER

- DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_APPLICATION

- QUERY_EXTENDED_USER_ATTRIBUTES

- QUERY_EXTENDED_ATTRIBUTE_MAPPINGS

- EC_SET_PROPERTY

- EC_DELETE_PROPERTY

- EC_GET_PROPERTY

- EC_GET_PROPERTY_BY_KEY

- SET_DEFAULT_ATTRIBUTES

- DELETE_DEFAULT_ATTRIBUTES

- GET_DEFAULT_ATTRIBUTES

- SET_EXTENDED_ATTRIBUTE_MAPPINGS

- DELETED_EXTENDED_ATTRIBUTE_MAPPINGS

次のサービスは、拡張ユーザー属性コンポーネントをサポートするように拡張されました。

- ADD_USER

- EDIT_USER

- DELETE_USER

- QUERY_USER_ATTRIBUTES

11.2.1 ADD_EXTENDED_USER_ATTRIBUTES

ユーザーに対して拡張属性を追加するサービス。このサービスを使用する前にユーザーが存在することは、必須条件ではありません。すでに存在する拡張属性をユーザーに対して追加するようにこのサービスに要求した場合、このサービスは以前のエントリを変更します。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dName: ユーザー名。

- ExtUserAttribInfo Resultset: 拡張ユーザー属性情報を格納する結果セット。

オプションのサービス・パラメータ

- CheckUserMustExist: trueに設定すると、拡張属性の追加前に、ユーザーが存在していることを検証する限定チェックが実行されます。このチェックはローカル・ユーザーに対してのみ機能します。標準のサービス・コールでこの値を設定することはお薦めしません。

例

add_user_attr.txtの次の例は、このサービスの使用方法を示しています。

# Add a security group and an account to the user's extended attributes
# with different applications
@Properties LocalData
IdcService=ADD_EXTENDED_USER_ATTRIBUTES
dName=jsmith
@end
@ResultSet ExtUserAttribInfo
3
dUserName
dApplication
AttributeInfo
jsmith
appl
account,abc/def,15
jsmith
app2
role,contributor,15
@end

11.2.2 EDIT_EXTENDED_USER_ATTRIBUTES

ユーザーの拡張ユーザー属性を編集するサービス。このサービスを使用する前にユーザーが存在することは、必須条件ではありません。以前の拡張属性はすべて、指定した新しい拡張属性に置換されます。

場所:

IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dName: ユーザー名。

- ExtUserAttribInfo ResultSet: 拡張ユーザー属性情報を格納する結果セット。

オプションのサービス・パラメータ

- CheckUserMustExist: trueに設定すると、拡張属性の追加前に、ユーザーが存在していることを検証する限定チェックが実行されます。このチェックはローカル・ユーザーに対してのみ機能します。標準のサービス・コールでこの値を設定することはお薦めしません。

例

edit_user_attr.txtの次の例は、このサービスの使用方法を示しています。

# Change the user to have all permissions with #all
@Properties LocalData
IdcService=EDIT_EXTENDED_USER_ATTRIBUTES
dName=jsmith
@end
@ResultSet ExtUserAttribInfo
3
dUserName
dApplication
AttributeInfo
jsmith
appl
account,\#all,15
@end

11.2.3 DELETE_EXTENDED_USER_ATTRIBUTES

ユーザーの特定の拡張ユーザー属性を削除するサービス。

場所:

IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dName: ユーザー名。

- ExtUserAttribInfo ResultSet: 拡張ユーザー属性情報を格納する結果セット。

- allowMissingAttributes: trueに設定すると、存在しない属性を削除しようとしたときのエラーが抑止されます(デフォルトはfalse)。

オプションのサービス・パラメータ

- CheckUserMustExist: trueに設定すると、拡張属性の追加前に、ユーザーが存在していることを検証する限定チェックが実行されます。このチェックはローカル・ユーザーに対してのみ機能します。標準のサービス・コールでこの値を設定することはお薦めしません。

例

# Delete the #all account from extended attributes for jsmith
@Properties LocalData
IdcService=DELETE_EXTENDED_USER_ATTRIBUTES
dName=jsmith
@end
@ResultSet ExtUserAttribInfo
3
dUserName
dApplication
AttributeInfo
jsmith
appl
account,\#all,15
@end

11.2.4 DELETE_EXTENDED_ATTRIBUTES_BY_APPLICATION

指定したアプリケーションの特定のロール/アカウントのすべての拡張属性を削除するサービス。

場所:

IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dAttributeType: 削除する属性のタイプ。

- dAttributeName: 削除する属性の名前。

- dApplication: 削除対象の属性が含まれているアプリケーション。

例

delete_attr_by_app.txtの次の例は、このサービスの使用方法を示しています。

# Delete the xyz account from extended attributes for appl
@Properties LocalData
IdcService=DELETE_EXTENDED_ATTRIBUTES_BY_APPLICATION
dAttributeName=xyz
dAttributeType=account
dApplication=appl
@end

11.2.5 DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_USER

ユーザーのすべての拡張属性を削除するサービス。

追加の必須サービス・パラメータ

- dName: ユーザー名。

オプションのサービス・パラメータ

- CheckUserMustExist: trueに設定すると、拡張属性の追加前に、ユーザーが存在していることを検証する限定チェックが実行されます。このチェックはローカル・ユーザーに対してのみ機能します。標準のサービス・コールでこの値を設定することはお薦めしません。

例

delete_user_attr_all.txtの次の例は、このサービスの使用方法を示しています。

# Add roles
@Properties LocalData
IdcService=DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_USER
dName=jsmith
@end

11.2.6 DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_APPLICATION

アプリケーションのすべての拡張ユーザー属性を削除するサービス。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dApplication: アプリケーション。

例

del_all_attr_app.txtの次の例は、このサービスの使用方法を示しています。

# Delete all extended attribute information for appl
@Properties LocalData
IdcService=DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_APPLICATION
dApplication=appl
@end

11.2.7 QUERY_EXTENDED_USER_ATTRIBUTES

ユーザーのすべての拡張属性をバインダ内の結果セットに配置するサービス。すべてのデータがExtUserAttribInfo ResultSetに入力されます。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dName: ユーザー名。

オプションのサービス・パラメータ

- dApplication: 属性のアプリケーション名。

- dAttributeType: 属性のタイプ。

- dAttributeName: 属性の名前。

例

1つ以上のオプション・パラメータを追加することによって、問合せをより柔軟に絞り込むことができます。query_user_attr_ext.txtの次の例は、このサービスの使用方法を示しています。

# Query the extended attributes of a user
@Properties LocalData
IdcService=QUERY_EXTENDED_USER_ATTRIBUTES
dName=jsmith
@end

11.2.8 QUERY_EXTENDED_ATTRIBUTE_MAPPINGS

特定の属性からのマップされたすべての拡張属性をバインダ内の結果セットに配置するサービス。すべてのデータがExtUserAttribInfo ResultSetに入力されます。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dMappedAttributeName: マップする属性の名前。

オプションのサービス・パラメータ

- dApplication: 属性のアプリケーション名。

- dAttributeType: 属性のタイプ。

- dAttributeName: 属性の名前。

例

1つ以上のオプション・パラメータを追加することによって、問合せをより柔軟に絞り込むことができます。query_attr_map_ext.txtの次の例は、このサービスの使用方法を示しています。

<?hda version="11gR1-dev" jcharset=Cp1252 encoding=iso-8859-1?>

# Query the attributes mapped from role 'guest'
@Properties LocalData
IdcService=QUERY_EXTENDED_ATTRIBUTE_MAPPINGS
dMappedAttributeName=guest
@end

11.2.9 EC_SET_PROPERTY

拡張構成プロパティを設定するサービス。新規プロパティの追加または既存のプロパティの編集に使用できます。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dECPropType: プロパティのタイプ。

- dECPropKey: キー(通常、dECPropTypeに関連)。

- dECPropValue: プロパティ値。

オプションのサービス・パラメータ

- dECPropSubKey: (推奨) 2番目のキー。たとえば、dECPropTypeおよびdEDPropKeyによる定義内容の機能をこのキーとして指定できます。

例

set_property.txtの次の例は、このサービスの使用方法を示しています。

# Set an extended configuration property
@Properties LocalData
IdcService=EC_SET_PROPERTY
dECPropType=account
dECPropKey=#abc
dECPropSubKey=URL
dECPropValue=http://www.example.com
@end

11.2.10 EC_DELETE_PROPERTY

拡張構成プロパティを削除するサービス。削除対象のキーを正確に指定することが重要です。このサービスでは、キー内のすべてのサブキーの自動削除は実行されません。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dECPropType: プロパティのタイプ。

- dECPropKey: キー(通常、dECPropTypeに関連)。

オプションのサービス・パラメータ

- dECPropSubKey: (推奨) 2番目のキー。たとえば、dECPropTypeおよびdEDPropKeyによる定義内容の機能をこのキーとして指定できます。

例

del_property.txtの次の例は、このサービスの使用方法を示しています。

# Delete an extended configuration property
@Properties LocalData
IdcService=EC_DELETE_PROPERTY
dECPropType=account
dECPropKey=#abc
dECPropSubKey=URL
@end

11.2.11 EC_GET_PROPERTY

指定した拡張構成プロパティをResultSet PROPERTY_LISTに返すサービス。対象のキーを正確に指定することが重要です。そのキーのみ(サブキーではなく)に基づいて検索する場合は、EC_GET_PROPERTY_BY_KEYを使用します。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dECPropType: プロパティのタイプ。

- dECPropKey: キー(通常、dECPropTypeに関連)。

オプションのサービス・パラメータ

- dECPropSubKey: (推奨) 2番目のキー。たとえば、dECPropTypeおよびdEDPropKeyによる定義内容の機能をこのキーとして指定できます。

例

get_property.txtの次の例は、このサービスの使用方法を示しています。

# Retrieve an extended configuration property
@Properties LocalData
IdcService=EC_GET_PROPERTY
dECPropType=account
dECPropKey=#abc
dECPropSubKey=URL
@end

11.2.12 EC_GET_PROPERTY_BY_KEY

指定した拡張構成プロパティをResultSet PROPERTY_LISTに返すサービス。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dECPropType: プロパティのタイプ。

- dECPropKey: キー(通常、dECPropTypeに関連)。

例

get_property_by_key.txtの次の例は、このサービスの使用方法を示しています。

# Retrieve an extended configuration property by key - gets all
# accounts of key #abc (regardless of subkey)
@Properties LocalData
IdcService=EC_GET_PROPERTY_BY_KEY
dECPropType=account
dECPropKey=#abc
@end

11.2.13 SET_DEFAULT_ATTRIBUTES

常にユーザーに適用されるいくつかのデフォルト属性を設定するサービス。タイプはdefaultsで、キーはuserattributesです。したがって、これらの指定は不要です。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- dDefAttribs: 3つのエントリで構成される、カンマ区切りのエントリの形式のデフォルト属性。

オプションのサービス・パラメータ

- dECPropSubKey: 2番目のキー。このキーが指定されているかどうかにかかわらず、デフォルト属性はすべてのユーザーに対してロードされます。

- IsSecureDefaultAttribute: デフォルトのWebサービス( )の使用時にこのパラメータをデータ・バインダとともに使用した場合、値を1に設定すると、ログインしているユーザーにのみ適用されるデフォルトが登録されます。(デフォルトでは、デフォルト属性は、anonymousも含むすべてのユーザーに適用されます。)

例

set_defs.txtの次の例は、このサービスの使用方法を示しています。

# Sets some default attributes for all users
@Properties LocalData
IdcService=SET_DEFAULT_ATTRIBUTES
dECPropSubKey=extprops
dDefAttribs=account,#abc,15
@end

11.2.14 DELETE_DEFAULT_ATTRIBUTES

常にユーザーに適用されるいくつかのデフォルト属性を削除するサービス。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

オプションのサービス・パラメータ

- dECPropSubKey: 2番目のキー。このパラメータが指定されていないと、このサービスはサブキーなしで指定されているデフォルト属性のみを削除します。他の属性は削除されません。

- IsSecureDefaultAttribute: デフォルトのWebサービス( )の使用時にこのパラメータをデータ・バインダとともに使用した場合、値を1に設定すると、ログインしているユーザーにのみ適用されるデフォルトが削除されます。(デフォルトでは、デフォルト属性は、anonymousも含むすべてのユーザーに適用されます。)

例

del_defs.txtの次の例は、このサービスの使用方法を示しています。

# Deletes some default attributes for all users
@Properties LocalData
IdcService=DELETE_DEFAULT_ATTRIBUTES
dECPropSubKey=extprops
@end

11.2.15 GET_DEFAULT_ATTRIBUTES

このサービスは、すべてのユーザーに適用されるデフォルト属性をResultSet DEFAULT_ATTRIBUTESに返します。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

オプションのサービス・パラメータ

- dECPropSubKey: 指定すると、デフォルト属性の検索が、このサブキーに一致するものに絞り込まれます。

- IsSecureDefaultAttribute: デフォルトのWebサービス( )の使用時にこのパラメータをデータ・バインダとともに使用した場合、値を1に設定すると、ログインしているユーザーにのみ適用されるデフォルトが取得されます。(デフォルトでは、デフォルト属性は、anonymousも含むすべてのユーザーに適用されます。)

例

get_defs.txtの次の例は、このサービスの使用方法を示しています。

# Returns all default attributes for all users
@Properties LocalData
IdcService=GET_DEFAULT_ATTRIBUTES
@end

11.2.16 SET_EXTENDED_ATTRIBUTE_MAPPINGS

あるユーザー属性から別のユーザー属性へのマッピングを設定するサービス。ロールから他の属性へのマッピングのみがサポートされています(ソースがアカウントの場合、マッピングは機能しません)。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- ExtUserAttribInfo: 拡張ユーザー属性情報を格納する結果セット。

例

set_attr_mapping.txtの次の例は、このサービスの使用方法を示しています。

<?hda version="11gR1-dev" jcharset=Cp1252 encoding=iso-8859-1?>

# Add the 'contributor' role to all users with the
# 'guest' role, and then consequently give all users
# with the 'contributor' role read/write access to
# account 'abc'. (This does mean that users with
# the 'guest' role ultimately end up with access to 'abc').
@Properties LocalData
IdcService=SET_EXTENDED_ATTRIBUTE_MAPPINGS
@end
@ResultSet ExtUserAttribInfo
3
dAttributeName
dApplication
guest
appl
role,contributor,15
contributor
app2
account,abc,3
@end

11.2.17 DELETED_EXTENDED_ATTRIBUTE_MAPPINGS

あるユーザー属性から別のユーザー属性へのマッピングを削除するサービス。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

追加の必須サービス・パラメータ

- ExtUserAttribInfo: 拡張ユーザー属性情報を格納する結果セット。

オプションのサービス・パラメータ

- allowMissingAttributes: trueに設定すると、存在しない属性を削除しようとしたときのエラーが抑止されます。デフォルトは、falseです。

例

del_attr_mapping.txtの次の例は、このサービスの使用方法を示しています。

<?hda version="11gR1-dev" jcharset=Cp1252 encoding=iso-8859-1?>

# Delete two attribute mappings
@Properties LocalData
IdcService=DELETE_EXTENDED_ATTRIBUTE_MAPPINGS
@end
@ResultSet ExtUserAttribInfo
3
dAttributeName
dApplication
AttributeInfo
guest
appl
role,contributor,15
contributor
app2
account,abc,3
@end

11.2.18 ADD_USER

このサービスは変更され、ユーザーの追加時に拡張ユーザー属性も同時に追加されるようになりました。詳細は、第4.14.4項「ADD_USER」を参照してください。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

オプションのサービス・パラメータ

- ExtUserAttribInfo ResultSet: 拡張ユーザー属性情報を格納する結果セット。これを含んでいない場合、拡張属性は追加されません。

例

add_user.txtの次の例は、このサービスの使用方法を示しています。

# Add user with extended security data
@Properties LocalData
IdcService=ADD_USER
dName=jsmith
dUserAuthType=Local
dFullName=Jennifer Smith
dPassword=password
dEmail=email@example.com
@end
@ResultSet UserAttribInfo
2
dUserName
AttributeInfo
jsmith
role,guest,15
@end
@ResultSet ExtUserAttribInfo
3
dUserName
dApplication
AttributeInfo
jsmith
appl
account,abc,15
@end

11.2.19 EDIT_USER

このサービスは変更され、拡張ユーザー属性も同時に編集できるようになりました。以前の値のすべてが新しい値に置換されます。詳細は、第4.14.4項「ADD_USER」を参照してください。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

オプションのサービス・パラメータ

- ExtUserAttribInfo ResultSet: 拡張ユーザー属性情報を格納する結果セット。これを含んでいない場合、拡張属性は置換されません。

例

edit_user.txtの次の例は、このサービスの使用方法を示しています。

# Edit user with extended security data
@Properties LocalData
IdcService=EDIT_USER
dName=jsmith
dUserAuthType=Local
dFullName=Justin Smith
dPassword=12345
dEmail=real@real.com
@end
@ResultSet UserAttribInfo
2
dUserName
AttributeInfo
jsmith
role,guest,15
@end
@ResultSet ExtUserAttribInfo
3
dUserName
dApplication
AttributeInfo
jsmith
appl
account,abc,7,account,xyz,15
@end

11.2.20 DELETE_USER

このサービスは変更され、ユーザーの拡張属性が削除されるようになりました(拡張属性が存在する場合)。詳細は、第4.14.10項「DELETE_USER」を参照してください。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

例

delete_user.txtの次の例は、このサービスの使用方法を示しています。

# Delete user with extended security data
@Properties LocalData
IdcService=DELETE_USER
dName=jsmith
@end

11.2.21 QUERY_USER_ATTRIBUTES

このサービスは通常どうり動作しますが、このサービスによって返される属性はgetAllAttributesパラメータに依存します。このパラメータがtrueとして渡された場合、このサービスは通常のユーザー属性と拡張ユーザー属性の混合を返します。詳細は、第4.14.25項「QUERY_USER_ATTRIBUTES」を参照してください。

場所: IdcHomeDir/components/ExtendedUserAttributes/resources/extendeduserattributes_services.htm

例

query_user_attr.txtの次の例は、このサービスの使用方法を示しています。

# The normal QUERY_USER_ATTRIBUTES, except it gathers all
# attributes now
@Properties LocalData
IdcService=QUERY_USER_ATTRIBUTES
dName=jsmith
getAllAttributes=true
@end

12 フォリオ・サービス

この章では、フォリオ・コンポーネントの使用時およびカスタマイズ時に利用可能なOracle WebCenter Contentサービスについて説明します。

この章の内容は、次のとおりです。

- 第12.1項「フォリオ・サービスについて」

- 第12.2項「フォリオ・サービス」

12.1 フォリオ・サービスについて

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

個々のフォリオ・サービスの場所は、それぞれのサービスの説明の中で示します。

フォリオの詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentのマネージング』を参照してください。

注意:

最も一般的に使用されるサービスには、より広範囲な説明があります。

12.2 フォリオ・サービス

この項では、次のサービスについて説明します。

- LOAD_FOLIO_NODE

- UPDATE_FOLIO

- CHECKIN_NEW_FOLIO

- CREATE_FOLIO_SNAPSHOT

- LOCK_FOLIO

- UNLOCK_FOLIO

- CREATE_FOLIO_RENDITION

- GENERATE_GUIDS

12.2.1 LOAD_FOLIO_NODE

リクエストされたノードの直下の子であるノード、スロットおよびリンクを返すことによて、フォリオ・ノードのコンテンツを表示するサービス。デフォルトでは、このサービスは再帰的ではありません。再帰的にコールされた場合、このサービスは完全なフォリオを返します。

場所: IdcHomeDir/components/ContentContentFolios/resources/cpd_service.htm

追加の必須サービス・パラメータ

- dID: フォリオのコンテンツID。

- RevisionSelectionMethod: 取得した情報を最新のリビジョンに基づいて使用するか、最新リリースのバージョンに基づいて使用するかをContent Serverインスタンスに指示します。最新のリビジョンの場合、未リリースの状態であることがあります。値は、Specific、Latest (未リリースの場合があります)またはLatest Releasedです。

オプションのサービス・パラメータ

- parentNodeId: フォリオ内の指定したノードのコンテンツの詳細を取得します。プロパティは取得されません。このパラメータを省略すると、デフォルトで、ルート・ノードとそのプロパティが取得されます。

例1

http://myserver/idc/idcplg?IdcService=LOAD_FOLIO_NODE&dID=68095
&RevisionSelectionMethod=Specific

例2

http://myserver/idc/idcplg?IdcService=LOAD_FOLIO_NODE&dID=68095
&RevisionSelectionMethod=Specific&parentNodeId=E176-3B00-1D2A-A592-E0CF

12.2.2 UPDATE_FOLIO

フォリオに1つ以上のコンテンツを追加し、フォリオを変更するサービス。複数の変更を1回のサービス・コールの一部としてリクエストできます。

前提条件: フォリオにアイテムを追加するためには、事前に標準のCHECKIN_NEWまたはCHECKIN_UNIVERSALサービスを使用してそのアイテムをContent Serverインスタンスにチェックインする必要があります。

場所: IdcHomeDir/components/ContentContentFolios/resources/cpd_service.htm

追加の必須サービス・パラメータ

- NumChanges: サービス・コールの一部として渡す変更または更新の数を指定します。たとえば、2つの変更を渡す場合は、NumChanges=2とします。

- change(n-1): フォリオに適用する実際の変更を指定します。デフォルトでは、変更は1つです。これは、change()またはchange0によって示されます。フォリオに対する変更数(NumChangesで指定)が複数の場合は、個々の変更ごとにパラメータを渡す必要があります。たとえば、NumChanges=3の場合は、change()、change1およびchange2となります。

注意:

個々のchange(n-1)パラメータごとに、change_data(n-1)パラメータを使用する必要があります。たとえば、change1パラメータを指定した場合は、change_data1パラメータも指定する必要があります。

change(n-1)パラメータの値は、dID:Operation:TargetGUID:ParentGUIDの形式にする必要があります。

- dID: 更新するフォリオのdID。

- Operation: 次の選択肢のいずれか。

- removeNode: ノードの削除

- addNode: ノードの追加

- addItem: スロットの追加

- addContent: 実際のファイルの追加

- removeContent: コンテンツ・アイテムの削除

- modifyAttribute: プロパティの変更

- modifyTemplateAttribute: テンプレート・プロパティの変更

- TargetGUID: 変更するフォリオ内のノード、スロットまたはコンテンツ・アイテムのGUID。

- ParentGUID: 変更するモード、スロットまたはコンテンツ・アイテムの親GUID。これは、addNodeなどの一部の操作にのみ関連します。

- change_data(n-1): change(n-1)パラメータで指定した操作の値を指定します。このパラメータの形式は、カンマで区切ったname:valueペアです。いずれかの名前または値でコロン(:)が必要な場合は、カレット(^)をセパレータとして使用できます(name:name^value)。
コンテンツを追加するときには、次のプロパティを指定する必要があります。

- dDocAuthor

- dDocName

- dDocName_encoded

- dDocTitle

- dDocType

- dFormat

- dID

- docURL

- docURL_encoded

- dOriginalName

- dRevLabel

プロパティ情報は、フォリオに追加するアイテムに対してDOC_INFOサービス・コールを使用することによって取得できます。dDocName_encoded、docURLおよびdocURL_encodedプロパティに関する情報を提供する必要があります。フォリオ定義に追加するカスタム・プロパティは、XCSTまたはXCSDデータとして指定できます。

例1

既存のコンテンツ・フォリオに新規コンテンツ・アイテムを追加するには、2つの変更を定義する必要があります。最初の変更操作ではaddItemを指定します。これによって、スロットが追加されます。2番目の変更操作ではaddContentを指定します。これによって、ドキュメントがスロットに挿入されます。両方の変更について、change_dataパラメータでコンテンツのプロパティを指定する必要があります。プロパティのxcsd^nameおよびxcst^nameの指定も行う必要があります。

IdcService=UPDATE_FOLIO
NumChanges=2
dDocName=OCS_223948
RevisionSelectionMethod=Latest
change0=8611:addItem:4952-6EBE-1275-0A59-0D19:F5C4-A3D0-E671-D4CF-9C28
change_data0=xcsd^dFormat:application/vnd.ms-excel,id:4952-6EBE-1275-0A59-0D19,
xcsd^dID:18251,xcsd^dDocTitle:Next Year Goals,xcsd^dDocType:Document,xcsd^dRendition1:T,
xcsd^dRevLabel:3,xcsd^dOriginalName:Next Year Goals.xls,xcsd^dDocAuthor:weblogic,
xcsd^docURL:/cs/groups/Secure/documents/Document/OCS_158654.xls,xcsd^dDocName_encoded:OCS_158654,
xcsd^docURL_encoded:%2Fcs%2Fgroups%2FSecure%2Fdocuments%2FDocument%2FEOCS_158654.xls,
xcst^name:Next Year Goals,xcst^description:
change1=8611:addContent:4952-6EBE-1275-0A59-0D19
change_data1=xcsd^dFormat:application/vnd.ms-excel,id:4952-6EBE-1275-0A59-0D19,
xcsd^dDocName:OCS_158654,xcsd^dID:18251,xcsd^dDocTitle:Next Year Goals,xcsd^dDocType:Document,
xcsd^dRendition1:T,xcsd^dRevLabel:3,xcsd^dOriginalName:Next Year Goals.xls,
xcsd^dDocAuthor:weblogic,xcsd^docURL:/cs/groups/Secure/documents/Document/OCS_158654.xls,
xcsd^dDocName_encoded:OCS_158654,
xcsd^docURL_encoded:%2Fcs%2Fgroups%2FSecure%2Fdocuments%2FDocument%2FEOCS_158654.xls,
xcst^name:Next Year Goals,xcst^description:

例2

RIDCコードの一部として既存のフォリオに新規コンテンツ・アイテムを追加する手順は次のとおりです。

// Start a new client connection to UCM
IdcClientManager manager = new IdcClientManager();
// build a client that will communicate using the intradoc protocol
IdcClient idcClient = manager.createClient("idc://localhost:4444");

// create a trusted user connection to UCM
IdcContext userContext = new IdcContext("weblogic");

// create the binder for the set of GUIDs needed later on
DataBinder guidBinder = idcClient.createBinder();
// populate the binder with the parameters
guidBinder.putLocal("IdcService", "GENERATE_GUIDS");

// send the request and get the response back from local data and result set
ServiceResponse guidResponse = idcClient.sendRequest(userContext, guidBinder);
DataBinder folderData = guidResponse.getResponseAsBinder ();
DataResultSet guidResults = folderData.getResultSet ("GUID_SET");

// put the set of GUIDs in an array
String guids[] = new String[25];
int n = 0;
for (DataObject dataObject : guidResults.getRows ()) {
guids[n] = dataObject.get("id");
}

// create the binder to get the content information of the document to add
DataBinder docInfoBinder = idcClient.createBinder();
// populate the binder with the parameters
docInfoBinder.putLocal("IdcService", "DOC_INFO_BY_NAME");
docInfoBinder.putLocal("dDocName", "OCS_158654");

// send the request and get the response back from local data and result set
ServiceResponse infoResponse = idcClient.sendRequest(userContext, docInfoBinder);
DataBinder infoData = infoResponse.getResponseAsBinder ();
DataResultSet docInfoResults = infoData.getResultSet ("DOC_INFO");

// create the binder to get the content information of the folio to update
DataBinder folioInfoBinder = idcClient.createBinder();
// populate the binder with the parameters
folioInfoBinder.putLocal("IdcService", "DOC_INFO_BY_NAME");
folioInfoBinder.putLocal("dDocName", "OCS_223948);

// send the request and get the response back from local data and result set
ServiceResponse folioInfoResponse = idcClient.sendRequest(userContext, folioInfoBinder);
DataBinder folioInfoData = folioInfoResponse.getResponseAsBinder ();
ataResultSet folioInfoResults = folioInfoData.getResultSet ("DOC_INFO");
String foliodID = folioInfoData.getLocal("dID");

// build the change data string for the content
String newItemStr = "";
for (DataObject dataObject : docInfoResults.getRows ()) {
// build the path to the document
String urlStr = "/cs/groups/" + dataObject.get ("dSecurityGroup") + "/documents/" + dataObject.get ("dDocType") + "/" + dataObject.get ("dDocName") + "." + dataObject.get ("dWebExtension");
// assemble the string with the parameters needed for the content folio service change string
newItemStr = "xcsd^dFormat:" + dataObject.get ("dFormat") + ",";
newItemStr += "id:" + guids[0] + ",";
newItemStr += "xcsd^dDocName:" + dataObject.get ("dDocName") + ",";
newItemStr += "xcsd^dID:" + dataObject.get ("dID") + ",";
newItemStr += "xcsd^dDocTitle:" + dataObject.get ("dDocTitle") + ",";
newItemStr += "xcsd^dDocType:" + dataObject.get ("dDocType") + ",";
newItemStr += "xcsd^dRendition1:" + dataObject.get ("dRendition1") + ",";
newItemStr += "xcsd^dRevLabel:" + dataObject.get ("dRevLabel") + ",";
newItemStr += "xcsd^dOriginalName:" + dataObject.get ("dOriginalName") + ",";
newItemStr += "xcsd^dDocAuthor:" + dataObject.get ("dDocAuthor") + ",";
newItemStr += "xcsd^docURL:" + urlStr + ",";
newItemStr += "xcsd^dDocName_encoded:" + java.net.URLEncoder.encode(dataObject.get ("dDocName"), "UTF-8") + ",";
newItemStr += "xcsd^docURL_encoded:" + java.net.URLEncoder.encode(urlStr, "UTF-8") + ",";
newItemStr += "xcst^name:" + dataObject.get ("dDocTitle") + ",";
newItemStr += "xcst^description:";
}

// create the binder to get the folio root GUID
DataBinder rootBinder = idcClient.createBinder();
// populate the binder with the parameters
rootBinder.putLocal("IdcService", "LOAD_FOLIO_NODE");
rootBinder.putLocal("dDocName", folioName);
rootBinder.putLocal("RevisionSelectionMethod", "Latest");

// send the request and get the response back from local data
ServiceResponse rootGUIDResponse = idcClient.sendRequest(userContext, rootBinder);
DataBinder rootGUIDData = rootGUIDResponse.getResponseAsBinder ();
String rootGUID = rootGUIDData.getLocal("RootNode");

// assemble the first change parameter for the service.  This will tell the content folio service
// to add a slot
String change0 = foliodID + ":addItem:" + guids[0] + ":" + rootGUID;

// assemble the second change parameter for the service.  This will tell the content folio service
// to add a content item to the new slot
String change1 = foliodID + ":addContent:" + guids[0];

// create the binder to run the UPDATE_FOLIO service
DataBinder folioBinder = idcClient.createBinder();
// populate the binder with the parameters
folioBinder.putLocal("IdcService", "UPDATE_FOLIO");
folioBinder.putLocal("dDocName", folioName)
folioBinder.putLocal("RevisionSelectionMethod", "Latest");
folioBinder.putLocal("NumChanges", "2");
folioBinder.putLocal("change0", change0);
folioBinder.putLocal("change_data0", newItemStr);
folioBinder.putLocal("change1", change1);
folioBinder.putLocal("change_data1", newItemStr);

// send the request and get the response back from local data
ServiceResponse folioResponse = idcClient.sendRequest(userContext, folioBinder);
DataBinder folioData = folioResponse.getResponseAsBinder ();

12.2.3 CHECKIN_NEW_FOLIO

ルート・ノードとともに新規フォリオを作成し、チェックインするサービス。

場所: IdcHomeDir/components/ContentContentFolios/resources/cpd_service.htm

オプションのサービス・パラメータ

- このサービスでは、dDocName、dDocTitleなどの標準のメタデータ・パラメータを使用できます。このサービスで使用するパラメータで必要な他のメタデータも指定する必要があります。

- サーバーでコンテンツIDの自動生成が設定されている場合、dDocNameパラメータを指定しないと、新しいコンテンツIDが自動的に生成されます。

- サービス・レスポンスのLocalDataセクションに、新規フォリオのdIDが示されます。

例

http://myserver/xpedio/icdplg?IdcServer=CHECKIN_NEW_FOLIO
&dDocName=myFolioTest&dDocTitle=MyFolioAPITest2&dDocType=TestData
&dDocAuthor=authorname&dSecurityGropu=Public&IsJava=1

12.2.4 CREATE_FOLIO_SNAPSHOT

フォリオのバージョンを取得し、ロック済バージョンと新規バージョンを作成するサービス。

場所: IdcHomeDir/components/ContentContentFolios/resources/cpd_service.htm

追加の必須サービス・パラメータ

- dID: フォリオのコンテンツID。

- RevisionSelectionMethod: 取得した情報を最新のリビジョンに基づいて使用するか、最新リリースのバージョンに基づいて使用するかをContent Serverインスタンスに指示します。最新のリビジョンの場合、未リリースの状態であることがあります。値は、Specific、Latest (未リリースの場合があります)またはLatest Releasedのいずれかです。

例

http://myserver/idc/idcplg?IdcService=CREATE_FOLIO_SNAPSHOT&dID=68095
&RevisionSelectionMethod=Specific

12.2.5 LOCK_FOLIO

編集不可で表示のみ可能なように、フォリオをロックするサービス。このコンテンツ・アイテムに対する追加の変更は許可されません。

場所: IdcHomeDir/components/ContentContentFolios/resources/cpd_service.htm

追加の必須サービス・パラメータ

- dID: フォリオのコンテンツID。

- RevisionSelectionMethod: 取得した情報を最新のリビジョンに基づいて使用するか、最新リリースのバージョンに基づいて使用するかをContent Serverインスタンスに指示します。最新のリビジョンの場合、未リリースの状態であることがあります。値は、Specific、Latest (未リリースの場合があります)またはLatest Releasedです。

例

http://myserver/idc/idcplg?IdcService=LOCK_FOLIO&dID=68095&RevisionSelectionMethod=Specific

12.2.6 UNLOCK_FOLIO

ロック済フォリオの新規バージョンを作成するサービス。この新規バージョンのフォリオは編集可能です。

場所: IdcHomeDir/components/ContentContentFolios/resources/cpd_service.htm

追加の必須サービス・パラメータ

- dID: フォリオのコンテンツID。

- RevisionSelectionMethod: 取得した情報を最新のリビジョンに基づいて使用するか、最新リリースのバージョンに基づいて使用するかをContent Serverインスタンスに指示します。最新のリビジョンの場合、未リリースの状態であることがあります。値は、Specific、Latest (未リリースの場合があります)またはLatest Releasedです。

例

http://myserver/idc/idcplg?IdcService=UNLOCK_FOLIO&dID=68095&RevisionSelectionMethod=Specific

12.2.7 CREATE_FOLIO_RENDITION

フォリオのリビジョンの特定のレンディションをブラウザに返すサービス。チェックアウトを実行することなく、フォリオのコピーが取得されます。

場所: IdcHomeDir/components/ContentContentFolios/resources/cpd_service.htm

追加の必須サービス・パラメータ

- dID: フォリオのコンテンツID。

- RenderID: レンディションのタイプ(PDF、ZIP、XML)。カスタムのレンディションを使用できます。

例

http://myserver/idc/idcplg?IdcService=CREATE_FOLIO_RENDITION&dID=68095&RenditionID=PDF

12.2.8 GENERATE_GUIDS

25個のグループ・ユーザーIDを生成し、返すことによって、これらを使用できるようにするサービス。

場所: IdcHomeDir/components/ContentContentFolios/resources/cpd_service.htm

例

http://myserver/expedio/idcplg?IdcService=GENERATE_GUIDS&IsJava=1

13 リンク・マネージャ・サービス

この章では、リンク・マネージャ・コンポーネントの使用時およびカスタマイズ時に利用可能なOracle WebCenter Contentサービスについて説明します。

この章の内容は、次のとおりです。

- 第13.1項「リンク・マネージャ・サービスについて」

- 第13.2項「リンク・マネージャ・サービス」

13.1 リンク・マネージャ・サービスについて

リンク・マネージャ・コンポーネントは、索引付きコンテンツのURLをデータベース表(ManagedLinks)への格納のために抽出する前に、このURLの評価、フィルタ処理および解析を実行します。抽出したURLリンクがManagedLinks表に移入されると、このコンポーネントはこの表を参照して、リンク検索結果、「コンテンツ情報」ページ用のリンク参照リストおよび「リンク情報」ページ用のリソース情報を生成します。

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

個々のリンク・マネージャ・サービスの場所は、それぞれのサービスの説明の中で示します。

リンク・マネージャの詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentのマネージング』を参照してください。

13.2 リンク・マネージャ・サービス

リンク・マネージャ機能では、次のサービスが使用されます。

- ABORT_LINKS_ACTIVITY

- ADD_MANAGED_DOCLINKS

- DELETE_MANAGED_DOCLINKS

- GET_LINK_INFO

- GET_LINKS_ADMIN_PAGE

- LK_GET_SEARCH_RESULTS

- RECOMPUTE_MANAGED_LINKS

- REFRESH_MANAGED_DOCLINKS

- REFRESH_MANAGED_LINKS

- REFRESH_REFS_MANAGED_LINKS

13.2.1 ABORT_LINKS_ACTIVITY

このサービスは、リンク・マネージャが実行している現在のアクティビティを停止するために使用されます。

このサービスを実行するには、管理者の資格証明を使用してContent Serverインスタンスにログインする必要があります。このサービスは、リンク・マネージャの管理ページからも利用できます。

場所: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

例

IdcService=ABORT_LINKS_ACTIVITY

13.2.2 ADD_MANAGED_DOCLINKS

このサービスは、特定の入力ファイルからHTMLリンクを抽出するために使用されます。コンテンツ・アイテムが索引付けされるときに自動的に実行されます。

場所: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

例

IdcService=ADD_MANAGED_DOCLINKS

13.2.3 DELETE_MANAGED_DOCLINKS

このサービスは、特定のコンテンツ・アイテムの管理されたリンクをデータベースから削除するために使用されます。コンテンツ・アイテムの削除時に自動的に実行されます。

場所: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

例

IdcService=DELETE_MANAGED_DOCLINKS

13.2.4 GET_LINK_INFO

このサービスは、特定のコンテンツ・アイテムのリンク情報を表示するために使用されます。

場所: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

追加の必須サービス・パラメータ

- dLkClassid: ManagedLinks表でリンクに割り当てられている一意のクラスID。

結果

- ResultSets:

- DOC_INFO (標準のメタデータ・フィールド)

- LinkInfo:

- dLkGUID: ManagedLinks表で行に割り当てられている一意のID。

- dLkClassId: ManagedLinks表でリンクに割り当てられている一意のID。

- dDocName: リンクが検出されたドキュメント名。

- dLkType: リンクのタイプ。external、unknown、ss_link_rel、ss_link_page、ss_link_node、ss_link_page、ss_link_node、ss_link_internal、ss_link_page、ss_link_page、ss_link_node、ss_link_absのいずれかです。

- dLkOriginalUrl: リンクの元のURL。

- dLkContainerID: リンクが見つかったSite Studio siteId。

- dLkResource: dID、dDocName、ssDocName、nodeIdのいずれかの値(dLkResourceType値に依存。外部リンクの場合これはnullです)。

- dLkResourceAlias: docNameまたはnodeLabel。

- dLdResourceType: id、doc、nodeのいずれか。

- dLkHasAlias: (ブール)エイリアスが存在するかどうかを示します。

- dLkState: YまたはN。Yは、リンクがチェックインされたコンテンツ・アイテムを参照しており、有効であることを意味します。Nは、リンクが削除されたコンテンツ・アイテムを参照しており、無効であることを意味します。

- dLkCreateTs: リンクが作成されたときのタイムスタンプ。

- dLkUpdateTs: リンクが最後に更新されたときのタイムスタンプ。

- dLkCycle: このリンクの処理を行っているLinkManagerを示すために使用されるフラグ(A - リフレッシャ、D - デコーダ、null - なし)

例

IdcService=GET_LINK_INFO
dLkClassId=652

戻り情報のサンプル。ResultSetの先頭では、存在するフィールド数(この例では14個)、各列の名前、データ型(文字列、日付、整数など)およびフィールド・サイズ(バイト単位)が示されます。これらのエントリに続いて、次の14行に、これらのフィールドの値が示されます。結果セット内に複数のエントリがある場合は、エントリごとにさらに14行のセットが含まれます。

@ResultSet LinkInfo14
dLkGUID 6 30
dLkClassId 3 38
dDocName 6 30
dLkType 6 20
dLkOriginalUrl 6 1024
dLkContainerId 6 50
dLkResource 6 50
dLkResourceAlias 6 50
dLkResourceType 6 50
dLkHasAlias 6 1
dLkState 6 1
dLkCreateTs 5 20
dLkUpdateTs 5 20
dLkCycle 6 1

13.2.5 GET_LINKS_ADMIN_PAGE

このサービスは、現在のリンク・マネージャ・アクティビティのステータスを取得するために使用されます。ステータスの表示用にリンク・マネージャの管理ページで使用されます。

場所: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

例

IdcService=GET_LINKS_ADMIN_PAGE

13.2.6 LK_GET_SEARCH_RESULTS

このサービスは、コンテンツ・アイテムへのリンクおよびコンテンツ・アイテムからのリンクを検索するために使用されます。

場所: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

例

次の例では、送信されたときにLK_GET_SEARCH_RESULTSサービスを実行するフォームが開かれます。

IdcService=LK_SEARCH_FORM

13.2.7 RECOMPUTE_MANAGED_LINKS

このサービスは、索引付きドキュメントのURLリンクを抽出し、パターン・エンジンに従ってURLの評価、フィルタ処理および解析を実行して、データベース表に結果を格納するために使用されます。

このサービスを実行するには、管理者の資格証明を使用してContent Serverインスタンスにログインする必要があります。このサービスは、リンク・マネージャの管理ページからも利用できます。

場所: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

例

IdcService=RECOMPUTE_MANAGED_LINKS

13.2.8 REFRESH_MANAGED_DOCLINKS

このサービスは、特定のドキュメントのリンクをリフレッシュするために使用されます。リフレッシュでは、リンクの再抽出は行われません。データベースにリストされたリンクが反復処理され、リンクの現在のステータスが判別されます。

場所: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

例

IdcService=REFRESH_MANAGED_DOCLINKS

13.2.9 REFRESH_MANAGED_LINKS

このサービスは、MANAGEDLINKSデータベース表に存在する管理されたリンクをリフレッシュするために使用されます。RECOMPUTE_MANAGED_LINKSとは異なり、コンテンツ・アイテムからの管理されたリンクの再抽出は行われません。

このサービスを実行するには、管理者の資格証明を使用してContent Serverインスタンスにログインする必要があります。このサービスは、リンク・マネージャの管理ページからも利用できます。

場所: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

例

IdcService=REFRESH_MANAGED_LINKS

13.2.10 REFRESH_REFS_MANAGED_LINKS

このサービスは、MANAGEDLINKS表に存在するコンテンツ参照に対して再カウントを実行するために使用されます。各コンテンツ・アイテムが表で参照されており、これらのアイテムが集計され、参照表に格納されます。

このサービスを実行するには、管理者の資格証明を使用してContent Serverインスタンスにログインする必要があります。このサービスは、リンク・マネージャの管理ページからも利用できます。

場所: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

例

IdcService=REFRESH_REFS_MANAGED_LINKS

14 仮想コンテンツ・リポジトリ・サービス

この章では仮想コンテンツ・リポジトリ(VCR)の使用時およびカスタマイズ時に利用可能なOracle WebCenter Contentサービスについて説明します。

この章の内容は、次のとおりです。

- 第14.1項「仮想コンテンツ・リポジトリ・サービスについて」

- 第14.2項「仮想コンテンツ・リポジトリ・サービス」

14.1 仮想コンテンツ・リポジトリ・サービスについて

Oracle WebLogic Portalでは、様々なリポジトリからのコンテンツを公開する手段としてVCRサービス・プロバイダ・インタフェースが使用されます。このインタフェースと連携して動作するアプリケーションでは、サービスが使用されます。Content ServerアプリケーションはVCR機能をサポートしています。

注意:

VCRサービスは、コントリビューション・フォルダ(Folders_gコンポーネントが提供)とともに使用する場合にのみサポートされています。VCRサービスは、フォルダ(FrameworkFoldersコンポーネントが提供)ではサポートされていません。コントリビューション・フォルダ・サービスの詳細は、第7章を参照してください。

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

14.2 仮想コンテンツ・リポジトリ・サービス

この項では、次のVCRサービスについて説明します。

- VCR_FOLDER_INFO

- VCR_GET_CONTENT_TYPE

- VCR_GET_CONTENT_TYPES

- VCR_GET_DOCUMENT

- VCR_GET_DOCUMENT_BY_NAME

14.2.1 VCR_FOLDER_INFO

VCRサービス・プロバイダ・インタフェースで必要な形式のコンテンツを含むFolders_gフォルダに関する情報を取得するために使用されるサービス。

サービス・クラス: DocService

追加の必須サービス・パラメータ

Folders_gフォルダを特定するための次のいずれかのパラメータ:

- dCollectionID: ターゲット・コンテンツを含むフォルダのフォルダID。

- dCollectionPath: ターゲット・コンテンツを含むフォルダのパス。

結果

- ResultSets:

- VcrNode

- createdBy

- createdDate

- hasChildren

- modifiedBy

- name

- objectClass

- parentID

- path

- VcrPropertyValues

- dChildManipulation

- dCollectionCreator

- dCollectionEnabled

- dCollectionGUID

- dCollectionID

- dCollectionInherit

- dCollectionMark

- dCollectionModifier

- dCollectionName

- dCollectionOwner

- dCollectionPath

- dCollectionQueries

- dCollectionType

- dCreateDate

- dDependent

- dDocAccount

- dDocAuthor

- dDocName

- dDocTitle

- dDocType

- dInDate

- dLastModifiedDate

- dOutDate

- dParentCollectionID

- dPromptForMetadata

- dReleaseDate

- dRevLabel

- dSecurityGroup

- xClbraAliasList

- xClbraRoleList

- xClbraUserList

- xCollectionID

- xComments

- xDontShowInListsForWebsites

- xEmailCC

- xEmailFrom

- xEmailSubject

- xEmailTo

- xForceFolderSecurity

- xHidden

- xIdcProfile

- xInhibitUpdate

- xProfileTrigger

- xPublicationDate

- xReadOnly

- xReceivedDate

- xRegionDefinition

- xt

- xTrashDeleteDate

- xTrashDeleteLoc

- xTrashDeleteName

- xTrashDeleter

- xtestdec2

- xtestdec3

- xtTestField1

- xtTestField2

- xtestINTEGER

- xWebsiteObjectType

- xWebsites

- xWebsiteSection

14.2.2 VCR_GET_CONTENT_TYPE

特定のVCRコンテンツ・タイプに関する詳細な情報をリクエストするサービス。

サービス・クラス: Service

追加の必須サービス・パラメータ

- vcrContentType: コンテンツのID。コンテンツ・タイプの名前とも呼ばれます。

結果

- ResultSets:

- VcrContentType

- VcrProperties

- VcrPropertyChoices (FIELDNAME)

14.2.3 VCR_GET_CONTENT_TYPES

システムで定義されているすべてのVCRコンテンツ・タイプのリストをリクエストするサービス。

サービス・クラス: Service

結果

- ResultSet: VcrContentTypes

14.2.4 VCR_GET_DOCUMENT

コンテンツ・アイテムの特定のリビジョンのコンテンツ・アイテム情報を取得するサービス。

このサービスはDOC_INFOサービスとほとんど同じですが、VCRのコンテキストで処理しやすいように変更されたデータが返されます。

サービス・クラス: Service

追加の必須サービス・パラメータ

- dID: 生成済のコンテンツ・アイテムのリビジョンID。

結果

- ResultSets:

- VcrPropertyValues

- DOC_INFOサービスで返されるすべての標準のDOC_INFO ResultSet列

- idcPrimaryFile

- idcRenditions

- REVISION_HISTORY

- dDocName

- dFormat

- dID

- dInDate

- dOutDate

- dProcessingState

- dRevLabel

- 削除されていないすべてのリビジョンのdRevisionID

- dStatus

14.2.5 VCR_GET_DOCUMENT_BY_NAME

パラメータとして指定されたコンテンツID (dDocName)に基づいてコンテンツ・アイテムの最新リビジョンに関する情報を取得するサービス。

このサービスはDOC_INFO_BY_NAMEサービスとほとんど同じですが、VCRのコンテキストで処理しやすいように変更されたデータが返されます。

サービス・クラス: Service

追加の必須サービス・パラメータ

- dDocName: コンテンツ・アイテム名。

オプションのサービス・パラメータ

- RevisionSelectionMethod: 最新のバージョンを取得するにはLatest、最新のリリース・バージョンを取得するにはLatestReleasedまたはSpecific (Specificに設定する場合、dIDを指定する必要があります)に設定できます。Specificに設定した場合、dDocNameのかわりにdIDを使用して特定のリビジョンを指すことができます。

結果

- ResultSets:

- VcrPropertyValues

- DOC_INFOサービスで返されるすべての標準のDOC_INFO ResultSet列

- idcPrimaryFile

- idcRenditions

- REVISION_HISTORY

- dDocName

- dFormat

- dID

- dInDate

- dOutDate

- dProcessingState

- 削除されていないすべてのリビジョンのdRevisionID

- dRevLabel

- dStatus

A アクション

この付録では、Oracle WebCenter Contentサービスで使用されるアクションをアルファベット順にリストし、それぞれのアクションについて説明します。

アクションとは、サービス・スクリプトの一部として実行される操作です。アクションでは、SQL文の実行、問合せの実行、コードの実行、問合せ結果のキャッシュまたはオプション・リストのロードを行えます。

- A.1項「サービス・アクションについて」

- A.2項「A」

- A.3項「B」

- A.4項「C」

- A.5項「D」

- A.6項「E」

- A.7項「F」

- A.8項「G」

- A.9項「H」

- A.10項「I」

- A.11項「L」

- A.12項「M」

- A.13項「N」

- A.14項「P」

- A.15項「Q」

- A.16項「R」

- A.17項「S」

- A.18項「T」

- A.19項「U」

- A.20項「V」

A.1 サービス・アクションについて

アクションは、次の形式を使用した、コロン区切りのセグメントのリストとして定義されます。

type:name:parameters:control mask:error message

アクション・タイプは、番号または記述名によって指定できます。

- 1: 問合せの選択。情報の取得(読取り専用アクション)を行うデータベース問合せを実行し、その後、結果を破棄します。

- 2: 問合せの実行。データベースの情報を削除、追加または更新するデータベース問合せを実行します。

- 3: Javaメソッド。サービスを実装するJavaクラスの一部であるコード・モジュールを指定します。

- 4: オプション・リストのロード。システムに格納されているオプション・リストをロードします。

- 5: キャッシュ問合せの選択。情報の取得(読取り専用アクション)を行うデータベース問合せを実行し、結果を後で使用できるように格納します。

- 各アクションとそのパラメータおよび制御マスクの詳細は、第3.1.3項「アクション」を参照してください。

A.2 A

addAliases

エイリアスを追加し、IworkflowAliasをパラメータとして渡します。ADD_WORKFLOWALIASESによって、Javaメソッドとしてコールされます。

addCollaboration

ADD_COLLABORATIONによって、Javaメソッドとしてコールされます。

addContext

ADD_WEB_APPによって、Javaメソッドとしてコールされます。

addFiles:

コンテンツを名前によってチェックインします。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_BYNAME

- CHECKIN_NEW_SUB

- CHECKIN_SEL_SUB

- INSERT_NATIVE

- INSERT_NEW

- REPLACE_METAFILE_SUB

- UPDATE_BYREV

- WORKFLOW_CHECKIN_SUB

addOrEditDocMetaData

ADD_METADEFおよびEDIT_METADEFによって、Javaメソッドとしてコールされます。

addOrEditProvider

新規プロバイダを追加します。ADD_EDIT_PROVIDERによって、Javaメソッドとしてコールされます。

addOrEditSchemaTable

ADDOREDIT_SCHEMA_TABLEによって、Javaメソッドとしてコールされます。

addProblemReport

問題レポートをデータベースに追加します。ADD_PROBLEMREPORTによって、Javaメソッドとしてコールされます。

addRegisteredUserAttribute

ユーザーのデータベース・プロファイル情報を取得します。REGISTER_USERによって、Javaメソッドとしてコールされます。

addSchemaRelation

ADD_SCHEMA_RELATIONによって、Javaメソッドとしてコールされます。

addSchemaView

ADD_SCHEMA_VIEWによって、Javaメソッドとしてコールされます。

addSubscription

サブスクリプションを追加し、Isubscriptionをパラメータとして渡します。SUBSCRIBEによって、Javaメソッドとしてコールされます。

addTemplate

ADD_WF_TEMPLATEによって、Javaメソッドとしてコールされます。

addUserAttributes

ユーザーのセキュリティ属性を追加/更新し、IuserSecurityAttributeをパラメータとして渡します。ADD_USERおよびEDIT_USERによって、Javaメソッドとしてコールされます。

addWfDocuments

ワークフロー・コンテンツ・アイテムを追加し、ADD_WORKFLOWDOCUMENT_SUBをパラメータとして渡します。サービスがコンテンツ・アイテムのリビジョンを追加できない場合、このアクションはデータ例外をスローします。ADD_WORKFLOWDOCUMENTSによって、Javaメソッドとしてコールされます。

addWorkflow

ワークフローを追加します。ADD_WORKFLOWによって、Javaメソッドとしてコールされます。

addWorkflowScript

ADD_WORKFLOW_SCRIPTによって、Javaメソッドとしてコールされます。

addWorkflowStep

ワークフロー・ステップを追加し、IworkflowStepをパラメータとして渡します。サービスがワークフローにステップを追加できない場合、このアクションはデータ例外をスローします。ADD_WORKFLOWSTEPによって、Javaメソッドとしてコールされます。

addWorkflowStepScript

ADD_WORKFLOWSTEPによって、Javaメソッドとしてコールされます。

addWorkflowToken

ADD_WORKFLOW_TOKENによって、Javaメソッドとしてコールされます。

Alias

エイリアス情報を取得します。この問合せの結果はAliasパラメータに割り当てられ、後で使用できるように格納されます。GET_ALIASESによって、キャッシュ問合せの選択アクションとしてコールされます。

AliasUserMap

ユーザー・エイリアス・マップを取得します。この問合せの結果はAliasUserMapパラメータに割り当てられ、後で使用できるように格納されます。GET_ALIASESによって、キャッシュ問合せの選択アクションとしてコールされます。

allowProblemReportAction

問題レポート・アクションを実行してupdateをパラメータとして渡すことを可能にします。DELETE_PROBLEMREPORTおよびUPDATE_PROBLEMREPORTによって、Javaメソッドとしてコールされます。

appendCommonSystemInfo

GET_SYSTEM_AUDIT_INFOによって、Javaメソッドとしてコールされます。

appendDatabaseAuditMessage

APPEND_DATABASE_AUDIT_INFOによって、Javaメソッドとしてコールされます。

appendFileCachingMessage

APPEND_FILE_CACHING_INFOによって、Javaメソッドとしてコールされます。

approveDo

ワークフローのコンテンツ・アイテムを承認します。WORKFLOW_APPROVEによって、Javaメソッドとしてコールされます。

A.3 B

buildAllWebStringFiles

LM_BUILD_WEB_STRING_FILESによって、Javaメソッドとしてコールされます。

buildExpiredContentQuery

GET_EXPIREDによって、Javaメソッドとしてコールされます。

buildPreviewList

次のサービスによって、Javaメソッドとしてコールされます。

- CACHE_CHECKIN_NEW

- CACHE_CHECKIN_SEL

- CACHE_SUBMIT_HTML_FORM

- CACHE_WORKFLOW_CHECKIN

buildSearchIndex

START_SEARCH_INDEXによって、Javaメソッドとしてコールされます。

buildSourceInfo

ソース情報をビルドします。PROBLEMREPORT_INFOによって、Javaメソッドとしてコールされます。

A.4 C

cacheCheckin

次のサービスによって、Javaメソッドとしてコールされます。

- CACHE_CHECKIN_NEW

- CACHE_CHECKIN_SEL

- CACHE_SUBMIT_HTML_FORM

- CACHE_WORKFLOW_CHECKIN

cacheTemplates

テンプレートをキャッシュします。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_WF_TEMPLATE

- DELETE_WF_TEMPLATE

- EDIT_WF_TEMPLATE

cancelComponentInstall

コンポーネントのインストールを取り消します。CANCEL_COMPONENT_INSTALLによって、Javaメソッドとしてコールされます。

cancelCriteriaWorkflow

基準ワークフローを取り消し、WfDocumentsとQdocumentsをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_DISABLE_SUB

- DELETE_WORKFLOWCRITERIA

cancelSearchIndex

検索索引作成セッションを取り消します。CANCEL_SEARCH_INDEXによって、Javaメソッドとしてコールされます。

cancelWorkflow

ワークフローを取り消し、WfDocumentsとQdocumentsをパラメータとして渡します。DELETE_WORKFLOWおよびWORKFLOW_CANCELによって、Javaメソッドとしてコールされます。

canDeleteStep

ワークフロー・ステップが削除可能かどうかを評価します。DELETE_WORKFLOWSTEPによって、Javaメソッドとしてコールされます。

checkCanCreateDocSecurity

割り当てられているセキュリティ・レベルを評価して、ユーザーにこのアクションを実行する権限があることを確認します。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_SEL_FORM

- CHECKOUT_SUB

- UNDO_CHECKOUT

- UNDO_CHECKOUT_BY_NAME

checkCollaborationAccess

次のサービスによって、Javaメソッドとしてコールされます。

- ADD_COLLABORATION

- ADD_COLLABORATION_FORM

- DELETE_COLLABORATION

- EDIT_CLBRA_ACCESS_LIST

- EDIT_CLBRA_ACCESS_LIST_FORM

- EDIT_COLLABORATION

- EDIT_COLLABORATION_FORM

- GET_CLBRA_DOCUMENTS

- GET_CLBRA_INFO

checkConversionCache

GET_DYNAMIC_CONVERSION_SUBによって、Javaメソッドとしてコールされます。

checkCounters

INSERT_NATIVEによって、Javaメソッドとしてコールされます。

checkCriteriaWorkflow

基準ワークフローを評価します。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_BYNAME

- CHECKIN_NEW_SUB

- CHECKIN_SEL_SUB

checkDocRules

定義されているコンテンツ・アイテム・ルールを評価し、checkoutとisNotPublishedをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- CACHE_CHECKIN_NEW

- CHECKIN_NEW_SUB

- CHECKIN_SEL_FORM

- CHECKOUT_BY_NAME

- CHECKOUT_SUB

- GET_UPDATE_FORM

- UNDO_CHECKOUT

- UNDO_CHECKOUT_BY_NAME

- UPDATE_DOCINFO_SUB

checkDocState

ADD_WORKFLOWDOCUMENT_SUBによって、Javaメソッドとしてコールされます。

checkForceLogin

ログインを強制します。次のサービスによって、Javaメソッドとしてコールされます。

- GET_CLBRA_DOCUMENTS

- LOGIN

- PING_SERVER

- UPDATE_SUBSCRIPTION_NOTIFY

- UPDATE_SUBSCRIPTION_USED

checkForPublish

UPDATE_BYREVによって、Javaメソッドとしてコールされます。

checkForRefreshingCachedResources

LOAD_RESOURCE_FILEによって、Javaメソッドとしてコールされます。

checkInByID

CACHE_CHECKIN_SELおよびCHECKIN_SEL_SUBによって、Javaメソッドとしてコールされます。

checkInByName

コンテンツを名前によってチェックインします。CHECKIN_BYNAMEによって、Javaメソッドとしてコールされます。

checkIsLatestRev

最新リビジョンに関して評価します。CHECKOUT_BY_NAMEおよびRESUBMIT_FOR_CONVERSIONによって、Javaメソッドとしてコールされます。

checkIsSelf

ユーザーが自己編集しているかどうかをチェックします。EDIT_USER_PROFILEによって、Javaメソッドとしてコールされます。

checkParametersAgainstResultSet

DELETE_DOCによって、Javaメソッドとしてコールされます。

checkProblemReportSecurity

DOC_INFOパラメータに割り当てられたデータを取得し、問題レポートのセキュリティ情報を評価します。次のサービスによって、Javaメソッドとしてコールされます。

- DELETE_PROBLEMREPORT

- GET_UPDATE_PROBLEMREPORT_FORM

- PROBLEMREPORT_INFO

- RESEND_PROBLEMREPORT

- UPDATE_PROBLEMREPORT

checkRefreshUsers

ユーザー情報を更新します。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_USER

- CHANGE_USER_AUTH_TYPE

- DELETE_USER

- EDIT_USER

- EDIT_USER_PROFILE

- REGISTER_USER

checkRevisionProperties

最新リビジョン情報を取得し、Qrevisionsをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_SEL_FORM

- CHECKOUT_OK

- CHECKOUT_SUB

- GET_UPDATE_FORM

checkSecurity

DOC_INFOパラメータに割り当てられたデータを取得し、割り当てられたセキュリティ・レベルを評価して、ユーザーにこのアクションを実行する権限があることを確認します。パラメータはサービスによって異なります。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_PROBLEMREPORT

- ADD_WORKFLOW

- ADD_WORKFLOWALIASES

- ADD_WORKFLOWDOCUMENT

- ADD_WORKFLOWDOCUMENTS

- APPLET_DOCINFO

- CACHE_CHECKIN_NEW

- CACHE_CHECKIN_SEL

- CACHE_SUBMIT_HTML_FORM

- CACHE_WORKFLOW_CHECKIN

- CHECKIN_BYNAME

- CHECKIN_NEW

- CHECKIN_SEL

- CONTINUE_SUBMIT_HTML_FORM

- CONTINUE_CHECKIN

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_ENABLE

- DELETE_CHECKIN_CACHE

- DELETE_DOC

- DELETE_REV

- DELETE_REV_EX

- DELETE_WFCONTRIBUTORS

- DELETE_WORKFLOW

- DELETE_WORKFLOWCRITERIA

- DELETE_WORKFLOWDOCUMENTS

- DOC_INFO

- EDIT_WORKFLOW

- EDIT_WORKFLOWCRITERIA

- FORM_PROCESS

- GET_ARCHIVED_FILE

- GET_DOCUMENT_PROBLEMREPORTS

- GET_DYNAMIC_CONVERSION

- GET_EXTERNAL_DOC_INFO

- GET_EXTERNAL_HIGHLIGHT_INFO

- GET_EXTERNAL_XML_HIGHLIGHT_INFO

- GET_FILE

- GET_HIGHLIGHT_INFO

- GET_UPDATE_FORM

- GET_WF_COMPANION_INFO

- GET_WORKFLOW_INFO

- GET_WORKFLOW_INFO_BYNAME

- GET_WORKFLOWDOCREVISIONS

- GET_WORKFLOWDOCUMENTS

- GET_XML_HIGHLIGHT_INFO

- LOAD_RESOURCE_FILE

- RESUBMIT_FOR_CONVERSION

- REV_HISTORY

- REVIEW_WORKFLOW_DOC

- SELECTDOC

- SUBMIT_HTML_FORM

- SUBSCRIBE

- UNSUBSCRIBE

- UPDATE_DOCINFO_SUB

- VALIDATE_DOCINFO

- VIEW_DOC

- WORKFLOW_APPROVE

- WORKFLOW_CANCEL

- WORKFLOW_CHECKIN

- WORKFLOW_REJECT

- WORKFLOW_REJECT_FORM

- WORKFLOW_START

checkSubAdmin

ユーザーがサブ管理者ロールを保有しているかチェックし、パラメータを渡します。このパラメータは使用サービスに応じて異なります。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_USER

- ADD_WORKFLOW

- ADD_WORKFLOW_SCRIPT

- ADD_WORKFLOW_TOKEN

- ADD_WORKFLOWALIASES

- ADD_WORKFLOWDOCUMENT

- ADD_WORKFLOWDOCUMENTS

- ADD_WORKFLOWSTEP

- CHANGE_USER_AUTH_TYPE

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_ENABLE

- DELETE_USER

- DELETE_WFCONTRIBUTORS

- DELETE_WORKFLOW

- DELETE_WORKFLOW_SCRIPT

- DELETE_WORKFLOW_TOKEN

- DELETE_WORKFLOWCRITERIA

- DELETE_WORKFLOWDOCUMENTS

- DELETE_WORKFLOWSTEP

- EDIT_USER

- EDIT_WORKFLOW

- EDIT_WORKFLOW_SCRIPT

- EDIT_WORKFLOW_TOKEN

- EDIT_WORKFLOWCRITERIA

- EDIT_WORKFLOWSTEP

- GET_ADMIN_PAGE

- GET_CRITERIA_WORKFLOWS_FOR_GROUP

- GET_USERS

- GET_WF_COMPANION_INFO

- GET_WORKFLOW_SCRIPT

- GET_WORKFLOWS_FOR_ALL

- PAGE_HANDLER

- QUERY_USER_ATTRIBUTES

- UPDATE_USEROPTION_LIST

- WORKFLOW_CANCEL

- WORKFLOW_START

checkUserAuthType

CHANGE_USER_AUTH_TYPEによって、Javaメソッドとしてコールされます。

checkWorkflow

WF_INFOを参照することによってワークフロー情報をチェックし、isNotActiveBasicをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- CACHE_CHECKIN_SEL

- CACHE_WORKFLOW_CHECKIN

- CHECKIN_BYNAME

- CHECKIN_SEL_SUB

- CHECKOUT_SUB

- DELETE_DOC

- DELETE_REV

- DELETE_REV_EX

- WORKFLOW_CHECKIN_SUB

- WORKFLOW_START

checkWorkflowAdminAccess

GET_WORKFLOWSによって、Javaメソッドとしてコールされます。

computeCompanionDirectory

ADD_WORKFLOWDOCUMENT_SUBによって、Javaメソッドとしてコールされます。

computeDeleteSecurity

DELETE_REVによって、Javaメソッドとしてコールされます。

computeDocID

生成されたコンテンツ・アイテム・リビジョンIDを計算します。次のサービスによって、Javaメソッドとしてコールされます。

- GET_ARCHIVED_FILE

- GET_DYNAMIC_CONVERSION

- GET_FILE

- LOAD_RESOURCE_FILE

computeDocInfoInHtmlPage

HTMLページに関してコンテンツ情報を評価します。パラメータはサービスによって異なります。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_LIST

- CONTINUE_CHECKIN

- DELETE_CHECKIN_CACHE

- DOC_SUBS_LIST

- GET_EXPIRED

- SUBSCRIPTION_LIST

- UNSUBSCRIBE_FROM_LIST

- WORK_IN_PROGRESS

computeDocSubscribers

サブスクライバに関してコンテンツ・アイテムを評価します。GET_DOC_SUBSCRIBERSによって、Javaメソッドとしてコールされます。

computeRejectTargetStep

却下ターゲット・ステップを計算します。WORKFLOW_REJECTによって、Javaメソッドとしてコールされます。

computeRemainingUsers

次のサービスによって、Javaメソッドとしてコールされます。

- GET_WORKFLOW_INFO

- GET_WORKFLOW_INFO_BYNAME

- WORKFLOW_REJECT

computeURLs

URLを評価し、REVISIONSをパラメータとして渡します。REV_HISTORYによって、Javaメソッドとしてコールされます。

computeWfDocumentsInfo

ワークフロー・コンテンツ・アイテム情報を評価し、WfDocumentsをパラメータとして渡します。GET_WORKFLOWDOCUMENTSによって、Javaメソッドとしてコールされます。

conditionalDetermineCheckin

チェックイン用にフォームを準備します。FORM_PROCESSによって、Javaメソッドとしてコールされます。

continueCheckin

CONTINUE_CHECKINによって、Javaメソッドとしてコールされます。

controlIndexing

検索索引作成制御を実行します。CONTROL_SEARCH_INDEXによって、Javaメソッドとしてコールされます。

createAddEditProviderForm

プロバイダの追加/編集フォームを作成します。GET_ADD_EDIT_PROVIDER_FORMによって、Javaメソッドとしてコールされます。

createArchiveFileName

アーカイブ・ファイル名を作成します。GET_ARCHIVED_FILEによって、Javaメソッドとしてコールされます。

createFileName

新規ファイル名を作成します。GET_FILEおよびLOAD_RESOURCE_FILEによって、Javaメソッドとしてコールされます。

createNewRev

ADD_WORKFLOWDOCUMENT_SUBによって、Javaメソッドとしてコールされます。

createResultSetSQL

指定されたパラメータではなく、データ・バインダ(dataSourceおよびwhereClauseローカル・データ)から取得したパラメータを使用して問合せを実行します。データ・バインダに見つかったResultSet名(resultName)を使用して、ローカル・データに結果を配置します。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_LIST

- CONTINUE_CHECKIN

- DELETE_CHECKIN_CACHE

- GET_ACTIVE_WORKFLOWS

- DOC_SUBS_LIST

- GET_CLBRA_DOCUMENTS

- GET_DATARESULTSET

- GET_EXPIRED

- GET_WORKFLOWS

- SUBSCRIBE_EX

- UNSUBSCRIBE_FROM_LIST_EX

- WORK_IN_PROGRESS

createSubscriptionType

サブスクリプション・タイプを作成します。CREATE_SUBSCRIPTION_TYPEによって、Javaメソッドとしてコールされます。

createWebFileNameFromRelativeUrl

指定された相対URLからWebファイル名を作成し、TEMPLATE_URL_INFOをパラメータとして渡します。GET_DYNAMIC_URLによって、Javaメソッドとしてコールされます。

createWorkflowID

ワークフロー・ラベルを作成します。ADD_WORKFLOWによって、Javaメソッドとしてコールされます。

A.5 D

Dalias

エイリアスを削除します。DELETE_ALIASによって、問合せの実行アクションとしてコールされます。

DaliasUsers

エイリアス・ユーザーを削除します。DELETE_ALIASおよびEDIT_ALIASによって、問合せの実行アクションとしてコールされます。

Dcollaboration

DELETE_COLLABORATIONによって、問合せの実行アクションとしてコールされます。

DdocAccount

コンテンツ・アイテムのアカウントを削除します。DELETE_DOC_ACCOUNTによって、問合せの実行アクションとしてコールされます。

DdocFormat

コンテンツ・アイテムのフォーマットを削除します。DELETE_DOCFORMATによって、問合せの実行アクションとしてコールされます。

DdocType

コンテンツ・アイテム・タイプを削除します。DELETE_DOCTYPEによって、問合せの実行アクションとしてコールされます。

Ddocument

次のサービスによって、問合せの実行アクションとしてコールされます。

- REMOVE_METAFILE_SUB

- UPDATE_BYREV

- WORKFLOW_CHECKIN_SUB

decodeTopicValues

トピック値をデコードします。PNE_SAVE_QUERYによって、Javaメソッドとしてコールされます。

deleteAliases

DELETE_WFCONTRIBUTORSによって、Javaメソッドとしてコールされます。

deleteCollaboration

DELETE_COLLABORATIONによって、Javaメソッドとしてコールされます。

deleteDoc

REVISIONSパラメータに割り当てられたデータを取得し、コンテンツ・アイテムを削除します。DELETE_BYCLASSおよびDELETE_BYNAMEによって、Javaメソッドとしてコールされます。

deleteDocumentSubscription

コンテンツ・アイテムのサブスクリプションを削除し、deleteRevをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- DELETE_BYCLASS

- DELETE_BYNAME

- DELETE_BYREV

- DELETE_DOC

- DELETE_REV_EX

deleteProblemReport

問題レポート情報を削除します。DELETE_PROBLEMREPORTによって、Javaメソッドとしてコールされます。

deleteProvider

プロバイダを削除します。DELETE_PROVIDERによって、Javaメソッドとしてコールされます。

deleteResultTemplate

結果テンプレートを削除します。DELETE_RESULT_TEMPLATEによって、Javaメソッドとしてコールされます。

deleteRev

コンテンツ・アイテムの前のリビジョンを削除し、DOC_INFOをパラメータとして渡します。DELETE_REVおよびDELETE_REV_EXによって、Javaメソッドとしてコールされます。

deleteRevFiles

次のサービスによって、Javaメソッドとしてコールされます。

- REMOVE_METAFILE_SUB

- UPDATE_BYREV

- WORKFLOW_CHECKIN_SUB

deleteSchemaRelation

DELETE_SCHEMA_RELATIONによって、Javaメソッドとしてコールされます。

deleteSchemaTable

DELETE_SCHEMA_TABLEによって、Javaメソッドとしてコールされます。

deleteSchemaView

DELETE_SCHEMA_VIEWによって、Javaメソッドとしてコールされます。

deleteSubscriptionType

サブスクリプション・タイプを削除するアクション。DELETE_SUBSCRIPTION_TYPEによって、Javaメソッドとしてコールされます。

deleteTemplate

ワークフロー・テンプレートを削除します。ADD_WF_TEMPLATEによって、Javaメソッドとしてコールされます。

deleteWfDesign

DELETE_WORKFLOWおよびDELETE_WORKFLOWCRITERIAによって、Javaメソッドとしてコールされます。

deleteWfDocuments

ワークフロー・コンテンツ・アイテムを削除します。DELETE_WORKFLOWDOCUMENTSによって、Javaメソッドとしてコールされます。

deleteWorkflowScript

ワークフロー・スクリプトを削除します。DELETE_WORKFLOW_SCRIPTによって、Javaメソッドとしてコールされます。

deleteWorkflowStepScript

ワークフロー・ステップに関連付けられたスクリプトを削除します。DELETE_WORKFLOWSTEPによって、Javaメソッドとしてコールされます。

deleteWorkflowToken

ワークフロー・トークンを削除します。DELETE_WORKFLOW_TOKENによって、Javaメソッドとしてコールされます。

determineCheckin

チェックイン用にフォームを準備します。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_UNIVERSAL

- CONTINUE_SUBMIT_HTML_FORM

- SUBMIT_HTML_FORM

DextensionMap

拡張子マップを削除します。DELETE_DOCEXTENSIONによって、問合せの実行アクションとしてコールされます。

DgroupRole

ルールを削除します。DELETE_GROUPによって、問合せの実行アクションとしてコールされます。

disableSendFile

GET_DYNAMIC_CONVERSIONによって、Javaメソッドとしてコールされます。

Dmetadef

メタ定義情報を削除します。DEL_METADEFによって、問合せの実行アクションとしてコールされます。

doCachedCheckinCleanup

CONTINUE_CHECKINおよびDELETE_CHECKIN_CACHEによって、Javaメソッドとしてコールされます。

doCachedCleanup

CONTINUE_SUBMIT_HTML_FORMによって、Javaメソッドとしてコールされます。

DocFormats

コンテンツ・アイテムのフォーマットを取得します。この問合せの結果はDocFormatsパラメータに割り当てられ、後で使用できるように格納されます。GET_DOCFORMATSによって、キャッシュ問合せの選択アクションとしてコールされます。

docHistoryInfo

コンテンツ・アイテムの履歴情報を評価し、CheckoutとIdocHistoryをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_BYNAME

- CHECKIN_NEW_SUB

- CHECKIN_SEL_SUB

- CHECKOUT_SUB

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_DISABLE_SUB

- CRITERIAWORKFLOW_ENABLE

- DELETE_BYCLASS

- DELETE_BYNAME

- DELETE_BYREV

- DELETE_DOC

- DELETE_REV

- DELETE_REV_EX

- INSERT_NATIVE

- INSERT_NEW

- UNDO_CHECKOUT

- UNDO_CHECKOUT_BY_NAME

- UPDATE_BYREV

- UPDATE_DOCINFO_BYREV

- UPDATE_DOCINFO_SUB

- WORKFLOW_APPROVE

- WORKFLOW_CANCEL

- WORKFLOW_CHECKIN_SUB

- WORKFLOW_REJECT

- WORKFLOW_START

docRefinery

リファイナリ・チェックイン・プロセスを開始します。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_BYNAME

- CHECKIN_NEW

- CHECKIN_NEW_SUB

- CHECKIN_SEL_SUB

- INSERT_NATIVE

- INSERT_NEW

- REPLACE_METAFILE_SUB

- UPDATE_BYREV

- UPDATE_DOCINFO_SUB

- WORKFLOW_CHECKIN_SUB

doSubService

指定したサブサービスを実行します。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_WORKFLOWDOCUMENT

- CHECKIN_NEW

- CHECKIN_SEL

- CHECKOUT

- CHECKOUT_BY_NAME

- GET_DOC_PAGE

- GET_DYNAMIC_CONVERSION

- GET_SECURE_PAGE

- GET_SYSTEM_AUDIT_INFO

- LM_LOAD_LAYOUTS

- UPDATE_DOCINFO

- UPDATE_DOCINFO_BYFORM

- WORKFLOW_CHECKIN

doSubserviceIfMetafile

UPDATE_DOCINFO_SUBによって、Javaメソッドとしてコールされます。

doUpload

CHUNKED_UPLOADによって、Javaメソッドとしてコールされます。

downloadComponent

DOWNLOAD_COMPONENTによって、Javaメソッドとしてコールされます。

downloadItems

DOWNLOAD_LISTBOX_ITEMSによって、Javaメソッドとしてコールされます。

doWorkflowAction

ワークフロー・アクションを実行します。次のサービスによって、Javaメソッドとしてコールされます。

- DELETE_BYCLASS

- DELETE_BYNAME

- DELETE_BYREV

- DELETE_DOC

- DELETE_REV

- DELETE_REV_EX

DproblemReport

問題レポート情報を削除します。DELETE_PROBLEMREPORTによって、問合せの実行アクションとしてコールされます。

Drole

ルールを削除します。DELETE_ROLEによって、問合せの実行アクションとしてコールされます。

DsecurityGroup

セキュリティ・グループを削除します。DELETE_GROUPによって、問合せの実行アクションとしてコールされます。

DsubscriptionType

サブスクリプション・タイプを削除します。DELETE_SUBSCRIPTION_TYPEによって、問合せの実行アクションとしてコールされます。

Duser

DELETE_USERによって、問合せの実行アクションとしてコールされます。

DuserSecurityAttributes

ユーザーのセキュリティ属性を削除します。次のサービスによって、問合せの実行アクションとしてコールされます。

- ADD_USER

- DELETE_ROLE

- EDIT_USER

DuserSubscription

DELETE_USERによって、問合せの実行アクションとしてコールされます。

Dworkflow

ワークフローを削除します。DELETE_WORKFLOWおよびDELETE_WORKFLOWCRITERIAによって、問合せの実行メソッドとしてコールされます。

DworkflowAliasAll

ワークフロー・エイリアスを削除します。DELETE_WORKFLOWおよびDELETE_WORKFLOWCRITERIAによって、問合せの実行アクションとしてコールされます。

DworkflowCriteria

ワークフローの基準を削除します。DELETE_WORKFLOWCRITERIAによって、問合せの実行アクションとしてコールされます。

DworkflowDocState

ワークフロー・コンテンツ・アイテムの状態を削除します。WORKFLOW_REJECTによって、問合せの実行アクションとしてコールされます。

DworkflowDocumentAll

ワークフロー・コンテンツ・アイテムを削除します。次のサービスによって、問合せの実行としてコールされます。

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_DISABLE_SUB

- DELETE_WORKFLOW

- DELETE_WORKFLOWCRITERIA

DworkflowStateAll

ワークフローの状態を削除します。次のサービスによって、問合せの実行アクションとしてコールされます。

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_DISABLE_SUB

- DELETE_WORKFLOW

- DELETE_WORKFLOWCRITERIA

- WORKFLOW_CANCEL

DworkflowStep

ワークフロー・ステップを削除します。DELETE_WORKFLOWSTEPによって、問合せの実行アクションとしてコールされます。

DworkflowStepAliases

ワークフロー・ステップ・エイリアスを削除します。DELETE_WORKFLOWSTEPによって、問合せの実行アクションとしてコールされます。

DworkflowStepsAll

ワークフロー・ステップを削除します。DELETE_WORKFLOWおよびDELETE_WORKFLOWCRITERIAによって、問合せの実行アクションとしてコールされます。

DworkflowUserAttributeAll

ワークフロー・ユーザー属性を削除します。次のサービスによって、問合せの実行アクションとしてコールされます。

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_DISABLE_SUB

- DELETE_WORKFLOWCRITERIA

A.6 E

editCollaboration

EDIT_CLBRA_ACCESS_LISTおよびEDIT_COLLABORATIONによって、Javaメソッドとしてコールされます。

editCriteria

編集用に基準を準備します。EDIT_WORKFLOWCRITERIAによって、Javaメソッドとしてコールされます。

editRole

ロール情報を編集します。EDIT_ROLEによって、Javaメソッドとしてコールされます。

editSchemaRelation

EDIT_SCHEMA_RELATIONによって、Javaメソッドとしてコールされます。

editSchemaView

EDIT_SCHEMA_VIEWによって、Javaメソッドとしてコールされます。

editSchemaViewValues

EDIT_SCHEMA_VIEW_VALUESによって、Javaメソッドとしてコールされます。

editTemplate

ワークフロー・テンプレートを編集します。EDIT_WF_TEMPLATEによって、Javaメソッドとしてコールされます。

editWorkflowScript

EDIT_WORKFLOW_SCRIPTによって、Javaメソッドとしてコールされます。

editWorkflowStep

ワークフロー・ステップを編集し、IworkflowStepをパラメータとして渡します。EDIT_WORKFLOWSTEPによって、Javaメソッドとしてコールされます。

editWorkflowStepScript

ワークフロー・ステップに関連付けられたスクリプトを編集します。EDIT_WORKFLOWSTEPによって、Javaメソッドとしてコールされます。

editWorkflowToken

EDIT_WORKFLOW_TOKENによって、Javaメソッドとしてコールされます。

enableDisableProvider

プロバイダの有効状態を変更します。ENABLE_DISABLE_PROVIDERによって、Javaメソッドとしてコールされます。

executeArchiveMethod

指定されたアクション(追加、削除など)をアーカイブ・コレクションに対して実行します。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_ARCHIVE

- ADD_COLLECTION

- ADD_PROXIEDCOLLECTION

- CANCEL_ARCHIVE

- COPY_ARCHIVE

- DELETE_ARCHIVE

- DELETE_BATCH_FILE

- DELETE_BATCH_FILE_DOCUMENTS

- EDIT_ARCHIVE

- EDIT_ARCHIVEDATA

- EDIT_EXPORTERS

- EDIT_TRANSFEROPTIONS

- EXPORT_ARCHIVE

- GET_ARCHIVES

- GET_BATCH_SCHEMA

- GET_BATCH_VALUES

- GET_BATCHFILES

- GET_BATCH_FILE_DOCUMENTS

- GET_REPLICATION_DATA

- GET_TARGET_INFO

- GET_TARGET_TRANSFER_STATUS

- GET_TRANSFER_SOURCE_INFO

- IMPORT_ARCHIVE

- IMPORT_DOCUMENT

- INSERT_NATIVE

- REMOVE_COLLECTION

- REMOVE_EXPORTER

- REMOVE_IMPORTER

- REMOVE_PROXIEDTRANSFER

- REMOVE_PROXIEDTRANSFER

- REQUEST_TRANSFER

- TRANSFER_ARCHIVE

- UPDATE_TARGET_TOTALS

- UPDATE_TRANSFER_STATUS

- UPLOAD_ARCHIVE_TRANSFER

executeCommands

EXECUTE_BATCHによって、Javaメソッドとしてコールされます。

executeManifest

マニフェストを実行します。UPLOAD_NEW_COMPONENTによって、Javaメソッドとしてコールされます。

executePageService

ページ・サービスを実行します。PAGE_HANDLERおよびSAVE_GLOBALINCLUDESによって、Javaメソッドとしてコールされます。

ExtensionFormatMap

拡張子フォーマット・マップを取得します。この問合せの結果はExtensionFormatMapパラメータに割り当てられ、後で使用できるように格納されます。GET_DOCEXTENSIONSによって、キャッシュ問合せの選択メソッドとしてコールされます。

A.7 F

filterUpdateData

更新情報をフィルタ処理します。EDIT_USER_PROFILEによって、Javaメソッドとしてコールされます。

A.8 G

getCollaborationData

次のサービスによって、Javaメソッドとしてコールされます。

- EDIT_CLBRA_ACCESS_LIST_FORM

- EDIT_COLLABORATION_FORM

- GET_CLBRA_INFO

getCollaborationDocs

GET_CLBRA_DOCUMENTSによって、Javaメソッドとしてコールされます。

getCollaborations

GET_COLLABORATION_LISTによって、Javaメソッドとしてコールされます。

getCompanionHistory

GET_WORKFLOW_INFOおよびGET_WORKFLOW_INFO_BYNAMEによって、Javaメソッドとしてコールされます。

getComponentConfig

GET_COMPONENT_CONFIGによって、Javaメソッドとしてコールされます。

getDefaultDocFormats

デフォルトのコンテンツ・アイテムのフォーマットを設定します。DOC_FORMATS_WIZARDによって、Javaメソッドとしてコールされます。

getDocFormats

コンテンツ・アイテムのファイル・フォーマットを取得します。次のサービスによって、Javaメソッドとしてコールされます。

- DOC_INFO

- REVIEW_WORKFLOW_DOC

- WORKFLOW_REJECT_FORM

getDocSubscriptionInfo

現在のユーザーがコンテンツ・アイテムをサブスクライブしているかどうか評価し、DOC_INFOページを変更します。次のサービスによって、Javaメソッドとしてコールされます。

- DOC_INFO

- REVIEW_WORKFLOW_DOC

- SUBSCRIBE_DOC_USER

- SUBSCRIBE_FORM

- UNSUBSCRIBE_FORM

getDocumentList

コンテンツ・アイテム・リストを取得します。DOC_SUBS_LISTによって、Javaメソッドとしてコールされます。

getDynamicPage

動的ページを取得します。GET_DYNAMIC_PAGEによって、Javaメソッドとしてコールされます。

getExternalDocInfo

外部コンテンツ・アイテム情報を取得します。GET_EXTERNAL_DOC_INFOによって、Javaメソッドとしてコールされます。

getExternalSecurityInfo

割り当てられているセキュリティ・レベルを評価して、ユーザーにこのアクションを実行する権限があることを確認します。このアクションはSearchCollectionDocInfoをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- GET_EXTERNAL_DOC_INFO

- GET_EXTERNAL_HIGHLIGHT_INFO

- GET_EXTERNAL_XML_HIGHLIGHT_INFO

- VIEW_DOC

getFilesInAppDir

アプリケーション・ディレクトリにリストされているファイルを取得します。GET_FILELISTによって、Javaメソッドとしてコールされます。

getHighlightInfo

コンテンツ・アイテムのハイライト情報を表示します。次のサービスによって、Javaメソッドとしてコールされます。

- GET_EXTERNAL_HIGHLIGHT_INFO

- GET_EXTERNAL_XML_HIGHLIGHT_INFO

- GET_HIGHLIGHT_INFO

- GET_XML_HIGHLIGHT_INFO

getLatestID

QlatestIDをパラメータとして渡します。DELETE_REVによって、Javaメソッドとしてコールされます。

getLatestIDRevInfo

最新リビジョン情報を取得し、Qrevisionsをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_SEL_FORM

- CHECKOUT

- CHECKOUT_BY_NAME

- UNDO_CHECKOUT

- UNDO_CHECKOUT_BY_NAME

getOptionList

最新リビジョン情報を取得し、Qrevisionsをパラメータとして渡します。GET_OPTION_LISTおよびUPDATE_OPTION_LISTによって、Javaメソッドとしてコールされます。

getOutgoingProviders

GET_PROXIEDSERVERSによって、Javaメソッドとしてコールされます。

getProxiedArchiveCollections

GET_PROXIED_ARCHIVECOLLECTIONSによって、Javaメソッドとしてコールされます。

getSchemaRelations

GET_SCHEMA_RELATIONSによって、Javaメソッドとしてコールされます。

getSchemaTableInfo

GET_SCHEMA_TABLE_INFOおよびGET_SCHEMA_VIEW_INFOによって、Javaメソッドとしてコールされます。

getSchemaTables

GET_SCHEMA_TABLESによって、Javaメソッドとしてコールされます。

getSchemaViewInfo

GET_SCHEMA_VIEW_INFOによって、Javaメソッドとしてコールされます。

getSchemaViews

GET_SCHEMA_VIEWSによって、Javaメソッドとしてコールされます。

getSearchResults

検索結果を取得します。GET_SEARCH_RESULTSおよびPNE_GET_SEARCH_RESULTSによって、Javaメソッドとしてコールされます。

getSubscriptionList

サブスクリプション・リストを取得し、QdocNameSubscriptionおよびQnotDocNameSubscriptionsをパラメータとして渡します。SUBSCRIPTION_LISTおよびUNSUBSCRIBE_FROM_LISTによって、Javaメソッドとしてコールされます。

getTable

GET_TABLEによって、Javaメソッドとしてコールされます。

getTemplate

テンプレート・データを取得します。GET_WF_TEMPLATEによって、Javaメソッドとしてコールされます。

getTemplateConversions

GET_TEMPLATE_CONVERSIONSによって、Javaメソッドとしてコールされます。

getTemplates

ワークフロー・テンプレート・データを取得します。GET_WF_TEMPLATESによって、Javaメソッドとしてコールされます。

getURLAbsolute

コンテンツ・アイテムのURLを解決します。URLは、DOC_INFOテンプレートの「Webロケーション:」エントリに渡されます。DOC_INFOおよびREVIEW_WORKFLOW_DOCによって、Javaメソッドとしてコールされます。

getUserAttributes

ユーザー属性を取得します。QUERY_USER_ATTRIBUTESによって、Javaメソッドとしてコールされます。

getUserCollaborationList

GET_USER_CLBRA_LISTによって、Javaメソッドとしてコールされます。

getUserMailAddress

コンテンツ・アイテムの作成者およびコンテンツ・アイテムをチェックアウトしたユーザーの電子メール・アドレスを解決します。このアクションはdDocAuthorとAuthorAddressをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- DOC_INFO

- DOC_INFO_LATESTRELEASE

- DOC_INFO_SIMPLE

- DOC_INFO_SIMPLE_BYREV

- GET_WORKFLOW_INFO

- GET_WORKFLOW_INFO_BYNAME

- PROBLEMREPORT_INFO

- REVIEW_WORKFLOW_DOC

getUserProfile

ユーザー・プロファイル情報を取得します。GET_USER_INFOによって、Javaメソッドとしてコールされます。

getUsers

ユーザー・リストを取得します。GET_USERSによって、Javaメソッドとしてコールされます。

getUserUnique

一意のユーザー名を取得します。REGISTER_USERによって、Javaメソッドとしてコールされます。

getViewEditInfo

GET_SCHEMA_VIEW_EDIT_INFOによって、Javaメソッドとしてコールされます。

getViewValues

GET_SCHEMA_VIEW_VALUESによって、Javaメソッドとしてコールされます。

getWebAppStatus

GET_WEB_APP_STATUSによって、Javaメソッドとしてコールされます。

getWfDocuments

ワークフロー・コンテンツ・アイテムを取得し、WfDocumentsをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- DELETE_WORKFLOW

- DELETE_WORKFLOWCRITERIA

- WORKFLOW_CANCEL

- WORKFLOW_START

getWorkflowDesignInfo

GET_WORKFLOWによって、Javaメソッドとしてコールされます。

getWorkflowDocumentInfo

GET_WORKFLOWによって、Javaメソッドとしてコールされます。

getWorkflowInfo

コンテンツ・アイテムがワークフローの一部かどうか評価します。このアクションはWF_INFOをパラメータとして渡します。DOC_INFOテンプレートが参照され、WF_INFOが存在する場合はワークフロー情報がDOC_INFOテンプレートに含められます。DOC_INFOおよびREVIEW_WORKFLOW_DOCによって、Javaメソッドとしてコールされます。

getWorkflowScript

GET_WORKFLOW_SCRIPTによって、Javaメソッドとしてコールされます。

getWorkflowStepAliasesInfo

ワークフロー・ステップのエイリアス情報を取得します。GET_WORKFLOWによって、Javaメソッドとしてコールされます。

A.9 H

hidePassword

パスワードを非表示にし、USER_INFOをパラメータとして渡します。GET_USER_INFOによって、Javaメソッドとしてコールされます。

A.10 I

Ialias

エイリアス・ユーザー情報を挿入します。ADD_ALIASによって、問合せの実行アクションとしてコールされます。

Icollaboration

ADD_COLLABORATIONによって、問合せの実行アクションとしてコールされます。

IdocAccount

新規アカウントを挿入します。ADD_DOC_ACCOUNTによって、問合せの実行アクションとしてコールされます。

IdocFormat

コンテンツ・アイテムのフォーマットを挿入します。ADD_DOCFORMATによって、問合せの実行アクションとしてコールされます。

IdocType

コンテンツ・アイテム・タイプを挿入します。ADD_DOCTYPEによって、問合せの実行アクションとしてコールされます。

IextensionMap

拡張子マップを挿入します。ADD_DOCEXTENSIONによって、問合せの実行アクションとしてコールされます。

Imeta

メタデータ情報を挿入します。次のサービスによって、問合せの実行アクションとしてコールされます。

- CHECKIN_BYNAME

- CHECKIN_NEW_SUB

- CHECKIN_SEL_SUB

- INSERT_NATIVE

- INSERT_NEW

Imetadef

メタデータ定義情報を挿入します。ADD_METADEFによって、問合せの実行アクションとしてコールされます。

insertAliasUsers

エイリアス情報をデータベースに追加します。ADD_ALIASおよびEDIT_ALIASによって、Javaメソッドとしてコールされます。

insertGroupRow

ADD_GROUPによって、Javaメソッドとしてコールされます。

IproblemReport

問題レポートを更新します。ADD_PROBLEMREPORTによって、問合せの実行アクションとしてコールされます。

Irevision

リビジョンIDを更新します。次のサービスによって、問合せの実行アクションとしてコールされます。

- CHECKIN_BYNAME

- CHECKIN_NEW_SUB

- CHECKIN_SEL_SUB

- INSERT_NATIVE

- INSERT_NEW

Irole

ロールを挿入します。ADD_ROLEによって、問合せの実行としてコールされます。

isDocCheckedOut

次のサービスによって、Javaメソッドとしてコールされます。

- CACHE_WORKFLOW_CHECKIN

- WORKFLOW_APPROVE

- WORKFLOW_CHECKIN_SUB

IsecurityGroup

セキュリティ・グループを挿入します。ADD_GROUPによって、問合せの実行アクションとしてコールされます。

Isubscription

サブスクリプションを挿入します。SUBSCRIBE_EXによって、問合せの実行としてコールされます。

Iworkflow

ワークフロー情報をデータベースに挿入します。ADD_WORKFLOWによって、問合せの実行アクションとしてコールされます。

IworkflowDocument

ADD_WORKFLOWDOCUMENT_SUBによって、問合せの実行アクションとしてコールされます。

IworkflowState

アクティブなワークフローのコンテンツ・アイテムに関する情報を格納する内部ステータス表を提供します。WORKFLOW_APPROVEによって、問合せの実行アクションとしてコールされます。

A.11 L

loadActiveComponentData

構成情報をロードし、ACTIVE_COMPONENTSをパラメータとして渡します。CONFIG_INFOによって、Javaメソッドとしてコールされます。

loadAndValidateValues

指定された値を評価します。次のサービスによって、Javaメソッドとしてコールされます。

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_DISABLE_SUB

- CRITERIAWORKFLOW_ENABLE

- WORKFLOW_CANCEL

- WORKFLOW_START

loadCollaborationList

GET_ACTIVE_WORKFLOWSによって、Javaメソッドとしてコールされます。

loadComponentInstallInfo

GET_COMPONENT_INSTALL_FORMによって、Javaメソッドとしてコールされます。

loadComponentInstallSettings

GET_COMPONENT_INSTALL_SETTINGS'によって、Javaメソッドとしてコールされます。

loadConfigurationInfo

コンテンツ・アイテム固有の構成情報をロードします。GET_DOC_CONFIG_INFOによって、Javaメソッドとしてコールされます。

loadDefaultInfo

デフォルトの構成情報をロードします。次のサービスによって、Javaメソッドとしてコールされます。

- ASSIGN_DOCINFO_FORM

- CHECKIN_NEW_FORM

- CHECKIN_SEL_FORM

- CHECKIN_SIMILAR_FORM

- GET_DOC_CONFIG_INFO

- GET_PORTAL_PAGE

- GET_UPDATE_FORM

- LOAD_DOC_ENVIRONMENT

loadDocConfig

コンテンツ・アイテムの構成情報をロードします。DOC_FORMATS_WIZARDおよびEDIT_DOC_FORMATSによって、Javaメソッドとしてコールされます。

loadDocDefaults

次のサービスによって、Javaメソッドとしてコールされます。

- ASSIGN_DOCINFO_FORM

- CHECKIN_NEW_FORM

- CHECKIN_SIMILAR_FORM

loadFilterConfig

次のサービスによって、Javaメソッドとしてコールされます。

- ASSIGN_DOCINFO_FORM

- CHECKIN_NEW_FORM

- CHECKIN_SIMILAR_FORM

loadGlobalIncludes

グローバル・インクルードをロードします。LOAD_GLOBALINCLUDESによって、Javaメソッドとしてコールされます。

loadMetaDefaults

デフォルトの構成情報をロードします。次のサービスによって、Javaメソッドとしてコールされます。

- ASSIGN_DOCINFO_FORM

- CHECKIN_NEW_FORM

- CHECKIN_SIMILAR_FORM

- GET_UPDATE_FORM

loadMetaOptionsLists

メタデータ・オプション・リストをロードします。次のサービスによって、Javaメソッドとしてコールされます。

- ASSIGN_DOCINFO_FORM

- CHECKIN_NEW_FORM

- CHECKIN_SEL_FORM

- CHECKIN_SIMILAR_FORM

- GET_DOC_CONFIG_INFO

- GET_PORTAL_PAGE

- GET_UPDATE_FORM

- LOAD_DOC_ENVIRONMENT

loadPRStateLists

問題レポート状態リストをロードします。GET_PROBLEMREPORTS_SEARCH_FORMおよびGET_UPDATE_PROBLEMREPORT_FORMによって、Javaメソッドとしてコールされます。

loadRegisteredProjects

問題レポート検索情報を取得します。GET_PROBLEMREPORTS_SEARCH_FORMによって、Javaメソッドとしてコールされます。

loadServerOutput

サーバー出力をロードします。CLEAR_SERVER_OUTPUTおよびGET_SERVER_OUTPUTによって、Javaメソッドとしてコールされます。

loadSharedTable

共有表情報をロードし、ArchiveCollectionsをパラメータとして渡します。パラメータはサービスによって異なります。次のサービスによって、Javaメソッドとしてコールされます。

- CREATE_SUBSCRIPTION_TYPE

- DELETE_SUBSCRIPTION_TYPE

- GET_ARCHIVECOLLECTIONS

- GET_DOC_CONFIG_INFO

- GET_PACKAGE_ENVIRONMENT_PAGE

- GET_PORTAL_PAGE

- GET_RESULT_OPTIONS

- GET_SYSTEM_AUDIT_INFO

- GET_USER_INFO

- LOAD_DOC_ENVIRONMENT

- UPDATE_SUBSCRIPTION_TYPE

loadTopic

次のサービスによって、Javaメソッドとしてコールされます。

- LOAD_PNE_PORTAL

- LOAD_USER_TOPIC

- LOAD_WORKFLOW_QUEUE

loadTraceFlags

GET_SYSTEM_AUDIT_INFOによって、Javaメソッドとしてコールされます。

loadUserAndCheckEditAllowed

ユーザー情報をロードし、ユーザーに許可されている編集権限を評価します。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_USER

- CHANGE_USER_AUTH_TYPE

- DELETE_USER

- EDIT_USER

- QUERY_USER_ATTRIBUTES

loadUserMetaData

ユーザーのメタデータ情報をロードします。次のサービスによって、Javaメソッドとしてコールされます。

- GET_FILTER_ADMIN_PAGE

- GET_SELF_REGISTER_PAGE

- GET_USER_INFO

loadWfCompanionInfo

コンパニオン・ワークフローに関する情報を取得します。GET_WF_COMPANION_INFOによって、Javaメソッドとしてコールされます。

A.12 M

makeNewRevClass

CACHE_CHECKIN_NEWおよびCHECKIN_NEW_SUBによって、Javaメソッドとしてコールされます。

mapDocNamedResultSetValuesCheckMetaChange

CACHE_WORKFLOW_CHECKINによって、Javaメソッドとしてコールされます。

mapDocResultSetCheckMetaChange

CACHE_CHECKIN_SELおよびCHECKIN_SEL_SUBによって、Javaメソッドとしてコールされます。

mapNamedResultSetValues

DOC_INFOパラメータに割り当てられたデータを取得し、結果セットのdStatus、dReleaseStateおよびdProcessingStateの値をマップします。パラメータはサービス間で同じですが、結果セットのマップ値はサービスによって異なります。次のサービスによって、Javaメソッドとしてコールされます。

- DELETE_REV

- DOC_INFO

- RESUBMIT_FOR_CONVERSION

- REVIEW_WORKFLOW_DOC

mapResultSet

結果セットをマップし、QdocInfo、dRevClassID、dDocName、dSecurityGroup、dCheckoutUser、dDocAccountおよびdPublishStateをパラメータとして渡します。パラメータはサービスに応じて異なります。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_PROBLEMREPORT

- APPLET_DOCINFO

- CACHE_CHECKIN_NEW

- CACHE_CHECKIN_SEL

- CACHE_WORKFLOW_CHECKIN

- CHECKIN_BYNAME

- CHECKIN_NEW_SUB

- CHECKIN_SEL_FORM

- CHECKIN_SEL_SUB

- DOC_INFO_LATESTRELEASE

- DOC_INFO_SIMPLE_BYREV

- INSERT_NEW

- RESUBMIT_FOR_CONVERSION

- UNDO_CHECKOUT

- UNDO_CHECKOUT_BY_NAME

- SUBSCRIBE

- WORKFLOW_APPROVE

- WORKFLOW_CHECKIN_SUB

- WORKFLOW_REJECT

markDocDeleted

ステータス・メッセージを設定し、delete_docをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- DELETE_BYCLASS

- DELETE_BYNAME

- DELETE_DOC

markRevDeleted

リビジョンのステータスを削除済として更新します。次のサービスによって、Javaメソッドとしてコールされます。

- DELETE_BYREV

- DELETE_REV

- DELETE_REV_EX

mergeTable

指定された表をマージします。MERGE_TABLEによって、Javaメソッドとしてコールされます。

A.13 N

notifyChange

コンテンツ・アイテムの変更をプロバイダに通知します。NOTIFY_CHANGEによって、Javaメソッドとしてコールされます。

notifyCollaborationUsers

ADD_COLLABORATIONおよびEDIT_CLBRA_ACCESS_LISTによって、Javaメソッドとしてコールされます。

notifyContributor

ADD_PROBLEMREPORTおよびRESEND_PROBLEMREPORTによって、Javaメソッドとしてコールされます。

A.14 P

packageEnvironment

PACKAGE_ENVIRONMENTによって、Javaメソッドとしてコールされます。

packageLocalization

LOAD_USER_LOCALIZATIONによって、Javaメソッドとしてコールされます。

pageRequest

HTMLページ・リクエストを実行します。次のサービスによって、Javaメソッドとしてコールされます。

- GET_ADMIN_PAGE

- GET_DOC_PAGE

- GET_PORTAL_PAGE

- GET_SECURE_PAGE

- LOGIN

- PNE_SAVE_QUERY

- PNE_UPDATE_PERSONAL_URLS

- PNE_UPDATE_PORTAL_INFO

postCheckinFilter

ポスト・チェックイン・フィルタを処理します。FORM_PROCESSによって、Javaメソッドとしてコールされます。

postHtmlFormCheckin

HTMLフォームを送信します。CONTINUE_SUBMIT_HTML_FORMおよびSUBMIT_HTML_FORMによって、Javaメソッドとしてコールされます。

prepareCheckinSecurity

割り当てられているセキュリティ・レベルを評価して、ユーザーにこのアクションを実行する権限があることを確認します。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_NEW

- CHECKIN_SEL

- UPDATE_DOCINFO_SUB

prepareDocInfoValidate

VALIDATE_DOCINFOによって、Javaメソッドとしてコールされます。

prepareFormContinue

CONTINUE_SUBMIT_HTML_FORMによって、Javaメソッドとしてコールされます。

prepareForPreview

CACHE_SUBMIT_HTML_FORMによって、Javaメソッドとしてコールされます。

prepareInsertNew

INSERT_NEWによって、Javaメソッドとしてコールされます。

prepareMailForStepUsers

ワークフロー・ステップのユーザーに電子メールを送信します。WORKFLOW_REJECTおよびWORKFLOW_STARTによって、Javaメソッドとしてコールされます。

prepareRedirect

指定されたサービス用にリダイレクト・テンプレートを準備します。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_COLLABORATION

- ADD_EDIT_PROVIDER

- ADD_PROBLEMREPORT

- CHECKIN_NEW

- CHECKIN_SEL

- CHECKOUT

- CLEAR_SERVER_OUTPUT

- CONTINUE_SUBMIT_HTML_FORM

- DELETE_COLLABORATION

- DELETE_PROBLEMREPORT

- DELETE_PROVIDER

- DELETE_REV

- EDIT_CLBRA_ACCESS_LIST

- EDIT_COLLABORATION

- EDIT_DOC_FORMATS

- EDIT_TRACE_OPTIONS

- EDIT_USER_PROFILE

- ENABLE_DISABLE_PROVIDER

- RESUBMIT_FOR_CONVERSION

- SAVE_TEMPLATE_CONVERSIONS

- SAVE_USER_TOPICS

- SUBMIT_HTML_FORM

- SUBSCRIBE

- TEST_PROVIDER

- UNDO_CHECKOUT

- UNSUBSCRIBE

- UPDATE_DOCINFO_BYFORM

- UPDATE_FILTER_INFO

- UPDATE_PROBLEMREPORT

- UPLOAD_NEW_COMPONENT

- WORKFLOW_APPROVE

- WORKFLOW_CHECKIN

- WORKFLOW_REJECT

prepareTopicEdits

トピックの編集を準備します。次のサービスによって、Javaメソッドとしてコールされます。

- EDIT_USER_PROFILE

- GET_CLBRA_DOCUMENTS

- PNE_GET_SEARCH_RESULTS

- PNE_SAVE_QUERY

- PNE_UPDATE_PERSONAL_URLS

- PNE_UPDATE_PORTAL_INFO

- SAVE_USER_TOPICS

prepareWebViewableDelivery

GET_DYNAMIC_CONVERSIONによって、Javaメソッドとしてコールされます。

prepSubscription

Prepares the subscription.DOC_SUBS_LISTによって、Javaメソッドとしてコールされます。

prepSubscriptionDateUpdate

更新用にサブスクリプション日を準備し、指定されたパラメータを渡します。UPDATE_SUBSCRIPTION_NOTIFYおよびUPDATE_SUBSCRIPTION_USEDによって、Javaメソッドとしてコールされます。

processCheckinArchive

コンテンツ・アイテムをアーカイブにチェックインします。次のサービスによって、Javaメソッドとしてコールされます。

- CHECKIN_ARCHIVE

- CHECKIN_ARCHIVE_NO_NOTIFY

processForm

フォームの送信を処理し、checkSecurityをパラメータとして渡します。FORM_PROCESSによって、Javaメソッドとしてコールされます。

A.15 Q

Qalias

ユーザー・エイリアス情報の問合せを実行します。この問合せの結果はAliasInfoパラメータに割り当てられます。ADD_ALIASおよびEDIT_ALIASによって、問合せの選択アクションとしてコールされます。

QaliasesForUser

ユーザーにエイリアスが割り当てられているかどうかの問合せを実行します。この問合せの結果はAliasパラメータに割り当てられます。DELETE_USERによって、問合せの選択アクションとしてコールされます。

QarchivedDoc

データベースからアーカイブされたコンテンツ・アイテム情報を取得します。この問合せの結果はFILE_DOC_INFOパラメータに割り当てられ、後で使用できるように格納されます。このアクションでは例外はスローされません。制御マスク設定によって、この問合せではレコードを返す必要があること(レコードが返らない場合、アクションが失敗し、指定されたエラー・メッセージが出力されること)が指定されます。GET_ARCHIVED_FILEによって、キャッシュ問合せの選択アクションとしてコールされます。

Qcache

CONTINUE_SUBMIT_HTML_FORMによって、キャッシュ問合せの選択アクションとしてコールされます。

QcheckinCache

次のサービスによって、キャッシュ問合せの選択としてコールされます。

- CACHE_CHECKIN_NEW

- CACHE_CHECKIN_SEL

- CACHE_SUBMIT_HTML_FORM

- CACHE_WORKFLOW_CHECKIN

- CONTINUE_CHECKIN

- DELETE_CHECKIN_CACHE

- GET_CACHED_CHECKIN_INFO

QcheckinCachesForUser

次のサービスによって、キャッシュ問合せの選択アクションとしてコールされます。

- CHECKIN_LIST

- CONTINUE_CHECKIN

- "DELETE_BYREV"

Qcollaboration

ADD_COLLABORATIONによって、問合せの選択アクションとしてコールされます。

次のサービスによって、キャッシュ問合せの選択アクションとしてコールされます。

- DELETE_COLLABORATION

- EDIT_CLBRA_ACCESS_LIST

- EDIT_CLBRA_ACCESS_LIST_FORM

- EDIT_COLLABORATION

- EDIT_COLLABORATION_FORM

- GET_CLBRA_DOCUMENTS

- GET_CLBRA_INFO

QdocAccount

コンテンツ・アイテムのアカウント情報に関する問合せを実行します。この問合せの結果はDOCACCOUNT_INFOパラメータに割り当てられます。ADD_DOC_ACCOUNTによって、問合せの選択アクションとしてコールされます。

QdocAccounts

コンテンツ・アイテムのアカウント情報を取得します。この問合せの結果はDOCACCOUNT_INFOパラメータに割り当てられ、後で使用できるように格納されます。QUERY_DOC_ACCOUNTSによって、キャッシュ問合せの選択アクションとしてコールされます。

QdocInfo

コンテンツ・アイテム情報を取得します。この問合せの結果はDOC_INFOパラメータに割り当てられます。次のサービスによって、キャッシュ問合せの選択アクションとしてコールされます。

- ADD_PROBLEMREPORT

- APPLET_DOCINFO

- CACHE_WORKFLOW_CHECKIN

- CHECKIN_SEL_FORM

- CHECKOUT

- CHECKOUT_BY_NAME

- CHECKOUT_OK

- DELETE_DOC

- DELETE_REV

- DELETE_REV_EX

- DOC_INFO

- DOC_INFO_LATESTRELEASE

- DOC_INFO_SIMPLE

- DOC_INFO_SIMPLE_BYREV

- GET_DOC_CONFIG_INFO

- GET_DYNAMIC_CONVERSION

- GET_FILE

- GET_UPDATE_FORM

- GET_WORKFLOW_INFO

- NOTIFY_CONTRIBUTOR

- RESUBMIT_FOR_CONVERSION

- REV_HISTORY

- REVIEW_WORKFLOW_DOC

- SELECTDOC

- SUBSCRIBE

- SUBSCRIBE_DOC_USER

- SUBSCRIBE_FORM

- UNSUBSCRIBE_FORM

- UPDATE_DOCINFO_BYREV

- UPDATE_DOCINFO_SUB

- WORKFLOW_CHECKIN

QdocInfoSimilarCheckin

CHECKIN_SEL_SUBによって、キャッシュ問合せの選択としてコールされます。

QdocName

次のサービスによって、キャッシュ問合せの選択としてコールされます。

- DELETE_PROBLEMREPORT

- DOC_INFO_SIMPLE

- GET_UPDATE_PROBLEMREPORT_FORM

- GET_WF_COMPANION_INFO

- PROBLEMREPORT_INFO

- RESEND_PROBLEMREPORT

- UPDATE_PROBLEMREPORT

QdocNameMeta

コンテンツ・アイテム名を取得します。この問合せの結果はDOC_INFOパラメータに割り当てられ、後で使用できるように格納されます。次のサービスによって、キャッシュ問合せの選択としてコールされます。

- DOC_INFO_SIMPLE

- GET_DOCUMENT_PROBLEMREPORTS

- GET_WORKFLOW_INFO_BYNAME

QdocType

コンテンツ・アイテムのファイル・タイプ情報に関する問合せを実行します。この問合せの結果はDOCTYPE_INFOパラメータに割り当てられます。ADD_DOCTYPEによって、問合せの選択アクションとしてコールされます。

QdocTypeDocuments

特定のコンテンツ・アイテムのファイル・タイプ情報に関する問合せを実行します。この問合せの結果はDOCUMENTSパラメータに割り当てられます。DELETE_DOCTYPEによって、問合せの選択アクションとしてコールされます。

QdocTypes

コンテンツ・アイテム・タイプを取得します。この問合せの結果はDocTypesパラメータに割り当てられ、後で使用できるように格納されます。GET_DOCTYPESによって、キャッシュ問合せの選択アクションとしてコールされます。

QdocumentProblemReports

GET_DOCUMENT_PROBLEMREPORTSによって、キャッシュ問合せの選択アクションとしてコールされます。

Qdocuments

UPDATE_DOCINFO_BYREVおよびUPDATE_DOCINFO_SUBによって、キャッシュ問合せの選択アクションとしてコールされます。

QextensionFormatMap

コンテンツ・アイテムのフォーマット・マップ拡張子に関する問合せを実行します。この問合せの結果はFormatMapパラメータに割り当てられます。DELETE_DOCFORMATによって、問合せの選択アクションとしてコールされます。

QextensionMap

ファイル拡張子のマッピングに関する問合せを実行します。この問合せの結果はExtensionMapパラメータに割り当てられます。ADD_DOCEXTENSIONによって、問合せの選択アクションとしてコールされます。

QformatMap

フォーマット・マップ情報に関する問合せを実行します。この問合せの結果はFormatMapパラメータに割り当てられます。ADD_DOCFORMATによって、問合せの選択アクションとしてコールされます。

Qgroup

グループ情報に関する問合せを実行します。この問合せの結果はGROUP_INFOパラメータに割り当てられます。ADD_GROUPによって、問合せの選択アクションとしてコールされます。

QgroupRevisions

グループ・リビジョン情報に関する問合せを実行します。この問合せの結果はGROUP_REVSパラメータに割り当てられます。DELETE_GROUPによって、問合せの選択アクションとしてコールされます。

QgroupRole

グループ・ロール情報に関する問合せを実行します。この問合せの結果はGroupRoleパラメータに割り当てられます。EDIT_GROUPによって、キャッシュ問合せの選択アクションとしてコールされます。

QgroupWF

グループ・ワークフロー情報に関する問合せを実行します。この問合せの結果はGROUP_WFパラメータに割り当てられます。DELETE_GROUPによって、問合せの選択アクションとしてコールされます。

QisAliasSubscribed

エイリアスがサブスクライブされているかどうかの問合せを実行します。この問合せの結果はSUBSCRIIPTION_INFOパラメータに割り当てられます。SUBSCRIBE_EXによって、問合せの選択アクションとしてコールされます。

QisDocWFLocked

ADD_WORKFLOWDOCUMENT_SUBによって、問合せの選択アクションとしてコールされます。

QisWfTokenUsed

DELETE_WORKFLOW_TOKENによって、問合せの選択アクションとしてコールされます。

QlatestIDByName

最新のコンテンツ・アイテム名情報を取得します。この問合せの結果はDOC_LATEST_IDパラメータに割り当てられ、後で使用できるように格納されます。制御マスク設定によって、この問合せではレコードを返す必要があること(レコードが返らない場合、アクションが失敗し、指定されたエラー・メッセージが出力されること)が指定されます。CHECKOUT_BY_NAMEおよびUNDO_CHECKOUT_BY_NAMEによって、キャッシュ問合せの選択アクションとしてコールされます。

Qmetadef

次のサービスによって、問合せの選択アクションとしてコールされます。

- ADD_METADEF

- EDIT_METADEF

- DEL_METADEF

QmetaFieldInfo

メタデータ・フィールド情報を取得し、MetaFieldInfoをパラメータとして渡します。GET_METADEFSおよびUPDATE_META_TABLEによって、キャッシュ問合せの選択アクションとしてコールされます。

QODMAdocInfo

ODMA_DOC_INFO_SIMPLEによって、キャッシュ問合せの選択アクションとしてコールされます。

QproblemReport

問合せを使用してデータベースから問題レポート情報を取得します。この問合せの結果はProblemReportパラメータに割り当てられ、後で使用できるように格納されます。次のサービスによって、キャッシュ問合せの選択としてコールされます。

- ADD_PROBLEMREPORT

- DELETE_PROBLEMREPORT

- GET_UPDATE_PROBLEMREPORT_FORM

- PROBLEMREPORT_INFO

- RESEND_PROBLEMREPORT

- UPDATE_PROBLEMREPORT

QprojectDocument

次のサービスによって、キャッシュ問合せの選択としてコールされます。

- ADD_PROBLEMREPORT

- GET_DOCUMENT_PROBLEMREPORTS

- PROBLEMREPORT_INFO

- RESEND_PROBLEMREPORT

QregisteredProject

登録されているプロジェクト情報を取得します。この問合せの結果は指定されたパラメータに割り当てられます。次のサービスによって、キャッシュ問合せの選択としてコールされます。

- ADD_PROBLEMREPORT

- GET_DOCUMENT_PROBLEMREPORTS

- PROBLEMREPORT_INFO

- RESEND_PROBLEMREPORT

QreleasedDocInfo

コンテンツ・アイテムのセキュリティ情報を取得します。この問合せの結果はSEC_DOC_INFOパラメータに割り当てられ、後で使用できるように格納されます。制御マスク設定によって、この問合せではレコードを返す必要があること(レコードが返らない場合、アクションが失敗し、指定されたエラー・メッセージが出力されること)が指定されます。GET_HIGHLIGHT_INFOおよびGET_XML_HIGHLIGHT_INFOによって、キャッシュ問合せの選択アクションとしてコールされます。

QrevHistory

リビジョンの履歴情報を取得します。この問合せの結果はREVISION_HISTORYパラメータに割り当てられます。DOC_INFOテンプレートは、REVISION_HISTORYをループで使用して、DOC_INFページ内の各リビジョンに関する情報を表示します。DOC_INFOおよびREVIEW_WORKFLOW_DOCによって、キャッシュ問合せの選択アクションとしてコールされます。

QrevHistoryReleased

リビジョンの履歴情報を取得します。この問合せの結果はREVISION_HISTORYパラメータに割り当てられます。DOC_INFOテンプレートは、REVISION_HISTORYをループで使用して、DOC_INFOページ内の各リビジョンに関する情報を表示します。REV_HISTORYによって、キャッシュ問合せの選択アクションとしてコールされます。

QrevisionsByClass

クラス別のリビジョン情報を取得します。この問合せの結果はREVISIONSパラメータに割り当てられ、後で使用できるように格納されます。DELETE_BYCLASSおよびDELETE_DOCによって、キャッシュ問合せの選択アクションとしてコールされます。

QrevisionsByName

DELETE_BYNAMEによって、キャッシュ問合せの選択アクションとしてコールされます。

Qrole

ロール情報に関する問合せを実行します。この問合せの結果はROLE_INFOパラメータに割り当てられます。ADD_ROLEによって、問合せの選択アクションとしてコールされます。

Qroles

ロール情報に関する問合せを実行します。この問合せの結果はROLESパラメータに割り当てられ、後で使用できるように格納されます。ロールのリストに関する問合せができない場合、このアクションはデータ例外をスローします。ADD_GROUPによって、キャッシュ問合せの選択アクションとしてコールされます。

QsecurityGroup

データベースからセキュリティ・グループ情報を取得します。この問合せの結果はSECURITY_GROUPSパラメータに割り当てられます。制御マスク設定によって、この問合せではレコードを返す必要があること(レコードが返らない場合、アクションが失敗し、指定されたエラー・メッセージが出力されること)が指定されます。セキュリティ・グループがデータベースに含まれていない場合、このアクションはデータ例外をスローします。

EDIT_GROUPによって、問合せの選択アクションとしてコールされます。

QUERY_GROUPによって、キャッシュ問合せの選択アクションとしてコールされます。

Quser

ユーザー情報を取得します。この問合せの結果はUSER_INFOパラメータに割り当てられ、後で使用できるように格納されます。制御マスク設定によって、この問合せではレコードを返す必要があること(レコードが返らない場合、アクションが失敗し、指定されたエラー・メッセージが出力されること)が指定されます。指定されたユーザーの情報をシステムが取得できない場合、このアクションはデータ例外をスローします。GET_USER_INFOによって、キャッシュ問合せの選択アクションとしてコールされます。

QuserMetaFieldInfo

GET_USER_METADEFSおよびUPDATE_USER_META_TABLEによって、キャッシュ問合せの選択アクションとしてコールされます。

QuserSecurityAttributeByType

タイプ別のセキュリティ属性を取得します。この問合せの結果はRoleUsersパラメータに割り当てられます。DELETE_ROLEによって、問合せの選択アクションとしてコールされます。

QuserSubscription

ユーザー・サブスクリプション情報を取得します。この問合せの結果はUSER_SUBSCRIPTIONパラメータに割り当てられ、後で使用できるように格納されます。DOC_SUBS_LISTによって、キャッシュ問合せの選択アクションとしてコールされます。

QwfCriteriaDocRevs

ワークフロー・リビジョン基準を取得します。この問合せの結果はWfDocumentsパラメータに割り当てられ、後で使用できるように格納されます。このアクションでは例外はスローされません。CRITERIAWORKFLOW_DISABLEおよびCRITERIAWORKFLOW_DISABLE_SUBよって、キャッシュ問合せの選択アクションとしてコールされます。

QwfDocInformation

アクティブなワークフロー・コンテンツ・アイテムのリビジョンIDを参照します。この問合せの結果はDOC_INFOパラメータに割り当てられ、後で使用できるように格納されます。WORKFLOW_REJECTによって、キャッシュ問合せの選択アクションとしてコールされます。

QwfDocName

ADD_WORKFLOWDOCUMENT_SUBによって、キャッシュ問合せの選択アクションとしてコールされます。

QwfDocState

GET_WORKFLOW_INFOおよびGET_WORKFLOW_INFO_BYNAMEによって、キャッシュ問合せの選択アクションとしてコールされます。

QwfStates

ワークフロー状態情報を取得し、アクティブなワークフローのコンテンツ・アイテムに関する情報を格納する内部ステータス表を提供します。この問合せの結果はWorkflowStateパラメータに割り当てられ、後で使用できるように格納されます。このアクションでは例外はスローされません。GET_WORKFLOWDOCREVISIONSによって、キャッシュ問合せの選択アクションとしてコールされます。

Qworkflow

ワークフロー情報を取得します。この問合せの結果は指定されたパラメータに割り当てられます。ADD_WORKFLOWによって、問合せの選択アクションとしてコールされます。

次のサービスによって、キャッシュ問合せの選択アクションとしてコールされます。

- ADD_WORKFLOWALIASES

- ADD_WORKFLOWDOCUMENT

- ADD_WORKFLOWDOCUMENTS

- ADD_WORKFLOWSTEP

- CRITERIAWORKFLOW_ENABLE

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_DISABLE_SUB

- DELETE_WFCONTRIBUTORS

- DELETE_WORKFLOW

- DELETE_WORKFLOWCRITERIA

- DELETE_WORKFLOWSTEP

- DELETE_WORKFLOWDOCUMENTS

- DELETE_WORKFLOWSTEP

- EDIT_WORKFLOW

- EDIT_WORKFLOWCRITERIA

- EDIT_WORKFLOWSTEP

- GET_WORKFLOW

- GET_WORKFLOWDOCUMENTS

- GET_WORKFLOWDOCREVISIONS

- WORKFLOW_START

- WORKFLOW_CANCEL

QworkflowAlias

ワークフロー・エイリアス情報を取得します。この問合せの結果はWFAliasパラメータに割り当てられます。DELETE_ALIASによって、問合せの選択アクションとしてコールされます。

QworkflowAliases

ワークフロー・エイリアス情報を取得します。DELETE_WFCONTRIBUTORSによって、キャッシュ問合せの選択アクションとしてコールされます。

QworkflowCriteriaForGroup

GET_CRITERIA_WORKFLOWS_FOR_GROUPによって、キャッシュ問合せの選択アクションとしてコールされます。

QworkflowCriteriaStepsForGroup

GET_CRITERIA_WORKFLOWS_FOR_GROUPによって、キャッシュ問合せの選択アクションとしてコールされます。

QworkflowDocument

ワークフロー・コンテンツ・アイテム情報を取得します。この問合せの結果はWfDocumentsパラメータに割り当てられ、後で使用できるように格納されます。次のサービスによって、キャッシュ問合せの選択アクションとしてコールされます。

- GET_WF_COMPANION_INFO

- GET_WORKFLOW_INFO

- GET_WORKFLOW_INFO_BYNAME

QworkflowDocuments

ワークフロー・コンテンツ・アイテム情報を取得します。この問合せの結果はWfDocumentsパラメータに割り当てられ、後で使用できるように格納されます。GET_WORKFLOWおよびGET_WORKFLOWDOCUMENTSによって、キャッシュ問合せの選択アクションとしてコールされます。

QworkflowForID

GET_WORKFLOW_INFOおよびGET_WORKFLOW_INFO_BYNAMEによって、キャッシュ問合せの選択アクションとしてコールされます。

Qworkflows

GET_WORKFLOWS_FOR_ALLによって、キャッシュ問合せの選択アクションとしてコールされます。

QworkflowStep

ワークフロー・ステップ情報を取得します。この問合せの結果はSTEP_INFOパラメータに割り当てられます。ステップ名が一意でない場合、このアクションはデータ例外をスローします。ADD_WORKFLOWSTEPによって、問合せの選択アクションとしてコールされます。EDIT_WORKFLOWSTEPよって、キャッシュ問合せの選択アクションとしてコールされます。

QworkflowSteps

各ステップを渡すために必要な、手順説明、タイプ、レビューア数などのワークフロー・ステップ情報を取得します。この問合せの結果は指定されたパラメータに割り当てられます。次のサービスによって、キャッシュ問合せの選択アクションとしてコールされます。

- CRITERIAWORKFLOW_ENABLE

- GET_WORKFLOW_INFO

- GET_WORKFLOW_INFO_BYNAME

- WORKFLOW_START

QworkflowStepsAll

GET_WORKFLOWS_FOR_ALLによって、キャッシュ問合せの選択アクションとしてコールされます。

A.16 R

refreshCache

キャッシュされた指定の情報をリフレッシュします。指定の情報はサービスによって異なります。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_ALIAS

- ADD_DOC_ACCOUNT

- ADD_DOCEXTENSION

- ADD_DOCFORMAT

- ADD_DOCTYPE

- ADD_METADEF

- ADD_WORKFLOW

- ADD_WORKFLOWALIASES

- ADD_WORKFLOWDOCUMENT

- ADD_WORKFLOWDOCUMENTS

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_ENABLE

- DEL_METADEF

- DELETE_ALIAS

- DELETE_DOC_ACCOUNT

- DELETE_DOCEXTENSION

- DELETE_DOCFORMAT

- DELETE_DOCTYPE

- DELETE_WFCONTRIBUTORS

- DELETE_WORKFLOW

- DELETE_WORKFLOWCRITERIA

- DELETE_WORKFLOWDOCUMENTS

- EDIT_ALIAS

- EDIT_DOCEXTENSION

- EDIT_DOCFORMAT

- EDIT_DOC_FORMATS

- EDIT_DOCTYPE

- EDIT_METADEF

- EDIT_WORKFLOW

- EDIT_WORKFLOWCRITERIA

- UPDATE_META_TABLE

- UPDATE_USER_META

- UPDATE_USER_META_TABLE

- WORKFLOW_CANCEL

- WORKFLOW_START

refreshLayoutLists

LM_LOAD_LAYOUTS_SUBによって、Javaメソッドとしてコールされます。

refreshRoles

ユーザー・ロールをリフレッシュします。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_GROUP

- ADD_ROLE

- DELETE_GROUP

- DELETE_ROLE

- EDIT_ROLE

rejectDoc

コンテンツ・アイテムを却下し、UrevisionStatusをパラメータとして渡します。WORKFLOW_REJECTによって、Javaメソッドとしてコールされます。

remoteCredentialsCheck

CHECK_USER_CREDENTIALSによって、Javaメソッドとしてコールされます。

removeCachedUser

次のサービスによって、Javaメソッドとしてコールされます。

- ADD_USER

- DELETE_USER

- EDIT_USER

- REGISTER_USER

removeContext

REMOVE_WEB_APPによって、Javaメソッドとしてコールされます。

removeSubscription

サブスクリプションを削除し、Dsubscriptionをパラメータとして渡します。次のサービスによって、Javaメソッドとしてコールされます。

- UNSUBSCRIBE

- UNSUBSCRIBE_FROM_LIST

- UNSUBSCRIBE_FROM_LIST_EX

renameValues

関連付けられた値の名前を変更し、指定されたパラメータを渡します。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_PROBLEMREPORT

- CACHE_CHECKIN_SEL

- CACHE_WORKFLOW_CHECKIN

- CHECKIN_SEL_SUB

- CHECKIN_SIMILAR_FORM

- DELETE_PROBLEMREPORT

- DELETE_REV

- DELETE_ROLE

- DELETE_USER

- GET_UPDATE_FORM

- GET_WORKFLOW_INFO

- GET_WORKFLOW_INFO_BYNAME

- NOTIFY_CONTRIBUTOR

- SUBSCRIBE

- WORKFLOW_APPROVE

- WORKFLOW_CHECKIN_SUB

- WORKFLOW_REJECT

- WORKFLOW_START

requestSecurityInfo

セキュリティ情報をリクエストします。REQUEST_SECURITYINFOによって、Javaメソッドとしてコールされます。

resubmitDocToConversion

コンテンツ・アイテムを変換用に再送信します。RESUBMIT_FOR_CONVERSIONによって、Javaメソッドとしてコールされます。

retrieveAllProviderInfo

プロバイダ・リストを取得します。GET_ALL_PROVIDERSによって、Javaメソッドとしてコールされます。

retrieveCachedInfo

次のサービスによって、Javaメソッドとしてコールされます。

- CONTINUE_CHECKIN

- CONTINUE_SUBMIT_HTML_FORM

- GET_CACHED_CHECKIN_INFO

retrieveProblemReportInfo

問題レポート情報を取得します。次のサービスによって、Javaメソッドとしてコールされます。

- GET_UPDATE_PROBLEMREPORT_FORM

- PROBLEMREPORT_INFO

- RESEND_PROBLEMREPORT

retrieveProviderInfo

登録されているプロバイダ情報を取得します。GET_PROVIDER_INFOによって、Javaメソッドとしてコールされます。

retrieveUserDatabaseProfileData

ユーザーのデータベース・プロファイル情報を取得します。REGISTER_USERによって、Javaメソッドとしてコールされます。

runHtmlConversion

GET_DYNAMIC_CONVERSION_SUBによって、Javaメソッドとしてコールされます。

A.17 S

saveGlobalIncludes

グローバル・インクルードを保存します。SAVE_GLOBALINCLUDESによって、Javaメソッドとしてコールされます。

saveTemplateConversions

SAVE_TEMPLATE_CONVERSIONSによって、Javaメソッドとしてコールされます。

saveUserOptionList

ユーザー・オプション・リストを保存します。UPDATE_USEROPTION_LISTによって、Javaメソッドとしてコールされます。

searchCacheReport

APPEND_SEARCH_AUDIT_INFOによって、Javaメソッドとしてコールされます。

searchProblemReports

問題レポート検索情報を取得します。GET_PROBLEMREPORTS_SEARCH_RESULTSによって、Javaメソッドとしてコールされます。

sendMailTo

問題レポートのコントリビュータに電子メールを送信します。NOTIFY_CONTRIBUTORによって、Javaメソッドとしてコールされます。

setConditionVars

次のサービスによって、Javaメソッドとしてコールされます。

- ADD_COLLABORATION

- ADD_COLLABORATION_FORM

- ADD_WORKFLOW

- ADD_WORKFLOWALIASES

- ADD_WORKFLOWDOCUMENT

- ADD_WORKFLOWDOCUMENTS

- ASSIGN_DOCINFO_FORM

- CACHE_CHECKIN_NEW

- CACHE_CHECKIN_SEL

- CACHE_SUBMIT_HTML_FORM

- CACHE_WORKFLOW_CHECKIN

- CRITERIAWORKFLOW_DISABLE

- CRITERIAWORKFLOW_DISABLE_SUB

- CRITERIAWORKFLOW_ENABLE

- DELETE_COLLABORATION

- DELETE_WFCONTRIBUTORS

- DELETE_WORKFLOW

- DELETE_WORKFLOWCRITERIA

- DELETE_WORKFLOWDOCUMENTS

- EDIT_COLLABORATION

- EDIT_COLLABORATION_FORM

- EDIT_WORKFLOW

- EDIT_WORKFLOWCRITERIA

- GET_CLBRA_INFO

- GET_WORKFLOWDOCREVISIONS

- GET_WORKFLOWDOCUMENTS

- WORKFLOW_APPROVE

- WORKFLOW_CANCEL

- WORKFLOW_REJECT

- WORKFLOW_REJECT_FORM

- WORKFLOW_START

setDateToPresent

現在の日付を設定し、指定されたパラメータを渡します。次のサービスによって、Javaメソッドとしてコールされます。

- SUBSCRIBE_EX

- UPDATE_SUBSCRIPTION_NOTIFY

- UPDATE_SUBSCRIPTION_USED

setDeleteRevReleaseState

リビジョンのステータスを削除済として更新します。次のサービスによって、Javaメソッドとしてコールされます。

- DELETE_BYREV

- DELETE_REV

- DELETE_REV_EX

setExternalDocInfoFields

外部コンテンツ・アイテム情報フィールドを設定します。GET_EXTERNAL_DOC_INFOによって、Javaメソッドとしてコールされます。

setFileConversionInfo

GET_DYNAMIC_CONVERSIONによって、Javaメソッドとしてコールされます。

setInputConversionInfo

GET_DYNAMIC_CONVERSION_SUBによって、Javaメソッドとしてコールされます。

setLocalValues

関連付けられたローカル値を設定し、指定されたパラメータを渡します。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_GROUP

- ADD_PROBLEMREPORT

- ADD_PROXIEDCOLLECTION

- ADD_ROLE

- ADD_USER

- ASSIGN_DOCINFO_FORM

- CACHE_WORKFLOW_CHECKIN

- CHECKIN_ARCHIVE_NO_NOTIFY

- CHECKIN_LIST

- CHECKIN_NEW_FORM

- CHECKIN_SIMILAR_FORM

- CLEAR_SERVER_OUTPUT

- CONTINUE_CHECKIN

- CONTINUE_SUBMIT_HTML_FORM

- DELETE_CHECKIN_CACHE

- DELETE_ROLE

- EDIT_CLBRA_ACCESS_LIST_FORM

- EDIT_USER

- EDIT_USER_PROFILE

- GET_ACTIVE_WORKFLOWS

- GET_CLBRA_DOCUMENTS

- GET_DOC_CONFIG_INFO

- GET_EXPIRED

- GET_SYSTEM_AUDIT_INFO

- GET_WORKFLOWS

- LOAD_PNE_PORTAL

- LOAD_WORKFLOW_QUEUE

- REGISTER_USER

- REMOVE_PROXIEDTRANSFER

- RESUBMIT_FOR_CONVERSION

- REVIEW_WORKFLOW_DOC

- UPDATE_BYREV

- UPDATE_DOCINFO_BYREV

- UPDATE_DOCINFO_SUB

- VALIDATE_DOCINFO

- WORK_IN_PROGRESS

- WORKFLOW_APPROVE

- WORKFLOW_CHECKIN_SUB

- WORKFLOW_REJECT

setOutputConversionInfo

GET_DYNAMIC_CONVERSION_SUBによって、Javaメソッドとしてコールされます。

setStatusMessage

ステータス・メッセージを設定し、指定されたパラメータを渡します。次のサービスによって、Javaメソッドとしてコールされます。

- CACHE_CHECKIN_NEW

- CACHE_CHECKIN_SEL

- CACHE_SUBMIT_HTML_FORM

- CACHE_WORKFLOW_CHECKIN

- CHECKIN_NEW_SUB

- CHECKIN_SEL_SUB

- DELETE_BYCLASS

- DELETE_BYNAME

- DELETE_BYREV

- DELETE_DOC

- DELETE_REV

- DELETE_REV_EX

- INSERT_NATIVE

- INSERT_NEW

- REPLACE_METAFILE_SUB

- UPDATE_BYREV

- WORKFLOW_CHECKIN_SUB

setTemplateConversionInfo

GET_DYNAMIC_CONVERSION_SUBによって、Javaメソッドとしてコールされます。

setTraceFlags

EDIT_TRACE_OPTIONSによって、Javaメソッドとしてコールされます。

startCriteriaWorkflow

基準ワークフローを有効化します。CRITERIAWORKFLOW_ENABLEによって、Javaメソッドとしてコールされます。

startWorkflow

ワークフロー・プロセスを開始し、WfDocumentsをパラメータとして渡します。WORKFLOW_STARTによって、Javaメソッドとしてコールされます。

storeUserDatabaseProfileData

ユーザー・プロファイル情報をデータベースに格納します。次のサービスによって、Javaメソッドとしてコールされます。

- ADD_USER

- EDIT_USER

- EDIT_USER_PROFILE

- REGISTER_USER

submitForm

フォームを送信します。FORM_SUBMITによって、Javaメソッドとしてコールされます。

submitHtmlForm

フォームを送信します。次のサービスによって、Javaメソッドとしてコールされます。

- CACHE_SUBMIT_HTML_FORM

- CONTINUE_SUBMIT_HTML_FORM

- SUBMIT_HTML_FORM

A.18 T

testProvider

プロバイダをテストします。TEST_PROVIDERによって、Javaメソッドとしてコールされます。

testWorkflowScript

TEST_WORKFLOW_SCRIPTによって、Javaメソッドとしてコールされます。

A.19 U

Ualias

エイリアスを更新します。EDIT_ALIASによって、問合せの実行アクションとしてコールされます。

UcheckoutRevision

リビジョンをチェックアウト済として更新します。CHECKOUT_SUBによって、問合せの実行アクションとしてコールされます。

Ucollaboration

EDIT_CLBRA_ACCESS_LISTおよびEDIT_COLLABORATIONによって、問合せの実行アクションとしてコールされます。

UdeleteRevision

リビジョンのステータスを削除済として更新します。次のサービスによって、問合せの実行アクションとしてコールされます。

- DELETE_BYREV

- DELETE_REV

- DELETE_REV_EX

UdocFormat

コンテンツ・アイテムのフォーマット情報を更新します。EDIT_DOCFORMATによって、問合せの実行アクションとしてコールされます。

UdocType

コンテンツ・アイテム・タイプを更新します。EDIT_DOCTYPEによって、問合せの実行アクションとしてコールされます。

UextensionMap

拡張子マップを更新します。EDIT_DOCEXTENSIONによって、問合せの実行アクションとしてコールされます。

Umeta

メタデータ情報を更新します。次のサービスによって、問合せの実行アクションとしてコールされます。

- UPDATE_BYREV

- UPDATE_DOCINFO_BYREV

- UPDATE_DOCINFO_SUB

- UPDATE_METADATA

- WORKFLOW_CHECKIN_SUB

Umetadef

メタデータ定義情報を更新します。EDIT_METADEFによって、問合せの実行アクションとしてコールされます。

UnextCounter

カウンタを更新します。ADD_PROBLEMREPORTによって、問合せの実行アクションとしてコールされます。

UnextRevID

リビジョンIDを更新します。次のサービスによって、問合せの実行アクションとしてコールされます。

- CHECKIN_BYNAME

- CHECKIN_NEW_SUB

- CHECKIN_SEL_SUB

- INSERT_NEW

uninstallComponent

UNINSTALL_COMPONENTによって、Javaメソッドとしてコールされます。

updateAffectedWorkflows

EDIT_COLLABORATIONによって、Javaメソッドとしてコールされます。

updateCache

UPDATE_FILTER_INFOによって、Javaメソッドとしてコールされます。

updateCollaborationCache

次のサービスによって、Javaメソッドとしてコールされます。

- ADD_COLLABORATION

- DELETE_COLLABORATION

- EDIT_CLBRA_ACCESS_LIST

- EDIT_COLLABORATION

updateComponentConfig

UPDATE_COMPONENT_CONFIGによって、Javaメソッドとしてコールされます。

updateConversionCache

GET_DYNAMIC_CONVERSION_SUBによって、Javaメソッドとしてコールされます。

updateDocFormatsConfig

コンテンツ・アイテムのフォーマット構成を更新します。EDIT_DOC_FORMATSによって、Javaメソッドとしてコールされます。

updateDocInfo

UPDATE_DOCINFO_BYREVおよびUPDATE_DOCINFO_SUBによって、Javaメソッドとしてコールされます。

updateFilterConfig

UPDATE_FILTER_INFOによって、Javaメソッドとしてコールされます。

updateLicense

UPDATE_LICENSEによって、Javaメソッドとしてコールされます。

updateMetaTable

メタデータ情報表を更新します。UPDATE_META_TABLEによって、Javaメソッドとしてコールされます。

updateOptionList

オプション・リスト表を更新します。UPDATE_OPTION_LISTによって、Javaメソッドとしてコールされます。

updateProblemReport

データベース内の問題レポート情報を更新します。UPDATE_PROBLEMREPORTによって、Javaメソッドとしてコールされます。

updateResultTemplate

結果テンプレートを更新します。UPDATE_RESULT_TEMPLATEによって、Javaメソッドとしてコールされます。

updateRevisionIDAndLabel

リビジョンIDとリビジョン・ラベルを更新します。CHECKIN_SEL_FORMによって、Javaメソッドとしてコールされます。

updateSubscriptionType

サブスクリプション・タイプを更新します。UPDATE_SUBSCRIPTION_TYPEによって、Javaメソッドとしてコールされます。

updateUserLocale

EDIT_USER_PROFILEによって、Javaメソッドとしてコールされます。

updateUserMeta

UPDATE_USER_METAによって、Javaメソッドとしてコールされます。

updateUserMetaTable

UPDATE_USER_META_TABLEによって、Javaメソッドとしてコールされます。

updateWorkflowAndDocState

ワークフローとコンテンツ・アイテムの状態情報を更新します。WORKFLOW_APPROVEおよびWORKFLOW_REJECTによって、Javaメソッドとしてコールされます。

updateWorkflowState

ワークフローの状態を更新します。DELETE_WORKFLOWDOCUMENTSによって、Javaメソッドとしてコールされます。

updateWorkflowStateAfterCheckin

WORKFLOW_CHECKIN_SUBによって、Javaメソッドとしてコールされます。

UproblemReport

データベース内の問題レポート情報を更新します。UPDATE_PROBLEMREPORTによって、問合せの実行アクションとしてコールされます。

Urevision

WORKFLOW_CHECKIN_SUBによって、問合せの実行アクションとしてコールされます。

Urevision2

次のサービスによって、問合せの実行アクションとしてコールされます。

- UPDATE_BYREV

- UPDATE_DOCINFO_BYREV

- UPDATE_DOCINFO_SUB

UrevisionStatus

リビジョン・ステータスを更新します。WORKFLOW_REJECTによって、問合せの実行アクションとしてコールされます。

UroleDefinition

ロール定義を更新します。ADD_GROUPおよびADD_ROLEによって、問合せの実行アクションとしてコールされます。

UsecurityGroup

セキュリティ・グループを更新します。EDIT_GROUPによって、問合せの実行アクションとしてコールされます。

UsubscriptionNotification

サブスクリプション通知データを更新します。UPDATE_SUBSCRIPTION_NOTIFYによって、問合せの実行アクションとしてコールされます。

UsubscriptionUse

ユーザー・サブスクリプションを更新します。UPDATE_SUBSCRIPTION_USEDによって、問合せの実行アクションとしてコールされます。

Uuncheckout

チェックアウト情報を更新します。次のサービスによって、問合せの実行アクションとしてコールされます。

- UNDO_CHECKOUT

- UNDO_CHECKOUT_BY_NAME

- UPDATE_BYREV

- WORKFLOW_CHECKIN_SUB

UuncheckoutPrevID

リビジョンIDを更新します。CHECKIN_BYNAMEおよびCHECKIN_SEL_SUBによって、問合せの実行アクションとしてコールされます。

UuserAuthType

ユーザーの認可タイプを更新します。CHANGE_USER_AUTH_TYPEによって、問合せの実行アクションとしてコールされます。

Uworkflow

ワークフローを更新します。EDIT_WORKFLOWによって、問合せの実行アクションとしてコールされます。

UworkflowCriteria

ワークフローの基準を更新します。EDIT_WORKFLOWCRITERIAによって、問合せの実行アクションとしてコールされます。

UworkflowDocStep

コンテンツ・アイテムのワークフロー・ステップを更新します。WORKFLOW_REJECTによって、問合せの実行アクションとしてコールされます。

UworkflowWithProject

ワークフロー・プロジェクト情報を更新します。EDIT_WORKFLOWCRITERIAによって、問合せの実行アクションとしてコールされます。

A.20 V

validateCheckinData

チェックイン・データを検証し、指定されたパラメータを渡します。次のサービスによって、Javaメソッドとしてコールされます。

- CACHE_CHECKIN_NEW

- CACHE_CHECKIN_SEL

- CACHE_SUBMIT_HTML_FORM

- CACHE_WORKFLOW_CHECKIN

- CHECKIN_BYNAME

- CHECKIN_NEW_SUB

- CHECKIN_SEL_SUB

- INSERT_NATIVE

- INSERT_NEW

- UPDATE_BYREV

- UPDATE_DOCINFO_BYREV

- UPDATE_DOCINFO_SUB

- VALIDATE_DOCINFO

- WORKFLOW_CHECKIN_SUB

validateCollaboration

次のサービスによって、Javaメソッドとしてコールされます。

- ADD_COLLABORATION

- EDIT_CLBRA_ACCESS_LIST

- EDIT_COLLABORATION

validateDelete

削除リクエストを検証します。DELETE_USERによって、Javaメソッドとしてコールされます。

validateMetaData

UPDATE_METADATAによって、Javaメソッドとしてコールされます。

validateProblemReport

問題レポートを検証します。ADD_PROBLEMREPORTおよびUPDATE_PROBLEMREPORTによって、Javaメソッドとしてコールされます。

validateStandard

標準データを検証します。次のサービスによって、Javaメソッドとしてコールされます。

- CACHE_CHECKIN_NEW

- CACHE_CHECKIN_SEL

- CACHE_SUBMIT_HTML_FORM

- CACHE_WORKFLOW_CHECKIN

- CHECKIN_BYNAME

- CHECKIN_NEW_SUB

- CHECKIN_SEL_SUB

- INSERT_NATIVE

- INSERT_NEW

- UPDATE_BYREV

- UPDATE_DOCINFO_BYREV

- UPDATE_DOCINFO_SUB

- VALIDATE_DOCINFO

- WORKFLOW_CHECKIN_SUB

validateSteps

WfStepsおよびQworkflowStepAliasesのステップを検証します。CRITERIAWORKFLOW_DISABLEおよびWORKFLOW_STARTによって、Javaメソッドとしてコールされます。

validateUserNameAndType

ADD_USERおよびCHANGE_USER_AUTH_TYPEによって、Javaメソッドとしてコールされます。

viewDoc

コンテンツ・アイテムを表示し、SearchCollectionDocInfoをパラメータとして渡します。VIEW_DOCによって、Javaメソッドとしてコールされます。

索引
A  B  C  D  E  F  G  H  I  J  L  M  N  O  P  Q  R  S  T  U  V  W

A

ABORT_LINKS_ACTIVITY, 13.2.1

アクセス・レベル属性, 3.1.2.2

アクション形式, 3.1.3, A.1

アクション

制御マスク, 3.1.3.4

エラー・メッセージ, 3.1.3.5

name, 3.1.3.2

パラメータ, 3.1.3.3

サービス・リソース, 3.2.3

タイプ, 3.1.3.1

「アクション」列

サービスのResultSet, 3.1.3

ACTIVATE_SERVICE, 9.2.1 ADD_ALIAS, 4.14.1 ADD_ARCHIVE, 6.2.1 ADD_COLLABORATION, 4.15.1 ADD_COLLABORATION_FORM, 4.15.2, 4.15.7 ADD_COLLECTION, 6.2.2 ADD_DOC_ACCOUNT, 4.2.1 ADD_DOCEXTENSION, 4.2.2 ADD_DOCFORMAT, 4.2.3 ADD_DOCPROFILE, 4.4.1 ADD_DOCRULE, 4.4.2 ADD_DOCTYPE, 4.2.4 ADD_EDIT_PROVIDER, 4.11.1 ADD_EXTENDED_USER_ATTRIBUTES, 11.2.1 ADD_FUNCTION_BARCODE, 10.2.1 ADD_GROUP, 4.14.2 ADD_MANAGED_DOCLINKS, 13.2.2 ADD_METADEF, 4.8.1 ADD_PROBLEMREPORT, 5.2.1 ADD_PROXIEDCOLLECTION, 6.2.3, 6.2.3 ADD_ROLE, 4.14.3 ADD_SCHEMA_FIELD, 4.12.1 ADD_SCHEMA_RELATION, 4.12.2 ADD_SCHEMA_VIEW, 4.12.3 ADD_USER, 4.14.4, 11.2.18 ADD_WEB_APP, 4.5.1, 6.2.4 ADD_WF_TEMPLATE, 5.3.1, 6.2.4 ADD_WORKFLOW, 5.4.1 ADD_WORKFLOW_SCRIPT, 5.4.2 ADD_WORKFLOW_TOKEN, 5.4.3 ADD_WORKFLOWALIASES, 5.4.4 ADD_WORKFLOWDOCUMENT_SUB, 5.4.6 ADD_WORKFLOWDOCUMENTS, 5.4.7 ADD_WORKFLOWSTEP, 5.4.8 addAliases, A.2 addCollaboration, A.2 addContext, A.2 addFiles, A.2 ADDOREDIT_SCHEMA_TABLE, 4.12.4 addOrEditDocMetaData, A.2 addOrEditProvider, A.2 addOrEditSchemaTable, A.2 addProblemReport, A.2 addRegisteredUserAttributes, A.2 addSchemaRelation, A.2 addSchemaView, A.2 addSubscription, A.2 addTemplate, A.2 addUserAttributes, A.2 addWfDocuments, A.2 addWorkflow, A.2 addWorkflowScript, A.2 addWorkflowStep, A.2 addWorkflowStepScript, A.2 addWorkflowToken, A.2 ADJUST_INVOICE, 10.2.2 ADJUST_INVOICE_FORM, 10.2.3 Alias, A.2 AliasUserMap, A.2 allowProblemReportAction, A.2 APPEND_DATABASE_AUDIT_INFO, 4.11.2 APPEND_FILE_CACHING_INFO, 4.5.2 APPEND_SEARCH_AUDIT_INFO, 4.13.1 appendCommonSystemInfo, A.2 appendDatabaseAuditMessage, A.2 appendFileCachingMessage, A.2 APPLET_DOCINFO, 4.2.5, 6.2.4 APPROVE_DELETE_SERVICE, 9.2.2 approveDoc, A.2 ASSIGN_DOCINFO_FORM, 4.3.1 属性

サービス・リソース, 3.2.2

属性列

サービスのResultSet, 3.1.2

認証チャレンジ, 2.1.7

B

BARCODE_PROCESS, 10.2.4

BATCH_STORAGE_CREATION_FORM, 10.2.5

blDateFormat, 2.1.6

blFieldTypes, 2.1.6

BLOCK_STORAGE, 10.2.6

BROWSE_CATEGORY_FORM, 9.2.3

BROWSE_CHARGE_INVOICES_FORM, 10.2.7

BROWSE_CHARGE_TRANSACTIONS_BY_INVOICE_FORM, 10.2.8

BROWSE_CHARGE_TRANSACTIONS_FORM, 10.2.9

BROWSE_CHARGE_TRANSACTIONS_WITH_NO_INVOICE_FORM, 10.2.10

BROWSE_FOLDER_FORM, 9.2.4

BROWSE_RESERVATION_ITEMS_FORM, 10.2.11

BROWSE_SERIES_FORM, 9.2.5

BROWSE_STORAGE_FORM, 10.2.12

buildAllWebStringFiles, A.3

buildExpiredContentQuery, A.3

buildPreviewList, A.3

buildSearchIndex, A.3

buildSourceInfo, A.3

C

CACHE_CHECKIN_NEW, 4.3.2

CACHE_CHECKIN_SEL, 4.3.3

CACHE_SUBMIT_HTML_FORM, 4.3.4

CACHE_WORKFLOW_CHECKIN, 4.3.5

cacheCheckin, A.4

cacheTemplates, A.4

CANCEL_ARCHIVE, 6.2.4, 6.2.4

CANCEL_COMPONENT_INSTALL, 4.7.1

CANCEL_SEARCH_INDEX, 4.6.1

cancelComponentInstall, A.4

cancelCriteriaWorkflow, A.4

cancelSearchIndex, A.4

cancelWorkflow, A.4

canDeleteStep, A.4

CHANGE_USER_AUTH_TYPE, 4.14.5

CHECK_USER_CREDENTIALS, 4.14.6

checkCanCreateDocSecurity, A.4

checkCollaborationAccess, A.4

checkConversionCache, A.4

checkCounters, A.4

checkCriteriaWorkflow, A.4

checkDocRules, A.4

checkDocState, A.4

checkForceLogin, A.4

checkForPublish, A.4

checkForRefreshingCachedResources, A.4

CHECKIN_ARCHIVE, 6.2.5

CHECKIN_ARCHIVE_NO_NOTIFY, 4.3.6

CHECKIN_BYNAME, 4.3.7

CHECKIN_CONFIRM_FORM, 4.3.8

CHECKIN_EXTERNAL_ITEM, 10.2.13

CHECKIN_LIST, 4.3.9

CHECKIN_NEW, 4.3.10

CHECKIN_NEW_FOLIO, 12.2.3

CHECKIN_NEW_FORM, 4.3.11

CHECKIN_NEW_REVISION_SERVICE, 9.2.6

CHECKIN_SEL, 4.3.13

CHECKIN_SEL_FORM, 4.3.14

CHECKIN_SEL_SUB, 4.3.15

CHECKIN_SIMILAR_FORM, 4.3.16, 9.2.7

CHECKIN_UNIVERSAL, 4.3.17

checkInByID, A.4

checkInByName, A.4

checkIsLatestRev, A.4

checkIsSelf, A.4

CHECKOUT, 4.3.18

CHECKOUT_BY_NAME, 4.3.19

CHECKOUT_EXTERNAL_ITEM, 10.2.14

CHECKOUT_OK, 4.3.20

CHECKOUT_SUB, 4.3.21

checkParametersAgainstResultSet, A.4

checkProblemReportSecurity, A.4

checkRefreshUsers, A.4

checkRevisionProperties, A.4

checkSecurity, A.4

checkSubAdmin, A.4

checkUserAuthType, A.4

checkWorkflow, A.4

checkWorkflowAdminAccess, A.4

CHUNKED_UPLOAD, 4.9.1

CLEAN_UP_STORAGE, 10.2.15

CLEAR_FOLDER_CANCELLED_DATE, 9.2.8

CLEAR_FOLDER_EXPIRATION_DATE, 9.2.9

CLEAR_FOLDER_OSBOLETE_DATE, 9.2.10

CLEAR_FOLDER_RESCINDED_DATE, 9.2.11

CLEAR_FOLDER_REVIEW_DATE, 9.2.12

CLEAR_RECORD_CANCELLED_DATE, 9.2.13

CLEAR_RECORD_EXPIRATION_DATE, 9.2.14

CLEAR_RECORD_OBSOLETE_DATE, 9.2.15

CLEAR_SERVER_OUTPUT, 4.7.2

ClientEncoding, 2.1.6

CLOSE_FOLDER, 9.2.16

COLLECTION_ADD, 7.2.1

COLLECTION_ADD_LINK, 7.2.2

COLLECTION_BROWSE, 7.2.3

COLLECTION_CHECKIN_NEW, 7.2.4

COLLECTION_CHECKIN_REVISION, 7.2.5

COLLECTION_CHECKIN_SEL_SUB, 7.2.6

COLLECTION_COPY_ALL, 7.2.7

COLLECTION_COPY_COLLECTION, 7.2.8

COLLECTION_COPY_ITEM, 7.2.9

COLLECTION_COPY_LOT, 7.2.10

COLLECTION_DELETE, 7.2.11

COLLECTION_DELETE_ALL, 7.2.12

COLLECTION_DELETE_COLLECTION, 7.2.13

COLLECTION_DELETE_ITEM, 7.2.14

COLLECTION_DELETE_LOT, 7.2.15

COLLECTION_DISPLAY, 7.2.16

COLLECTION_EDIT, 7.2.17

COLLECTION_GET_ADMIN_CONFIG, 7.2.18

COLLECTION_GET_ADMIN_INHERIT_CONFIG, 7.2.19

COLLECTION_GET_ADMIN_MARKED_CONFIG, 7.2.20

COLLECTION_GET_ADMIN_META_CONFIG, 7.2.21

COLLECTION_GET_ADMIN_METADATA_DEFAULTS, 7.2.22

COLLECTION_GET_ADMIN_MOUNTED_CONFIG, 7.2.23

COLLECTION_GET_ARCHIVE, 7.2.24

COLLECTION_GET_BRANCH, 7.2.25

COLLECTION_GET_COLLECTION, 7.2.26

COLLECTION_GET_COLLECTIONS, 7.2.27

COLLECTION_GET_CONTENT_FILE, 7.2.28

COLLECTION_GET_CONTENTS, 7.2.29

COLLECTION_GET_FILE, 7.2.30

COLLECTION_GET_INFO, 7.2.31

COLLECTION_GET_LINKS, 7.2.32

COLLECTION_GET_META_MAPPING, 7.2.33

COLLECTION_GET_PROFILE_METADATA_DEFAULTS, 7.2.34

COLLECTION_GET_PROFILE_METADATA_REVISION_DEFAULTS, 7.2.35

COLLECTION_GET_REFERENCE, 7.2.36

COLLECTION_GET_SYSTEM_FILE, 7.2.38

COLLECTION_GET_USER_CONFIG, 7.2.39

COLLECTION_INFO, 7.2.40

COLLECTION_ISVALID_MET, 7.2.41

COLLECTION_LOCK, 7.2.42

COLLECTION_MOVE_ALL, 7.2.43

COLLECTION_MOVE_COLLECTION, 7.2.44

COLLECTION_MOVE_ITEM, 7.2.45

COLLECTION_MOVE_LOT, 7.2.46

COLLECTION_NEW, 7.2.47

COLLECTION_PROFILE_GET_COLUMNS, 7.2.48

COLLECTION_PROFILE_UPDATE_COLUMNS, 7.2.49

COLLECTION_RESTORE_COLLECTION, 7.2.50

COLLECTION_RESTORE_ITEM, 7.2.51

COLLECTION_SEARCH_CONTENT, 7.2.52

COLLECTION_SEARCH_RESULTS, 7.2.53

COLLECTION_SET_ARCHIVE, 7.2.54

COLLECTION_SET_USER_CONFIG, 7.2.55

COLLECTION_UNLOCK, 7.2.56

COLLECTION_UPDATE, 7.2.57

COLLECTION_UPDATE_ADMIN_CONFIG, 7.2.58

COLLECTION_UPDATE_ADMIN_INHERIT_CONFIG, 7.2.59

COLLECTION_UPDATE_ADMIN_METADATA_DEFAULTS, 7.2.60

COLLECTION_UPDATE_ALL, 7.2.61

COLLECTION_UPDATE_ITEM, 7.2.62

COLLECTION_UPDATE_META, 7.2.63

COLLECTION_UPDATE_META_TABLE, 7.2.64

COLLECTION_UPDATE_PROFILE_METADATA_DEFAULTS, 7.2.65

COLLECTION_UPDATE_PROFILE_METADATA_REVISION_DEFAULTS, 7.2.66

COLLECTION_UPDATE_STRUCTURE, 7.2.67

COLLECTION_VERIFY_FOLDER_NAME, 7.2.68

コンポーネント・ウィザード

サービス・リソースの作成, 3.3

computeCompanionDirectory, A.4 computeDeleteSecurity, A.4 computeDocID, A.4 computeDocInfoInHtmlPage, A.4 computeDocSubscribers, A.4 computeRejectTargetStep, A.4 computeRemainingUsers, A.4 computeURLs, A.4 computeWfDocumentsInfo, A.4 conditionalDetermineCheckin, A.4 CONFIG_CHARGE_BACKS, 10.2.16 CONFIG_CHARGE_BACKS_FORM, 10.2.17 CONFIG_INFO, 4.2.6 CONFIGURE_CHARGE_BILLERS_FORM, 10.2.18 CONFIGURE_CHARGE_PAYMENT_TYPES_FORM, 10.2.19 CONFIGURE_CHARGE_TYPES_FORM, 10.2.20 CONTINUE_CHECKIN, 4.3.22 CONTINUE_SUBMIT_HTML_FORM, 4.3.23 continueCheckin, A.4 制御マスク, 3.1.3.4 CONTROL_SCHEMA, 4.12.5 CONTROL_SEARCH_INDEX, 4.6.2 controlIndexing, A.4 convertDatabaseDate, 2.1.6 COPY_ARCHIVE, 6.2.6 COPY_REVISION, 4.3.24 CREATE_CHARGE_BILLER, 10.2.21 CREATE_CHARGE_BILLER_FORM, 10.2.22 CREATE_CHARGE_PAYMENT_TYPE, 10.2.23 CREATE_CHARGE_PAYMENT_TYPE_FORM, 10.2.24 CREATE_CHARGE_TRANSACTION, 10.2.27 CREATE_CHARGE_TRANSACTION_FORM, 10.2.28 CREATE_CHARGE_TRANSACTION_MULTIPLE, 10.2.29 CREATE_CHARGE_TYPE, 10.2.25 CREATE_CHARGE_TYPE_FORM, 10.2.26 CREATE_EXTERNAL_ITEM, 10.2.30 CREATE_EXTERNAL_ITEM_FORM, 10.2.31 CREATE_EXTERNAL_ITEM_SIMILAR_FORM, 10.2.32 CREATE_FOLDER, 9.2.17 CREATE_FOLDER_FORM, 9.2.18 CREATE_FOLIO_RENDITION, 12.2.7 CREATE_FOLIO_SNAPSHOT, 12.2.4 CREATE_MEDIA_TYPE, 10.2.33 CREATE_MEDIA_TYPE_FORM, 10.2.34 CREATE_OBJECT_TYPE, 10.2.35 CREATE_OBJECT_TYPE_FORM, 10.2.36 CREATE_RESERVATION, 10.2.37 CREATE_RESERVATION_FORM, 10.2.38 CREATE_STORAGE, 10.2.39 CREATE_STORAGE_FORM, 10.2.40 CREATE_STORAGE_TYPE, 10.2.41 CREATE_STORAGE_TYPE_FORM, 10.2.42 CREATE_SUBSCRIPTION_TYPE, 4.3.25 createAddEditProviderForm, A.4 createArchiveFileName, A.4 createFileName, A.4 createNewRev, A.4 createResultSetSQL, A.4 createSubscriptionType, A.4 createWebFileNameFromRelativeUrl, A.4 createWorkflowID, A.4 作成

サービス・リソース, 3.3

CRITERIAWORKFLOW_DISABLE, 5.4.9 CRITERIAWORKFLOW_DISABLE_SUB, 5.4.10 CRITERIAWORKFLOW_ENABLE, 5.4.11 ローカル・パラメータのカスタマイズ, 2.1.6

D

Dalias, A.5

DaliasUsers, A.5

日付と時刻の形式, 2.1.1.4

Dcollaboration, A.5

DdocAccount, A.5

DdocFormat, A.5

DdocType, A.5

Ddocument, A.5

decodeTopicValues, A.5

DEL_METADEF, 4.8.2

DELELE_ALL_EXTENDED_ATTRIBUTES_FOR_USER, 11.2.5

DELETE_ALIAS, 4.14.7

DELETE_ALL_BUT_LAST_N_REVISIONS_SERVICE service, 9.2.19

DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_APPLICATION, 11.2.6

DELETE_ARCHIVE, 6.2.7

DELETE_BATCH_FILE, 6.2.8

DELETE_BATCH_FILE_DOCUMENTS, 6.2.9

DELETE_BATCH_FILE_TABLES, 6.2.10

DELETE_BYCLASS, 4.3.26

DELETE_BYNAME, 4.3.27

DELETE_BYREV, 4.3.28

DELETE_BYREV_REVISION, 4.3.29

DELETE_CHARGE_BILLER, 10.2.43

DELETE_CHARGE_INVOICE, 10.2.44

DELETE_CHARGE_PAYMENT_TYPE, 10.2.45

DELETE_CHARGE_TRANSACTION, 10.2.46

DELETE_CHARGE_TYPE, 10.2.47

DELETE_CHECKIN_CACHE, 4.3.30

DELETE_COLLABORATION, 4.15.3

DELETE_COMPLETED_RESERVATIONS, 10.2.48

DELETE_DEFAULT_ATTRIBUTES, 11.2.14

DELETE_DOC, 4.3.31

DELETE_DOC_ACCOUNT, 4.2.7

DELETE_DOCEXTENSION, 4.2.8

DELETE_DOCFORMAT, 4.2.9

DELETE_DOCPROFILE, 4.4.3

DELETE_DOCRULE, 4.4.4

DELETE_DOCTYPE, 4.2.10

DELETE_ENTENDED_ATTRIBUTES_BY_APPLICATION, 11.2.4

DELETE_EXTENDED_USER_ATTRIBUTES, 11.2.3

DELETE_EXTERNAL_ITEM, 10.2.49

DELETE_FOLDER, 9.2.20

DELETE_GROUP, 4.14.8

DELETE_MANAGED_DOCLINKS, 13.2.3

DELETE_MEDIA_TYPE, 10.2.50

DELETE_OBJECT_TYPE, 10.2.51

DELETE_PROBLEMREPORT, 5.2.2

DELETE_PROVIDER, 4.11.3

DELETE_RESERVATION, 10.2.52

DELETE_RESERVATION_ITEM, 10.2.53

DELETE_RESULT_TEMPLATE, 4.10.1

DELETE_REV, 4.3.32

DELETE_REV_EX, 4.3.33

DELETE_REVISION_SERVICE, 9.2.21

DELETE_ROLE, 4.14.9

DELETE_SCHEMA_FIELD, 4.12.6

DELETE_SCHEMA_RELATION, 4.12.7

DELETE_SCHEMA_TABLE, 4.12.8

DELETE_SCHEMA_VIEW, 4.12.9

DELETE_STORAGE, 10.2.54

DELETE_STORAGE_TYPE, 10.2.55

DELETE_SUBSCRIPTION_TYPE, 4.3.34

DELETE_USER, 4.14.10, 11.2.20

DELETE_WF_TEMPLATE, 5.3.2

DELETE_WFCONTRIBUTORS, 5.4.12

DELETE_WORKFLOW, 5.4.13

DELETE_WORKFLOW_SCRIPT, 5.4.14

DELETE_WORKFLOW_TOKEN, 5.4.15

DELETE_WORKFLOWCRITERIA, 5.4.16

DELETE_WORKFLOWDOCUMENTS, 5.4.17

DELETE_WORKFLOWSTEP, 5.4.18

deleteAliases, A.5

deleteCollaboration, A.5

deleteDoc, A.5

deleteDocumentSubscription, A.5

deleteProblemReport, A.5

deleteProvider, A.5

deleteResultTemplate, A.5

deleteRev, A.5

deleteRevFiles, A.5

deleteSchemaRelation, A.5

deleteSchemaTable, A.5

deleteSchemaView, A.5

deleteSubscriptionType, A.5

deleteTemplate, A.5

deleteWfDesign, A.5

deleteWfDocuments, A.5

deleteWorkflowScript, A.5

deleteWorkflowStepScript, A.5

deleteWorkflowToken, A.5

determineCheckin, A.5

DextensionMap, A.5

DgroupRole, A.5

disableSendFile, A.5

Dmetadef, A.5

DOC_FORMATS_WIZARD, 4.3.35

DOC_INFO, 4.3.36

DOC_INFO_BY_NAME, 4.3.37

DOC_INFO_LATESTRELEASE, 4.3.38

DOC_INFO_SIMPLE, 4.3.39

DOC_INFO_SIMPLE_BYREV, 4.3.40

DOC_SUBS_LIST, 4.3.41

doCachedCheckinCleanup, A.5

doCachedCleanup, A.5

DocFormats, A.5

docHistoryInfo, A.5

DOCPROFILE_PREVIEW, 4.4.5

docRefinery, A.5

doSubService, A.5

doSubserviceIfMetafile, A.5

doUpload, A.5

DOWNLOAD_COMPONENT, 4.7.3

DOWNLOAD_LISTBOX_ITEMS, 4.9.2

downloadComponent, A.5

downloadItems, A.5

doWorkflowAction, A.5

DproblemReport, A.5

Drole, A.5

DsecurityGroup, A.5

DsubscriptionType, A.5

Duser, A.5

DuserSecurityAttributes, A.5

DuserSubscription, A.5

Dworkflow, A.5

DworkflowAliasAll, A.5

DworkflowCriteria, A.5

DworkflowDocState, A.5

DworkflowDocumentAll, A.5

DworkflowStateAll, A.5

DworkflowStep, A.5

DworkflowStepAliases, A.5

DworkflowStepsAll, A.5

DworkflowUserAttributeAll, A.5

動的ページ, 2.1.2

E

EC_DELETE_PROPETY, 11.2.10

EC_GET_PROPERTY, 11.2.11

EC_GET_PROPERTY_BY_KEY, 11.2.12

EC_SET_PROPERTY, 11.2.9

EDIT_ALIAS, 4.14.11

EDIT_ARCHIVE, 6.2.11

EDIT_ARCHIVEDATA, 6.2.12

EDIT_CHARGE_BILLER, 10.2.56

EDIT_CHARGE_BILLER_FORM, 10.2.57

EDIT_CHARGE_PAYMENT_TYPE, 10.2.58

EDIT_CHARGE_TYPE_FORM, 10.2.59

EDIT_CLBRA_ACCESS_LIST, 4.15.4

EDIT_CLBRA_ACCESS_LIST_FORM, 4.15.5

EDIT_COLLABORATION, 4.15.6

EDIT_COLLABORATION_FORM, 4.15.7

EDIT_DOC_FORMATS, 4.3.42

EDIT_DOCEXTENSION, 4.2.11

EDIT_DOCFORMAT, 4.2.12

EDIT_DOCPROFILE, 4.4.6

EDIT_DOCPROFILE_TRIGGER, 4.4.7

EDIT_DOCRULE, 4.4.8

EDIT_DOCTYPE, 4.2.13

EDIT_EXPORTERS, 6.2.13

EDIT_EXTENDED_USER_ATTRIBUTES, 11.2.2

EDIT_EXTERNAL_ITEM, 10.2.60

EDIT_EXTERNAL_ITEM_FORM, 10.2.61

EDIT_FOLDER, 9.2.22

EDIT_FOLDER_FORM, 9.2.23

EDIT_GROUP, 4.14.12

EDIT_MEDIA_TYPE_FORM, 10.2.62, 10.2.63

EDIT_METADEF, 4.8.3

EDIT_OBJECT_TYPE, 10.2.64

EDIT_OBJECT_TYPE_FORM, 10.2.65

EDIT_OBJECT_TYPE_RELATIONSHIPS, 10.2.66

EDIT_OBJECT_TYPE_RELATIONSHIPS_FORM, 10.2.67

EDIT_RESERVATION, 10.2.68

EDIT_RESERVATION_FORM, 10.2.69

EDIT_RESERVATION_ITEM, 10.2.70

EDIT_RESERVATION_ITEM_FORM, 10.2.71

EDIT_RESERVATION_ITEM_STATUS, 10.2.72

EDIT_ROLE, 4.14.13

EDIT_SCHEMA_FIELD, 4.12.10

EDIT_SCHEMA_NODE, 4.12.11

EDIT_SCHEMA_RELATION, 4.12.12

EDIT_SCHEMA_VIEW, 4.12.13

EDIT_SCHEMA_VIEW_VALUES, 4.12.14

EDIT_STORAGE, 10.2.73

EDIT_STORAGE_FORM, 10.2.74

EDIT_STORAGE_TYPE, 10.2.75

EDIT_STORAGE_TYPE_FORM, 10.2.76

EDIT_TRACE_OPTIONS, 4.2.14

EDIT_TRANSFEROPTIONS, 6.2.14

EDIT_USER, 4.14.14, 11.2.19

EDIT_USER_PROFILE, 4.14.15

EDIT_WF_TEMPLATE, 5.3.3

EDIT_WORKFLOW, 5.4.19

EDIT_WORKFLOW_SCRIPT, 5.4.20

EDIT_WORKFLOW_TOKEN, 5.4.21

EDIT_WORKFLOWCRITERIA, 5.4.22, 5.4.22

EDIT_WORKFLOWSTEP, 5.4.23

editCollaboration, A.6

editCriteria, A.6

editRole, A.6

editSchemaRelation, A.6

editSchemaView, A.6

editSchemaViewValues, A.6

editTemplate, A.6

editWorkflowScript, A.6

editWorkflowStep, A.6

editWorkflowStepScript, A.6

editWorkflowToken, A.6

ENABLE_DISABLE_PROVIDER, 4.11.4

enableDisableProvider, A.6

エラー・メッセージ, 3.1.3.5

エラー・メッセージ属性, 3.1.2.6

例

サービス・アクション, 3.2.3

サービス属性, 3.2.2

サービス・リソース, 3.1, 3.2

EXECUTE_BATCH, 6.2.15 executeArchiveMethod, A.6 executeCommands, A.6 executeManifest, A.6 executePageService, A.6 EXPORT_ARCHIVE, 6.2.16 ExtensionFormatMap, A.6 extraFieldTypes, 2.1.6

F

filterUpdateData, A.7

FLD_BROWSE, 8.2.1

FLD_BROWSE_POPUP, 8.2.2

FLD_COPY, 8.2.3

FLD_CREATE_FILE, 8.2.4

FLD_CREATE_FILE_FORM, 8.2.5

FLD_CREATE_FOLDER, 8.2.6

FLD_CREATE_FOLDER_FORM, 8.2.7

FLD_DELETE, 8.2.8

FLD_EDIT_FILE, 8.2.9

FLD_EDIT_FILE_FORM, 8.2.10

FLD_EDIT_FOLDER, 8.2.11

FLD_EDIT_FOLDER_FORM, 8.2.12

FLD_EDIT_METADATA_RULES, 8.2.13

FLD_EDIT_METADATA_RULES_FORM, 8.2.14

FLD_FOLDER_MIGRATION_STATUS, 8.2.15

FLD_FOLDER_SEARCH, 8.2.16

FLD_FOLDER_SEARCH_FORM, 8.2.17

FLD_GET_CHOOSE_DESTINATION_DIALOG, 8.2.18

FLD_GET_CREATE_LINK_DIALOG, 8.2.19

FLD_GET_CREATE_SHORTCUT_DIALOG, 8.2.20

FLD_GET_RENAME_FILE_DIALOG, 8.2.21

FLD_GET_RENAME_FOLDER_DIALOG, 8.2.22

FLD_INFO, 8.2.23

FLD_LOAD_SOFT_LINKS_FOR_DOCUMENT, 8.2.24, 8.2.25

FLD_MOVE, 8.2.26

FLD_PRE_CHECKIN, 8.2.27

FLD_PROPAGATE, 8.2.28

FLD_PROPAGATE_FORM, 8.2.29

FLD_REINDEX_FOLDER_CONTENTS, 8.2.30

FLD_RETRIEVE_CHILD_FILES, 8.2.31

FLD_RETRIEVE_CHILD_FOLDERS, 8.2.32

FLD_SUBSCRIBE, 8.2.33

FLD_TEST_USER_CAPABILITIES, 8.2.34

FLD_UNFILE, 8.2.36

FLD_UNSUBSCRIBE, 8.2.35

FOLDERSLOCAL_BUILD_MOUNT, 7.2.69

FOLDERSLOCAL_CREATE_MOUNT, 7.2.70

FOLDERSLOCAL_DELETE_MOUNT, 7.2.71

FOLDERSLOCAL_UPDATE_MOUNT, 7.2.72

FORM_PROCESS, 4.3.43

FORM_SUBMIT, 4.3.44

書式

アクション, 3.1.3, A.1

FREEZE_FOLDER, 9.2.24 FREEZE_RECORD, 9.2.25

G

GENERATE_CHARGE_INVOICE, 10.2.77

GENERATE_GUIDS, 12.2.8

GET_ACTIVE_WORKFLOWS, 5.4.24

GET_ADD_EDIT_PROVIDER_FORM, 4.11.5

GET_ADMIN_PAGE, 4.10.2

GET_ADVANCED_SEARCH_OPTIONS, 4.8.4

GET_ALIASES, 4.14.16

GET_ALL_PROVIDERS, 4.11.6

GET_ALL_WORKFLOWDOCREVISIONS, 5.4.25

GET_ARCHIVECOLLECTIONS, 6.2.17

GET_ARCHIVED_FILE, 6.2.19

GET_ARCHIVERELATIONQUERY, 6.2.21

GET_ARCHIVES, 6.2.20

GET_ARCHIVETABLECONTENT, 6.2.18

GET_BATCH_FILE_DOCUMENTS, 6.2.22

GET_BATCH_PROPERTIES, 6.2.23

GET_BATCH_SCHEMA, 6.2.24

GET_BATCH_VALUES, 6.2.25

GET_BATCHFILES, 6.2.26

GET_CACHED_CHECKIN_INFO, 4.3.45

GET_CLBRA_DOCUMENTS, 4.15.8

GET_CLBRA_INFO, 4.15.9

GET_COLLABORATION_LIST, 4.15.10

GET_COMPONENT_CONFIG, 4.7.4

GET_COMPONENT_INSTALL_FORM, 4.7.5

GET_COMPONENT_INSTALL_PROMPTS_FORM, 4.7.6

GET_COMPONENT_INSTALL_SETTINGS, 4.7.7

GET_CRITERIA_WORKFLOWS_FOR_GROUP, 5.2.3, 5.4.26

get_criteria_workflows_for_group, 5.4.26

GET_DATARESULTSET, 4.2.15

GET_DEFAULT_ATTRIBUTES, 11.2.15

GET_DISPLAY_FIELDS, 4.8.5

GET_DOC_CONFIG_INFO, 4.3.46

GET_DOC_METADATA_INFO, 4.8.6

GET_DOC_PAGE, 4.10.3

GET_DOC_SUBSCRIBERS, 4.3.47

GET_DOCEXTENSIONS, 4.2.16

GET_DOCFORMATS, 4.2.17

GET_DOCPROFILE, 4.4.9

GET_DOCPROFILES, 4.4.10

GET_DOCRULE, 4.4.11

GET_DOCRULES, 4.4.12

GET_DOCTYPES, 4.2.18

GET_DOCUMENT_HISTORY_REPORT, 4.3.48

GET_DOCUMENT_PROBLEMREPORTS, 5.2.4

GET_DYNAMIC_CONVERSION, 4.5.3

GET_DYNAMIC_CONVERSION_SUB, 4.5.4

GET_DYNAMIC_PAGE, 4.10.4

GET_DYNAMIC_URL, 4.5.5

GET_EXPIRED, 4.3.50

GET_EXPORT_INVOICES, 10.2.78

GET_EXTERNAL_DOC_INFO, 4.13.2

GET_EXTERNAL_HIGHLIGHT_INFO, 4.13.3

GET_EXTERNAL_XML_HIGHLIGHT_INFO, 4.13.4

GET_FIELD_LENGTHS, 4.2.19

GET_FILE, 4.6.3

GET_FILELIST, 4.2.20

GET_FILTER_ADMIN_PAGE, 4.14.17

GET_HIGHLIGHT_INFO, 4.13.5

GET_LINK_INFO, 13.2.4

GET_LINKS_ADMIN_PAGE, 13.2.5

GET_LOCAL_REGISTRATION_FORM, 4.7.8

GET_MANIFEST_INFO, 4.7.9

GET_METADEFS, 4.2.21

GET_OPTION_LIST, 4.8.7

GET_OPTION_LISTS, 7.2.74

GET_PACKAGE_ENVIRONMENT_PAGE, 4.3.51

GET_PORTAL_PAGE, 4.10.6

GET_PROBLEMREPORTS_SEARCH_ FORM, 5.2.5

GET_PROBLEMREPORTS_SEARCH_ RESULTS, 5.2.6

GET_PROVIDER_INFO, 4.11.7

GET_PROXIED_ARCHIVECOLLECTIONS, 6.2.27

GET_PROXIEDSERVERS, 6.2.28

GET_REPLICATION_DATA, 6.2.29

GET_RESULT_OPTIONS, 4.2.22

GET_SCHEMA_FIELD_INFO, 4.12.15

GET_SCHEMA_FIELDS, 4.12.16

GET_SCHEMA_RELATIONS, 4.12.19

GET_SCHEMA_STATS, 4.12.18

GET_SCHEMA_TABLE_INFO, 4.12.19

GET_SCHEMA_TABLES, 4.12.20

GET_SCHEMA_VIEW_EDIT_INFO, 4.12.21

GET_SCHEMA_VIEW_FRAGMENT, 4.12.22

GET_SCHEMA_VIEW_INFO, 4.12.23

GET_SCHEMA_VIEW_VALUES, 4.12.24

GET_SCHEMA_VIEWS, 4.12.25

GET_SEARCH_RESULTS, 4.13.6

GET_SEARCH_RESULTS_FORCELOGIN, 4.13.7

GET_SECURE_PAGE, 4.10.7

GET_SELF_REGISTER_PAGE, 4.14.18

GET_SERVER_OUTPUT, 4.7.10

GET_SYSTEM_AUDIT_INFO, 4.2.23, 4.14.20

GET_TABLE, 4.2.24

GET_TABLECOLUMNLIST, 6.2.30

GET_TARGET_INFO, 6.2.31

GET_TARGET_TRANSFER_STATUS, 6.2.32

GET_TEMPLATE_CONVERSIONS, 4.5.6

GET_TRANSFER_SOURCE_INFO, 6.2.33

GET_UPDATE_FORM, 4.3.52

GET_UPDATE_PROBLEMREPORT_FORM, 5.2.7

GET_USER_CLBRA_LIST, 4.15.11

GET_USER_INFO, 4.14.20

GET_USER_METADATA_INFO, 4.8.8

GET_USER_METADEFS, 4.2.25

GET_USERDOCPROFILES, 4.14.19

GET_USERS, 4.14.21

GET_WEB_APP_STATUS, 4.5.7

GET_WF_COMPANION_INFO, 5.4.27

GET_WF_TEMPLATE, 5.3.4

GET_WF_TEMPLATES, 5.3.5

GET_WORKFLOW, 5.4.28

GET_WORKFLOW_INFO, 5.4.29

GET_WORKFLOW_INFO_BYNAME, 5.4.30

GET_WORKFLOW_SCRIPT, 5.4.31

GET_WORKFLOWDOCREVISIONS, 5.4.32

GET_WORKFLOWDOCUMENTS, 5.2.8

GET_WORKFLOWS, 5.4.33

GET_WORKFLOWS_FOR_ALL, 5.2.9

GET_XML_HIGHLIGHT_INFO, 4.13.8

getCollaborationData, A.8

getCollaborationDocs, A.8

getCollaborations, A.8

getCompanionHistory, A.8

getComponentConfig, A.8

getDefaultDocFormats, A.8

getDocFormats, A.8

getDocSubscriptionInfo, A.8

getDocumentList, A.8

getDynamicPage, A.8

getExternalDocInfo, A.8

getExternalSecurityInfo, A.8

getFilesInAppDir, A.8

getHighlightInfo, A.8

getLatestID, A.8

getLatestIDRevInfo, A.8

getOptionList, A.8

getOutgoingProviders, A.8

getProxiedArchiveCollections, A.8

getSchemaRelations, A.8

getSchemaTableInfo, A.8

getSchemaTables, A.8

getSchemaViewInfo, A.8

getSchemaViews, A.8

getSearchResults, A.8

getSubscriptionList, A.8

getTable, A.8

getTemplate, A.8

getTemplateConversions, A.8

getTemplates, A.8

getURLAbsolute, A.8

getUserAttributes, A.8

getUserCollaborationList, A.8

getUserMailAddress, A.8

getUserProfile, A.8

getUsers, A.8

getUserUnique, A.8

getViewEditInfo, A.8

getViewValues, A.8

getWebAppStatus, A.8

getWfDocuments, A.8

getWorkflowDesignInfo, A.8

getWorkflowDocumentInfo, A.8

getWorkflowInfo, A.8

getWorkflowScript, A.8

getWorkflowStepAliasesInfo, A.8

GOTO_COLLECTION, 7.2.75

GOTO_ROOT_COLLECTION, 7.2.76

H

HEADER_ENCODING, 2.1.6

hidePassword, A.9

I

Ialias, A.10

Icollaboration, A.10

IdocAccount, A.10

IdocFormat, A.10

IdocType, A.10

IextensionMap, A.10

Imeta, A.10

Imetadef, A.10

IMPORT_ARCHIVE, 6.2.34

IMPORT_ARCHIVE_START_AUTOMATED, 6.2.35

IMPORT_BATCHFILE, 6.2.36

IMPORT_DOCUMENT, 6.2.37

IMPORT_TABLE_ENTRY, 6.2.38

INFO_CATEGORY_FORM, 9.2.26

INFO_CHARGE_BILLER_FORM, 10.2.79

INFO_CHARGE_INVOICE_FORM, 10.2.80

INFO_CHARGE_PAYMENT_TYPE_FORM, 10.2.81

INFO_CHARGE_TRANSACTION_FORM, 10.2.82

INFO_CHARGE_TYPE_FORM, 10.2.83

INFO_EXTERNAL_ITEM_FORM, 10.2.84

INFO_FOLDER_FORM, 9.2.27

INFO_FOLDER_LIFECYCLE, 9.2.28

INFO_FOLDER_METADATA_HISTORY, 9.2.29

INFO_FOLDER_REVIEW_HISTORY, 9.2.30

INFO_MEDIA_TYPE_FORM, 10.2.85

INFO_OBJECT_TYPE_FORM, 10.2.86

INFO_RECORD_LIFECYCLE, 9.2.31

INFO_RECORD_METADATA_HISTORY, 9.2.32

INFO_RECORD_REVIEW_HISTORY, 9.2.33

INFO_RESERVATION_FORM, 10.2.87

INFO_RESERVATION_ITEM_FORM, 10.2.88

INFO_SERIES_FORM, 9.2.34

INFO_STORAGE_FORM, 10.2.89

INFO_STORAGE_TYPE_FORM, 10.2.90

INSERT_NATIVE, 6.2.39, 6.2.41

INSERT_NEW, 6.2.40

insertAliasUsers, A.10

insertGroupRow, A.10

IproblemReport, A.10

Irevision, A.10

Irole, A.10

isDocCheckedOut, A.10

IsecurityGroup, A.10

Isubscription, A.10

Iworkflow, A.10

IworkflowDocument, A.10

IworkflowState, A.10

J

JAVA_PROPERTIES, 4.2.26

L

LK_GET_SEARCH_RESULTS, 13.2.6

LM_BUILD_WEB_STRING_FILES, 4.2.27

LM_LOAD_LAYOUTS, 4.2.28

LM_LOAD_LAYOUTS_SUB, 4.2.29

LOAD_DOC_ENVIRONMENT, 4.2.30

LOAD_FOLIO_NODE, 12.2.1

LOAD_GLOBALINCLUDES, 4.10.8

LOAD_PNE_PORTAL, 4.14.22

LOAD_RESOURCE_FILE, 4.5.8

LOAD_USER_LOCALIZATION, 4.9.3

LOAD_USER_TOPIC, 4.14.23

LOAD_WORKFLOW_QUEUE, 5.2.10

loadActiveComponentData, A.11

loadAndValidateValues, A.11

loadCollaborationList, A.11

loadComponentInstallInfo, A.11

loadComponentInstallSettings, A.11

loadConfigurationInfo, A.11

loadDefaultInfo, A.11

loadDocConfig, A.11

loadDocDefaults, A.11

loadFilterConfig, A.11

loadGlobalIncludes, A.11

loadMetaDefaults, A.11

loadMetaOptionsLists, A.11

loadPRStateLists, A.11

loadRegisteredProjects, A.11

loadServerOutput, A.11

loadSharedTable, A.11

loadTopic, A.11

loadTraceFlags, A.11

loadUserAndCheckEditAllowed, A.11

loadUserMetaData, A.11

loadWfCompanionInfo, A.11

locale parameters, 2.1.6

LOCK_FOLIO, 12.2.5

LOGIN, 4.2.31

M

makeNewRevClass, A.12

mapDocNamedResultSetValuesCheckMetaChange, A.12

mapDocResultSetCheckMetaChange, A.12

mapNamedResultSetValues, A.12

mapResultSet, A.12

MARK_FOLDER_ACTIVATION_DATE, 9.2.35

MARK_FOLDER_CANCELLED_DATE, 9.2.36

MARK_FOLDER_EXPIRATION_DATE, 9.2.37

MARK_FOLDER_OBSOLETE_DATE, 9.2.38

MARK_FOLDER_RESCINDED_DATE, 9.2.39

MARK_FOLDER_REVIEW_DATE, 9.2.40

MARK_FOLDER_REVIEW_DATE_RECURSIVE, 9.2.41

MARK_INVOICE_PAID, 10.2.91

MARK_INVOICE_PAID_FORM, 10.2.92

MARK_RECORD_CANCELLED_DATE, 9.2.42

MARK_RECORD_EXPIRATION_DATE, 9.2.43

MARK_RECORD_OBSOLETE_DATE, 9.2.44

MARK_RECORD_RESCINDED_DATE, 9.2.45

MARK_RECORD_REVIEW_DATE, 9.2.46

markDocDeleted, A.12

markRevDeleted, A.12

MERGE_TABLE, 4.2.32

mergeTable, A.12

modified services, 11.2

MOVE_FOLDER, 9.2.47

MOVE_METADEF, 4.8.9

MOVE_STORAGE, 10.2.93

N

「名前」列

サービスのResultSet, 3.1.1

NOTIFY_CHANGE, 4.11.8 NOTIFY_CONTRIBUTOR, 5.2.11 NOTIFY_INDEXER, 4.3.53 NOTIFY_OVERDUE_USERS, 10.2.94 notifyChange, A.13 notifyCollaborationUsers, A.13 notifyContributor, A.13

O

ODMA_DOC_INFO_SIMPLE, 4.3.54

概要

アクション, A.1

アーカイブ・サービス, 6.1

P

PACKAGE_ENVIRONMENT, 4.3.55

packageEnvironment, A.14

packageLocalization, A.14

PAGE_HANDLER, 4.10.9

pageRequest, A.14

パラメータ

アクション, 3.1.3.3

PING_SERVER, 4.2.33 PNE_GET_SEARCH_RESULTS, 4.13.9 PNE_SAVE_QUERY, 4.10.10 PNE_UPDATE_PERSONAL_URLS, 4.10.11 PNE_UPDATE_PORTAL_INFO, 4.10.12 postCheckinFilter, A.14 postHtmlFormCheckin, A.14 prepareCheckinSecurity, A.14 prepareDocInfoValidate, A.14 prepareFormContinue, A.14 prepareForPreview, A.14 prepareInsertNew, A.14 prepareMailForStepUsers, A.14 prepareRedirect, A.14 prepareTopicEdits, A.14 prepareWebViewableDelivery, A.14 prepSubscription, A.14 prepSubscriptionDateUpdate, A.14 PREVIEW_RECORD_LIFECYCLE, 9.2.48 PROBLEMREPORT_INFO, 5.2.12 PROCESS_OVERDUE_REQUESTS, 10.2.95 PROCESS_STORAGE_SPACE_COUNTS, 10.2.96 processCheckinArchive, A.14 processForm, A.14 PROXIED_REQUEST, 4.7.11 PUBLISH_SCHEMA, 4.12.26

Q

Qalias, A.15

QaliasesForUser, A.15

QarchivedDoc, A.15

Qcache, A.15

QcheckinCache, A.15

QcheckinCachesForUser, A.15

Qcollaboration, A.15

QdocAccount, A.15

QdocAccounts, A.15

QdocInfo, A.15

QdocInfoSimilarCheckin, A.15

QdocName, A.15

QdocNameMeta, A.15

QdocType, A.15

QdocTypeDocuments, A.15

QdocTypes, A.15

QdocumentProblemReports, A.15

Qdocuments, A.15

QextensionFormatMap, A.15

QextensionMap, A.15

QformatMap, A.15

Qgroup, A.15

QgroupRevisions, A.15

QgroupRole, A.15

QgroupWF, A.15

QisAliasSubscribed, A.15

QisDocWFLocked, A.15

QisWfTokenUsed, A.15

QlatestIDByName, A.15

Qmetadef, A.15

QmetaFieldInfo, A.15

QODMAdocInfo, A.15

QproblemReport, A.15

QprojectDocument, A.15

QregisteredProject, A.15

QreleasedDocInfo, A.15

QrevHistory, A.15

QrevHistoryReleased, A.15

QrevisionsByClass, A.15

QrevisionsByName, A.15

Qrole, A.15

Qroles, A.15

QsecurityGroup, A.15

QUERY_DOC_ACCOUNTS, 4.2.34

QUERY_EXTENDED_USER_ATTRIBUTES, 11.2.7, 11.2.8, 11.2.16, 11.2.17

QUERY_GROUP, 4.14.24

QUERY_USER_ATTRIBUTES, 4.14.25, 11.2.21

Quser, A.15

QuserMetaFieldInfo, A.15

QuserSecurityAttributeByType, A.15

QuserSubscription, A.15

QwfCriteriaDocRevs, A.15

QwfDocInformation, A.15

QwfDocName, A.15

QwfDocState, A.15

QwfStates, A.15

Qworkflow, A.15

QworkflowAlias, A.15

QworkflowAliases, A.15

QworkflowCriteriaForGroup, A.15

QworkflowCriteriaStepsForGroup, A.15

QworkflowDocument, A.15

QworkflowDocuments, A.15

QworkflowForID, A.15

Qworkflows, A.15

QworkflowStep, A.15

QworkflowSteps, A.15

QworkflowStepsAll, A.15

R

RECOMPUTE_MANAGED_LINKS, 13.2.7

REFRESH_MANAGED_DOCLINKS, 13.2.8

REFRESH_MANAGED_LINKS, 13.2.9

REFRESH_REFS_MANAGED_LINKS, 13.2.10

refreshCache, A.16

refreshLayoutLists, A.16

refreshRoles, A.16

REGISTER_IMPORTER, 6.2.41

REGISTER_USER, 4.14.26

rejectDoc, A.16

remoteCredentialsCheck, A.16

REMOVE_COLLECTION, 6.2.42

REMOVE_EXPORTER, 6.2.43

REMOVE_IMPORTER, 6.2.44

REMOVE_METAFILE_SUB, 4.3.56

REMOVE_PROXIEDTRANSFER, 6.2.45

REMOVE_QUEUED_IMPORT, 6.2.46

REMOVE_TRANSFER, 6.2.47

REMOVE_WEB_APP, 4.5.9

removeCachedUser, A.16

removeContext, A.16

removeSubscription, A.16

renameValues, A.16

REPLACE_METAFILE_SUB, 4.3.57

REQUEST_SECURITYINFO, 4.11.9

REQUEST_TRANSFER, 6.2.48

requestSecurityInfo, A.16

RESEND_PROBLEMREPORT, 5.2.13

RESERVE_STORAGE, 10.2.97

RESTORE_REVISION, 4.3.58

RESUBMIT_FOR_CONVERSION, 4.3.59

resubmitDocToConversion, A.16

retrieveAllProviderInfo, A.16

retrieveCachedInfo, A.16

retrieveProblemReportInfo, A.16

retrieveProviderInfo, A.16

retrieveUserDatabaseProfileData, A.16

REV_HISTORY, 4.3.60

REVIEW_WORKFLOW_DOC, 5.2.14

RMA_CLOSE_SERVICE, 9.2.49

RMA_CUTOFF_SERVICE, 9.2.50

RMA_DESTROY_SERVICE, 9.2.51

RMA_EXPORT_ARCHIVE_SERVICE, 9.2.52

RMA_EXPORT_SERVICE, 9.2.53

RMA_MARK_COMPLETED, 9.2.54

RMA_NO_ACTION_SERVICE, 9.2.55

RMA_OBSOLETE_SERVICE, 9.2.56

RMA_SCRUB_SERVICE, 9.2.57

RMA_SUPERSEDE_SERVICE, 9.2.58

RUN_CHARGEBACK_REPORT, 10.2.98

RUN_CHARGEBACK_REPORT_MULTIPLE, 10.2.99

RUN_FUNCTION_BARCODE_LABEL, 10.2.100

RUN_RESERVATION_REPORT, 10.2.101

RUN_RESERVATION_SEARCH_RESULTS_REPORT, 10.2.102

RUN_STORAGE_BARCODE_LABEL, 10.2.103

RUN_STORAGE_REPORT, 10.2.104

RUN_USER_BARCODE_LABEL, 10.2.105

runHtmlConversion, A.16

S

SAVE_GLOBALINCLUDES, 4.10.13

SAVE_TEMPLATE_CONVERSIONS, 4.5.10

SAVE_USER_TOPICS, 4.14.27

saveGlobalIncludes, A.17

saveTemplateConversions, A.17

saveUserOptionList, A.17

SCREEN_CHARGE_BACKS_ADVANCED_FORM, 10.2.106

SCREEN_CHARGE_BACKS_FORM, 10.2.107

SEARCH_EXTERNAL_ITEM_FORM, 10.2.108

searchCacheReport, A.17

searchProblemReports, A.17

SELECTDOC, 4.3.61

sendMailTo, A.17

サービス属性

アクセス・レベル, 3.1.2.2

エラー・メッセージ, 3.1.2.6

サービス・クラス, 3.1.2.1

サービス・タイプ, 3.1.2.4

通知された件名, 3.1.2.5

テンプレート・ページ, 3.1.2.3

サービス・クラス属性, 3.1.2.1 サービス定義表, 3.1 サービス・リソース

属性, 3.2.2

サービス・リソース

アクション, 3.2.3

作成, 3.3

例, 3.1, 3.2

サービスのResultSet

「アクション」列, 3.1.3

属性列, 3.1.2

「名前」列, 3.1.1

サービス・タイプ属性, 3.1.2.4 サービス

アクション, 3.1.3

アーカイブ, 6.2

コアOracle Content Server, 4.2

DELETE_ALL_BUT_LAST_N_REVISIONS_SERVICE, 9.2.19

拡張ユーザー属性, 11.2

フォルダ, 7.2

Folders_g, 7.2

フォリオ, 12.2

Framework Folders, 8.2

概要, 4.2

Oracle Universal Records Management, 9.2

ワークフロー, 5.2

SET_DEFAULT_ATTRIBUTES, 11.2.13 setConditionVars, A.17 setDateToPresent, A.17 setDeleteRevReleaseState, A.17 setExternalDocInfoFields, A.17 setFileConversionInfo, A.17 setInputConversionInfo, A.17 setLocalValues, A.17 setOutputConversionInfo, A.17 setStatusMessage, A.17 setTemplateConversionInfo, A.17 setTraceFlags, A.17 SOAP_FAULT, 4.2.35 START_SEARCH_INDEX, 4.6.4 startCriteriaWorkflow, A.17 startWorkflow, A.17 static page, 2.1.2 storeUserDatabaseProfileData, A.17 subjects notified attribute, 3.1.2.5 SUBMIT_HTML_FORM, 4.3.62 submitForm, A.17 submitHtmlForm, A.17 SUBSCRIBE, 4.3.63 SUBSCRIBE_DOC_USER, 4.3.64 SUBSCRIBE_EX, 4.3.65 SUBSCRIBE_FORM, 4.3.66 SUBSCRIPTION_LIST, 4.3.67 SuppressResultLocalization, 2.1.6 構文

サービス・アクション, 3.1.3, A.1

T

テンプレート・ページ属性, 3.1.2.3

TEST_PROVIDER, 4.11.10

TEST_WORKFLOW_SCRIPT, 5.4.34

testProvider, A.18

testWorkflowScript, A.18

TRANSFER_ARCHIVE, 6.2.49

U

Ualias, A.19

UcheckoutRevision, A.19

Ucollaboration, A.19

UdeleteRevision, A.19

UdocFormat, A.19

UdocType, A.19

UextensionMap, A.19

Umeta, A.19

Umetadef, A.19

UNCLOSE_FOLDER, 9.2.59

UNDO_CHECKOUT, 4.3.68

UNDO_CHECKOUT_BY_NAME, 4.3.69

UnextCounter, A.19

UnextRevID, A.19

UNFREEZE_FOLDER, 9.2.60

UNFREEZE_RECORD, 9.2.61

UNINSTALL_COMPONENT, 4.7.12

uninstallComponent, A.19

UNLOCK_FOLIO, 12.2.6

UNRESERVE_STORAGE, 10.2.109

UNSUBSCRIBE, 4.3.70

UNSUBSCRIBE_FORM, 4.3.71

UNSUBSCRIBE_FROM_LIST, 4.3.72

UNSUBSCRIBE_FROM_LIST_EX, 4.3.73

UPDATE_ADVANCED_SEARCH_OPTIONS, 4.8.10

UPDATE_BYREV, 4.3.74

UPDATE_COMPONENT_CONFIG, 4.7.13

UPDATE_DOCINFO, 4.3.75

UPDATE_DOCINFO_BYFORM, 4.3.76

UPDATE_DOCINFO_BYREV, 4.3.77, 4.3.78

UPDATE_DOCINFO_METAFILE_BYREV, 4.3.78

UPDATE_DOCINFO_STATUS, 4.3.79

UPDATE_DOCINFO_SUB, 4.3.80

UPDATE_FILTER_INFO, 4.14.28

UPDATE_FOLIO, 12.2.2

UPDATE_LICENSE, 4.7.14

UPDATE_META_TABLE, 4.8.13

UPDATE_METADATA, 4.3.84

UPDATE_OPTION_LIST, 4.8.14

UPDATE_PROBLEMREPORT, 5.2.15

UPDATE_RESULT_TEMPLATE, 4.10.14

UPDATE_STORAGE_DEPTHS, 10.2.110

UPDATE_SUBSCRIPTION_NOTIFY, 4.3.81

UPDATE_SUBSCRIPTION_TYPE, 4.3.82

UPDATE_SUBSCRIPTION_USED, 4.3.83

UPDATE_TARGET_TOTALS, 6.2.50

UPDATE_TRANSFER_STATUS, 6.2.51

UPDATE_USER_META, 4.8.11

UPDATE_USER_META_TABLE, 4.8.12

UPDATE_USEROPTION_LIST, 4.14.29

UPDATE_USERS_WITH_NO_BARCODES, 10.2.111

updateAffectedWorkflows, A.19

updateCache, A.19

updateCollaborationCache, A.19

updateComponentConfig, A.19

updateConversionCache, A.19

updateDocFormatsConfig, A.19

updateDocInfo, A.19

updateFilterConfig, A.19

updateLicense, A.19

updateMetaTable, A.19

updateOptionList, A.19

updateProblemReport, A.19

updateResultTemplate, A.19

updateRevisionIDAndLabel, A.19

updateSubscriptionType, A.19

updateUserLocale, A.19

updateUserMeta, A.19

updateUserMetaTable, A.19

updateWorkflowAndDocState, A.19

updateWorkflowState, A.19

updateWorkflowStateAfterCheckin, A.19

UPLOAD_ARCHIVE_TRANSFER, 6.2.52

UPLOAD_NEW_COMPONENT, 4.7.15

UproblemReport, A.19

Urevision, A.19

Urevision2, A.19

UrevisionStatus, A.19

UroleDefinition, A.19

UsecurityGroup, A.19

UserDateFormat, 2.1.6

UsubscriptionNotification, A.19

UsubscriptionUse, A.19

Uuncheckout, A.19

UuncheckoutPrevID, A.19

UuserAuthType, A.19

Uworkflow, A.19

UworkflowCriteria, A.19

UworkflowDocStep, A.19

UworkflowWithProject, A.19

V

VALIDATE_DOCINFO, 4.3.85

validateCheckinData, A.20

validateCollaboration, A.20

validateDelete, A.20

validateMetaData, A.20

validateProblemReport, A.20

validateStandard, A.20

validateSteps, A.20

validateUserNameAndType, A.20

VCR_FOLDER_INFO, 14.2.1

VCR_GET_CONTENT_TYPE, 14.2.2

VCR_GET_CONTENT_TYPES, 14.2.3

VCR_GET_DOCUMENT, 14.2.4

VCR_GET_DOCUMENT_BY_NAME, 14.2.5

VIEW_DOC, 4.13.10

viewDoc, A.20

VirtualContentRepository services, 14.2

W

WORK_IN_PROGRESS, 4.3.86

WORKFLOW_APPROVE, 5.4.35

WORKFLOW_CANCEL, 5.4.36

WORKFLOW_CHECKIN, 5.4.37

WORKFLOW_CHECKIN_SUB, 5.2.16

WORKFLOW_EDIT_APPROVE, 5.4.38

WORKFLOW_EDIT_REV, 5.2.17

WORKFLOW_NEW_REV, 5.2.18

WORKFLOW_REJECT, 5.4.39

WORKFLOW_REJECT_FORM, 5.2.19

WORKFLOW_START, 5.4.40

オラクル社の法律上の注意点について

コピーライトについて

Copyright © 1994-2013, Oracle and/or its affiliates.All rights reserved.

商標と登録商標について

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の登録商標です。

ライセンス制約の保証と結果的に生じる損害の免責

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

保証免責

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

制限付権利

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

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）、その他の対策を講じることは使用者の責任となります。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

第三者のコンテンツ、製品、サービスに対する免責事項

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

ドラフトのアルファ版およびベータ版ドキュメントについて

このドキュメントが試作版の場合:

このドキュメントは試作版であり、デモおよび暫定使用のみを目的としたものです。このソフトウェアを使用するハードウェアに限定するものではありません。オラクル社およびその関連会社は、このドキュメントに関して一切の責任を負わず、いかなる保証もいたしません。また、このドキュメントを使用したことによって損失、費用、あるいは損害が発生しても、一切の責任を負いかねます。