| Oracle® Fusion Middleware Oracle WebCenter Contentサービス・リファレンス 11gリリース1 (11.1.1) B72418-02 |
|
 前 |
 次 |
| Oracle® Fusion Middleware Oracle WebCenter Contentサービス・リファレンス 11gリリース1 (11.1.1) B72418-02 |
|
前 |
次 |
この章では、Oracle WebCenter Content Serverアーカイブを使用およびカスタマイズする際に使用可能なサービスについて説明します。
この章の内容は、次のとおりです。
WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、第2章「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、第3章「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります
特定のアーカイブ・サービスの場所は、各サービス内にリスト表示されています。
|
注意: 最も一般的に使用されるサービスには、より広範囲な説明があります。 |
|
重要: すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。 |
|
重要: ほとんどのアーカイブ・サービスはEDIT_ARCHIVEDATAで使用される基礎となるメソッドを使用するため、その結果として、適切な値に設定されるEditItemsパラメータが必要です。ユーザー・インタフェースは、通常、このパラメータに含める内容を制御します。必要に応じて、ユーザーは値の設定方法を決定するため、Filter Debugフラグを有効にしたユーザー・インタフェースからアーカイブ・サービスを実行する必要があります。Filter Debugフラグを使用することにより、サーバーに送信されるリクエストをそのままキャプチャすることができます。 |
特記しないかぎり、ここにリストされているすべてのサービスは、ArchiveServiceサービス・クラスです。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。
この項では、次のサービスについて説明します。
アーカイブ・コレクションにアーカイブを追加するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、アーカイブ名が一意ではないことです。
場所: 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
新しいアーカイブ・コレクションを作成するサービス。最も発生しがちなエラーは、インスタンス・メニュー・ラベルが一意ではないことです。
|
注意: 重複する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
別のサーバーからアーカイブ・コレクションを追加するために使用されるサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
psIDC_Name: プロバイダ(プロキシ接続)の名前。
IDC_Name: アーカイブ・コレクションの名前。
現在のアーカイブ・リクエストをキャンセルするサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
アーカイブにコンテンツ・アイテムのリビジョンをチェックインするサービス。
アクセス・レベル: 管理者(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
コレクションにアーカイブをコピーするサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IdcService: COPY_ARCHIVEに設定する必要があります。
InstanceMenuLabel: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
例
IdcService=COPY_ARCHIVE InstanceMenuLabel=Master_on_server01
コレクションから既存のアーカイブを削除するサービス。最も発生しがちなエラーは、指定されたアーカイブがシステムに存在しないことです。
場所: 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
アーカイブからバッチ・ファイルを削除するサービス。
場所: 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
バッチ・ファイルの編集中に使用されるサービス。アーカイバ/一般/バッチ・ファイルの表示/編集のダイアログを使用している場合に使用できます。このダイアログを使用して、ユーザーはバッチ・ファイルの選択したエントリを削除できます。
ユーザーが編集を完了し、「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
エクスポートされた表データで使用されることを除き、DELETE_BATCH_FILE_DOCUMENTSに類似したサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
aArchiveName: アーカイブ名。
アーカイブの説明が作成された後で、それを変更するために使用されるサービス。説明にアクセスするには、アーカイブ・リストのアーカイブをダブルクリックします。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
例
IdcService=EDIT_ARCHIVE IDC_Name=Master_on_server01
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
指定されたアーカイブのアーカイブ・データを編集するサービス。指定される場合、アーカイブを登録するか、または登録解除します。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
EditItems: 承認される唯一の値はaIsAutomatedExportおよびaRegisteredExportersです。
EditItemsを設定することにより、次のパラメータも必須になります。
aIsAutomatedExport
aRegisteredExporters
アーカイブ・プロセスの転送オプションを編集するために使用されるサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
アーカイブのバッチ操作を実行するサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
aBatchFile: 実行するバッチ・ファイルのパスおよびファイル名。
アーカイブをエクスポートするサービス。
エクスポートではアーカイブの定義ファイルが読み込まれ、指定されているエクスポート・ルールに従います。これには、エクスポート問合せの指定、ユーザーまたはドキュメントの構成情報(またはその両方)をエクスポートするかどうかおよび前のバッチ・ファイルを削除するかどうかが含まれます。
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
すべてのアーカイブ・コレクションのリストを返すサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
エクスポートされる表データをプレビューするために使用されるサービス。アーカイバ/データのエクスポート/表/プレビューのダイアログで使用されます。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
aArchiveName: アーカイブ名。
resultName: 表の内容の結果セット名。
アーカイブからアーカイブ済コンテンツ・アイテムのリビジョンの特定のレンディションを返すサービス。
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
コレクションのすべてのアーカイブのリストを返すサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
例
IdcService=GET_ARCHIVES IDC_Name=Master_on_server01
エクスポートされる表間の確立された関係を問い合せるために使用されるサービス。すべてのパラメータはユーザー・インタフェースにより提供され、アーカイブの定義に由来します。アーカイブ・エクスポート定義に従って、GET_ARCHIVETABLECONTENTを実行する前にこのサービスをコールする必要があります。
場所: IdcHomeDir/resources/core/tables/std_services.htm
すべてのバッチ・ファイルのコンテンツ・アイテムを返すサービス。
場所: 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
指定されたバッチ・ファイルのプロパティを返すサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
aArchiveName: アーカイブ名。
aBatchFile: バッチ・ファイルのサブディレクトリおよびHDAファイル名。
バッチ・スキーマを返すサービス。スキーマ情報は、データベースに格納されるオブジェクトのクラスを記述します。
場所: 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
バッチのメタデータ・フィールド値を返すサービス。
場所: 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
指定されたアーカイブのバッチ・ファイルを返すサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
必須のサービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
aArchiveName: アーカイブ名。
例
IdcService=GET_BATCHFILES IDC_Name=Master_on_server01 aArchiveName=latest_archive
プロキシContent Serverインスタンス上のすべてのアーカイブ・コレクションのリストを返すサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
psIDC_Name: プロキシContent Serverインスタンスの名前。
例
IdcService=GET_PROXIED_ARCHIVECOLLECTIONS psIDC_Name=Proxied_2_on_test13
レプリケーション・データを返すサービス。最も発生しがちなエラーは、アーカイブの場所が正しくないことです。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
例
IdcService=GET_REPLICATION_DATA IDC_Name=Master_on_server01
指定された表に関する列情報を取得するサービス。列の名前、タイプおよび長さを返します。このサービスを実行するには、コール元にADMIN権限が必要です。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
aArchiveName: アーカイブ名。
tableName: カンマで区切られた表名のリスト。
ターゲットのステータス・チェックを実行するサービス。ターゲットがターゲット化可能であり、ターゲットが存在するかどうかを判断するために初期ステータス・チェックを実行します。
このサービスは外部で使用することを目的としていません。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
aArchiveName: アーカイブ名。
TargetCollection: ターゲットにされるコレクションの名前。
TargetArchive: ターゲット・コレクション内のアーカイブの名前。
aTransferOwner: 転送を開始しているユーザーの名前。
転送ステータスを判別するために転送中に使用されるサービス。TransferMonitorはこれを使用して、転送が完了したかまたは進行中であるかどうかを判別します。
外部で使用することを目的としていません。
場所: IdcHomeDir/resources/core/tables/std_services.htm
実行される必要がある作業を確立するためにプル転送中に使用されるサービス。転送用ソース・アーカイバがプロキシ・サーバー上にあり、転送所有者がどの作業を実行する必要があるかどうか(ある場合)を決定する必要があるときに使用されます。
外部で使用することを目的としていません。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
SourceArchive: ターゲットのソースとして使用されるアーカイブ。
aTransferOwner: 転送を開始しているユーザーの名前。
aArchiveName: アーカイブ名。
アーカイブをインポートするサービス。
インポートではアーカイブの定義ファイルが読み込まれ、指定されているインポート・ルールに従います。
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
インポート用のキュー待機アーカイブを登録するサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
aArchiveName: アーカイブ名。
「バッチ・ファイルの表示」ダイアログからの選択に従って、指定されたバッチ・ファイルのコンテンツ・アイテムをContent Serverインスタンス内にインポートするサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
aArchiveName: アーカイブ名。
指定されたドキュメント(通常は「バッチ・ファイルの表示」ダイアログから選択される)を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
アーカイブの表にエントリを追加るために使用されるサービス。このサービスはIMPORT_DOCUMENTと同じです。エクスポートされたコンテンツ・アイテムではなく、エクスポートされた表アイテム上で機能します。「バッチ・ファイルの表示」ダイアログからアクセス可能で、指定された表アイテムをインポートするために使用されます。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
aArchiveName: アーカイブ名。
aBatchFile: 表が格納されるバッチ・ファイルのパスおよびファイル名。
INSERT_NEWの実行時に作成されるIDをリカバリするためにアーカイバで使用されるサブサービス。このサービスは新しいIDを生成しません。エクスポート中に格納されるIDを再使用します。このサブサービスは、管理者がエクスポートの作成元のシステムにアーカイブしているときにのみ使用されます。アーカイバがINSERT_NATIVEを使用するのは、エクスポータとインポータが同じインスタンス名(IDC_name)を持ち、システムがコンテンツ・アイテムを完全にリカバリしようとしているときです。
場所: IdcHomeDir/resources/core/tables/std_services.htm
空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1
指定されたdDocNameを持つ前のアイテムがシステムで検出されなかったときに、CHECKIN_ARCHIVEの実行中に使用されるサブサービス。このサブサービスは、バッチ・ロード中およびアーカイブのインポート操作中に使用されます。これは新しいコンテンツ・アイテムをシステムに追加し、その新しいID (dID、dRevClassIDなど)を作成します。
場所: IdcHomeDir/resources/core/tables/std_services.htm
空のファイルのチェックインを禁止するには、次を設定します: ValidatePrimaryFileNotEmpty=1
アーカイブのインポータを登録または登録解除するサービス。最も発生しがちなエラーは、パラメータに不整合があるか、正しくないインスタンス・メニュー・ラベルまたはアーカイブ名があることです。
場所: 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
アーカイブ・コレクションを削除するサービス。デフォルトのアーカイブ・コレクションは削除できません。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。
例
IdcService=REMOVE_COLLECTION IDC_Name=new_collection
アーカイブからエクスポータを削除するサービス。最も発生しがちなエラーは、アーカイブの場所が正しくないことです。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
aArchiveName: アーカイブ名。
IDC_Name: エクスポータの名前。
例
IdcService=REMOVE_EXPORTER IDC_Name=Master_on_server02 aArchiveName=archive_02
アーカイブからインポータを削除するサービス。最も発生しがちなエラーは、アーカイブの場所が正しくないことです。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: インポータの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
aArchiveName: アーカイブ名。
例
IdcService=REMOVE_IMPORTER IDC_Name=Master_on_server01 aArchiveName=my_archive_test
アーカイブの転送設定を削除するときにコールされるが、アクティビティを実行しているContent Serverインスタンスが、アーカイブを所有するContent Serverインスタンスではない(つまり、転送がプロキシされている)サービス。転送を削除または停止するには、リクエストをこのプロキシ・サーバーに送信する必要があります。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
aArchiveLocation: アーカイブの場所。
IDC_Name: 転送の所有者の名前。
ユーザーがキュー・インポートを削除できるサービス。これは、「アーカイバ・オプション」→「自動化の詳細を表示する」→「キューに入っている自動インポート」をクリックすることによりアクセス可能な「自動化」ダイアログから使用されます。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: インポータの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
ユーザーが自動転送を削除または停止できるサービス。これは、「アーカイバ・オプション」→「自動化の詳細を表示する」をクリックすることによりアクセス可能な「自動化」ダイアログから使用されます。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
aArchiveLocation: アーカイブの場所。
IDC_Name: インポータの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
転送リクエストを開始するサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
aArchiveName: アーカイブ名。
IDC_Name: エクスポータの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
指定された手動転送を開始するサービス。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
aArchiveName: アーカイブ名。
IDC_Name: エクスポータの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
アーカイバがアーカイブ定義ファイルで完了した作業量を更新するサービス。このサービスは外部で使用することを目的としていません。これは、自動転送を監視したり、手動または自動転送の完了時にデータを更新したりする役割を担う転送エンジンの一部です。
場所: IdcHomeDir/resources/core/tables/std_services.htm
転送の進捗に関する更新情報を送信するためにTransferMonitorで使用されるサービス。クライアント・アプリケーションで使用することを目的としていません。
場所: IdcHomeDir/resources/core/tables/std_services.htm
ターゲットにエクスポート・バッチ・ファイルをアップロードするために使用されるサービス。このサービスは、外部で使用するために拡張されていません。アーカイバの転送エンジンを構成するサービスの一部です。
場所: IdcHomeDir/resources/core/tables/std_services.htm
追加の必須サービス・パラメータ
IDC_Name: コレクションの名前。デフォルトのコレクションを使用している場合、これはContent Serverインスタンスの名前です。
TargetCollection: ターゲットにされるコレクションの名前。
TargetArchive: ターゲット・コレクション内のアーカイブの名前。
SourceCollection: 転送に使用されるコレクションの名前。
SourceArchive: ターゲットのソースとして使用されるアーカイブ。
aBatchFile: 転送で使用されるバッチ・ファイルの名前。
ZipFile:path: アップロードされる転送のzipファイルへパス名。
