27 統合のためのCOM APIの使用

この章では、Microsoft Component Object Model (COM)統合について説明します。Oracle WebCenter Content Serverは、COM環境内から機能をコールする機能を提供する、COMベースのAPIを使用します。

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

• COM APIについて

• IntradocClient OCXコンポーネントを使用したコンテンツ・サーバー・サービスのコール

• ODMA APIを使用した、デスクトップ・アプリケーションからコンテンツ・サーバーへのアクセス

27.1 COM APIについて

COMインタフェースを使用して、コンテンツ管理をMicrosoft環境およびアプリケーションと統合できます。コンテンツ・サーバー内のコンテンツおよびコンテンツ管理機能にアクセスするためのインタフェース・オプションとして、ActiveXコントロールおよびOCXコンポーネントが提供されています。さらに、COMインタフェースを通じてODMA対応アプリケーションと通信できます。

27.2 IntradocClient OCXコンポーネントを使用したコンテンツ・サーバー・サービスのコール

リモートのコンテンツ・サーバー・インスタンスに接続してContent Serverサービスを実行するために、Object Linking and Embedding Control Extension (OCX)コントロールが用意されています。IdcClient OCXコントロールは、コンテンツ・サーバー内のコンテンツおよびコンテンツ管理機能にアクセスするために、Windows Visual Basic開発環境内で使用されます。

IdcClient OCXコントロールを使用してコンテンツ・サーバー・サービスをコールすることができます。IdcClient.ocxコントロールは、リモートのコンテンツ・サーバー・インスタンスに接続し、標準的なサーバー機能を実行するために使用されます。

ノート:

• IdcClient OCXコンポーネントを使用するには、Visual BasicまたはVisual C++開発環境が必要です。

• Intradocの詳細は、Oracle Fusion Middleware Oracle WebCenter Content Remote Intradoc Client (RIDC) Java APIリファレンスを参照してください。

27.2.1 OCXインタフェース

IntradocClient OCXコンポーネントは、コンテンツ・サーバー内のコンテンツおよびコンテンツ管理機能にアクセスするために、Windows Visual Basic開発環境内で使用されます。OCX統合は、ビジュアル開発環境でサービスをコールするように、またはリモートのコンテンツ・サーバー・インスタンスに接続するように設計されています。

IntradocClient OCXコンポーネントは、メソッド・コールを使用してアクセス可能な機能を提供します。メソッドはアクションを実行し、多くの場合、結果を返します。情報は、パラメータを使用してメソッドに渡されます。関数には、パラメータをとらないもの、パラメータを1つとるもの、複数のパラメータをとるものがあります。

IntradocClient OCXコンポーネントでは、コマンドの実行にユーザー名とパスワードが必要です。ユーザーには、コマンドを実行するための適切な権限が必要です。管理者アクセス・レベルを必要とするコマンドもあれば、書込み権限のみを必要とするコマンドもあります。

initおよびconnection管理メソッドを除き、すべてのメソッドは、通信のために、シリアル化されたHDAフォーマットを使用します。返された、シリアル化されたHDAフォーマットの文字列には、コマンドの成否に関する情報が含まれています。障害が発生した場合、StatusCodeは負の値になり、StatusMessageにエラーが示されます。

27.2.2 IdcClient OCXの説明

IdcClientは、サービスの実行やファイル・パス情報の取得などのアクションをプログラムで実行できるようにするActiveXコントロールです。IdcClientコントロールは、Microsoft Internet Explorerブラウザのラッパーでもあります。

IdcClient OCXコントロールは、Unicode規格を使用するように設計されており、ほとんどの場合、UTF-8形式でコンテンツ・サーバーとデータを交換します。Unicodeは、1文字当たり2バイト(16ビット)のストレージを使用し、様々な言語(英語、日本語、アラビア語など)で使用される文字を表すことができます。英語のASCII(情報交換用米国標準コード)文字は1バイト(8ビット)しか必要としないため、ASCII文字では、各Unicode文字の上位バイトがゼロで表されます。

Unicode規格の詳細は、WebでUnicode Consortium(http://www.unicode.org)を参照してください。

ノート:

IdcClient OCXは、Microsoft Layer for Unicodeの上に構築されており、Microsoft Layer for Unicodeによって、UnicodeアプリケーションをWin9xプラットフォームで実行することが可能になります。9xプラットフォーム上でIdcClient OCXコントロールを配布するときは、unicows.dllも配布する必要があります。このコンパニオンDLLは、Windowsベースのシステム上には配布できません。

ほとんどの場合、メソッドは、通信のために、シリアル化されたHDAフォーマットを使用します。シリアル化されたHDAフォーマットは、通信のために使用されるJavaメソッドです。返された、シリアル化されたHDAフォーマットの文字列には、コマンドの成否に関する情報が含まれています。

IdcClient OCXコントロールは、メソッド・コールを使用して実行可能な機能を提供します。メソッドはアクションを実行し、多くの場合、結果を返します。情報は、パラメータを使用してメソッドに渡されます。関数には、パラメータをとらないもの、パラメータを1つとるもの、複数のパラメータをとるものがあります。たとえば、文字列として渡される2つのパラメータを持つ関数は、次のフォーマットを使用します。

Function(Parameter As String, Parameter As String) As String

• ユーザーは、IdcClient OCXを使用して、サービスを実行するクライアント・アプリケーションを作成できます。OCXコントロールは、コマンドおよびパラメータを含む名前/値のペアを取得し、指定されたサービスをコールします。実行結果は、コール側プログラムに渡されます。

• IdcClient OCXでは、コマンドの実行にユーザー名とパスワードが必要です。ユーザーには、コマンドを実行するための適切な権限が必要です。管理者アクセス・レベルを必要とするコマンドもあれば、書込み権限のみを必要とするコマンドもあります。

27.2.2.1 OCXイベント

イベントは、ユーザーまたはサーバーがアクションを実行すると実行されます。たとえば:

• IntradocBrowserPostイベントは、ユーザーがフォームをブラウザ内から送信するたびに実行されます。

• IntradocServerResponseイベントは、サーバーがリクエストされたアクションを完了すると実行されます。

27.2.2.2 OCXメソッド

Visual Basic標準コントロールは、すべてのVisual Basic開発環境に共通のメソッドを提供します。また、IdcClient OCXコントロールは、この特定のコントロールに固有のプライベート・メソッドを提供します。これらのメソッドは、特性の設定ではなく、アクションの実行または開始に使用されます。

たとえば:

• AboutBox() メソッドは、製品のバージョン情報を示す「情報」ボックスを起動します。

• GoCheckinPage メソッドは、新しいコンテンツ・アイテムまたはコンテンツ・アイテムのリビジョンをチェックインします。

27.2.2.3 OCXプロパティ

プロパティは、オブジェクトを記述またはフォーマットし、コードによって、またはVisual Basic開発環境でプロパティ・ウィンドウを使用して変更できます。プロパティは、オブジェクトの基本的な特性を記述します。

たとえば:

• UserNameプロパティは、割り当てられたユーザー名を指定します。

• WorkingDirプロパティは、ダウンロードされたファイルが格納される場所を指定します。

27.2.2.4 IdcClient OCXインタフェース

IdcClient OCXコントロールは、コンテンツ・サーバー内のコンテンツおよびコンテンツ管理機能にアクセスするために、Windows Visual Basic開発環境内で使用されます。OCX統合は、ビジュアル開発環境でサービスをコールするように、またはリモートのコンテンツ・サーバー・インスタンスに接続するように設計されています。

ほとんどの場合、メソッドは、通信のために、シリアル化されたHDAフォーマットを使用します。返された、シリアル化されたHDAフォーマットの文字列には、コマンドの成否に関する情報が含まれています。障害が発生した場合、StatusCodeは負の値になり、StatusMessageにエラーが示されます。返されたHDAにStatusCodeパラメータが含まれていない場合、サービス・コールが成功したことを示しています。

27.2.3 IdcClient OCXコントロールの設定

Microsoft Visual Basic開発環境で、IdcClient OCXコンポーネントを設定し、ビジュアル・インタフェースを作成できます。

27.2.3.1 IdcClient OCXコンポーネントの設定

Microsoft Visual Basic開発環境で、IdcClient OCXコンポーネントを設定するには、次のステップを実行します。

1. 新規プロジェクトを作成します。
2. 「プロジェクト」を選択し、「コンポーネント」を選択します。
3. システムでIdcClient.ocxファイルを参照し、「開く」をクリックします。

   IdcClientモジュールがコンポーネント・コントロール・リストに追加されます。

4. IdcClient ActiveX Controlモジュールのチェック・ボックスが選択されていることを確認し、「OK」をクリックします。

   IdcClient OCXコントロールが、コントロールのリストに入ります。

5. (オプション) Visual Basic開発環境を使用してユーザー独自のビジュアル・インタフェースを構築できます。または、「ビジュアル・インタフェースの作成」に記載されているステップに従って基本的なビジュアル・インタフェースを構築できます。

27.2.3.2 ビジュアル・インタフェースの作成

ビジュアル・インタフェースを作成するための次の手順は、Visual Basicプロジェクトが作成されており、IdcClient OCXコントロールがコントロールのリストに入っていることを前提としています。詳細は、「IdcClient OCXコンポーネントの設定」を参照してください。

基本的なビジュアル・インタフェースを構築するには、次のステップを実行します。

1. コントロールを選択し、それをVisual Basicフォーム上に描画します。

   図27-1では、IdcClient OCXコントロールを示しています。

   図27-1 Visual Basicフォーム上に描画されたOCXコントロール

   
   「図27-1 Visual Basicフォーム上に描画されたOCXコントロール」の説明

2. 「プロパティ」ウィンドウのドロップダウン・リストから、「IdcClient OCX」を選択します。

   「プロパティ」ウィンドウが表示されていない場合は、メイン・メニューから「表示」→「プロパティ・ウィンドウ」を選択します。

3. IdcClient OCXコントロールの名前をIdcClientCtrlに変更します。

4. 特定のインスタンスのiss_idc_cgi.dllを参照するようにHostCgiUrlを定義します。

   たとえば:

   http://testserver/intradoc-cgi/iss_idc_cgi.dll
   

   図27-2では、このURLをHostCgiUrlの値として示しています。

   図27-2 編集後のIdcClientのプロパティ

   
   「図27-2 編集後のIdcClientのプロパティ」の説明

5. フォームで、テキスト・ボックスを描画し、CgiUrlという名前を付けます。

6. 「テキスト」フィールドに、表示されるテキストとしてHostCgiUrlの値(http://testserver/intradoc-cgi/iss_idc_cgi.dllなど)を入力します。

   図27-3では、「テキスト」の値としてこのURLが示されています。

   図27-3 編集後のCgiUrlテキスト・ボックスのプロパティ

   
   「図27-3 編集後のCgiUrlテキスト・ボックスのプロパティ」の説明

7. フォームで、テキスト・ボックスを描画し、コマンドという名前を付けます。

8. 「テキスト」フィールドのエントリをクリア(空白のままに)し、「MultiLine」を「True」に設定します。

   図27-4では、MultiLineの値を示しています。

   図27-4 編集後のコマンド・テキスト・ボックスのプロパティ

   
   「図27-4 編集後のコマンド・テキスト・ボックスのプロパティ」の説明

9. フォームで、テキスト・ボックスを描画し、レスポンスという名前を付けます。

10. 「テキスト」フィールドのエントリをクリア(空白のままに)します。

    図27-5は、レスポンス・テキスト・ボックスのフィールド値を示しています。

    図27-5 編集後のレスポンス・テキスト・ボックスのプロパティ

    
    「図27-5 編集後のレスポンス・テキスト・ボックスのプロパティ」の説明

11. フォームで、ボタンを描画し、SendPostCommandという名前を付けます。

12. 「キャプション」フィールドに、表示されるテキストとして「Postコマンドの送信」と入力します。

    図27-6は、SendPostCommandボタンに表示される「キャプション」の値を示しています。

    図27-6 編集後のSendPostCommand CommandButtonのプロパティ

    
    「図27-6 編集後のSendPostCommand CommandButtonのプロパティ」の説明

13. フォームで、「表示」→「コード」を選択します。

14. ドロップダウン・リストから「SendPostCommand」→「クリック」を選択して、次のアクションを実行するようにコードを変更します。

    • Host Cgi URLの値を設定する。

    • コマンドを発行する。

    • (オプション) LFをCRLFに置換して、編集コントロールでの表示が読みやすくなるようにする。

    • レスポンスを表示する。

    次のようにコードを変更します。

    Dim R As String
    IdcClientCtrl.HostCgiUrl = CgiUrl.Text
    R = IdcClientCtrl.1.SendPostCommand(Command.Text)
    R = Replace(R, vbLf, vbCrLf
    Response.Text = R
    

    図27-7は、コードの変更内容を示しています。

    図27-7 編集後のSendPostCommand_Clickコード

    
    「図27-7 編集後のSendPostCommand_Clickコード」の説明

15. ドロップダウン・リストから「フォーム」→「ロード」を選択し、次の行を追加してコンテンツ・サーバー・インスタンスのログイン・プロンプトを設定します。

    IdcClientCtrl.UseBrowserLoginPrompt = True
    IdcClientCtrl.UseProgressDialog = True
    

    図27-8は、変更後のコードを示しています。

    図27-8 編集後のForm_Loadコード

    
    「図27-8 編集後のForm_Loadコード」の説明

16. (オプション) 「Cgi Url」、「コマンド」、「レスポンス」など、適切な説明ラベルを追加します。

    図27-9は、説明ラベルのあるフォームを示しています。

    図27-9 説明ラベルのあるビジュアル・インタフェース

    
    「図27-9 説明ラベルのあるビジュアル・インタフェース」の説明

17. 「実行」→「起動」を選択して、ビジュアル・インタフェースをテストします。

    図27-10は、テストが成功した場合の結果を示しています。

    図27-10 完成したビジュアル・インタフェース

    
    「図27-10 完成したビジュアル・インタフェース」の説明

18. 「コマンド」フィールドに、書式設定済のコマンドを入力します。

    図27-11は、ユーザーを追加するADD_USERコマンドを示しています。

    ADD_USERサービスの詳細は、『Oracle Fusion Middleware Oracle WebCenter Contentサービス・リファレンス』のADD_USERに関する項を参照してください。

    図27-11 コマンドが定義されたビジュアル・インタフェース

    
    「図27-11 コマンドが定義されたビジュアル・インタフェース」の説明

19. 「Postコマンドの送信」ボタンをクリックして、コマンドを実行します。返された結果が「レスポンス」フィールドに表示されます。

    図27-12は、返された結果の一部を示しています。

    図27-12 結果が返されたビジュアル・インタフェース

    
    「図27-12 結果が返されたビジュアル・インタフェース」の説明

コマンドを検証するには:

1. Webブラウザで、コンテンツ・サーバーに管理者としてログインします。
2. 「管理」トレイまたはメニューから、「デスクトップ・クライアント・アプリケーション」を選択します。
3. 「ユーザー管理」をクリックします。アプリケーションが起動し、追加されたユーザー(user99など)が表示されます。

27.2.4 IdcClientイベント

イベントは、ユーザーまたはサーバーがアクションを実行すると実行されます。次のIdcClient OCXイベントを使用できます。

• IntradocBeforeDownload

• IntradocBrowserPost

• IntradocBrowserStateChange

• IntradocRequestProgress

• IntradocServerResponse

27.2.4.1 IntradocBeforeDownload

ファイルのダウンロード前に実行されます。

• ダウンロード前に必要なサーバーのアクションおよび更新を開始します。

パラメータ

このイベントは、次のパラメータを渡します。

• ByVal params As String

• cancelDownload As Boolean

27.2.4.2 IntradocBrowserPost

フォームがブラウザ内から送信されるたびに実行されます。

パラメータ

このイベントは、次のパラメータを渡します。

• ByVal url As String

• ByVal params As String

• cancelPost As Boolean

27.2.4.3 IntradocBrowserStateChange

ブラウザの状態が変わるたびに実行されます。

パラメータ

このイベントは、次のパラメータを渡します。

• ByVal browserStateItem As String

• ByVal enabled As Boolean

27.2.4.4 IntradocRequestProgress

サーバーからの進行状況レポートの送信リクエストを実行します。このイベントが発生するのは、メソッドのコール後のみです。

パラメータ

このイベントは、次のパラメータを渡します。

• ByVal statusData As String

• ByVal isDone As Boolean

27.2.4.5 IntradocServerResponse

サーバーがリクエストされたアクションを完了した後に実行されます。たとえば、ファイルのダウンロード後などです。このイベントは、サーバーからのレスポンスであるHDAエンコード・データを処理します。このイベントが発生するのは、アクションがブラウザで実行される場合のみです。

パラメータ

このイベントは、次のパラメータを渡します。

• ByVal response As String

27.2.5 IdcClient OCXメソッド

次のIdcClient OCXメソッドを使用できます。

• AboutBox

• Back

• CancelRequest*

• DoCheckoutLatestRev

• DownloadFile

• DownloadNativeFile

• Drag

• EditDocInfoLatestRev

• Forward

• GoCheckinPage

• Home

• InitiateFileDownload*

• InitiatePostCommand*

• Move

• Navigate

• NavigateCgiPage

• Refresh Browser

• SendCommand*

• SendPostCommand*

• SetFocus

• ShowDMS

• ShowDocInfoLatestRev

• ShowWhatsThis

• StartSearch

• Stop

• UndoCheckout

• ViewDocInfo

• ViewDocInfoLatestRev

• ZOrder

アスタリスク(*)が付けられたメソッドは、ブラウザ・アクティビティとは関係なく、値を返すメソッドです。

ノート:

特に示されていないかぎり、すべてのパラメータは必須です。

27.2.5.1 AboutBox

Sub AboutBox()

説明

製品のバージョン情報を示す「情報」ボックスを起動します。

• このメソッドは、製品の「情報」ボックスを表示します。
• コールを実行できない場合、メソッドは、FALSEを返します。

パラメータ

なし

27.2.5.2 Back

Sub Back()

説明

前のHTMLページを表示します。

• 前の画面に戻ります。
• このメソッドは、ユーザーに表示する、前のHTMLページをキャッシュされた情報から取得します。

パラメータ

なし

27.2.5.3 CancelRequest

Function CancelRequest() As Boolean

説明

このメソッドは、現在アクティブなリクエストを取り消します。リクエストを取り消すことができない場合、または現在アクティブなリクエストがない場合は、FALSEを返します。

パラメータ

なし

出力

次のブール値を返します。

• リクエストが取り消された場合は、TRUEを返します。
• 取消しリクエストを実行できない場合は、FALSEを返します。

27.2.5.4 DoCheckoutLatestRev

Sub DoCheckoutLatestRev(docName As String, curID As String)

説明

コンテンツ・アイテムの最新のリビジョンをチェックアウトまたはロックします。

• コンテンツ・アイテム名およびバージョン・ラベルが指定されると、このメソッドは、コンテンツ・アイテムの最新のリビジョンをチェックアウトします。

• IntradocServerResponseイベントを実行します。イベントは、メソッドの発生前に実行されます。詳細は、IdcClientのイベントを参照してください。

  ノート:

  curID値は、コンテンツ・アイテムのバージョン・ラベルです。生成されたコンテンツ・アイテムのリビジョンIDではありません。

この関数は、次の値を返します。

• dIDおよびdDocNameを含むシリアル化されたHDA。

• 最新のリビジョンがチェックアウトできない場合、またはシステムに見つからない場合、FALSE。

• パラメータとして渡されたデータ。

パラメータ

• docName: ユーザーが割り当てたコンテンツ・アイテム名。

• curID: 最新のリビジョンに対する一意の識別子。オプション。

27.2.5.5 DownloadFile

Function DownloadFile(command As String, filename As String) As String

説明

定義されたファイルをダウンロードします。

• 現在関連付けられているコマンドおよびファイル・タイプが指定されると、このメソッドは、変換後のファイルのファイル・ダウンロードを実行します(DownloadNativeFileと比較)。

• IntradocBeforeDownloadイベントを実行します。イベントは、メソッドの発生前に実行されます。詳細は、IdcClientのイベントを参照してください。

この関数では、次のように値が返されます。

• ステータス・コードおよびステータス・メソッドを含むシリアル化されたHDA。

• パラメータとして渡されたデータ。

• 指定されたファイルをダウンロードできない場合、FALSE。

パラメータ

• command: 現在関連付けられているコマンド。

• filename: ファイル形式。これは、PDFやHTMなど、サポートされる形式のファイル・タイプです。

27.2.5.6 DownloadNativeFile

Function DownloadNativeFile(id As String, docName As String, filename As String) As String

説明

定義されたネイティブ・ファイルをダウンロードします。

• コンテンツ・アイテムのリビジョンID、コンテンツ・アイテム名およびファイル・タイプが指定されると、このメソッドは、ネイティブ・ファイルのファイル・ダウンロードを実行します(DownloadFileと比較)。

• IntradocBeforeDownloadイベントを実行します。イベントは、メソッドの発生前に実行されます。詳細は、「IdcClientのイベント」を参照してください。

  ノート:

  id値は、生成されたコンテンツ・アイテムのリビジョンIDです。コンテンツ・アイテムのバージョン・ラベルではありません。

この関数では、次のように値が返されます。

• dIDおよびdDocNameを含むシリアル化されたHDA。

• パラメータとして渡されたデータ。

• 指定されたファイルをダウンロードできない場合、FALSE。

パラメータ

• id: 最新のリビジョンに対する一意の識別子。

• docName: ユーザーが割り当てたコンテンツ・アイテム名。

• filename: ファイル形式。これは、DOCやRTFなど、サポートされる任意の形式のファイル・タイプです。

27.2.5.7 Drag

Sub Drag([nAction])

説明

ドラッグ操作を開始、終了または取り消します。

• Dragメソッドは、標準コントロールの実装と同様に処理されます。

• 詳細は、Visual BasicのAPIリファレンスを参照してください。

パラメータ

• nAction: 実行するアクションを指定します。nActionを省略すると、nActionは1に設定されます。

Dragメソッドの設定は次のとおりです。

• 0: ドラッグ操作を取り消し、コントロールの元の位置を復元します。

• 1: (デフォルト)コントロールのドラッグを開始します。

• 2: ドラッグを終了します。つまり、コントロールをドロップします。

27.2.5.8 EditDocInfoLatestRev

Sub EditDocInfoLatestRev(docName As String, curID As String, activateAction As String)

説明

最新のリビジョンに関するコンテンツ・アイテム情報を編集します。

• ODMA関連です。

• コンテンツ・アイテム名、バージョン・ラベルおよび現在アクティブなリクエストされたアクションが指定されると、このメソッドは、最新のリビジョンに関するコンテンツ・アイテム情報を編集します。

• 最新のリビジョンに関するコンテンツ・アイテム情報を編集できない場合、またはその情報がシステムに見つからない場合、この関数はFALSEを返します。

  ノート:

  curID値は、コンテンツ・アイテムのバージョン・ラベルです。生成されたコンテンツ・アイテムのリビジョンIDではありません。

パラメータ

• curID: 最新のリビジョンに対する一意の識別子。

• activateAction: ODMActivateに渡されます。これは、Idocスクリプトとして使用できます。オプションです。

• docName: ユーザーが割り当てたコンテンツ・アイテム名。オプションです。

27.2.5.9 Forward

Sub Forward()

説明

次のHTMLページを表示します。

• 次の画面に移動します。

• このメソッドは、ユーザーに表示する、次のHTMLページに関するキャッシュされた情報を取得します。

パラメータ

なし

27.2.5.10 GoCheckinPage

Sub GoCheckinPage(id As String, docName As String, isNew As Boolean, params As String)

説明

新しいコンテンツ・アイテムまたはコンテンツ・アイテムのリビジョンをチェックインします。

• コンテンツ・アイテムのリビジョンIDおよびコンテンツ・アイテム名が指定されると、この関数は、新しいコンテンツ・アイテムまたはコンテンツ・アイテムのリビジョンをチェックインします。

• このメソッドは、コンテンツ・アイテムのチェックイン・ページを開き、一意のコンテンツ・アイテム識別子、ユーザーが割り当てたコンテンツ・アイテム名および割り当てられたコンテンツ・アイテムの任意のパラメータを関連するテキスト・フィールドに入力します。また、新しいコンテンツ・アイテムなのか、リビジョンなのかも指定します。

  ノート:

  id値は、生成されたコンテンツ・アイテムのリビジョンIDです。コンテンツ・アイテムのバージョン・ラベルではありません。

出力

この関数では、次のように値が返されます。

• 指定されたファイルをチェックインできない場合、FALSE。

• dIDおよびdDocNameを含むシリアル化されたHDA。

• パラメータとして渡されたデータ。

パラメータ(すべてオプション)

• id: 最新のリビジョンに対する一意の識別子。

• docName: ユーザーが割り当てたコンテンツ・アイテム名。

• IsNew: チェックインされるコンテンツ・アイテムが新しいコンテンツ・アイテムなのか、リビジョンなのかを定義します。

  • TRUEの場合、新しい一意のコンテンツ・アイテムのバージョン・ラベルが割り当てられます。

  • デフォルトはTRUEです。

• params: 「チェックイン」ページを事前入力するパラメータ。

27.2.5.11 Home

Sub Home()

説明

定義されたホームページに戻ります。

• ホーム画面に移動します。

• HTMLページ・リクエストを実行し、定義されたホームページをユーザーに表示します。

パラメータ

なし

27.2.5.12 InitiateFileDownload

Function InitiateFileDownload(command As String, filename As String) As String

説明

ファイル・ダウンロードを開始します。

• 現在関連付けられているコマンドおよびファイル・タイプが指定されると、この関数は、ファイル・ダウンロードを開始します。このメソッドは、コンテンツ・アイテムの特定のレンディション、最新のリビジョンまたは最新リリースのリビジョンのファイル・ダウンロードを開始します。

• IntradocServerResponseイベントを実行します。イベントは、メソッドの発生前に実行されます。詳細は、IdcClientのイベントを参照してください。

パラメータ

• command: 現在関連付けられているコマンド。

• filename: ファイル形式。これは、PDFやHTMなど、サポートされる形式のファイル・タイプです。

出力

• リクエストされた情報を含む、シリアル化されたHDAを返します。

• パラメータとして渡されたデータを返します。

27.2.5.13 InitiatePostCommand

Function InitiatePostCommand(postData As String) As String

説明

postコマンドを開始します。

• サービス・コールを開始します。割り当てられたpostデータが指定されると、このメソッドは、postコマンドを開始します。

• IntradocServerResponseイベントを実行します。イベントは、メソッドの発生前に実行されます。詳細は、IdcClientのイベントを参照してください。

パラメータ

• postData: サービス・コマンドおよび必要なサービス・パラメータを含む、シリアル化されたHDA。

出力

• リクエストされた情報を含む、シリアル化されたHDAを返します。

• StatusCodeおよびStatusMessageを返します。

  • 障害が発生した場合、StatusCodeは負の値になり、StatusMessageにエラーが示されます。

  • 返されたHDAにStatusCodeパラメータが含まれていない場合、サービス・コールが成功したことを示しています。

27.2.5.14 Move

Sub Move(Left As Single, [Top], [Width], [Height])

説明

オブジェクトを移動します。

• Moveメソッドは、標準コントロールの実装と同様に処理されます。

• 詳細は、Visual BasicのAPIリファレンスを参照してください。

パラメータ

• nLeft: オブジェクトの左端の水平座標を指定します。これは、単精度値です。

• nTop: オブジェクトの上端の垂直座標を指定します。これは、単精度値です。

• nWidth: オブジェクトの新しい幅を指定します。これは、単精度値です。

• nHeight: オブジェクトの新しい高さを指定します。これは、単精度値です。

27.2.5.15 Navigate

Sub Navigate(url As String

説明

URLパスを計算します。

• 完全なURLが指定されると、このメソッドは、シリアル化されたHDAからURLを計算し、文字列として値を返します。

この関数は、次の値を返します。

• リクエストされた情報を含む、シリアル化されたHDA。

• パラメータとして渡されたデータ。

パラメータ

• url: 完全なURLパス。

27.2.5.16 NavigateCgiPage

Sub NavigateCgiPage(params As String)

説明

CGIパスを計算します。

• 定義されたコンテンツ・アイテムのパラメータが指定されると、このメソッドは、シリアル化されたHDAからCGIパスを計算し、文字列として値を返します。

パラメータ

• params: 割り当てられたコンテンツ・アイテムのパラメータ。

27.2.5.17 Refresh Browser

説明

ブラウザをリフレッシュします。

• このメソッドは、Web ブラウザをリフレッシュし、動的情報を更新します。

パラメータ

なし

27.2.5.18 SendCommand

Function SendCommand(params As String) As String

説明

サービス・リクエストをコンテンツ・サーバーに発行します。

• 定義されたコンテンツ・アイテムのパラメータが指定されると、この関数は、コンテンツ・アイテムの処理に関連するコンテンツ・サーバーからサービスを実行します。

パラメータ

• params: CGI URLエンコードのパラメータ。

出力

• リクエストされた情報を含む、シリアル化されたHDAを返します。

• パラメータとして渡されたデータを返します。

27.2.5.19 SendPostCommand

Function SendPostCommand(postData As String) As String

説明

postコマンドを送信します。

• サービス・コールを実行します。

• IntradocBrowserPostイベントを実行します。イベントは、メソッドの発生前に実行されます。詳細は、IdcClientのイベントを参照してください。

パラメータ

• postData: サービス・コマンドおよび必要なサービス・パラメータを含む、シリアル化されたHDA。

出力

• リクエストされた情報を含む、シリアル化されたHDAを返します。

• StatusCodeおよびStatusMessageを返します。

  • 障害が発生した場合、StatusCodeは負の値になり、StatusMessageにエラーが示されます。

  • 返されたHDAにStatusCodeパラメータが含まれていない場合、サービス・コールが成功したことを示しています。

27.2.5.20 SetFocus

Sub SetFocus()

説明

コントロールにフォーカスを割り当てます。

• SetFocusメソッドは、標準コントロールの実装と同様に処理されます。

• 詳細は、Visual BasicのAPIリファレンスを参照してください。

パラメータ

なし

27.2.5.21 ShowDMS

Sub ShowDMS()

説明

コンテンツ・マネージャに関連付けられているHTMLページを開きます。

• ODMA関連です。

• コンテンツ・マネージャのアクセス・ページをブラウザに表示します。

パラメータ

なし

27.2.5.22 ShowDocInfoLatestRev

Sub ShowDocInfoLatestRev(docName As String, curID As String, activateAction As String)

説明

最新のリビジョンに関するコンテンツ・アイテム情報を表示します。

ノート:

curID値は、コンテンツ・アイテムのバージョン・ラベルです。生成されたコンテンツ・アイテムのリビジョンIDではありません。

パラメータ

• docName: ユーザーが割り当てたコンテンツ・アイテム名。

• curID: 最新のリビジョンに対する一意の識別子。オプションです。

• activateAction: 現在アクティブな、リクエストされたアクション。オプションです。

27.2.5.23 ShowWhatsThis

Sub ShowWhatsThis()

説明

WhatsThisHelpIDプロパティを持つオブジェクトに対して指定された「説明の表示」ヘルプ・トピックを表示します。

• ShowWhatsThisメソッドは、標準コントロールの実装と同様に処理されます。

• 詳細は、Visual BasicのAPIリファレンスを参照してください。

パラメータ

• Object: 「説明の表示」ヘルプ・トピックを表示するオブジェクトを指定します。

27.2.5.24 StartSearch

Sub StartSearch()

説明

問合せページをブラウザ・コントロールに表示します。

• ブラウザ操作を実行します。

パラメータ

なし

27.2.5.25 Stop

Sub Stop()

説明

ブラウザを停止します。

• このメソッドは、ブラウザでの情報のロードを停止または取り消します。

パラメータ

なし

27.2.5.26 UndoCheckout

Sub UndoCheckout(docName As String, curID As String)

説明

このサービスは、コンテンツ・アイテムのチェックアウトを元に戻します。

• コンテンツ・アイテム名およびバージョン・ラベルが指定されると、このサービスは、コンテンツ・アイテムをシステムで検索し、チェックアウトを元に戻そうとします。コンテンツ・アイテムがシステムに存在しない場合、コンテンツ・アイテムがチェックアウトされていない場合、またはチェックアウトを元に戻すのに十分な権限がユーザーにない場合、サービスは失敗します。

• IntradocServerResponseイベントを実行します。イベントは、メソッドの発生前に実行されます。詳細は、IdcClientのイベントを参照してください。

ノート:

curID値は、コンテンツ・アイテムのバージョン・ラベルです。生成されたコンテンツ・アイテムのリビジョンIDではありません。

パラメータ

• curID: 最新のリビジョンに対する一意の識別子。

• docName: ユーザーが割り当てたコンテンツ・アイテム名。オプションです。

27.2.5.27 ViewDocInfo

Sub ViewDocInfo(id As String)

説明

コンテンツ・アイテム情報ページに移動し、コンテンツ・アイテム情報をブラウザに表示します。

• ブラウザ操作を実行します。

• コンテンツ・アイテムのリビジョンIDが指定されると、このメソッドは、コンテンツ・アイテム情報をブラウザに表示します。

  ノート:

  id値は、生成されたコンテンツ・アイテムのリビジョンIDです。コンテンツ・アイテムのバージョン・ラベルではありません。

パラメータ

• id: 最新のリビジョンに対する一意の識別子。

27.2.5.28 ViewDocInfoLatestRev

Sub ViewDocInfoLatestRev(docName As String, curID As String)

説明

コンテンツ・アイテム情報ページに移動し、最新のリビジョンに関するコンテンツ・アイテム情報を表示します。

• コンテンツ・アイテム名およびバージョン・ラベルが指定されると、このメソッドは、最新のリビジョンに関するコンテンツ・アイテム情報を表示します。

  ノート:

  curID値は、コンテンツ・アイテムのバージョン・ラベルです。生成されたコンテンツ・アイテムのリビジョンIDではありません。

この関数は、次の値を返します。

• dIDおよびdDocNameを含むシリアル化されたHDA。

• パラメータとして渡されたデータ。

パラメータ

• docName: ユーザーが割り当てたコンテンツ・アイテム名。

• curID: 最新のリビジョンに対する一意の識別子。

27.2.5.29 ZOrder

Sub ZOrder([Position])

説明

グラフィカル・レベル内で、指定したフォームまたはコントロールをz-orderの前または後に配置します。

• ZOrderメソッドは、標準コントロールの実装と同様に処理されます。

• 詳細は、Visual BasicのAPIリファレンスを参照してください。

パラメータ

• nOrder: 他のオブジェクトに対する相対的なオブジェクトの位置を示す整数を指定します。nOrderを省略すると、設定は0になります。

ZOrderメソッドの設定は次のとおりです。

• 0: (デフォルト)オブジェクトはz-orderの前に配置されます。

• 1: オブジェクトはz-orderの後に配置されます。

27.3 ODMA APIを使用した、デスクトップ・アプリケーションからコンテンツ・サーバーへのアクセス

Open Document Management Application (ODMA)は、デスクトップ・アプリケーションとファイル管理ソフトウェアをつなぐために使用される標準的なAPIです。コンテンツ・サーバーのためのODMA統合は、別な製品であるDesktopで使用可能です。ODMA統合製品を使用して、(ODMA準拠デスクトップ・アプリケーションのために)コンテンツ・サーバー内のコンテンツおよびコンテンツ管理機能にアクセスできます。

Microsoft Word、Corel WordPerfect、Adobe FrameMakerなどの任意のODMA準拠アプリケーションからWebリポジトリに直接ファイルを公開できます。ODMAをWeb中心に導入することで、情報をWebに直接チェックインおよび公開することができます。これは、従来のODMAクライアント/サーバー実装に対する大きな進歩です。従来の実装では、情報は、まずサーバーに公開され、ただちにWebで使用できるようにはなりません。

詳細は、ODMAまたはODMA/FrameMakerのオンライン・ヘルプを参照してください。

27.3.1 ODMAクライアント

ODMAクライアントは、別な製品であり、コア製品とともには出荷されません。これは、情報をデスクトップ・アプリケーションからWebに直接チェックインまたは公開するために使用されます。ODMAクライアントは、従来のODMAクライアント/サーバー・モデルより優れています。従来のモデルでは、情報はサーバーに公開され、ただちにWebで使用できるようにはなりません。デスクトップ・アプリケーション内からODMAクライアントを使用して、たとえば次のような、コンテンツ・サーバーと対話する多数のタスクを実行できます。

• ファイルを保存し、すぐにコンテンツ・サーバーにチェックインする。

• ファイルを保存して、後でチェックインする。

• コンテンツ・サーバーからファイルをチェックアウトします。

• ファイルのメタデータ(コンテンツ情報)を更新する。

• ファイルをローカルのファイル・システムに保存し、ODMAクライアント・システムを迂回する。

27.3.2 ODMAインタフェース

次のODMAインタフェースを使用できます。

• ODMAクライアント・インタフェース: 最近使用したファイル・オプションが選択されている「ドキュメントの選択」画面には、ODMAを通じて最近使用されたファイルのリストが表示されます。この画面は、通常の「開く」ダイアログ・ボックスのかわりに表示されます。この画面にファイルが表示されていない場合は、コンテンツ・サーバー内かローカルのファイル・システムでファイルを検索できます。

• ODMAデスクトップ・シェル・インタフェース: クライアント・デスクトップ・シェルは、ドラッグ・アンド・ドロップのチェックイン機能を提供し、デスクトップ・アプリケーションの外部からODMAクライアントの「ドキュメントの選択」画面にアクセスできるようにします。デスクトップ・シェルを通じて、次のことを実行できます。

  • デスクトップまたはWindowsエクスプローラ・ウィンドウからファイルを選択し、それをデスクトップ・シェルにドラッグしてコンテンツ・サーバーにチェックインする。

  • 「最近使用したファイル」リストから、またはコンテンツ・サーバーからファイルを選択して開きます。

• ODMAが有効なコンテンツ・サーバー・インタフェース: コンテンツ・サーバーの「コンテンツ情報」ページからODMAファイルを直接開いてチェックアウトすることができます。コンテンツ・サーバーからファイルを開くと、ファイルを編集したり、コンテンツ・サーバーに迅速にチェックインしたりできるように、ファイルはそのネイティブのアプリケーション内で開かれます。

  ノート:

  ODMA準拠アプリケーション内からファイルを開いてチェックアウトすることや、ファイルをチェックアウトせずにそのコピーを開くことも可能です。詳細は、ODMAのオンライン・ヘルプを参照してください。