プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle WebCenter Contentでの開発
12c (12.2.1.1)
E77334-02
目次へ移動
目次
前
前へ 		次
次へ

A Idoc Scriptの関数および変数

この付録では、Oracle WebCenter Contentのカスタマイズに使用可能なIdoc Scriptの関数および変数について説明します。

Idoc Scriptには、多数のビルトイン・グローバル関数があります。関数は、文字列の比較、操作ルーチン、日付フォーマット化、ResultSetの操作といったアクションを実行します。いくつかの関数は、計算または比較の結果などの結果も返します。

関数名の後に情報をカッコで閉じることによって、情報が関数に渡されます。関数に渡される情報のピースをパラメータといいます。関数には、パラメータをとらないもの、パラメータを1つとるもの、複数のパラメータをとるものがあります。関数のなかには、その使用方法によってパラメータ数が異なるものもあります。

ビルトイン・グローバル関数の他に、カスタム・クラスを含む新規のグローバル関数を、Javaコードを使用して定義できます。詳細は、コンテンツ・サーバーのコンポーネントのスタート・ガイドおよびカスタム・コンポーネントの作成を参照してください。

Idoc Scriptは、ビルトイン関数とともに、様々な変数を使用します。Idocスクリプトの中で使用される変数には、動的変数、条件動的変数およびページ表示変数があります。これらの変数の多くは、スクリプトの中で使用したり、WebCenter Contentのconfig.cfgファイルとintradoc.cfgファイル内で個別に指定したり、WebブラウザのURLに使用したりすることもできます。

.cfgファイルまたはWebブラウザのURLでのみ使用される変数の詳細は、『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』を参照してください。

A.1 abortToErrorPage()

現在のページを中止して、エラー・メッセージを表示します。

  • この関数はStatusCode変数を評価し、負の数値(-1)が返された場合は、現在のページにかえてエラー・ページを表示します。
  • StatusMessage変数は、エラー・メッセージ文字列として使用できます。

タイプおよび使用方法

パラメータ

唯一のパラメータはエラー・メッセージ文字列です。

出力

エラー・ページのエラー・メッセージ文字列を返します。

例

現在のページを中止し、エラー・メッセージとして「アクセスが拒否されました」を表示します。

<$abortToErrorPage("Access Denied")$>

現在のページを中止し、エラー・メッセージとしてStatusMessage変数の値を表示します。

<$abortToErrorPage("<$StatusMessage$>")$>

関連項目

A.2 addEmptyOption

メタデータ・フィールドのオプション・リストの最初のオプションが空白の値であることを指定します。

タイプおよび使用方法

出力

  • オプション・リストの最初の値が空白である場合、TRUEを返します。
  • オプション・リストの最初の値が空白でない場合、FALSEを返します。

例

オプション・リストの最初の値が空白であることを指定します。

<$if ForceDocTypeChoice and isTrue(ForceDocTypeChoice)$>
    <$addEmptyOption = 1$>
<$endif$>

関連項目

A.3 AdminAtLeastOneGroup

現在のユーザーが少なくとも1つのセキュリティ・グループに対して管理者ロールを持っているかどうかを確認します。

タイプおよび使用方法

出力

  • ユーザーが少なくとも1つのセキュリティ・グループの管理者である場合、TRUEを返します。
  • ユーザーに管理者ロールが割り当てられていない場合、FALSEを返します。

例

管理者に対するオプションのプレゼンテーションの実行に使用できます。

<$if (AdminAtLeastOneGroup)$>
    <a href="<$redirect$>">
<$endif$>

関連項目

A.4 AdsSimpleAuth

Oracle WebCenter Content ServerのロールおよびアカウントをActive Directoryグループから導出するかどうかを指定します。

  • TRUEに設定すると、Active Directoryからはユーザー・パスワードだけが認証されます。ロールとアカウントは別のユーザー・ベース(たとえばLDAPサーバー)から導出する必要があります。
  • FALSEに設定すると、ロールとアカウントがActive Directoryグループから導出されます。
  • デフォルトはFALSEです。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。
  • 外部セキュリティ

場所

instance_dir/data/users/config/filter.hda

例

構成エントリとしての使用例:

AdsSimpleAuth=true

A.5 AdsUserName

Active Directoryに読取り権限を持っているユーザー名を指定します。

  • この設定が必須なのは、Active Directoryに対する読取り権限のないWindowsサーバー上でWebサーバーが実行されている場合のみです。
  • ユーザー名は、DOMAIN_NAME\user_nameの形式である必要があります。
  • この設定およびAdsUserPassword設定を指定しない場合、デフォルトはWebサーバーを実行しているユーザー名になります。

使用方法

場所

  • アクティブ・ディレクトリ構成ページ - 「ユーザー名」
  • instance_dir/data/users/config/filter.hda

例

構成エントリとしての使用例:

AdsUserName=CORP_DOMAIN\admin_user

関連項目

A.6 AdsUserPassword

Active Directoryに読取り権限を持っているユーザー名を指定しているAdsUserName設定に対するパスワードを指定します。

  • この設定が必須なのは、Active Directoryに対する読取り権限のないWindowsサーバー上でWebサーバーが実行されている場合のみです。
  • AdsUserName設定およびこの設定を指定しない場合、デフォルトはWebサーバーを実行しているユーザー名になります。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。
  • 外部セキュリティ

場所

  • アクティブ・ディレクトリ構成ページ - 「ユーザー・パスワード」
  • instance_dir/data/users/config/filter.hda

例

構成エントリとしての使用例:

AdsUserPassword=idc

関連項目

A.7 AfterLogin

現在のページがログインの直後に作成されたかどうかを指定します。

タイプおよび使用方法

出力

  • ページがログインの直後に作成された場合、TRUEを返します。
  • ページがログインの直後に作成されなかった場合、FALSEを返します。

例

ページがログインの直後に作成されなかった場合は、代替URLが表示されます。

<$if not AfterLogin$>
    <a href="<$redirect$>">
<$endif$>

A.8 AllowCheckin

現在のユーザーがコンテンツ・アイテムのセキュリティ・グループに対してチェックイン権限を持っているかどうかを確認します。

タイプおよび使用方法

出力

  • ユーザーがチェックイン権限を持っている場合、TRUEを返します。
  • ユーザーがチェックイン権限を持っていない場合、FALSEを返します。

例

チェックイン権限を持つユーザーに対するオプションのプレゼンテーションの実行に使用できます。

<$if (AllowCheckin)$>
    <a href="<$redirect$>">
<$endif$>

A.9 AllowCheckout

現在のユーザーがコンテンツ・アイテムのセキュリティ・グループに対してチェックアウト権限を持っているかどうかを確認します。

タイプおよび使用方法

出力

  • ユーザーがチェックアウト権限を持っている場合、TRUEを返します。
  • ユーザーがチェックアウト権限を持っていない場合、FALSEを返します。

例

チェックアウト権限を持つユーザーに対するオプションのプレゼンテーションの実行に使用できます。

<$if (AllowCheckout)$>
    <a href="<$redirect$>">
<$endif$>

A.10 AllowIntranetUsers

Microsoftネットワーク(NTLM)認証が使用可能かどうか確認します。

タイプおよび使用方法

出力

  • NtlmSecurityEnabledがTRUEに設定されている場合、TRUEを返します。
  • NtlmSecurityEnabledがTRUEに設定されている場合、FALSEを返します。

例

Microsoftネットワークのセキュリティを評価します。

<$AllowIntranetUsers$>

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のNtlmSecurityEnabledに関する項

A.11 AllowReview

現在のユーザーが現在のワークフロー・アイテムの承認または却下を実行できるかどうかを確認します。

タイプおよび使用方法

出力

  • ユーザーが現在のワークフロー・ステップのレビューアである場合、TRUEを返します。
  • ユーザーが現在のワークフロー・ステップのレビューアでない場合、FALSEを返します。

例

ユーザーがレビューアである場合、「承認」ボタンと「却下」ボタンが表示されます。

<$if AllowReview$>
    <$include workflow_doc_action_buttons$>
<$endif$>

A.12 AuthorAddress

コンテンツ・アイテムの作成者の電子メール・アドレスを指定します。

タイプおよび使用方法

出力

使用に応じて文字列またはブール値を返します。

  • 標準的な使用: コンテンツ・アイテムの作成者の電子メール・アドレスを文字列として返します。
  • 条件文で次のように使用されます。
    • コンテンツ・アイテムの作成者が定義済の電子メール・アドレスを持っている場合、TRUEを返します。
    • コンテンツ・アイテムの作成者が電子メール・アドレスを持っていない場合、FALSEを返します。

例

リビジョンが作成されるときに、電子メールを介してコンテンツ・アイテムの作成者を変更できます。

<$AuthorAddress$>

A.13 AuthorDelete

作成者が、セキュリティ・グループに対する削除権限を持っていなくても自分のリビジョンを削除できるようにします。

  • TRUEに設定された場合、作成者はセキュリティ・グループに対する削除権限を持っていなくても自分のリビジョンを削除できます。
  • デフォルトは空の文字列です。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。
  • 内部セキュリティ

場所

  • 「システム・プロパティ」、「コンテンツ・セキュリティ」タブ、「作成者にリビジョンの削除を許可する」
  • 「管理」、「管理サーバー」、「コンテンツ・セキュリティ」メニュー・オプション、「作成者にリビジョンの削除を許可する」
  • IntradocDir/config/config.cfg

例

構成エントリとして:

AuthorDelete=true

Idoc Scriptとして:

<$if AuthorDelete$>
    <$AuthorDelete$>
<$else$>
    false
<$endif$>

A.14 AutoNumberPrefix

自動番号付けされたすべてのコンテンツIDに追加される接頭辞を定義します。

  • 自動番号付け接頭辞を返します(構成設定の値を返します)。
  • 文字列を返します。

タイプおよび使用方法

場所

  • 「システム・プロパティ」、「オプション」タブ、「自動的に名前の前に付ける接頭辞」
  • 「管理」、「管理サーバー」、「一般構成」メニュー・オプション、「自動採番接頭辞」
  • IntradocDir/config/config.cfg

例

構成設定として、自動番号付け接頭辞を定義します。

AutoNumberPrefix=HR

Idoc Scriptとして、構成設定の値を返します。

<$AutoNumberPrefix$>

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』の「IsAutoNumber」

A.15 BatchLoaderPath

デフォルトのバッチ・ロード・テキスト・ファイルへのパスを定義します。

文字列としてファイル・パスを返します。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。
  • バッチ・ローダー

場所

DomainHome/ucm/cs/bin/intradoc.cfg

例

  • Windows構成エントリとしての使用例:
    BatchLoaderPath=c:/domain/BatchLoader/batchfile.txt
  • Solaris/UNIX構成エントリとしての使用例:
    BatchLoaderPath=/u1/intradoc3/batLd/batchfile
  • Idoc Scriptとして、文字列としてファイル・パスを返します。
    <$BatchLoaderPath$>

A.16 break()

ループの終了に多く使用されます。

  • ブレーク指示によって、一番内側のループが終了します。
  • ループの終了に続いて、最初の文で制御が再開されます。

タイプおよび使用方法

A.17 BrowserVersionNumber

クライアント・ブラウザのバージョン番号を取得します。

タイプおよび使用方法

出力

文字列としてブラウザのバージョン番号を返します。

例

ユーザーが使用しているブラウザのバージョン番号とOracle WebCenter Content Serverに互換性があることの確認に使用できます。

<$BrowserVersionNumber$>

A.18 c

コメントをIdoc Scriptコードで指定します。

タイプおよび使用方法

例

コード内にコメントを入れます。

<$c = "Sets the variables to empty strings."$>

A.19 cacheInclude()

この関数は、inc() Idoc Script関数と同じように動作します。includeNameに対応する動的HTMLインクルードを評価して、それをページに表示します。考えられる相違点は、レンダリングされたHTMLを再評価するかわりに、それをキャッシュからプルすることです。

詳細は、「キーワードと関数の比較」を参照してください。

タイプおよび使用方法

パラメータ

3つの必須パラメータと2つのオプションのパラメータを取ります。次に例を示します。

cacheInclude(includeName, scope, lifeSpan[,  cacheName][, key])
パラメータ 説明
includeName 評価する動的HTML要素の名前。
scope ユーザーごとに異なるHTMLを表示する場合はsessionに設定し、すべてのユーザーに同じものを表示する場合はapplicationに設定します。
lifeSpan このインクルードのキャッシュ内での存続期間(秒単位)。
cacheName オプション: デフォルトのキャッシュのかわりに、データを名前付きキャッシュに入れる場合に使用。空の文字列が渡される場合は、インクルードをセッションのデフォルトのキャッシュに入れます。
key オプション: 競合を避けるためにキャッシュの名前-範囲の自動指定を行わない場合は、ここで一意のキーを指定できます。

例

キーの指定により、std_page_beginインクルードがユーザー別に10分間キャッシュされます。これは、キャッシュ内でユーザーごとに約10 KBを消費します。

<$cacheInclude("std_page_begin", "session", 600)$>

関連項目

A.20 captionEntryWidth

メタデータ・フィールドの幅をパーセンテージで指定します。

タイプおよび使用方法

出力

現在のメタデータ・フィールドのキャプションの幅をパーセンテージで返します。

例

スクリプトとしての使用例:

<$if isInfo$>
    <$captionFieldWidth="30%"$>
    <$captionEntryWidth="70%"$>
<$elseif isEditMode$>
    <$captionFieldWidth="20%"$>
    <$captionEntryWidth="80%"$>
<$endif$>

関連項目

A.21 captionFieldWidth

メタデータ・フィールドのキャプションの幅をパーセンテージで指定します。

タイプおよび使用方法

出力

現在のメタデータ・フィールドのキャプションの幅をパーセンテージで返します。

例

スクリプトとしての使用例:

<$if isInfo$>
    <$captionFieldWidth="30%"$>
    <$captionEntryWidth="70%"$>
<$elseif isEditMode$>
    <$captionFieldWidth="20%"$>
    <$captionEntryWidth="80%"$>
<$endif$>

関連項目

A.22 clearSchemaData()

スキーマResultSetからデータをクリアします。

タイプおよび使用方法

パラメータ

この関数は、ゼロ、1つまたは2つのパラメータを取ることができます。

  • 渡された引数がゼロの場合は、データ・バインダがクリアされます。戻り値はありません。
  • 渡される引数が1つの場合、その引数は現在行から値をクリアするResultSetの名前です。戻り値はありません。
  • 2つの引数が渡される場合は、最初の引数としてResultSetの名前、2番目の引数としてクリアするデータ・オブジェクトを特定するキーが渡されます。データが存在しない場合は0を返し、データが存在する場合は1を返します。戻り値に基づいてスクリプトを条件付きで実行するために、True()またはFalse()を使用します。

例

<$clearSchemaData()$>

関連項目

A.23 ClientControlled

ページがODMAクライアントからアクセスされたかどうかを確認します。

この値は、クライアントにより指定された更新プロセスを制御するために、文字列により渡されます。

タイプおよび使用方法

出力

  • ページがODMAクライアントからアクセスされた場合、TRUEを返します。
  • ページがODMAクライアントからアクセスされなかった場合、FALSEを返します。

例

ページがODMAクライアントからアクセスされたかどうかを確認します。

<$ClientControlled$>

関連項目

A.24 computeDocUrl()

この関数は、ページのデータに基づいてコンテンツ・アイテムのURLを計算します。

たとえば、アイテムのResultSetをループするときに、この関数をコールしてアイテムのURLを生成することができます。

ページに次の情報が表示されている必要があります。

  • dDocAccount (オプション)
  • dDocName
  • dDocType
  • dProcessingState
  • dRevLabel
  • dSecurityGroup
  • dWebExtension

タイプおよび使用方法

パラメータ

唯一のパラメータをTRUE (1)またはFALSE (0)に設定して、URLが関連するかどうかを示します。

A.25 computeRenditionUrl()

指定されたレンディションのURLを返します。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータはコンテンツ・アイテムのURLです。
  • 2番目のパラメータはdRevLabel値です。
  • 3番目のパラメータはdRendition1値です。dRendition1に使用可能な値は次のとおりです。
    • T = サムネイル・レンディション
    • X = XMLレンディション

出力

文字列としてレンディションの完全なURLを返します。

例

文字列としてレンディションのURLを返します。

<$computeRenditionUrl(url, dRevLabel, dRendition1)$>

A.26 CONTENT_LENGTH

クライアントにより指定されたようにリクエストされたコンテンツ・アイテムの長さをバイト数で取得します。

この変数は、現在のゲートウェイ・プログラム・リクエスト固有のものです。

注意:

この設定は、コンテンツ・サーバーのバージョン7.0以降では廃止されています。Webサーバー・フィルタでは、この情報は送信されなくなりました。

タイプおよび使用方法

出力

コンテンツの長さをバイト数で返します。

例

ページまたはログへの情報出力としての使用例:

CONTENT_LENGTH=0

Idoc Script文または評価の一部としての使用例:

<$if CONTENT_LENGTH$>
<!--statement-->

A.27 coreContentOnly

フォームのみを表示するには、この変数をサービス・リクエストのURLに設定します。std_page_beginおよびstd_page_endの各インクルード・ファイルは表示されません。

タイプおよび使用方法

出力

なし。

A.28 CURRENT_DATE

現在の日付と時刻が戻されます。

この変数はdateCurrent()関数と類似していますが、dateCurrent()の方が頻繁に使用されます。

タイプおよび使用方法

出力

ユーザーのロケールに従ってフォーマット化された文字列を返します。

例

スクリプトとしての使用例:

<$CURRENT_DATE$>

関連項目

A.29 CURRENT_ROW

ResultSetのどの行にいるかを評価します。

ResultSetの最初の行は行ゼロ(0)です。

タイプおよび使用方法

出力

行番号を返します。

例

スクリプトとしての使用例:

<$CURRENT_ROW$>

A.30 dateCurrent()

現在の日付と時刻が戻されます。

現在の日付と時間をユーザーに返したり、日付評価を使用するコマンドを作成したりする場合に使用できます。

タイプおよび使用方法

パラメータ

唯一のオプション・パラメータは、現在の日付に基づいて指定された日数で日付を調節する整数です。

出力

ユーザーのロケールに従ってフォーマット化された日付を返します。

例

次の例では、デフォルトのEnglish-USロケールに従って日付がフォーマット化されます。

m/d/yy h:mm XM

次の例は、現在の日付と現在の時間(例: 8/12/01 1:55 PM)を返します。

<$dateCurrent()$>

10日後の日付と現在の時間(例: 8/22/01 1:55 PM)を返します。

<$dateCurrent(10)$>

10日前の日付と現在の時間(例: 8/2/01 1:55 PM)を返します。

<$dateCurrent(-10)$>

関連項目

A.31 dcShowExportLink

この関数は、コンテンツ・アイテムを変換するようにDynamic Converterが構成されているかどうかを検証します。戻り値は、アイテムのdFormatの値に基づきます。

この関数は通常、条件付きでDynamic Converterリンクを表示するために「検索結果」ページで使用します。

タイプおよび使用方法

出力

  • Dynamic Converterがコンテンツ・アイテムを変換するように構成されている場合、TRUEを返します。

  • Dynamic Converterが構成されていない場合、FALSEを返します。

例

<$QueryText = "dDocTitle <substring> `test`"$>
<$executeService("GET_SEARCH_RESULTS")$>
<$loop SearchResults$>
    <$if dcShowExportLink()$>
        <a href="<$HttpCgiPath$>?IdcService=
        GET_DYNAMIC_CONVERSION&dID=<$dID$>">
        HTML Conversion of <$dDocTitle$></a>
    <$endif$>
<$endloop$>

A.32 ddAppendIndexedColumnResultSet()

この関数は、dynamicdata表をResultSetにロードします。これは、ddLoadIndexedColumnResultSetとほとんど同じです。主な相違点は、Idoc Script ResultSetがすでに存在している場合、dynamicdata表から作成された新しいResultSetがそれに追加されることです。dynamicdata表にあってもターゲットのResultSetに存在しないフィールドは、自動的に追加されます。

タイプおよび使用方法

パラメータ

次の表に、この関数のパラメータを示します。

パラメータ 説明

dataTableName

ロードするdynamicdata表の名前。

idocTableName

dynamicdata表の追加先であるResultSetの名前。

indexColumn

dynamicdata表の索引付き列の名前。

indexValue

元の表のセクションの選択に使用する値。この値は、各行のindexColumn値と照合して、大/小文字を区別しないで確認されます。一致した場合、その行はResultSetにロードされ、一致しない場合はスキップされます。

mappingTableName

最後のResultSetの列名の変更に使用するdynamicdata表の名前。名前の変更は、指定したマッピング表の列名を同じ表の最初の行の値にマッピングして処理されます。これは、ddLoadResultSetでの処理とまったく同じです。

出力

dynamicdata表が正常にロードされた場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
<?commatable indexedColumns="fieldA"?>
fieldA, fieldB, fieldC
1,      2,       3
4,      5,       6
1,      3,       9
<@end@>


<$exec rsCreateResultSet("MyResultSet", "fieldA,fieldB")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "first value"$>
<$MyResultSet.fieldB = "second value"$>
<$exec ddLoadIndexedColumnResultSet("MyDataTable", "MyResultSet", "fieldA", "1")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.fieldB$>    [[% (foo == 'second value') %]]<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.fieldC$>    [[% (bar == '3') %]]

関連項目

A.33 ddAppendResultSet()

この関数は、dynamicdata表をResultSetにロードします。これはddLoadResultSetとほとんど同じです。主な相違点は、Idoc Script ResultSetがすでに存在している場合、dynamicdata表から作成された新しいResultSetがそれに追加されることです。dynamicdata表にあってもターゲットのResultSetに存在しないフィールドは、自動的に追加されます。

タイプおよび使用方法

パラメータ

次の表に、この関数のパラメータを示します。

パラメータ 説明

dataTableName

ロードするdynamicdata表の名前。

idocTableName

dynamicdata表の追加先であるResultSetの名前。

mappingTableName

最後のResultSetの列名の変更に使用するdynamicdata表の名前。名前の変更は、指定したマッピング表の列名を同じ表の最初の行の値にマッピングして処理されます。これは、ddLoadResultSetでの処理とまったく同じです。

出力

dynamicdata表が正常にロードされた場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
field1, field2, field3
a,      b,       c
d,      e,       f
<@end@>


<$exec rsCreateResultSet("MyResultSet", "field1,field2")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.field1 = "first value"$>
<$MyResultSet.field2 = "second value"$>
<$exec ddAppendResultSet("MyDataTable", "MyResultSet")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.field1$>    [[% (foo == 'first value') %]]
<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.field3$>    [[% (bar == 'c') %]]

関連項目

A.34 ddApplyTableSortToResultSet()

この関数は、特定のdynamicdata表で定義されたルールを使用して既存のResultSetをソートします。

タイプおよび使用方法

パラメータ

次の表に、この関数のパラメータを示します。

パラメータ 説明

dataTableName

ソート・ルールに使用するdynamicdata表の名前。

resultSetName

dynamicdata表の追加先であるResultSetの名前。

出力

ソートが正常に実行された場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
<?commatable sortcolumn="order" sortType="int" sortOrder="asc"?>
user,    service,            order
jane,    DOC_INFO,           10
bob,     GET_SEARCH_RESULTS, 20
annette, CHECKIN_NEW,        30
<@end@>


<$exec rsCreate("MyResultSet")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.user = "james"$>
<$MyResultSet.service = "GET_FILE"$>
<$MyResultSet.order = 75$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.user = "zoe"$>
<$MyResultSet.service = "DOC_INFO_BY_NAME"$>
<$MyResultSet.order = 20$>
<$exec ddApplyTableSortToResultSet("MyDataTable", "MyResultSet")$>

A.35 ddGetFieldList()

この関数はdynamicdata表を取り込み、その表の列名が含まれているカンマ区切り文字列を返します。多くのdynamicdata表は、コンテンツ・サーバー・システムでコード化される値のカンマ区切りリストのみを指定するために、行を含まないフィールド名のみで構成されることが想定されています。

タイプおよび使用方法

パラメータ

この関数には、ロードするdynamicdata表の名前であるパラメータ、dataTableNameが指定されています。

出力

dynamictableが存在する場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
foo,bar,baz
<@end@>


<$fieldList = ddGetFieldList("MyDataTable")$>
<$trace(fieldList, "#console")$> [[% Outputs: foo,bar,baz %]]

A.36 ddIncludePreserveValues()

この関数はリソース・インクルードを実行しますが、dynamicdata表により指定された値は変更されないように保護します。データ表の列名は、保護する必要のある変数名のリストとして使用されます。これらの変数は、一時的にキャッシュされ、インクルードがコールされ、キャッシュされた値に変数を再設定することによって保護されます。変数がnullの場合は空白に設定されます。

表の列名の1つがドル記号($)で始まる場合、後に続く文字列はResultSetの名前と見なされます。その場合、それはメモリーに一時的にキャッシュされたResultSetのポインタとなり、リソース・インクルードの実行終了後に置換されます。キャッシングの時点でそのResultSetが存在していなかった場合は、末尾にそのキーが指定されているResultSetが削除されます。ポインタがキャッシュされたときにResultSetがアクティブであれば、インクルードのコール中に同名のResultSetを新規に作成でき、それまでアクティブであったResultSetは、ループを妨げることなく適切に回復されます。サイド・エフェクトの1つとして、アクティブResultSetを一時的に置換するResultSetが新規に作成された場合、最初にアクティブResultSetから値を取得する変数置換アルゴリズムで、キャッシュされたアクティブResultSetから変数の値を検索することができます(その変数が、より優先度の高いアクティブResultSetにフィールドとして検索されないことを前提とします)。キャッシュされたアクティブResultSetは、アクティブResultSetのスタックに場所を保持します。

タイプおよび使用方法

パラメータ

次の表に、この関数のパラメータを示します。

パラメータ 説明

includeName

実行するリソース・インクルードの名前。

dataTableName

ローカル・データおよびResultSetの保存に使用するdynamicdata表の名前。

出力

実行されたリソース・インクルードの出力を表す文字列。

例

<@dynamicdata MyPreservedFields@>
foo, bar, $baz
<@end@>


<@dynamichtml my_include@>
    <$foo = "tempValue1"$>
    <$bar = "tempValue2"$>
<@end@>


<$foo = 5$>
<$ddIncludePreserveValues("my_include", "MyPreservedFields")$>
<$trace(foo, "#console")$>   [[% Outputs: 5 %]]

A.37 ddLoadIndexedColumnResultSet()

この関数は、dynamicdata表をResultSetにロードします。この関数は、indexColumnの値がindexValueと一致する行のみをロードする点を除き、ddLoadResultSetと同じです。この列で行われる比較は、大/小文字を区別しません。

タイプおよび使用方法

パラメータ

次の表に、この関数のパラメータを示します。

パラメータ 説明

dataTableName

ロードするdynamicdata表の名前。

idocTableName

dynamicdata表のロード先であるResultSetの名前。

indexColumn

dynamicdata表の索引付き列の名前。

indexValue

元の表のセクションの選択に使用する値。この値は、各行のindexColumn値と照合して、大/小文字を区別しないで確認されます。値が一致した場合、その行はResultSetにロードされ、一致しない場合、その行はスキップされます。

mappingTableName

最後のResultSetの列名の変更に使用するdynamicdata表の名前。名前の変更は、指定したマッピング表の列名を同じ表の最初の行の値にマッピングして処理されます。これは、ddLoadResultSetでの処理とまったく同じです。

出力

dynamicdata表が正常にロードされた場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
<?commatable indexedColumns="fieldA"?>
fieldA, fieldB, fieldC
1,      2,       3
4,      5,       6
1,      3,       9
<@end@>


<$exec ddLoadIndexedColumnResultSet("MyDataTable", "MyResultSet", "fieldA", "1")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.fieldB$>    [[% (foo == '2') %]]
<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.fieldC$>    [[% (bar == '9') %]]

関連項目

A.38 ddLoadResultSet()

この関数は、dynamicdata表をResultSetにロードします。

タイプおよび使用方法

パラメータ

次の表に、この関数のパラメータを示します。

パラメータ 説明

dataTableName

ロードするdynamicdata表の名前。

idocTableName

dynamicdata表のロード先であるResultSetの名前。

mappingTableName

最後のResultSetの列名の変更に使用するdynamicdata表の名前。名前の変更は、指定したマッピング表の列名を同じ表の最初の行の値にマッピングして処理されます。これは、ddLoadIndexedColumnResultSetの処理とまったく同じです。

出力

dynamicdata表が正常にロードされた場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
fieldA, fieldB, fieldC
1,      2,       3
4,      5,       6
1,      3,       9
<@end@>


<$exec ddLoadResultSet("MyDataTable", "MyResultSet")$>
<$exec ddLoadResultSet("MyDataTable", "MyAliasedResultSet")$>
<$exec rsFirst("MyResultSet")$>
<$exec rsFirst("MyAliasedResultSet")$>
<$foo = MyResultSet.field1$>         [[% (foo == 'a') %]]
<$bar = MyAliasedResultSet.alias2$>  [[% (bar == 'c') %]]

関連項目

A.39 ddMergeIndexedColumnResultSet()

この関数は、dynamicdata表をResultSetにマージします。この関数は、indexColumnの値がindexValueと一致する行のみをマージする点を除き、ddMergeResultSetと同じです。この列で行われる比較は、大/小文字を区別しません。

タイプおよび使用方法

パラメータ

次の表に、この関数のパラメータを示します。

パラメータ 説明

dataTableName

ロードするdynamicdata表の名前。

idocTableName

dynamicdata表のマージ先であるResultSetの名前。

indexColumn

dynamicdata表の索引付き列の名前。

indexValue

元の表のセクションの選択に使用する値。この値は、各行のindexColumnと照合して、大/小文字を区別しないで確認されます。一致した場合、その行はResultSetにロードされ、一致しない場合はスキップされます。

mergeType

実行されるマージのタイプ。これをreplaceに設定して、マージによって新規行が追加されるのを防ぎます。このパラメータのその他の値はすべて、appendとして扱われます。

mappingTableName

最後のResultSetの列名の変更に使用する必要のあるdynamicdata表の名前。名前の変更は、このマッピング表の列名を同じ表の最初の行の値にマッピングして処理されます。これは、ddLoadResultSetでの処理とまったく同じです。

出力

dynamicdata表が正常にマージされた場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
fieldA, fieldB, fieldC
1,      2,       3
4,      5,       6
1,      3,       9
<@end@>


<$exec rsCreateResultSet("MyResultSet", "fieldA,fieldB,fieldC")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "4"$>
<$MyResultSet.fieldB = "8"$>
<$MyResultSet.fieldB = "23"$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "8"$>
<$MyResultSet.fieldB = "21"$>
<$MyResultSet.fieldB = "59"$>
<$exec ddMergeIndexedColumnResultSet("MyDataTable", "MyResultSet", "fieldA", "4", "replace")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.fieldB$>    [[% (foo == '5') %]]
<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.fieldC$>    [[% (bar == '59') %]]

関連項目

A.40 ddMergeResultSet()

この関数は、dynamicdata表を既存のResultSetにマージします。ターゲットResultSetが存在しない場合、この関数はddLoadResultSetと同様に動作して、ターゲットResultSetが作成されます。そうでない場合は、新規のResultSetの最初の列をマージ・キーとして使用してマージが実行されます。デフォルトでは、既存のIdoc Script表のどの行とも一致しない行が、マージによって新規のResultSetから追加されます。例外として、mergeTypeパラメータがreplaceに設定されている場合、新しい行はIdoc Script ResultSetに追加されません。

このマージによって、新規のResultSetの特定の行に一致したすべての行が置換されるのではなく、最初に検出された行のみが置換されることに注意してください。この一致では、大/小文字が区別されます。mergeTypeパラメータはオプションであり、デフォルトはnullです。

タイプおよび使用方法

パラメータ

次の表に、この関数のパラメータを示します。

パラメータ 説明

dataTableName

ロードするdynamicdata表の名前。

idocTableName

dynamicdata表のマージ先であるResultSetの名前。

mergeType

実行されるマージのタイプ。これをreplaceに設定して、マージによって新規行が追加されるのを防ぎます。このパラメータのその他の値はすべて、appendとして扱われます。

mappingTableName

最後のResultSetの列名の変更に使用する必要のあるdynamicdata表の名前。名前の変更は、このマッピング表の列名を同じ表の最初の行の値にマッピングして処理されます。これは、ddLoadResultSetでの処理とまったく同じです。

出力

dynamicdata表が正常にマージされた場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
fieldA, fieldB, fieldC
1,      2,       3
4,      5,       6
<@end@>


<$exec rsCreateResultSet("MyResultSet", "fieldA,fieldB,fieldC")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "4"$>
<$MyResultSet.fieldB = "52"$>
<$MyResultSet.fieldC = "18"$>
<$exec ddMergeResultSet("MyDataTable", "MyResultSet", "replace")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.fieldB$>    [[% (foo == 52) %]]
<$bar = MyResultSet.#numRows$>  [[% (bar == 1) %]]

関連項目

A.41 ddMergeUsingIndexedKey()

この関数はdynamicdata表から選択的な行をプルし、それを使用してターゲットResultSetの特定行の値を置換します。ターゲットResultSetの特定の列の値は、dynamicdata表の索引参照の値として使用されます。取得された副表は、ターゲットResultSetで一致する列名のある列の値の置換に使用されます。dynamicdata表には、索引値で選択された行が副表に1つだけあるものと想定されます。複数の行がある場合は、最初の行のみを使用して値をターゲットResultSetにマージします。

タイプおよび使用方法

パラメータ

次の表に、この関数のパラメータを示します。

パラメータ 説明

dataTableName

ロードするdynamicdata表の名前。

idocTableName

dynamicdata表のマージ先であるResultSetの名前。

indexColumn

dynamicdata表の索引付き列の名前と、dynamicdata表の副表を選択するために値が取得されるターゲットResultSetの列の名前。

mappingTableName

最後のResultSetの列名の変更に使用する必要のあるdynamicdata表の名前。名前の変更は、このマッピング表の列名を同じ表の最初の行の値にマッピングして処理されます。これは、ddLoadResultSetでの処理とまったく同じです。

出力

dynamicdata表が正常にマージされた場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
<?commatable indexedColumns="fieldA"?>
fieldA, fieldB, fieldC
1,      2,       3
4,      5,       6
7,      8,       9
<@end@>


<$exec rsCreateResultSet("MyResultSet", "fieldA,fieldB,fieldC")$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "4"$>
<$MyResultSet.fieldB = "8"$>
<$MyResultSet.fieldB = "23"$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "7"$>
<$MyResultSet.fieldB = "20"$>
<$MyResultSet.fieldB = "41"$>
<$exec rsAppendNewRow("MyResultSet")$>
<$MyResultSet.fieldA = "8"$>
<$MyResultSet.fieldB = "21"$>
<$MyResultSet.fieldB = "59"$>
<$exec ddMergeIndexedColumnResultSet("MyDataTable", "MyResultSet", "fieldA")$>
<$exec rsFirst("MyResultSet")$>
<$foo = MyResultSet.fieldB$>    [[% (foo == '5') %]]
<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.fieldC$>    [[% (bar == '9') %]]
<$exec rsNext("MyResultSet")$>
<$bar = MyResultSet.fieldC$>    [[% (bar == '59') %]]

A.42 ddSetLocal()

この関数はdynamicdata表を取り込んで全体を反復し、行ごとにローカル・データ値を設定します。表の最初の列はキーのリストとして使用され、2番目の列は値のリストとして使用されます。

タイプおよび使用方法

パラメータ

この関数には、ロードするdynamicdata表の名前であるパラメータ、dataTableNameが指定されています。

出力

dynamicdata表が存在する場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
key, value
foo, 15
bar, 23
baz, 77
<@end@>


<$exec ddSetLocal("MyDataTable")$>
<$tmp1 = #local.foo$>   [[% (tmp1 == '15') %]]
<$tmp2 = #local.bar$>   [[% (tmp2 == '23') %]]
<$tmp3 = #local.baz$>   [[% (tmp3 == '77') %]]

関連項目

A.43 ddSetLocalByColumnsFromFirstRow()

この関数はdynamicdata表の最初の行を取り込み、列名をキーとして使用して、列ごとにローカル値とそれに対応する値を設定します。最初の行が存在しない場合、この関数は何も実行しません。これは、大量のローカル値を迅速に設定する場合に便利なメソッドです。dynamicdata表のプロパティ、filterIncludeおよびincludeColumnsは無視されます。

タイプおよび使用方法

パラメータ

この関数には、ロードするdynamicdata表の名前であるパラメータ、dataTableNameが指定されています。

出力

dynamicdata表が正常にロードされた場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
fieldA, fieldB, fieldC
foo,    bar,    baz
<@end@>


<$exec ddSetLocalByColumnsFromFirstRow("MyDataTable")$>
<$tmpStr1 = #local.fieldA$>   [[% (tmpStr1 == 'foo') %]]
<$tmpStr2 = #local.fieldC$>   [[% (tmpStr2 == 'baz') %]]

関連項目

A.44 ddSetLocalByColumnsFromFirstRowIndexed()

この関数はdynamicdata表の最初の行を取り込み、列名をキーとして使用して、列ごとにローカル値とそれに対応する値を設定します。最初の行が存在しない場合、この関数は何も実行しません。この関数は、ddSetLocalByColumnsFromFirstRow()とほとんど同じです。唯一の相違点として、この関数は、dynamicdata表の第1行ではなく、索引付き列が指定されている最初の行を使用します。索引付き行が見つからない場合、この関数は何も実行しません。

タイプおよび使用方法

パラメータ

次の表に、この関数のパラメータを示します。

パラメータ 説明

dataTableName

ロードするdynamicdata表の名前。

indexColumn

dynamicdata表の索引付き列の名前。

indexValue

元の表の行の選択に使用する値。この値は、各行のindexColumnと照合して、大/小文字を区別しないで確認されます。一致した場合は、その行が使用され、表のその他の行は無視されます。

出力

dynamicdata表が正常にロードされた場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
<?commatable indexedColumns="fieldB"?>
fieldA, fieldB, fieldC
1,      2,      3
4,      5,      6
7,      8,      9
3,      5,      2
<@end@>


<$exec ddSetLocalByColumnsFromFirstRowIndexed("MyDataTable", "fieldB", 5)$>
<$tmpStr1 = #local.fieldA$>   [[% (tmpStr1 == '4') %]]
<$tmpStr2 = #local.fieldC$>   [[% (tmpStr2 == '6') %]]

関連項目

A.45 ddSetLocalEmpty()

この関数はdynamicdata表を取り込んで全体を反復し、ローカル・データをクリアします。最初の列は、クリアするキーとして使用されます。

タイプおよび使用方法

パラメータ

この関数には、使用するdynamicdata表の名前であるパラメータ、dataTableNameが指定されています。

出力

dynamicdata表が存在する場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
key
foo
bar
baz
<@end@>


<$foo = 1$>
<$bar = 2$>
<$baz = 3$>
<$exec ddSetLocalEmpty("MyDataTable")$>
<$if foo or bar or baz$>
    [[% This will not be executed as foo, bar, and baz are all empty. %]]
<$endif$>

関連項目

A.46 ddSetLocalEmptyByColumns()

この関数はdynamicdata表を取り込み、列を使用してローカル・データの値をクリアします。

タイプおよび使用方法

パラメータ

この関数には、使用するdynamicdata表の名前であるパラメータ、dataTableNameが指定されています。

出力

dynamicdata表が存在する場合、TRUEを返します。

例

<@dynamicdata MyDataTable@>
foo, bar, baz
<@end@>


<$bar = "asdf"$>
<$exec ddSetLocalEmptyByColumns("MyDataTable")$>
<$if bar$>
    [[% This will not execute as bar will be empty. %]]
<$endif$>

関連項目

A.47 DefaultAccounts

匿名ユーザーのデフォルトのアカウントを定義します。

  • アカウントのカンマ区切りリストを使用する必要があります。

  • アカウント別の権限を、アカウント名の後にカッコに入れて指定する必要があります。

  • #noneエントリは、アカウントが割り当てられていないコンテンツ・アイテムに権限を付与します。#allエントリでは、すべてのアカウントに権限が与えられます。

  • デフォルトは#none(RWDA)です。

  • 文字列としてアカウントのリストを返します。

タイプおよび使用方法

場所

IntradocDir/config/config.cfg

例

構成設定として、デフォルトのアカウント情報を定義します。

DefaultAccounts=BOS(R),SEA(RW),MSP/Gen(RWD)

Idoc Scriptとして、文字列としてアカウント情報を返します。

<$DefaultAccounts$>

関連項目

A.48 defaultFieldInclude

メタデータ・フィールドの表示に使用するインクルードを指定します。

タイプおよび使用方法

例

問合せページの非表示フィールドに対するデフォルトのフィールド表示インクルードをstd_query_hidden_fieldに設定します。

<$if isFieldHidden$>
    <$if isQuery and not (fieldType like "Date") and not (fieldType like "Int")$>
        <$defaultFieldInclude = "std_query_hidden_field"$>
    <$endif$>

関連項目

A.49 defaultOptionListScript

標準的なオプション・リスト・フィールドを表示するIdoc Scriptを定義します。

タイプおよび使用方法

出力

なし。

例

optList関数を使用して、オプション・リストを生成します。

<$if optionsAllowPreselect and fieldValue$>
    <$defaultOptionListScript = "<$optList " & optionListName & ":fieldValue$>"$>
<$else$>
    <$defaultOptionListScript = "<$optList " & optionListName & ":noselected$>"$>
<$endif$>

現在のオプション・リストResultSetをループして、オプション・リストを生成します。

<@dynamichtml compute_resultset_option_list_script@>
<$if not optionListKey$>
    <$optionListKey = fieldName$>
<$endif$>
<$defaultOptionListScript = "<$loop " & optionListResultSet & "$>" & "<$inc('std_resultset_option_list_item')$>" & "<$endloop$>"$>
<@end@>

関連項目

A.50 DelimitedUserRoles

現在のユーザーが属しているロールのカンマ区切り、コロン区切りリストを取得します。

タイプおよび使用方法

出力

文字列としてユーザー・ロール・リストを返します。

例

次のようにフォーマット化されたロールのリストを返します。

:guest:,:PublicContributor:,:ClassifiedConsumer:

関連項目

A.51 docLoadResourceIncludes()

現在ページの表示に使用するために、指定されたコンテンツ・アイテムのすべてのインクルードをロードします。

  • 指定されたコンテンツ・アイテムのファイル拡張子が.idocになっている必要があります。

  • この関数は、サイド・エフェクトとしてStatusCodeを設定します。ページを正しく表示するために指定したファイルが正常にロードされる必要がある場合は、abortToErrorPage関数を使用してください。

タイプおよび使用方法

パラメータ

コンテンツ・サーバーにチェックインされるコンテンツ・アイテムを指定するCGIエンコード形式のパラメータ・リストを取り込みます。次の表に、パラメータ・オプションを示します。

オプション・パラメータ 説明

dID

dIDが存在しない場合は、dDocNameおよびRevisionSelectionMethodが存在している必要があります。このIDを持つコンテンツ・アイテムのリビジョンのレンディションが存在し、かつRevisionSelectionMethodパラメータが存在しないか、その値がSpecificである場合は、そのレンディションが返されます。

dDocName

dDocNameは、dDocNameが判明しているコンテンツ・アイテムのすべてのリクエストに存在していることをお薦めします。エラー・メッセージは、フォームなどの他の機能と同様に、これが存在しているという想定に基づいています。

  • dDocNameが存在しない場合は、dIDが存在している必要があり、RevisionSelectionMethodが存在していてはいけません。

  • RevisionSelectionMethodが存在している場合、その名前を持つコンテンツ・アイテムのリビジョンのレンディションが存在する場合に、それが返されます。

  • RevisionSelectionMethodが指定されない場合、エラー・メッセージにdDocNameが示される可能性があります。

RevisionSelectionMethod

これが指定された場合は、dDocNameも指定する必要があります。この変数の値は、指定されたdDocName値からdID値を計算するために使用されるメソッドです。RevisionSelectionMethod値は、Specific、LatestまたはLatestReleasedです。

  • Specific: dDocNameは無視され、dIDは必須であり、特定のリビジョンの取得に使用されます。

  • Latest: コンテンツ・アイテムの最新リビジョン(ワークフロー内のリビジョンを含む)を使用してdID値が計算されます。

  • LatestReleased: コンテンツ・アイテムの最新リリースのリビジョンを使用してdID値が計算されます。

Rendition

  • 指定されない場合、RenditionのデフォルトはPrimaryになります。このパラメータは、コンテンツ・アイテムのレンディションを指定します。

  • 値がPrimary、WebまたはAlternateの場合、選択されたリビジョンのプライマリ、Web表示可能または代替レンディションが返されます。

注意:

HCSPページに使用する場合、CGIエンコード形式のパラメータ・リストのアンパサンド文字(&)を&amp;文字に変更する必要があります。

出力

なし。

例

mydocの最新リビジョンのプライマリ・ボールト・レンディションにリソース・インクルードをロードします。

<$docLoadResourceIncludes("dDocName=mydoc&RevisionSelectionMethod=Latest")$>

関連項目

A.52 docRootFilename()

拡張子またはディレクトリ・パスのないファイルのファイル名を取得します。

  • この関数は通常、コンテンツ・サーバーにより管理される静的URLのコンテンツID (dDocName)部分の取得に使用されます。

タイプおよび使用方法

パラメータ

次のパラメータを取ります。

  • 唯一のパラメータはファイル名のパスです。

出力

文字列としてファイル名を返します。

例

値mydocを返します。

docRootFilename("/groups/public/documents/adacct/mydoc.pdf")

A.53 DocTypeSelected

現在のコンテンツ・アイテムのタイプがアクティブResultSetでのタイプと一致するかどうかを評価します。

タイプおよび使用方法

出力

  • コンテンツ・アイテムのタイプが一致する場合、TRUEを返します。

  • コンテンツ・アイテムのタイプが一致しない場合、FALSEを返します。

例

コンテンツ・アイテムのタイプがResultSetのタイプと一致するかどうかに基づいて、値を返します。

<$DocTypeSelected$>

A.54 DocUrl

weblayout/ディレクトリにあるファイルのURLを取得します。この変数は、サービス・コールごとに1回ではなく、コンテンツ・アイテムごとに1回評価されます。

タイプおよび使用方法

出力

文字列としてファイルのURLを返します。

例

コンテンツ・アイテムへのURLリンクの作成に使用します。

<$if HasUrl$>
    <a href="<$DocUrl$>"><$dDocName$></a>
<$else$>
    <$dDocName$>
<$endif$>

A.55 docUrlAllowDisclosure()

URLを現在のユーザーに公開できるかどうかを評価します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、次のような絶対パスです。

http://mycomputer/domain/groups/.../documents/mydoc.pdf

次のようなフル相対パスが使用できます。

/oracle/domain/.../documents/mydoc.pdf).

出力

ブール値を返します。

  • URLが公開できる場合、TRUEを返します。

  • URLが制限されている場合、FALSEを返します。

例

ユーザーがmydoc.pdfドキュメントのURLを表示できるかどうかを判別します。

<$docUrlAllowDisclosure("/domain/groups/documents/mydoc.pdf")$>

A.56 DownloadApplet

複数ファイルのダウンロード・アプレットを有効にします。

  • TRUEに設定されている場合、ダウンロード・アプレットが有効になって、複数のファイルが検索結果ページからダウンロード可能になります。

  • FALSEに設定されている場合、ダウンロード・アプレットは無効です。

  • デフォルトはFALSEです。

注意:

DownloadApplet/UploadAppletはアプレットとして機能し続けます。

タイプおよび使用方法

場所

  • 「システム・プロパティ」、「オプション」タブ、「ダウンロード・アプレットの有効化」

  • 「管理」、「管理サーバー」、「一般構成」メニュー・オプション、「ダウンロード・アプレットを有効にする」

  • IntradocDir/config/config.cfg

例

構成設定として、ダウンロード・アプレットを有効化します。

DownloadApplet=true

スクリプトとして、ダウンロード・アプレットの条件を評価します。

<$DownloadApplet$>

関連項目

A.57 DownloadSuggestedName

ダウンロード中のファイルのデフォルト・パスと提案された名前を取得します。

提案された名前は、コンテンツ・アイテムの元のファイル名に基づいています。

タイプおよび使用方法

出力

文字列としてダウンロードされたファイルのパスと提案された名前を返します。

例

次のようにダウンロードされたファイルのパスと提案された名前を返します。

<$DownloadSuggestedName$>

A.58 dpGet()

dpSet関数により設定された値を返すために使用する関数です。

dpGetおよびdpSetの両方を使用して、表示するコンテンツ・プロファイル・ルールのロジックを制御します。一般に、ユーザーは指定されたキーの値を設定するアクティブ化条件を作成することもできます。条件がFALSEに評価された場合でも(つまり、ルールの実行に失敗)、キーは設定されます。別のルールでキーにアクセスして、そのアクティブ化条件を評価するときに値を取得できます。この2つの関数を使用することにより、ユーザーはルール間の依存性を作成できます。たとえば、先行するルールが評価される場合のみ、ルールを評価したい場合があります。

タイプおよび使用方法

パラメータ

次のパラメータを取ります。

  • Key: 返される値の指定。

例

<$myValue = dpGet("myKey")$>

関連項目

A.59 dpPromote()

ルール評価コンテキストの値をリクエスト・コンテキストに昇格させるための関数です。すべてのルールの評価後に、この関数によって指定されたキーと値がローカル・データにプッシュされます。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、返される値の指定です。

  • 2番目のパラメータは、返される値です。

例

この例では、1つのリクエストに対してAutoNumberPrefixの値をdDocTypeの値になるように変更します。

<$dpPromote("AutoNumberPrefix", dDocType)$>

この例では、チェックイン・ページで「タイトル」フィールドを非表示にします。

<$dpPromote("dDocTitle:isHidden", "1")$>

関連項目

A.60 dpPromoteRs()

dpPromoteと同様に、この関数によって、プロファイル・ルールで生成されるResultSetはリクエスト・コンテキストに昇格できます。ResultSetは、すべてのルールの評価後にDataBinderにプッシュされます。値は、ルール・アクティブ化または操作の間は評価されませんが、ページ表示用に使用可能です。

タイプおよび使用方法

パラメータ

この関数は、2つのパラメータを取ることができます。

  • 最初のパラメータは、データにプッシュされるResultSetの名前です。

  • オプションです。2番目のパラメータは、ResultSetの代替名です。

関連項目

A.61 dpSet()

Idoc Scriptが評価される任意の場所で、アクティブ化条件またはルールの値の評価時に一時的な値の設定に使用される関数です。

値は作業領域に設定され、dpGet関数のコールによって取得できます。設定されるキーと値は永続しませんが、評価されるプロファイルではグローバルに使用可能です。すべてのキー/値のペアは、プロファイルのルールによってアクセスできます。

dpGetおよびdpSetの両方を使用して、表示するコンテンツ・プロファイル・ルールのロジックを制御します。一般に、ユーザーは指定されたキーの値を設定するアクティブ化条件を作成することもできます。条件がFALSEに評価された場合でも(つまり、ルールの実行に失敗)、キーは設定されます。別のルールでキーにアクセスして、そのアクティブ化条件を評価するときに値を取得できます。この2つの関数を使用することにより、ユーザーはルール間の依存性を作成できます。たとえば、先行するルールが評価される場合のみ、ルールを評価したい場合があります。

タイプおよび使用方法

パラメータ

この関数は、2つのパラメータを取ります。

  • Key: 返される値の指定。

  • Value: キーに関連付けられた値。

例

<$dpSet("myKey", "1")$>

関連項目

A.62 dWfName

ワークフローの名前を取得します。

タイプおよび使用方法

出力

文字列としてワークフローの名前を返します。

例

IdcHomeDir/resources/core/templates/workflow_info.htmテンプレート・ページにある次のコードは、「ワークフロー・ステップ情報」ページでのワークフロー名の表示に使用します。

<td align=right><span class=infoLabel><$lc("wwLabelWorkflow")$></span></td>
<td><span class=tableEntry><$dWfName$></span></td>

A.63 dWfStepName

ワークフロー内の現在のステップの名前を取得します。

タイプおよび使用方法

出力

文字列として現在のステップの名前を返します。

例

IdcHomeDir/resources/core/templates/workflow_info.htmテンプレート・ページにある次のコードは、ワークフロー・ステップ情報ページでの現在のステップ名の表示に使用します。

<td align=right><span class=infoLabel><$lc("wwCurrentStep")$>
</span></td>
<td><span class=tableEntry>
    <$loop WorkflowStep$>
    <$dWfStepName$>
    <$exec RequiredUsers = dWfStepWeight$>
    <$if isTrue(dWfStepIsAll)$><$exec RequiredUsers = 0$><$endif$>
    <$endloop$></span>
</td>

A.64 EmptyAccountCheckinAllowed

アカウントをチェックイン・ページで指定する必要があるかどうかを確認します。

アカウントが指定されていない場合にエラー・メッセージを表示するために、「標準ページ・リソース」ページで使用します。

タイプおよび使用方法

出力

  • アカウント値が必要な場合、TRUEを返します。

  • アカウント値が必要でない場合、FALSEを返します。

例

アカウント番号が必要かどうかを評価し、エラー・メッセージを表示します。 

<$if not EmptyAccountCheckinAllowed$>
    <$isRequired = 1, requiredMsg = "Please specify an account."$>
<$endif$>

A.65 EnableDocumentHighlight

PDF、テキスト、HTMLの各ファイルでのフルテキスト検索条件の強調表示を有効化します。

  • TRUEに設定されている場合、検索条件の強調表示が有効化されます。

  • FALSEに設定されている場合、検索条件の強調表示は無効になります。

  • コンテンツ・サーバーのインストール後のデフォルトはFALSEです。

  • PDF Converterのインストール後のデフォルトはTRUEです。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • 検索

場所

  • 「システム・プロパティ」、「オプション」タブ、「検索キーワードの強調表示を有効にする」

  • 「管理」、「管理サーバー」、「一般構成」メニュー・オプション、「検索キーワードの強調表示を有効にする」

  • IntradocDir/config/config.cfg

例

構成設定の使用例: 

EnableDocumentHighlight=false

スクリプトとして、構成設定の値を返します。 

<$EnableDocumentHighlight$>

関連項目

A.66 encodeHtml()

無効な、または破損HTML構成に対するデータ入力のフィルタに使用するIdoc関数。デフォルトでは、この関数は、インストール時に使用可能なコンポーネントであるスレッド・ディスカッションで使用されます。

ruleパラメータのunsafe値の使用時にコンテンツ・サーバーにより受信された入力データはすべて、定式の安全でないスクリプト・タグのみに適用されます。この機能を変更するには、HtmlDataInputFilterLevel構成変数を使用して、実行されたフィルタリングを変更します。

タイプおよび使用方法

パラメータ

2つの必須パラメータと1つのオプションのパラメータを取ります。

  • 最初のパラメータは、エンコードする文字列です。

  • 2番目のパラメータは、HTML構成のエンコード時に適用されるルールです。許容される値は次のとおりです。

    • none: HTML構成は変換されません。

    • unsafe: 定式の安全でないスクリプト・タグのみがエンコードされます。

    • exceptsafe: 定式の安全なスクリプト・タグがエンコードされません。

    • lfexceptsafe: 拡張コメントがユーザーによって入力され、元のテキストの改行を保持する必要があるときに使用します。

  • 空白文字のない長い文字列を改行するかどうかと、適用する最大ワード・サイズを指定するオプションのパラメータも使用可能です。wordbreakまたはnowordbreakのいずれかを指定します。

出力

エンコードされた文字列を返します。

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のHtmlDataInputFilterLevelに関する項

A.67 entryCount

現在のワークフロー・ステップが現在のリビジョンによって入力された回数を取得します。

  • この変数は条件文の作成に使用できますが、ハードコード化したり変更したりしないようにしてください。

  • この変数はコンパニオン・ファイルの中でローカライズされ、キーに保持されます。

    <step_name>@<workflow_name>.entryCount

タイプおよび使用方法

出力

文字列としてエントリ・カウントを返します。

例

次のコードではMaxEntryというジャンプを定義します。これは、親ワークフローに出て、最後にステップに入ったときが1週間以上前であったかどうかをレビューアに通知します。

<$if wfCurrentGet("entryCount")==2$>
    <$wfSet("WfJumpName","MaxEntry")$>
    <$wfSet("WfJumpTargetStep",wfExit(0,0))$>
    <$wfSet("WfJumpEntryNotifyOff","0")$>
<$endif$>

A.68 eval()

変数定義をIdoc Scriptとして評価します。リテラル文字列の再帰的評価に使用できます。

タイプおよび使用方法

パラメータ

唯一のパラメータは、Idoc Scriptとして評価される文字列を定義する変数です。

出力

変数定義にあるIdoc Scriptをすべて解決したパラメータ文字列を返します。

例

変数oneには文字列CompanyNameが割り当てられ、変数twoには、Idoc Scriptデリミタ内に変数oneを組み込んだ文字列が割り当てられます。ページ上では、変数oneは文字列Company Nameを表し、変数twoは文字列Welcome to <$one$>を表し、eval(two)は文字列Welcome to Company Nameを表します。

<$one="CompanyName"$>
<$two="Welcome to <$one$>"$>
<$one$><br>
<$two$><br>
<$eval(two)$>

名前に接頭辞xPrefixのあるメタデータ・フィールドをすべて除外するとします。eval()関数をこの目的で次のように使用してIdoc Scriptを動的に作成し、評価することができます。

<$loop DocMetaDefinition$>
<$if strIndexOf("xPrefix", dName) >= 0$>
    <$myScript = "<$" & dName & ":isExcluded=1$>"$>
    <$eval(myScript)$>
<$endif$>
<$endloop$>

関連項目

A.69 ExclusiveCheckout

別のユーザーにより作成されたコンテンツを、ユーザーがチェックアウトできるかどうかを判別します。

  • TRUEに設定した場合、作成者、またはセキュリティ・グループの管理者権限を持つユーザーのみがコンテンツ・アイテムをチェックアウトできます。

  • FALSEに設定した場合、セキュリティ・グループの書込み権限を持つユーザーが、別のユーザーにより作成されたコンテンツをチェックアウトできます。

  • デフォルトはFALSEです。

タイプおよび使用方法

場所

  • 「システム・プロパティ」、「コンテンツ・セキュリティ」タブ、「元のコントリビュータにのみチェックアウトを許可する」

  • 「管理」、「管理サーバー」、「コンテンツ・セキュリティ」メニュー・オプション、「元のコントリビュータにのみチェックアウトを許可する」

  • IntradocDir/config/config.cfg

例

構成設定として、元のコントリビュータのみがコンテンツ・アイテムをチェックアウトできます。

ExclusiveCheckout=true

Idoc Scriptとして、構成設定の値を返します。

<$ExclusiveCheckout$>

関連項目

A.70 exec

Idoc Script式を実行して、出力を抑制します(式をページに表示しません)。

  • 旧バージョンのIdoc Scriptでは、execキーワードは変数の値を出力ファイルに表示しないようにするために必須でした。現行バージョンでは、execキーワードは式を出力ファイルに表示しないようにする場合のみ必要です。

    次の例の最初の行は、最後の2行と同等です。

    <$varA="stringA", varB ="stringB"$>
<$exec varA="stringA"$>
<$exec varB="stringB"$>

  • execキーワードは通常、あとでページで使用するインクルードの指定など、背景で実行されるコードの評価に使用します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、Idoc Script式です。

出力

式の値を返しますが、式をページに表示しません。

例

incグローバル関数を評価して、ページにコードを表示せずに指定されたインクルードを取り込みます。

<@dynamichtml std_definitions@>
    <$exec inc("std_page_variable_definitions")$>
    <$exec inc("define_image_files")$>
<@end@>

関連項目

A.71 executeService()

コンテンツ・サーバーのサービスを実行します。

  • この関数は、ページの作成中でも、指定されたサービスを実行できるようにします。通常、サービスはブラウザでIdcCommandまたはCGI URLなどのツールを使用して実行されます。

  • 動的サーバー・ページで使用されます。

  • executeService関数でコールできるサービスは、パラメータ入力が必要でないという意味で、スクリプト可能である必要があります。スクリプト可能なサービスのアクセス・レベルは32以上です。

タイプおよび使用方法

パラメータ

唯一のパラメータは、実行されるサービスの名前です。DataBinder内のライブ・データは、指定されたサービスのパラメータとして使用されます。

出力

  • サービスが正常に実行された場合、StatusCode値として0を返します。

  • サービス実行中にエラーが発生した場合、StatusCode値として-1を返します。

  • 実行されたサービスの出力はすべて抑制されますが、ResultSetとロードされた値はいずれも使用可能です。

例

サービス名が指定されたときに、サービスを実行します。

<$executeService("servicename")$>

関連項目

A.72 ExternalUserAccounts

外部ユーザー・ベース(NTLM、Active Directory、またはLDAP)により定義されたユーザーのデフォルトのロールを取得します。

タイプおよび使用方法

出力

  • アカウント別の権限をアカウント名の後にカッコに入れて指定したアカウントのカンマ区切りリストを返します。

  • #none エントリは、アカウントが割り当てられていないコンテンツ・アイテムに権限を付与します。 #all エントリでは、すべてのアカウントに権限が与えられます。

例

スクリプトとして、文字列としてデフォルトのアカウント情報を返します。

<$ExternalUserAccounts$>

関連項目

A.73 ExternalUserRoles

外部ユーザー・ベース(NTLM、Active Directory、またはLDAP)により定義されたユーザーのデフォルトのロールを取得します。

タイプおよび使用方法

出力

  • 文字列としてロールのリストを返します。

例

スクリプトとして、文字列としてデフォルトのロール情報を返します。

<$ExternalUserRoles$>

関連項目

A.74 fieldCaption

メタデータ・フィールドのキャプション・ラベルを指定します。

タイプおよび使用方法

出力

文字列としてメタデータ・フィールドのキャプションを返します。

例

dDocTitleメタデータ・フィールドのキャプションを、ローカライズされた文字列wwTitleとして定義します。

<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1, fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle")$>

A.75 fieldCaptionInclude

メタデータ・フィールドのキャプションの表示に使用するインクルードを指定します。

タイプおよび使用方法

出力

なし。

例

キャプション表示インクルードをstd_field_captionに設定します。

<$fieldCaptionInclude = "std_field_caption"$>

関連項目

A.76 fieldCaptionStyle

メタデータ・フィールドのキャプションのスタイルを指定します。

次のSPANスタイルは通常、キャプションに使用します。これは、IdcHomeDir/resources/core/std_page.htmリソース・ファイル内のstd_style_declarationインクルードで定義されています。

  • searchLabel

  • infoLabel

  • tableEntry

  • requiredField

タイプおよび使用方法

出力

キャプション・スタイルの名前を返します。

例

キャプション・スタイルをrequiredFieldに設定します。

<$if isRequired and not suppressCaptionHighlighting$>
    <$fieldCaptionStyle = "requiredField"$>
<$endif$>
Generates the standard field caption:
<@dynamichtml std_field_caption@>
    <span class=<$fieldCaptionStyle$>><$fieldCaption$><$if not     isFormSubmit$><$":"$><$endif$></span>
<@end@>

関連項目

A.77 fieldDefault

メタデータ・フィールドのデフォルト値を指定します。

タイプおよび使用方法

出力

文字列としてメタデータ・フィールドのデフォルト値を返します。

例

dDocTitleメタデータ・フィールドのデフォルト値を定義します。

<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1,
     fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle"),
     fieldDefault="Enter a Title"$>

A.78 fieldEditWidth

HTMLページでのメタデータ入力フィールドの文字幅を指定します。これは、リソースcompute_std_field_includes.に含まれているcompute_namevalue_edit_widthsで設定されます。

タイプおよび使用方法

出力

なし。

A.79 fieldEntryInclude

メタデータ・フィールドの値の表示に使用するインクルードを指定します。

タイプおよび使用方法

例

値表示インクルードをstd_checkbox_entryに設定します。

<$fieldEntryInclude = "std_checkbox_entry"$>

関連項目

A.80 fieldExtraScriptInclude

特定のメタデータ・フィールドに対して追加のJavaScript検証が含まれているインクルード・ファイルの名前を指定します。これは、リソースcompute_std_field_includesに設定されています。

タイプおよび使用方法

A.81 fieldInclude

メタデータ・フィールドを表示するインクルードの名前を指定します。通常、このインクルード・ファイルはstd_namevalue_fieldですが、別のインクルードに設定することもできます。

これは通常、xFieldName:includeを使用してページの一番上に設定されますが、リソースcompute_std_field_includesをオーバーライドして設定することもできます。

タイプおよび使用方法

A.82 fieldIsOptionList

メタデータ・フィールドにオプション・リストがあるかどうかを指定します。

  • TRUEに設定されている場合、フィールドにはオプション・リストがあります。

  • FALSEに設定されている場合、フィールドにはオプション・リストがありません。

  • デフォルトはFALSEです。

タイプおよび使用方法

出力

  • フィールドにオプション・リストがある場合、TRUEを返します。

  • フィールドにオプション・リストがない場合、FALSEを返します。

例

事前定義のアカウントが存在する場合、dDocAccountメタデータ・フィールドをオプション・リストとして定義します。

<$if HasPredefinedAccounts$>
    <$fieldIsOptionList = 1, optionListName = "docAccounts", 
    fieldOptionListType = "combo"$>
<$endif$>

関連項目

A.83 fieldMaxLength

メタデータ・フィールドの最大長を指定します。これはフィールドのサイズではなく、フィールドに含めることのできる最大文字数です。これは通常、xFieldName:includeを使用してページの一番上に設定されますが、リソースcompute_std_field_includesをオーバーライドして設定することもできます。

タイプおよび使用方法

A.84 fieldName

メタデータ・フィールドの内部名を指定します。

  • 事前定義されたメタデータ・フィールドは、小文字のdで始まります(例: dDocName)。

  • カスタム・メタデータ・フィールドは、小文字のxで始まります(例: xComments)。

タイプおよび使用方法

出力

文字列としてメタデータ・フィールドの名前を返します。

例

dDocTitle メタデータ・フィールドを定義します。

<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1, fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle")$>

A.85 fieldOptionListType

メタデータ・フィールドのオプション・リストのタイプを指定します。

この変数に使用可能な値は次のとおりです。

fieldOptionListTypeの値 構成マネージャで対応するオプション

strict

「Vタイプの選択リスト」または「NVタイプの選択リスト」

combo

「リストから1項目選択、もしくは項目の追加選択」

multi

リストから1項目以上の選択、もしくは項目の追加選択

access

なし(メンバー・アクセス・リスト用Collaboration Serverで使用)

タイプおよび使用方法

出力

文字列としてオプション・リスト・タイプを返します。

例

dDocAccountオプション・リスト・タイプをcombo (「単一値選択リスト」)として定義します。

<$if HasPredefinedAccounts$>
    <$fieldIsOptionList = 1, optionListName = "docAccounts",
    fieldOptionListType = "combo"$>
<$endif$>

関連項目

A.86 fieldType

メタデータ・フィールドのタイプを指定します。

この変数に使用可能な値は次のとおりです。

fieldTypeの値 構成マネージャで対応するオプション

Text

Text

BigText

Long Text

Int

Integer

Date

Date

Memo

Memo

タイプおよび使用方法

出力

文字列としてメタデータ・フィールド・タイプを返します。

例

dDocTitle メタデータ・フィールドをBigText (Long Text)フィールドとして定義します。

<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1,
    fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle")$>

A.87 fieldValue

メタデータ・フィールドの値を指定します。

タイプおよび使用方法

出力

現在のメタデータ・フィールドの値を返します。

例

標準のフィールド値を生成します。

<@dynamichtml std_value_label@>
    <span class="<$fieldValueStyle$>"><$fieldValue$></span><!--""-->
<@end@>

関連項目

A.88 fieldValueStyle

メタデータ・フィールドの値のスタイルを指定します。

次のSPANスタイルは通常、値に使用します。これは、IdcHomeDir/resources/core/std_page.htmリソース・ファイル内のstd_style_declarationインクルードで定義されています。

  • tableEntry

  • xxsmall

  • strongHighlight

タイプおよび使用方法

出力

値スタイルの名前を返します。

例

値スタイルを設定します。

<$if isFieldInfoOnly$>
    <$if valueStyle$>
<$fieldValueStyle = valueStyle$>
    <$else$>
<$fieldValueStyle = "tableEntry"$>
    <$endif$>
<$endif$>

標準のフィールド値を生成します。

<@dynamichtml std_value_label@>
    <span class="<$fieldValueStyle$>"><$fieldValue$></span><!--'"-->
<@end@>

関連項目

A.89 fieldWidth

メタデータ・フィールドの幅(単位: 文字数)を指定します。

タイプおよび使用方法

出力

現在のメタデータ・フィールドの幅を返します。

例

10文字の幅を持つExtensionフィールドを生成します。

<$fieldName = "dExtension", fieldCaption = lc("wwNativeExtension"), 
fieldWidth = 10$>

関連項目

A.90 fileUrl

現在の動的サーバー・ページ(HCSPまたはHCST)の相対URLを取得します。

この変数は通常、それ自身に転送するフォームなどの自己参照ページで使用します。

タイプおよび使用方法

出力

文字列としてURLを返します。

例

現在の動的サーバー・ページの相対URLを返します。

<$fileUrl$>

A.91 FIRSTREV

現在のリビジョン・ラベル・シーケンスの最初のリビジョン・ラベルを返します。

タイプおよび使用方法

出力

文字列として最初のリビジョン・ラベルを返します。

例

最初のリビジョン・ラベル(デフォルトは 1)を返します。

<$FIRSTREV$>

A.92 ForcedConversionRules

ファイルのチェックインに対して強制変換を適用するDynamic Converterルールを定義します。

  • これはカンマ区切りリストです。

  • コンテンツ・アイテムがチェックイン時に指定された変換ルールのいずれかと一致する場合、ファイルはそのルールに従って変換されます。各ファイルは、複数のレンディションに変換できます。

  • デフォルトはありません。

    注意:

    強制変換プロセスでは、同じDynamic Converterテンプレートを2回適用することはありません。たとえば、ForcedConversionRules=RuleA,RuleBを設定していて、RuleAとRuleBが異なるレイアウトで同じテンプレートを指定した場合、RuleBに準じた変換は行われません。(この場合のベスト・プラクティスは、レイアウトをマージし、Idoc Scriptを使用して適切なレイアウト要素を動的に選択することです。)

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • Dynamic Converter

場所

IntradocDir/config/config.cfg

例

構成エントリとしての使用例:

ForcedConversionRules=Rule1,Rule2,Rule3

関連項目

  • incDynamicConversionByRule()

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のDisableForcedConversionsおよびrule:IsFragmentOnlyに関する項

A.93 forceExpire()

この関数は、特定のインクルードのキャッシュを強制的に期限切れにするために使用できます。これは、新規メタデータ・フィールドを追加したり、ユーザーが新規問合せを保存したり、表示可能なリンクを変更する場合など、ページ表示の変更に役立ちます。

includeNameの値がnullであるか空の文字列である場合、キャッシュ全体が排除されます。これは、特定のページのインクルードがすべて同じキャッシュに入れられて、同時に期限切れにする必要がある場合に役立ちます。

詳細は、「キーワードと関数の比較」を参照してください。

タイプおよび使用方法

パラメータ

2つの必須パラメータと2つのオプションのパラメータを取ります。次に例を示します。

forceExpire(includeName, scope [, cacheName, key])
パラメータ 説明

includeName

評価する動的HTML要素の名前。

scope

ユーザーごとに異なるHTMLを表示する場合はsessionに設定し、すべてのユーザーに同じものを表示する場合はapplicationに設定します。

cacheName

オプション: このデータを、デフォルトのキャッシュのかわりに、名前付きキャッシュに入れる場合。空の文字列が渡される場合は、インクルードをセッションのデフォルトのキャッシュに入れます。

key

オプション: 競合を避けるためにキャッシュの名前-範囲の自動指定を行わない場合は、ここで一意のキーを指定できます。

例

これは、std_page_beginインクルードの置換として使用できます。ユーザーが、標準的な左ナビゲーション・バーのリンク(問合せの保存、ポータル設計の変更)を変更するために、標準サービス・コールの1つを実行したかどうかが検証されます。実行した場合、標準ページ開始のキャッシュされたHTMLは無効になります。その後で、次のcacheInclude関数によってインクルードが再評価され、キャッシュに戻されます。

<$if strEquals(IdcService, "PNE_SAVE_QUERY") or strEquals(IdcService, "PNE_UPDATE_PORTAL_INFO")$>
<$forceExpire("std_main_page_begin", "session", "", "std_main_page_begin")$>
<$endif$>
<$cacheInclude("std_main_page_begin", "session", 600, "", "std_main_page_begin")$>

関連項目

A.94 formatDate()

日付/時間のフォーマットをデフォルトの日付/時間フォーマットに変更します。

データベースでフォーマット化された日付(例: 2001-06-15)は評価できません。

長いフォーマットの日付(例: June 15, 2001)は評価できません。

タイプおよび使用方法

パラメータ

唯一のパラメータは、日付/時間を指定する文字列です。

出力

  • dateCurrentで使用するフォーマットで日付/時間を返します(例: 6/15/01 1:55 PM)。

  • パラメータが評価できない場合は、nullを返します。

  • 時間が指定されていない場合は、デフォルト時間である12:00 AMを返します。

例

次の例では、日付と時間をフォーマット化して、それを12/14/99 2:00 PMとして表示します。

<$formatDate("12/14/1999 02:00 PM")$>

次の例では、日付と時間をフォーマット化して、それを9/15/03 12:00 AMとして表示します。

<$formatDate("09/15/2003")$>

次のスクリプトは、指定された日付と時間をフォーマット化し、表示します。1行目では、日付と時間の代替フォーマットを評価して、それをカスタム変数に割り当てます。2行目では、この日付をユーザーに表示します。

<$my_customDateTime = formatDate("06/14/2004 15:05:34")$>
Final Approval: <$my_customDateTime$>

出力:

最終承認: 6/14/04 3:05 PM

A.95 formatDateDatabase()

SQL問合せの準備のために日付と時間をフォーマット化します。長いフォーマットの日付(例: May 22, 2000)は評価できません。

タイプおよび使用方法

パラメータ

唯一のパラメータは、日付/時間を指定する文字列または変数です。

出力

  • ODBCフォーマットの日付と時間を返します。

    [ts 'yyyy-mm-dd hh:mm:ss']

  • パラメータが評価できない場合は、nullを返します。

  • 時間が指定されていない場合は、デフォルト時間である00:00:00を返します。

例

SQL問合せに対する現在の日付と時間をフォーマット化します。

<$formatDateDatabase(dateCurrent())$>

日付と時間をフォーマット化し、2001-03-19 15:32:00として表示します。

<$formatDateDatabase("03/19/2001 3:32 PM")$>

日付と時間をフォーマット化し、1999-04-03 00:00:00として表示します。

<$formatDateDatabase("4/3/99")$>

A.96 formatDateDisplay()

日付/時間のフォーマットをユーザーへの表示用の日付/時間フォーマットに変更します。「システム・プロパティ」の「表示日付フォーマット」を使用して、日付をフォーマット化します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、日付/時間を指定する文字列です。

出力

  • 使用したフォーマットで日付/時間を返します。

  • パラメータが評価できない場合は、nullを返します。

例

<$formatDateDisplay$>

関連項目

A.97 formatDateOnly()

日付/時間のフォーマットをデフォルトの日付フォーマットに変更して、時間を削除します。

データベースでフォーマット化された日付(例: 2000-02-02)は評価できません。

長いフォーマットの日付(例: June 12, 2001)は評価できません。

タイプおよび使用方法

パラメータ

唯一のパラメータは、日付/時間を指定する文字列です。

出力

  • dateCurrentで使用するフォーマットで日付を返します(例: 7/12/00)。

  • パラメータが評価できない場合は、nullを返します。

例

現在の日付のみ(例: 9/12/01)を返します。

<$formatDateOnly(dateCurrent())$>

10日後の日付(例: 9/22/01)を返します。

<$formatDateOnly(dateCurrent(10))$>

日付と時間をフォーマット化し、日付のみを1/17/00として表示します。

<$formatDateOnly("01/17/2000 2:00 PM")$>

このスクリプトでは、現在の日付と100日後の日付が表示されます。1行目では、現在の日付のみがカスタム変数に割り当てられます。2行目では、100日後の日付が2番目のカスタム変数に割り当てられます。3行目では、これらの日付がユーザーに表示されます(たとえば、開始日: 10/12/01、終了日: 1/20/02)。

<$my_startDate = formatDateOnly(dateCurrent())$>
<$my_endDate = formatDateOnly(dateCurrent(100))$>
Start Date: <$my_startDate$> and End Date: <$my_endDate$>

A.98 formatDateOnlyDisplay()

日付のフォーマットをユーザーへの表示用の日付フォーマットに変更します。「システム・プロパティ」の「表示日付フォーマット」を使用して、日付をフォーマット化します。

formatDateDisplayと類似していますが、日付のみをフォーマット化します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、日付を指定する文字列です。

出力

  • 使用したフォーマットで日付を返します。

  • パラメータが評価できない場合は、nullを返します。

例

<$formatDateOnlyDisplay$>

関連項目

A.99 formatDateOnlyFull()

日付/時間のフォーマットを長い日付フォーマットに変更して、時間を削除します。データベースでフォーマット化された日付(例: 2000-02-02)は評価できません。

この設定は、バージョン5.1以降では非推奨です。formatDateWithPattern()を使用してください。

タイプおよび使用方法

パラメータ

唯一のパラメータは、日付/時間を指定する文字列です。

出力

  • 長いフォーマットの日付を返します。

    month d, yyyy

  • パラメータが評価できない場合は、nullを返します。

例

現在の日付を長いフォーマットで返します。

<$formatDateOnlyFull(dateCurrent())$>

365日後の日付を長いフォーマット(例: September 12, 2002)で返します。

<$formatDateOnlyFull(dateCurrent(365))$>

日付のみをフォーマット化し、June 12, 2001として表示します。

<$formatDateOnlyFull("6/12/01 3:00 PM")$>

A.100 formatDateWithPattern()

日付/時間のフォーマットをデ指定された日付/時間パターンに変更します。

この変数を(動的ページではなく)プログラムで使用している場合、!rfcを日付パターンの最後に追加します。これにより、rfc標準に準拠する日付フォーマットが提供されます。!rfcが追加されないと、プログラムは日付文字列を作成するのにロケールを使用しようとしますが、定期的に更新されるイベントの場合、ロケールは指定されません。その結果、出力は日付と月に対し、文字列のかわりに整数を使用します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、コンテンツ・サーバー・インスタンスにより使用される日付文字列、またはparseDate関数またはdateCurrent関数を使用して作成された日付オブジェクトです。

  • 2番目のパラメータは日付/時間パターン(例: MM/dd/yyyy)です。

    大文字のZは、エントリにUTCタイムゾーンが使用されることを意味します。小文字のzzzzは、オフセットを示すプラス(+)記号またはマイナス(-)記号が先行するUTC時間からのタイム・オフセット(HHMM)を示します。

出力

  • パターン・パラメータにより指定されたフォーマットで日付/時間を返します。

  • パラメータが評価できない場合は、nullを返します。

例

Wed, 5 Jul 2006 12:08:56 -0700と表示します。

<$formatDateWithPattern(dateCurrent(),"EEE, d MMM yyyy HH:mm:ss zzzz")$>

2006-07-05 14:30:33Zと表示します。

<$formatDateWithPattern(dateCurrent(),"yyyy-MM-dd HH:mm:ssZ")$>

A.101 formatTimeOnly()

日付/時間のフォーマットをデフォルトの時間フォーマットに変更して、日付を削除します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、日付/時間を指定する文字列または変数です。

出力

  • dateCurrentで使用するフォーマットで時間のみを返します(例: 1:15 PM)。

  • パラメータが評価できない場合は、nullを返します。

例

現在の時間のみを返します。

<$formatTimeOnly(dateCurrent())$>

時間のみをフォーマット化し、5:00 PMとして表示します。

<$formatTimeOnly("2/2/99 5:00 PM")$>

時間のみをフォーマット化し、6:14 PMとして表示します。

<$formatTimeOnly("04/21/2001 18:14:00")$>

A.102 formatTimeOnlyDisplay()

時間のフォーマットをユーザーへの表示用の時間フォーマットに変更します。「システム・プロパティ」の「表示日付フォーマット」を使用して、時間をフォーマット化します。

formatDateDisplayと類似していますが、時間のみをフォーマット化します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、時間を指定する文字列です。

出力

  • 使用したフォーマットで時間を返します。

  • パラメータが評価できない場合は、nullを返します。

例

<$formatTimeOnlyDisplay$>

関連項目

A.103 GATEWAY_INTERFACE

このサーバーが準拠しているCGI仕様のリビジョン・レベルを取得します。この変数はリクエスト固有ではなく、すべてのリクエストに対して設定されます。

タイプおよび使用方法

出力

文字列としてリビジョン・レベルをCGI/revisionのフォーマットで返します。

例

ページまたはログへの情報出力としての使用例: 

GATEWAY_INTERFACE=CGI/1.1

Idoc Script文または評価の一部としての使用例:

<$if GATEWAY_INTERFACE$>
<!--statement-->

A.104 generateUniqueId

この関数は、HTMLページの一意のIDを返します。これは、一意のIDを保証するために、HTML要素内でid属性とともに使用されます。

タイプおよび使用方法

パラメータ

唯一のパラメータは、IDが生成されるフィールド名です。

出力

HTMLページのIDを返します。

A.105 getCookie

ブラウザからCookieを取得します。

これは、情報をパーソナライズに格納する必要がない場合のユーザー・セッションの追跡に役立ちます。

最後に移動したページ、または最後に実行された検索の追跡に使用できます。

タイプおよび使用方法

パラメータ

1つのパラメータとしてCookieの名前を取ります。

例

<$myCounter=getCookie("myCounter")$>
<$if not myCounter$>
    <$myCounter=1$>
<$endif$>
Num times loaded: <$myCounter$>
<$setCookie("myCounter", myCounter+1, dateCurrent(1))$>

関連項目

A.106 GetCopyAccess

コンテンツ・アイテムのコピーの取得に必要なユーザーの権限を決定します。

TRUEに設定した場合、ユーザーは読取り権限のみを持っているコンテンツ・アイテムのコピーを取得できます。

FALSEに設定した場合、ユーザーは、コピーを取得できるようにするために、コンテンツ・アイテムの書込み権限を持っている必要があります。

デフォルトはFALSEです。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • 内部セキュリティ

場所

  • 「システム・プロパティ」、「コンテンツ・セキュリティ」タブ、「読取り権限を持つユーザーである場合にコピーを許可する」

  • 「管理」、「管理サーバー」、「コンテンツ・セキュリティ」メニュー・オプション、「読取り権限を持つユーザーである場合にコピーを許可する」

  • IntradocDir/config/config.cfg

例

構成設定の使用例:

GetCopyAccess=true

Idoc Scriptとして、構成設定の値を返します。

<$GetCopyAccess$>

A.107 getDebugTrace()

デバッグ・トレースの出力を取得します。

タイプおよび使用方法

出力

  • 構成中のページの累積デバッグ・トレースの出力を返します。

  • IsPageDebugが設定されていない場合、空の文字列を返します。

例

デバッグ・トレースの出力を取得して、その情報をページに出力します。

<$getDebugTrace()$>

関連項目

A.108 getErrorTrace()

エラー・トレースの出力を取得します。

エラー・トレースの出力は、HTMLページで表示するためにエンコードされます。たとえば、デリミタ< and >はHTMLエスケープであり、改行は<br>タグに変換されます。

タイプおよび使用方法

出力

  • 構成中のページの累積エラー・トレースの出力を返します。

  • IsPageDebugが設定されていない場合、この関数は空の文字列を返します。

例

エラー・トレースの出力を取得して、その情報をページに出力します。 

<$getErrorTrace()$>

関連項目

A.109 getFieldConfigValue

この関数は、特定のフィールドの構成フラグを返します。フィールドが存在しない場合は、かわりにデフォルトが返されます。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • メタデータ・フィールドの名前。

  • フィールドに対して返すフラグが見つかった場合は、そのフラグ。

  • フィールドが存在しない場合は、返されるデフォルト値。

出力

指定された構成フラグを返します。

例

<$caption = getFieldConfigValue("dDocTitle", "fieldCaption", lc("wwTitle"))$>

A.110 getFieldViewDisplayValue()

「スキーマ」オプション・リストにあるアイテムの表示値を返します。

たとえば、Customerというカスタム・メタデータ・フィールドに対してオプション・リストが存在すると仮定します。データベースには、CustomerName列と一意のCustomerID列を持つスキーマ表があります。チェックイン時にCustomerName値がユーザーに表示されますが、CustomerID値はデータベースに格納されます。getFieldViewDisplayValue関数は、CustomerID値に基づき、解読可能なCustomerName値を抽出します。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータは、オプション・リストに使用するフィールドの名前です。

  • 2番目のパラメータは、現在のフィールドに使用されたスキーマ・ビューの名前です。

  • 3番目のパラメータは、フィールドに割り当てられた値です。

出力

表示値を返します。

例

<$customerName = getFieldViewDisplayValue("xCustomer", "Customer_View", "1234")$>

A.111 getFieldViewValue()

この関数は、フィールドのコンテンツ・ルールの定義時に使用します。この関数を使用することにより、コンテンツ・プロファイルのフィールド値がビューに依存するように設定できます。フィールドにはデフォルト値と導出値の両方を設定できるため、ビューを使用してフィールド間の相互依存性を作成できます。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • フィールド。メタデータ・フィールドの名前。このフィールドにはビューを割り当てておく必要があります。

  • 値。値の参照キー。

  • 列名。ビューの表内の列。

出力

参照としてフィールド値を使用して指定された列の値を返します。

例

次の例では、xEmployeeフィールドの表示表にtypeという列があります。この関数は、xEmployeeメタデータ・フィールドで指定された値を使用してこの表に参照を指定し、type列の値を返します。

getFieldViewValue("xEmployee", #active.xEmployee, "type")

A.112 getFreeMemory()

この関数は、Java Virtual Machine (JVM)内の空きメモリーの量を返します。これは、「システム監査情報」ページで使用されるパフォーマンス監査機能です。

タイプおよび使用方法

出力

JVM空きメモリーの量(MB単位)。

例

<$freeMem = getFreeMemory()$>

関連項目

A.113 getHelpPage

この関数は、ページの名前に基づいてページをヘルプするために、相対URLを返します。

タイプおよび使用方法

パラメータ

使用したページの名前。

例

<input type=Button value="<$lc("wwQuickHelp")$>"
    onClick="QuickHelp('<$getHelpPage("QH_AdvancedSearch")$>', 'Search')">

A.114 getOptionListSize

この関数は、オプション・リストのサイズを返します。これは、「ユーザー・プロファイル」ページにカスタム・ユーザー・メタデータ・フィールドを表示するかどうかの判別に使用します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、サイズ設定対象のオプション・リストです。

出力

指定されたオプション・リストのサイズを返します。

A.115 getParentValue()

この関数は、スキーマ・ビューから親値を返します。これは、現在のフィールドの依存オプション・リストを生成する前に必要です。

多くのオプション・リストは親フィールドの一意のキーに対する依存性をトリガーするため、通常、この関数は内部の親値パラメータと同じ値を返します。ただし、これは、複合型の依存選択リストの要件ではありません。

タイプおよび使用方法

パラメータ

次の4つのパラメータをとります。

  • 現在のフィールドに使用されたスキーマ・ビューの名前。

  • このフィールドと親フィールド間のスキーマ・リレーションの名前。

  • 親フィールドの名前。

  • 親フィールドの内部値。これは、ページに表示される値とは異なる場合があります。これは、内部格納された一意の番号であることがよくあります。

例

<$parentValue=getParentValue("xState", "Country_State", "xCountry", "123")$>

A.116 getRequiredMsg()

この関数は、必要なエラー・メッセージを示すJavaスクリプトを移入するために、プレゼンテーション・ページで使用されます。エラー・メッセージは、必須として指定されたフィールドのコンテンツ・ルール・ユーザー・インタフェースに基づいて設定されます。次のアルゴリズムに基づいて、必要なメッセージを返します。

  1. この関数は、fieldname:requiredMsg値を検索します。

  2. 値が存在する場合は、ローカライズされます。

  3. 値が未定義であるか、メッセージが空の場合、デフォルトのメッセージは返されず、ローカライズも行われません。メッセージをローカライズするには、関数のコール元はlc関数をデフォルト・メッセージに使用した後で、それをこの関数(getRequiredMsg)に渡す必要があります。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • Fieldname: エラー・メッセージに関連付けられたフィールド。

  • Message: 使用するデフォルト・メッセージ。

関連項目

A.117 getTextFile()

テキスト・ファイルのWebバージョンを取得し、そのコンテンツを文字列に返します。

  • これは、text/html、text/plainまたはtext/xmlなどのテキストがフォーマットに含まれているファイルのみで使用できます。特に、コンテンツ・アイテムのdFormatフィールドはtextで始まる必要があります。たとえば、HCSPファイルをチェックインした場合、「コンテンツ情報」画面に「Formats: text/hcsp」が表示されるため、コンテンツはgetTextFile()関数によって表示されます。

  • コンテンツ・アイテムのWeb URLを判別するのに十分な情報が存在する必要があります。dID値のみが必須のメタデータ・フィールドです。

    次の情報が存在している必要があります。

    • dDocName、dWebExtension、dSecurityGroup、dRevLabelおよびdDocType。

    • アカウントが有効化されている場合は、dDocAccountも指定する必要があります。

    この情報は、GET_SEARCH_RESULTSのコール後またはDOC_INFOのコール後に自動的に使用可能になります。

  • パフォーマンスを改善するには、この関数をcacheIncludeコールでラップします。ただし、こうすると、すべてのドキュメントを同じキャッシュに入れる場合にセキュリティの問題が生じることがあります。

タイプおよび使用方法

パラメータ

この関数はパラメータを取りませんが、ページで変数を使用してドキュメントのURLを決定します。

例

<$loop SearchResults$>
    <$fullDocument=getTextFile()$>
    <h2><$dDocTitle$></h2>
    <div><$fullDocument$></div>
<$endloop$>

関連項目

A.118 getTotalMemory()

この関数は、Java Virtual Machine (JVM)内の総メモリー量を返します。これは、サーバーの使用メモリー量を判別するために、「システム監査情報」ページで使用されるパフォーマンス監査機能です。

タイプおよび使用方法

出力

JVMの総メモリー量(MB単位)。

例

<$totalMem = getTotalMemory()$>

関連項目

A.119 getUserValue()

現在のユーザーのユーザー・メタデータ・フィールドの値を取得します。

パラメータは、Usersデータベース表の列を参照する必要があります。グローバル参照をサポートしないユーザー・パーソナライズ関数とは異なり、Users表でユーザーに割り当てられた情報はコンテンツ・サーバー・インスタンスが使用できます。

タイプおよび使用方法

パラメータ

唯一のパラメータはユーザー関連の変数です。

出力

  • 現在のユーザーのメタデータ・フィールドの値を返します。

  • ユーザー値が取得された場合、TRUEに評価します。

  • 取得中にエラーが発生した場合、FALSEに評価します。

  • 値が未指定であったり、不明な場合には、StatusCode値として-1を返します。

例

現在ログオンしているユーザーのユーザー名・タイプを返します。

<$getUserValue('dUserType')$>

A.120 getValue()

この関数には、次のように複数の使用法があります。

  • 特定のメタデータ・フィールドの値をローカル・データ、アクティブ・データまたは環境データから取得します。

  • 特定の列の値を特定のResultSetから取得します。

  • ResultSet行に関する情報を取得します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、データ型またはResultSetの名前のいずれかです。

  • 2番目のパラメータは、メタデータ・フィールドの名前、列名またはResultSet行パラメータです。

バリエーション

getValue(arg1,arg2)関数とまったく同じ結果を返す省略フォーマットを使用することもできます。このフォーマットは<$arg1.arg2$>フォームを使用します。この場合のarg1およびarg2は、getValue関数に対するリテラル文字列引数"arg1"および"arg2"です。

注意:

データ型(local、activeおよびenv)とResultSetパラメータは、番号記号の(#)記号で始まる必要があります。

次のパラメータの組合せが使用できます。

getValueおよび省略フォーマット 説明

getValue("#local",fieldName)

<$#local.fieldName$>

指定したメタデータ・フィールドの値をローカル・データから取得します。

getValue("#active",fieldName)

<$#active.fieldName$>

指定したメタデータ・フィールドの値をデータから次の順序で取得しようとします。

  1. ローカル・データ

  2. アクティブResultSet

  3. その他すべてのResultSet

  4. 環境設定

getValue("#env",fieldName)

<$#env.fieldName$>

指定したメタデータ・フィールドの値を環境設定から取得します。

getValue(ResultSetName,fieldName)

<$ResultSetName.fieldName$>

指定したメタデータ・フィールドの値を、指定したResultSetの現在行から取得します。

getValue(ResultSetName,columnName)

<$ResultSetName.columnName$>

指定した列の値を、指定したResultSetの現在行から取得します。

getValue(columnName)

<$columnName$>

指定した列の値を、現在のResultSetの現在行から取得します。

getValue(ResultSetName,"#row")

<$ResultSetName.#row$>

指定したResultSetの現在行の番号を取得します。

最初の行は0です。

getValue(ResultSetName,"#numRows")

<$ResultSetName.#numRows$>

指定したResultSetの行の総数を取得します。

getValue(ResultSetName,"#isRowPresent")

<$ResultSetName.#isRowPresent$>

指定したResultSetに少なくとも1行が存在するかどうかを確認します。

これは、rsNextを使用して手動でループするときに役立ちます。

getValue(ResultSetName,"#isEmpty")

<$ResultSetName.#isEmpty$>

指定したResultSetに行が含まれていないかどうかを確認します。

出力

  • 出力値については、前述の項、バリエーションを参照してください。

  • 値が見つからない場合、空の文字列を返します。

例

  • DOC_INFOというResultSetからコンテンツIDを取得します。

    <$name = getValue("DOC_INFO","dDocName")$>

    または

    <$name = <$DOC_INFO.dDocName$>

  • 渡されたパラメータdDocType(これはローカル・データにあります)がアクティブResultSetの値と等しいかどうかを確認します。

    <$loop DocTypes$>
<$if strEquals(#active.dDocType, getValue("#local","dDocType"))$>
<!--do special HTML for selected document type--> 
<$endif$>
<!-- additional statement-->
<$endloop$>

関連項目

A.121 getValueForSpecifiedUser()

特定のユーザーのユーザー属性の値を取得します。この関数は、拡張ワークフロー機能を定義する際に役立ちます。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータはユーザー名です。

  • 2番目のパラメータは、ユーザー属性(dFullName、dUserTypeまたはdEmailなど)を指定するUsersデータベース表にある列の名前です。

出力

  • 指定したユーザーのユーザー属性の値を返します。

  • 値が見つからない場合、空の文字列を返します。

例

mjonesの完全名を取得します。

<$getValueForSpecifiedUser('mjones', 'dFullName')$>

A.122 getViewValue()

「スキーマ」オプション・リストにあるアイテムの表示値を返します。

たとえば、Customerというカスタム・メタデータ・フィールドに対してオプション・リストが存在すると仮定します。データベースには、CustomerNameと一意のCustomerIDを持つスキーマ表があります。チェックイン時にCustomerNameがユーザーに表示されますが、CustomerIDはデータベースに格納されます。getFieldViewDisplayValue関数は、CustomerIDに基づき、解読可能なCustomerNameを抽出します。

タイプおよび使用方法

パラメータ

この関数は、次の3つのパラメータを取ります。

  • 現在のフィールドに使用されたスキーマ・ビューの名前。

  • データベースに格納されたIDの値。

  • ビューに関連付けられている列名。

出力

表示値を返します。

例

<$custName = getViewValue("Customer_View", "1234", "CustomerName")$>
<$custRegion = getViewValue("Customer_View", "1234", "CustomerRegion")$>

関連項目

A.123 getViewValueResultSet()

この関数はスキーマ表をロードし、それをSchemaData.というResultSetとしてページに入れます。ResultSetの列名はデータベース表内の名前と同じです。

この関数は、親値に基づいて依存選択リストを取得する際に最も役立ちます。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 使用したスキーマ・ビューの名前。

  • スキーマとビューとのリレーション。

  • スキーマ親の値。

例

国リストのスキーマ表とビューがあるとします。ビュー名はCountry_viewです。

その表のコンテンツをページに出力するために、次のコードを使用します。

<$getViewValuesResultSet("Country_View", "", "")$>
<$loop SchemaData$>
<$count = 0, num = rsNumFields("SchemaData")$>
    <$loopwhile count < num$>
        <$fieldName=rsFieldByIndex("SchemaData", count)$>
        <$fieldName$> = <$getValue("SchemaData", fieldName)$>
        <$count = count + 1$>
    <$endloop$>
<$endloop$>

列名がわからなくても、表は出力されます。

次の例では、フィールドCountryおよびStateに対してDCLを持っていると仮定します。Statesのリストは、選択されるCountryに依存します。CountryがUSの場合にStatesリストを取得するには、次のコードを使用します。

<$getViewValuesResultSet("State_View", "Country_State", "US")$>

A.124 hasAppRights()

現在のユーザーが管理アプリケーションに対する権限を持っているかどうかを確認します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、次の管理アプリケーションのいずれか1つです。

  • UserAdmin

  • WebLayout

  • RepoMan

  • Workflow

  • ConfigMan

  • Archiver

出力

  • ユーザーが指定されたアプリケーションに対する権限を持っている場合、TRUEを返します。

  • ユーザーが指定されたアプリケーションに対する権限を持っていない場合、FALSEを返します。

  • 値が未指定であったり、不明な場合には、StatusCode値として-1 を返します。

例

現在のユーザーが指定されたアプリケーションに対する権限を持っているかどうかを評価します。

<$hasAppRights('RepoMan')$>

A.125 HasExternalUsers

外部ユーザー・データベースが存在することをコンテンツ・サーバーに指示します。

TRUEに設定した場合、システムは外部ユーザーを認識します。カスタム・コンポーネントが外部ユーザー統合(LDAPなど)をサポートするように作成されている場合は、これをTRUEに設定します。

デフォルトはFALSEです。

タイプおよび使用方法

場所

IntradocDir/config/config.cfg

例

構成設定の使用例:

HasExternalUsers=true

Idoc Scriptとして、構成設定の値を返します。 

<$HasExternalUsers$>

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のNtlmSecurityEnabledに関する項

A.126 HasLocalCopy

クライアント・コンピュータがダウンロード・ターゲット・ディレクトリにリクエストされたコンテンツ・アイテムのコピーを格納しているかどうかを確認します。

通常は、ダウンロード時に上書きするかどうかをユーザーに問い合わせるために使用します。たとえば、この変数はOracle ODMAクライアントによって使用されます。

タイプおよび使用方法

出力

  • ローカル・コピーが検出された場合、TRUEを返します。

  • ローカル・コピーが検出されない場合、FALSEを返します。

例

コンテンツ・アイテムのローカル・コピーがないか確認します。

<$HasLocalCopy$>

関連項目

A.127 hasOptionList

メタデータ・フィールドにオプション・リストがあることを指定します。

タイプおよび使用方法

出力

  • フィールドにオプション・リストがある場合、TRUEを返します。

  • フィールドにオプション・リストがない場合、FALSEを返します。

例

フィールドにオプション・リストがあることを指定します。

<$hasOptionList=1$>

フィールドにオプション・リストがある場合、オプション・リストの値を生成します。

<$if hasOptionList$>
    <$if isQuery$></td><td><$endif$>
    <$include std_option_list_entry$>
<$endif$>

関連項目

A.128 HasOriginal

リビジョンの元のファイルが存在するかどうかを確認します。

この変数は、dOriginalName値を確認します。

コンテンツ・アイテムのチェックインは可能ですが、コンテンツ・アイテムが元のファイルを持つことはできません(たとえば、基本ワークフローが開始していても、最初のコントリビューション・ステップでファイルがチェックインされていない場合)。

タイプおよび使用方法

出力

  • 元のファイルが存在する場合、TRUEを返します。

  • 元のファイルが存在しない場合、FALSEを返します。

例

元のファイルがあるかどうかを確認します。

<$if HasOriginal and not isNew$>

A.129 HasPredefinedAccounts

現在のユーザーが事前定義アカウントに対する権限を持っているかどうかを確認します。事前定義アカウントとは、「ユーザー管理」ユーティリティで作成されたアカウントです。

タイプおよび使用方法

出力

  • ユーザーが事前定義アカウントに割り当てられている場合、TRUEを返します。

  • ユーザーが事前定義アカウントに割り当てられていない場合、FALSEを返します。

例

ユーザーが事前定義アカウントに割り当てられている場合、「アカウント」オプション・リストを表示します。

<$if HasPredefinedAccounts$>
    <$fieldIsOptionList = 1, optionListName = "docAccounts",     fieldOptionListType = "combo"$>
<$endif$>

A.130 HasUrl

現在のコンテンツ・アイテムのファイルがweblayoutディレクトリに存在するかどうかを確認します。

タイプおよび使用方法

出力

  • weblayoutファイルが存在する場合、TRUEを返します。

  • weblayoutファイルが存在しない場合、FALSEを返します。

例

weblayoutファイルがあるかどうかを確認します。

<$if HasUrl$>
    <$include doc_url_field$>
<$endif$>

A.131 HeavyClient

チェックインがコンテンツ・サーバーのODMAクライアントまたはUploadアプレットを介しているかどうかを確認します。

タイプおよび使用方法

出力

  • ODMAクライアントまたはUploadアプレットがチェックインに使用されている場合、TRUEを返します。

  • ODMAクライアントまたはUploadアプレットがチェックインに使用されていない場合、FALSEを返します。

例

チェックイン方法を確認します。

<$HeavyClient$>

A.132 HelpDir

オンラインヘルプ・ファイルが含まれるディレクトリへのパスを定義します。

このパスは、コンテンツ・サーバーのインスタンスとOracle WebCenter Content: Inbound Refineryのインスタンスに対して別々に設定できます。

文字列としてパスを返します。

コンテンツ・サーバーのインスタンスに対するデフォルトは、install_dir/weblayout/helpです。

Inbound Refineryのデフォルトは、SharedDir/helpです。

タイプおよび使用方法

場所

  • コンテンツ・サーバー: IntradocDir/config/config.cfg

  • Inbound Refinery: install_dir/IdcRefinery/shared/idcrefinery.cfg

例

コンテンツ・サーバー・インスタンスの構成エントリとして使用します。

HelpDir=c:/stellent/weblayout/help/

Inbound Refineryインスタンスの構成エントリとして使用します。

HelpDir=c:/stellent/IdcRefinery/shared/help/

A.133 htmlRefreshTimeout

DefaultHtmlRefreshTimeoutInSecondsに類似しています。「処理中コンテンツ」ページ、「チェックアウト・コンテンツ」ページまたは「ワークフロー割当て」ページがリフレッシュする時間(単位: 秒)を定義します。

htmlRefreshTimeoutは、URLまたはサービスのデータ・バインダに設定できます。これは、ページごとに異なるリフレッシュ時間の設定に使用できます。これが必要な場合、config.cfgファイルにDefaultHtmlRefreshTimeoutInSecondsを設定するかわりに、URLまたはデータ・バインダにhtmlRefreshTimeoutを設定します。

タイプおよび使用方法

例

ページのURLでの使用例:

&htmlRefreshTimeout=90

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のDefaultHtmlRefreshTimeoutInSecondsに関する項

  • htmlRefreshUrl

A.134 htmlRefreshUrl

「処理中コンテンツ」ページ、「チェックアウト・コンテンツ」ページまたは「ワークフロー割当て」ページのリフレッシュ後にロードするページのURLの設定に使用します。デフォルトは現在のページです。この変数は、ページのURLまたはサービスのデータ・バインダに設定できます。

タイプおよび使用方法

例

ページのURLでの使用例:

&htmlRefreshUrl=http://www.home.com

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のDefaultHtmlRefreshTimeoutInSecondsに関する項

  • htmlRefreshUrl

A.135 HttpAbsoluteCgiPath

コンテンツ・サーバーのCGIパスを完全なURLとして取得します。

この変数は直接変更できません。パスを変更するには、『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』に説明するHttpAbsoluteCgiRoot構成設定を使用します。

タイプおよび使用方法

出力

文字列としてパスを返します。

例

コンテンツ・サーバーdomainに、次の値が返されます。

HttpAbsoluteCgiPath=http://localhost/domain/idcplg/

(または、マスター・コンテンツ・サーバーのdomainに対して返されます)

プロキシ設定されたコンテンツ・サーバー・インスタンス(stellent_2)に次の値が返されます。

HttpAbsoluteCgiPath=http://localhost/stellent/idcplg/stellent_2/pxs

関連項目

A.136 HttpAdminCgiPath

コンテンツ・サーバーのCGIパスを相対URLとして取得します。

タイプおよび使用方法

出力

文字列としてコンテンツ・サーバーのCGIパスを返します。

例

コンテンツ・サーバー・インスタンスに次の値が返されます。

HttpAdminCgiPath=/idcplg/idc_cgi_isapi-instance.dll/cs-admin/pxs

(マスターまたはプロキシ設定されたコンテンツ・サーバー・インスタンスに対して返されます)

A.137 HttpBrowserFullCgiPath

この変数は、アプレットおよびコンテンツ・サーバー・インスタンスのCGIパスの構成に対する明示的な制御の設定に使用します。

コンテンツ・サーバーは、ブラウザのアドレス・バーでHTTPアドレスを評価します。HttpIgnoreWebServerInternalPortNumber構成エントリでは評価を十分に支援できない場合、HttpBrowserFullCgiPathを明示的な回答とともに設定できます。

コンテンツ・サーバー・インスタンスへの相対パス(次の例では、idc1)を指定します。

タイプおよび使用方法

例

HttpBrowserFullCgiPath=http://localhost/idc1/idcplg

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のHttpIgnoreWebServerInternalPortNumberに関する項

A.138 HttpCgiPath

コンテンツ・サーバーのCGIパスを取得します。

次の構造設定は、この変数の値の決定に使用します。

変数 説明

UseSSL

TRUEに設定した場合、Secure Sockets Layer (SSL)が使用されます(httpではなく、httpsを使用)。

isAbsoluteCgi

相対パスのかわりに完全なURLを使用するかどうかを定義します。これはコンテンツ・サーバー・インスタンスにより設定される内部フラグであり、ユーザー構成を対象としていません。

タイプおよび使用方法

出力

文字列としてパスを返します。

例

コンテンツ・サーバー・インスタンスに次の値が返されます。

HttpCgiPath=/domain/idcplg

(または、マスター・コンテンツ・サーバー・インスタンスに対して返されます)

プロキシ設定されたコンテンツ・サーバー(stellent_2)に次の値が返されます。

HttpCgiPath=/stellent/idcplg/stellent_2/pxs

関連項目

A.139 HttpCommonRoot

commonディレクトリのURLを取得します。

1つのコンテンツ・サーバーのインストールのリソースを複数のコンテンツ・サーバー・インスタンスで共有できます。この変数は、共有中のリソースを持つコンテンツ・サーバー・インスタンスのDomainHome/ucm/cs/common/ディレクトリへのURLパスを定義します。たとえば、HttpCommonRootは、Webアプレットが置かれている共有の共通ディレクトリへのアクセスに使用する接頭辞を定義します。

タイプおよび使用方法

出力

文字列として相対URLを返します。URLが外部の場合は、相対パスではなく、完全なURLが返されます。

例

コンテンツ・サーバー・インスタンスに次の値が返されます。

HttpCommonRoot=/domain/common/

(マスターまたはプロキシ設定されたコンテンツ・サーバー・インスタンスに対して返されます)

関連項目

A.140 HttpEnterpriseCgiPath

コンテンツ・サーバー・インスタンスのCGIパスを相対URLとして取得します。

マスター・コンテンツ・サーバー・インスタンスのCGIパスを取得します。複数のコンテンツ・サーバー・インスタンスが同じWebログインを共有する場合、そのうちの1つがマスターまたはエンタープライズ・サーバーに指定されます。

タイプおよび使用方法

出力

文字列としてコンテンツ・サーバーのCGIパスを返します。

文字列としてマスター・コンテンツ・サーバーのCGIパスを返します。

例

コンテンツ・サーバー・インスタンスに次の値が返されます。

HttpEnterpriseCgiPath=/idcplg/idc_cgi_isapi-instance.dll

(マスターまたはプロキシ設定されたContent Serverに対して返されます)

関連項目

A.141 HttpHelpRoot

helpディレクトリのURLを取得します。

1つのコンテンツ・サーバーのインストールのオンライン・ヘルプ・ファイルを複数のコンテンツ・サーバー・インスタンスで共有できます。この変数は、共有中のヘルプ・ファイルを持つコンテンツ・サーバー・インスタンスのDomainHome/ucm/cs/weblayout/help/ディレクトリへのURLパスを定義します。

タイプおよび使用方法

出力

文字列として相対URLを返します。URLが外部の場合は、相対パスではなく、完全なURLが返されます。

例

コンテンツ・サーバー・インスタンスに次の値が返されます。

HttpHelpRoot=/domain/help/

(マスターまたはプロキシ設定されたContent Serverに対して返されます)

関連項目

A.142 HttpImagesRoot

images ディレクトリのURLを取得します。

1つのコンテンツ・サーバーのインストールのユーザー・インタフェース・イメージを複数のコンテンツ・サーバー・インスタンスで共有できます。この変数は、共有中のイメージ・ファイルを持つコンテンツ・サーバー・インスタンスのDomainHome/ucm/cs/weblayout/images/ディレクトリへのURLパスを定義します。

タイプおよび使用方法

出力

文字列として相対URLを返します。URLが外部の場合は、相対パスではなく、完全なURLが返されます。

例

コンテンツ・サーバーに次の値が返されます。

HttpImagesRoot=/domain/images/

マスターまたはプロキシ設定されたContent Serverに対して返されます。

関連項目

A.143 HttpLayoutRoot

現在のレイアウト・ファイルが含まれているフォルダのURLを取得します。これは、現在のレイアウトに固有の追加JavaScriptリソースを持っている場合に役立ちます。

タイプおよび使用方法

A.144 HttpRelativeAdminRoot

コンテンツ・サーバー・インスタンスに対する相対URLを取得します。

インストール時のデフォルトは/cs-admin/です。

タイプおよび使用方法

出力

文字列として相対URLを返します。

例

コンテンツ・サーバー・インスタンスに次の値が返されます。

HttpRelativeAdminRoot=/cs-admin/

(マスターまたはプロキシ設定されたContent Serverに対して返されます)

A.145 HttpRelativeWebRoot

Webサーバー・ルート・ディレクトリを相対URLとして定義します。

  • 完全ルート(http://www.mycomputer.com/domain/.など)ではなく、相対ルート(/domain/など)を使用します。

  • 文字列として相対Webルート・ディレクトリを返します。

  • デフォルト値はありません。

タイプおよび使用方法

場所

  • 「システム・プロパティ」、「インターネット」タブ、「HTTP相対Webルート」

  • コンテンツ・サーバー: IntradocDir/config/config.cfg

例

構成設定として、相対Webルートを定義します。

HttpRelativeWebRoot=/domain/

Idoc Scriptとして、文字列として相対Webルートを返します。

<$HttpRelativeWebRoot$>

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のHttpAbsoluteWebRootに関する項

A.146 HttpServerAddress

Webサーバー・アドレスを部分URLとして定義します。

完全アドレス(http://www.mycomputer.com/など)ではなく、部分URL (mycomputerなど)を使用します。

文字列としてWebサーバー・アドレスを返します。

デフォルト値はありません。

タイプおよび使用方法

場所

  • 「システム・プロパティ」、「インターネット」タブ、「HTTPサーバー・アドレス」

  • コンテンツ・サーバー: IntradocDir/config/config.cfg

例

構成設定として、Webサーバー・アドレスを定義します。

HttpServerAddress=mycomputer

Idoc Scriptとして、文字列としてWebサーバー・アドレスを返します。

<$HttpServerAddress$>

関連項目

  • Oracle WebCenter Content構成リファレンスのIdcAdminServerHostNameに関する項

  • Oracle WebCenter Content構成リファレンスのIdcCommandServerHostに関する項

  • Oracle WebCenter Content構成リファレンスのIdcAdminServerHostNameに関する項

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のIntradocServerHostNameに関する項

A.147 HttpSharedRoot

sharedディレクトリのURLパスを取得します。

1つのOracleコンテンツ・サーバーのインストールのリソースを複数のコンテンツ・サーバー・インスタンスで共有できます。この変数は、共有中のリソースを持つコンテンツ・サーバー・インスタンスのshared/ディレクトリへのURLパスを定義します。

タイプおよび使用方法

出力

文字列として相対URLを返します。URLが外部の場合は、相対パスではなく、完全なURLが返されます。

例

マスターまたはプロキシ設定されたContent Serverに対して返されます。

HttpSharedRoot=/domain/

関連項目

A.148 HttpSystemHelpRoot

HttpHelpRoot変数と類似していますが、この変数はデフォルトのシステム言語に対してヘルプ・ファイルへのパスを返す点が異なります。

タイプおよび使用方法

出力

ヘルプ・ファイルへのパスを返します。

例

HttpSystemHelpRoot=/domain/help/

関連項目

A.149 HttpWebRoot

weblayout/ディレクトリのURLパスを取得します。

1つのコンテンツ・サーバーのインストールのリソースを複数のコンテンツ・サーバー・インスタンスで共有できます。この変数は、共有中のリソース・ファイルを持つコンテンツ・サーバー・インスタンスのDomainHome/ucm/cs/weblayout/ディレクトリへのURLパスを定義します。

次の構成設定は、この変数の値を決定します。

変数 説明

UseSSL

TRUEに設定した場合、Secure Sockets Layer (SSL)が使用されます(httpではなく、httpsを使用)。

isAbsoluteWeb

相対パスのかわりに完全なURLを使用するかどうかを定義します。これはコンテンツ・サーバー・インスタンスにより設定される内部フラグであり、ユーザー構成を対象としていません。

タイプおよび使用方法

出力

文字列として相対URLを返します。URLが外部の場合は、相対パスではなく、完全なURLが返されます。

例

コンテンツ・サーバー・インスタンスに次の値が返されます。

HttpWebRoot=/domain/

(マスターまたはプロキシ設定されたContent Serverに対して返されます)

関連項目

A.150 HTTP_ACCEPT

ブラウザが受け入れられるコンテンツ・タイプのリストを取得します。

タイプおよび使用方法

出力

コンテンツ・タイプのリストをカンマ区切り文字列として返します。

例

ページまたはログへの情報出力としての使用例:

HTTP_ACCEPT=text/xml,application/xml,application/xhtml+xml,text/html;
q=0.9,text/plain;q=0.8,video/x-mng,image/png,image/jpeg,image/gif;
q=0.2,text/css,*/*;q=0.1

Idoc Script文または評価の一部としての使用例:

<$if HTTP_ACCEPT$>
<!--statement-->

A.151 HTTP_ACCEPT_ENCODING

ブラウザがサポートする圧縮エンコーディングのリストを取得します。

コンテンツ・サーバーのバージョン7.0以降、HTMLファイルは配信用に圧縮されています。GZIP圧縮がデフォルトです。

タイプおよび使用方法

出力

圧縮エンコーディングのリストをカンマ区切り文字列として返します。

例

ページまたはログへの情報出力としての使用例:

HTTP_ACCEPT_ENCODING=gzip, deflate, compress;q=0.9

Idoc Script文または評価の一部としての使用例:

<$if HTTP_ACCEPT_ENCODING$>
<!--statement-->

A.152 HTTP_ACCEPT_LANGUAGE

ブラウザ用に設定されているISO言語のリストを取得します。

この変数は、新規ユーザーまたはゲスト・ユーザー用にどのユーザー・ロケールが設定されるかを推定する場合に便利です。

タイプおよび使用方法

出力

言語のリストをカンマ区切り文字列として返します。

例

ページまたはログへの情報出力としての使用例:

HTTP_ACCEPT_LANGUAGE=en-us,en;q=0.50

Idoc Script文または評価の一部としての使用例:

<$if HTTP_ACCEPT_LANGUAGE$>
<!--statement-->

A.153 HTTP_COOKIE

HTTPリクエスト・ヘッダー内のCookieの名前と値のペアを取得します。

タイプおよび使用方法

出力

文字列をname1=string1; name2=string2のフォーマットで返します。

例

ページまたはログへの情報出力としての使用例:

HTTP_COOKIE=IntradocAuth=Basic; IntrdocLoginState=1

Idoc Script文または評価の一部としての使用例:

<$if HTTP_COOKIE$>
<!--statement-->

A.154 HTTP_HOST

Webサーバーの名前を取得します。

タイプおよび使用方法

出力

文字列としてWebサーバー名を返します。

例

ページまたはログへの情報出力としての使用例: 

HTTP_HOST=centralserver

Idoc Script文または評価の一部としての使用例:

<$if HTTP_HOST$>
<!--statement-->

A.155 HTTP_INTERNETUSER

システムがユーザーを設定できるようにWebサーバーのセキュリティ・フィルタからシステムに渡されるCGIパラメータを取得します。

この変数が設定されない場合は、REMOTE_USER変数の値が使用されます。

HTTP_INTERNETUSER変数とREMOTE_USER変数が設定されない場合、ユーザーは匿名になります。

タイプおよび使用方法

出力

文字列としてユーザー名を返します。

例

ページまたはログへの情報出力としての使用例:

HTTP_INTERNETUSER=admin

Idoc Script文または評価の一部としての使用例:

<$if HTTP_INTERNETUSER$>
<!--statement-->

A.156 HTTP_REFERER

ローカル・サーバー上で参照されるディレクトリの完全なURLを取得します。

タイプおよび使用方法

出力

文字列として完全なURLを返します。

例

ページまたはログへの情報出力としての使用例:

HTTP_REFERER=http://centralserver/domain/

Idoc Script文または評価の一部としての使用例: 

<$if HTTP_REFERER$>
<!--statement-->

A.157 HTTP_USER_AGENT

クライアントのブラウザ・タイプ、バージョン番号、ライブラリおよびブラウザが構成されているプラットフォームを取得します。

タイプおよび使用方法

出力

文字列をsoftware/version (library) (platform)のフォーマットで返します。

例

ページまたはログへの情報出力としての使用例:

HTTP_USER_AGENT=Mozilla/4.7 [en] (WinNT; U)

Idoc Script文または評価の一部としての使用例:

<$if HTTP_USER_AGENT$>
<!--statement-->

A.158 IdcAuthExtraRequestParams

Webサーバーのプラグインの値をローカル・データから取得し、リクエストのヘッダーに入れて送信するように指定します。

たとえば、Webサーバー・フィルタのプラグインを使用してユーザーの属性を取得し、それをローカル値に入れる場合、IdcAuthExtraRequestParamsの中に属性名を指定すると、データをコンテンツ・サーバー・インスタンスに渡すこともできます。

この設定は、Idoc Scriptを使用して余分なHTTPヘッダー値にアクセスする場合にも使用できます。これらの変数は、データ・バインダ環境変数セットに組み込まれます。

  • IdcAuthExtraRequestParamsリスト内の名前は、大/小文字に関係なくヘッダー名と一致している必要があります(大/小文字を区別しない一致)。

  • Idoc Script変数として使用している場合、IdcAuthExtraRequestParams内の名前は正確に一致している必要があります(大/小文字を区別する一致)。

デフォルト値はありません。

IdcCommandの詳細は、「コンテンツ・サーバーにアクセスするためのIdcCommandユーティリティの使用」を参照してください。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • Webサーバー

場所

IntradocDir/config/config.cfg

例

次の設定では、ヘッダーにあるHTTP_REFERERのローカル値を送信するようにIIS Webサーバーのプラグインに指示します(IISが自動的にHTTP_接頭辞を追加します)。

IdcAuthExtraRequestParams=referer

A.159 idocTestForInclude()

この関数は、dynamichtmlリソースが存在するかどうか確認するためにテストします。

タイプおよび使用方法

パラメータ

この関数には、dynamichtmlリソースの名前であるパラメータ、includeNameが指定されています。

出力

リソースが存在する場合、TRUEを返します。

例

<$if idocTestForInclude("std_page_begin")$>    <$include std_page_begin$><$endif$>

A.160 inc()

インクルード・リソースのコードをページに追加します。

この関数は、パラメータとしてIdoc Script変数を取れる点を除き、includeキーワードと同じ動作をします。詳細は、「キーワードと関数の比較」を参照してください。

タイプおよび使用方法

パラメータ

唯一のパラメータは、インクルードの名前を定義する変数です。

出力

指定したインクルード・リソースで定義されたコードを表示します。

例

たとえば、カスタム・メタデータ・フィールドの全部ではなく、一部に対してIdoc Scriptを実行するとします。次のIdoc Scriptを実行することにより、フィールド名(specific_include_xCommentsなど)に基づいてインクルードを動的に作成することもできます。

<$loop DocMetaDefinition$>
    <$myInclude = "specific_include_" & dName$>
    <$exec inc(myInclude)$>
<$endloop$>

inc関数によって指定されたインクルードの出力を抑制するexecキーワードの使用に留意してください。inc関数の前にexecを使用しない場合、指定されたインクルードの内側のHTMLはページに表示されます。

specific_include_xCommentsフィールドが存在しない場合は、出力が表示されないため、このコードによってエラーがスローされることはありません。

関連項目

A.161 incDynamicConversionByRule()

Dynamic Converterの特定の変換ルールに関連付けられているテンプレートとレイアウトを使用して、ドキュメントのLatestReleasedリビジョンの変換結果を返します。

強制変換によって作成されたフラグメントは、この関数を使用して直接参照することができます。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、ドキュメントのコンテンツIDです。

  • 2番目のパラメータは、変換ルールの名前です。

出力

指定した変換ルール用に定義されたテンプレートとレイアウトに従って変換された指定のドキュメントを取得します。

例

PhoneListのコンテンツIDを持つコンテンツ・アイテムの、変換ルールRuleAに従って変換された変換済レンディションを取得します。

<$incDynamicConversionByRule("PhoneList","RuleA")$>

関連項目

A.162 incGlobal()

テキスト・ファイルのコンテンツ全体を現在のページの表示に含めます。

この関数は、デフォルトのポータル・ページの生成に使用します。

グローバル・インクルード・ファイルは、HTMLコード、 Idoc Scriptコードまたはその両方が含まれているテキスト・ファイルです。これは、サーバー起動時にロードされます。

グローバル・インクルード・ファイルには.inc拡張子が付いていて、DomainHome/ucm/cs/data/pages/ディレクトリに置かれる必要があります。

タイプおよび使用方法

パラメータ

唯一のパラメータは、.incファイル拡張子のないグローバル・インクルード・ファイルの名前です。

出力

指定したグローバル・インクルード・ファイルで定義されたコードを表示します。

例

「Webレイアウト・エディタ」で「ポータルの更新」機能を使用してポータル・ページを変更すると、変更済テキストが含まれているportal_message.incというグローバル・インクルード・ファイルが作成されます。このファイルは、次のようにpne_home_page.htmテンプレートの中で参照されます。

<$incGlobal("portal_message")$>

A.163 include

インクルード・リソースのコード(<@dynamichtml include_name@>により定義)をページに追加します。

このキーワードは、コードの小さいチャンクを複数のテンプレート・ページで再使用できるため、Idoc Scriptで最もよく使われるコマンドでです。

詳細は、「インクルード」を参照してください。

タイプおよび使用方法

パラメータ

唯一のパラメータは、インクルードの名前です。

出力

指定したインクルード・リソースで定義されたコードを表示します。

例

次のインクルードは、ほとんどのコンテンツ・サーバーWebページの開始と終了の作成に使用します。これらのインクルードは、次のファイルで定義されます。

IdcHomeDir/resources/core/standard_page.htm

<$include std_html_head_declarations$>
<$include body_def$>
<$include std_page_begin$>
    Hello World!
<$include std_page_end$>

関連項目

A.164 incTemplate()

Idocスクリプトの評価後に、コンテンツ・サーバー・テンプレートのコンテンツをページに追加します。

この関数を使用して、テンプレート全体のコンテンツをインクルードすることができます。ただし、リソース・インクルードは通常、Idoc Scriptをページ間で共有するためのすべての要件に十分柔軟に対応できるため、これを使用する必要はありません。

タイプおよび使用方法

パラメータ

唯一のパラメータは、.htmファイル拡張子のないコンテンツ・サーバー・テンプレート・ファイルの名前です。

出力

指定したテンプレートで定義されたコードを表示します。

例

new_lookテンプレート・ファイルを取得します。

<$incTemplate("new_look")$>

A.165 indexerSetCollectionValue()

この関数は、検索インデクサのロジックを変更します。この関数は、索引コレクションに関する累積統計が計算できるように作成されています。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、使用するフラグの名前です。

  • 2番目のパラメータは、フラグの属性値です。

任意の名前と値が使用できます。これらの値は、次回にリソース・インクルードが索引コレクション用に実行されるときに使用可能になります。

A.166 InstanceDescription

インスタンスの説明を定義します。

インスタンスの説明はコンテンツ・サーバー・インスタンスで使用されます。

タイプおよび使用方法

場所

  • 「システム・プロパティ」、「サーバー」タブ、「インスタンスの説明」

  • IntradocDir/config/config.cfg

例

構成エントリとして:

InstanceDescription=Master_on_Server1

Idoc Scriptとして、文字列としてサーバー・インスタンスの説明を返します。

<$InstanceDescription$>

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のIDC_Nameに関する項

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のInstanceMenuLabelに関する項

A.167 isActiveTrace()

コアでセクションがトレースされているかどうかを確認します。

タイプおよび使用方法

出力

アクティブなトレース結果を返します。

例

<$isActiveTrace()$>

関連項目

A.168 isCheckin

現在のページがチェックイン・ページかどうかを指定します。

TRUEに設定した場合、現在のページがチェックイン・ページとして特定されます。

FALSEに設定した場合、現在のページはチェックイン・ページとして特定されません。

タイプおよび使用方法

出力

  • ページがチェックイン・ページである場合、TRUEを返します。

  • ページがチェックイン・ページでない場合、FALSEを返します。

例

ページの一番上に設定する使用例:

isCheckin=1

スクリプトとしての使用例:

<$if isCheckin or isUpdate or isQuery$>
    <$isFormSubmit = 1$>
    <$if not isQuery$>
        <$isEditMode = 1$>
        <$formName = "Checkin"$>
    <$endif$>
    <$else$>
        <$isFormSubmit = ""$>
        <$isEditMode = ""$>
<$endif$>

A.169 IsCheckinPreAuthed

セキュリティ・トークンを取得することにより、現在のチェックインがチェックイン・アプリケーションで事前認可されているかどうかを確認します。

タイプおよび使用方法

出力

  • チェックインが事前認可されている場合、TRUEを返します。

  • チェックインが事前認可されていない場合、FALSEを返します。

例

チェックインの事前認可を確認します。

<$IsCheckinPreAuthed$>

A.170 isComponentEnabled

定義されたコンポーネントが有効になっているかどうかを確認します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、コンポーネントの名前です。

出力

  • 定義されたコンポーネントが有効になっている場合、TRUEを返します。

  • 定義されたコンポーネントが有効になっていない場合、FALSEを返します。

例

<$isComponentEnabled("Folders")$>

A.171 IsContributor

ユーザーがコントリビュータであるかどうかの評価に使用します。通常は、ページに特殊なリンクを表示するかどうかの決定に使用します(たとえば、std_pageはこれを使用して、コンテンツ・マネージャ・リンクを表示するかどうかを決定します)。

タイプおよび使用方法

出力

  • ユーザーがコントリビュータである場合、TRUEを返します。

  • ユーザーがコントリビュータでない場合、FALSEを返します。

例

ユーザーがコントリビュータであるかどうかの評価に使用します。 

<$if IsContributor$>

A.172 IsCriteriaSubscription

コンテンツ・アイテムのサブスクリプションが、コンテンツID (dDocName)に基づくのではなく、基準に基づくかどうかを評価します。

タイプおよび使用方法

出力

  • サブスクリプションが基準に基づいている場合、TRUEを返します。

  • サブスクリプションが特定のコンテンツ・アイテムを対象としている場合、FALSEを返します。

例

サブスクリプションが基準に基づいているかどうかを評価します。

<$IsCriteriaSubscription$>

A.173 IsCurrentNav

現在表示中のページが、検索結果ページで次/前のナビゲーションの作成中にループされるページと同じであるかどうかを確認します。

タイプおよび使用方法

出力

  • ナビゲーションが現在のページと同じページでループしている場合、TRUEを返します。

  • ナビゲーションが現在のページとは別のページでループしている場合、FALSEを返します。

例

ナビゲーションが現在のページと同じページでループしている場合、ページ番号はプレーン・テキストとして表示されます。ナビゲーションが現在のページと同じページでループしている場合、ページ番号はハイパーテキスト・リンクとして表示されます。

<$loop NavigationPages$>
<$if IsCurrentNav$>
    <$HeaderPageNumber$>
<$else$>
    <a href="<$strRemoveWs(inc("searchapi_navigation_specific_page"))$>">
    <$HeaderPageNumber$></a>
<$endif$>
<$endloop$>

A.174 isDocPage

現在のページがメタデータを表示するページ(検索、チェックイン、コンテンツ情報などの各ページ)であるかどうかを指定します。

TRUEに設定した場合、現在のページがドキュメント・ページとして特定されます。

FALSEに設定した場合、現在のページはドキュメント・ページとして特定されません。

タイプおよび使用方法

出力

  • ページがドキュメント・ページである場合、TRUEを返します。

  • ページがドキュメント・ページでない場合、FALSEを返します。

例

ページの一番上に設定する使用例:

isDocPage=1

スクリプトとしての使用例:

<$if isDocPage$>
    <!--statement-->
<$endif$>

A.175 IsDynamic

ページがユーザーに動的に表示されるかどうかを確認します。

ユーザーによって表示されるページのほとんどは動的です。ただし、いくつかの静的ページは、変更せずにユーザーに配信されるように作成されています。例として、ゲスト・ポータル・ページや、自動生成される電子メールのコンテンツなどがあります。

タイプおよび使用方法

出力

  • ページがユーザーに動的に表示されている場合、TRUEを返します。

  • ページが静的であるか表示できない場合、FALSEを返します。

例

ページが動的に表示されるかどうかを評価します。

<$if IsDynamic$>
    <a href="<$redirect$>">
<$endif$>

A.176 IsDynamicConverterEnabled

Dynamic Converterを有効にします。

この値は、WebCenter Contentの初期インストール中はFALSEに設定されています。

この値は、Dynamic Converterのインストール中はTRUEに設定されています。

デフォルトはFALSEです。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • Dynamic Converter

場所

  • 「システム・プロパティ」、「オプション」タブ、「Dynamic Converterを有効にする」

  • 「管理」、「管理サーバー」、「一般構成」メニュー・オプション、「Dynamic Converterを有効にする」

  • IntradocDir/config/config.cfg

例

構成設定として、Dynamic Converter機能を有効にします。

IsDynamicConverterEnabled=true

Idoc Scriptとして、Dynamic Converterの機能が有効になっているかどうかの評価に使用します。 

<$if IsDynamicConverterEnabled and isTrue(IsDynamicConverterEnabled)$>
    <tr>
      <td align="center" width="75">
        <a href="<$HttpCgiPath$>?IdcService=GET_TEMPLATE_CONVERSIONS">
          <img src="<$HttpImagesRoot$><$admin_conversion_image$>" border="0"
        width="<$adminImageWidth$>" height="<$adminImageHeight$>"></a>
      </td>
      <td width="10">&nbsp;
      </td>
      <td width="245"><span class=largeTableEntry>
        <a href="<$HttpCgiPath$>?IdcService=GET_TEMPLATE_CONVERSIONS">
        <$lc("wwTemplateConversions")$></span></a>
      </td>
    </tr>
<$endif$>

A.177 isEditMode

現在のページのメタデータ・フィールドが編集可能かどうかを指定します。

この変数は、チェックイン・ページとコンテンツ情報更新ページに設定されます。

TRUEに設定した場合、現在のページのメタデータ・フィールドが編集可能になります。

FALSEに設定した場合、現在のページのメタデータ・フィールドは編集できません。

タイプおよび使用方法

出力

  • 現在のページのメタデータ・フィールドが編集可能な場合、TRUEを返します。

  • 現在のページのメタデータ・フィールドが編集できない場合、FALSEを返します。

例

ページの一番上に設定する使用例:

isEditMode=1

スクリプトとしての使用例:

<$if isCheckin or isUpdate or isQuery$>
    <$isFormSubmit = 1$>
    <$if not isQuery$>
        <$isEditMode = 1$>
        <$formName = "Checkin"$>
    <$endif$>
    <$else$>
        <$isFormSubmit = ""$>
        <$isEditMode = ""$>
<$endif$>

A.178 IsEditRev

現在のリビジョンがワークフロー内のエディタ・ステップにあるかどうかを確認します。

TRUEに設定した場合、レビューアはリビジョンのチェックアウト、編集およびチェックインを実行できます。

この変数は、ワークフロー・ステップを「ワークフロー管理」ツールでエディタ・ステップとして定義することによって設定されます。この変数はチェックイン・ページで評価されます。

タイプおよび使用方法

出力

  • 現在のリビジョンがワークフロー内のエディタ・ステップにある場合、TRUEを返します。

  • 現在のリビジョンがワークフロー内のエディタ・ステップにない場合、FALSEを返します。

例

ワークフロー詳細を指定します。

<$if IsEditRev$>
    addCheckinValue("IdcService", "WORKFLOW_CHECKIN");
if (form.isFinished.checked)
    addCheckinValue("isFinished", form.isFinished.value);
<$else$>
    addCheckinValue("IdcService", "CHECKIN_SEL");
<$endif$>

A.179 isExcluded

メタデータ・フィールドをページから完全に除外します。

タイプおよび使用方法

出力

  • メタデータ・フィールドがページから完全に除外された場合、TRUEを返します。

  • メタデータ・フィールドがページから除外されない場合、FALSEを返します。

例

現在のメタデータ・フィールドをページから除外します。

<$isExcluded=1$>

現在のメタデータ・フィールドに対するisExcludedのアクティブ値に応じて、カスタム変数を設定します。

<$isCustomExcluded = getValue("#active", fieldName & ":isExcluded")$>
$isCustomRelocated = getValue("#active", fieldName & ":isRelocated")$>
<$if isCustomExcluded or (isCustomRelocated and not isRelocated) or isExcluded or (isFieldHidden and not isFormSubmit)$>
    <$isFieldExcluded = 1$>
<$endif$>

関連項目

A.180 IsExternalUser

ユーザーが、外部システム(LDAPシステムなど)からコンテンツ・サーバー・インスタンスにアクセスしているかどうかを確認します。

またはプロキシ設定されたサーバー。

タイプおよび使用方法

出力

  • ユーザーが、外部システムからコンテンツ・サーバー・インスタンスにアクセスしている場合、TRUEを返します。

  • ユーザーが、コンテンツ・サーバー・インスタンスに直接アクセスしている場合、FALSEを返します。

例

ユーザーが外部の場所にいるかどうかを確認します。

<$IsExternalUser$>

A.181 IsFailedConversion

Oracle WebCenter Content: Inbound Refineryシステムがコンテンツ・アイテムの変換に失敗したかどうかを確認します。

タイプおよび使用方法

出力

  • 変換プロセスが失敗した場合、TRUEを返します。

  • 変換の失敗が検出されなかった場合、FALSEを返します。

例

変換プロセスが完全でなかった場合、テキストを表示します。

<$if IsFailedConversion$>
    <p><font face="arial" size="2">
    The Refinery was unable to complete the conversion process.</p>
<$endif$>

A.182 IsFailedIndex

インデクサがコンテンツ・アイテムの索引付けに失敗したかどうかを確認します。

タイプおよび使用方法

出力

  • インデクサがコンテンツ・アイテムを索引付けできなかった場合、TRUEを返します。

  • コンテンツ・アイテムが正常に索引付けされた場合、FALSEを返します。

例

コンテンツ・アイテムが索引付けされなかった場合、テキストを表示します。

<$if IsFailedIndex $>
    <p><font face="arial" size="2">
    Unable to index content item.</p>
<$endif$>

A.183 sawflies()

文字列または式がFALSEとして評価されるかどうかを確認します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、評価される文字列または式です。

出力

パラメータが文字列の場合:

  • 文字列がF、f、Nまたはnで始まるか、0の場合、TRUEを返します。

  • 文字列がその他の文字で始まる場合、FALSEを返します。

パラメータが文字列以外の場合:

  • 値が0の場合、TRUEを返します。

  • 値が0以外の場合、FALSEを返します。

例

文字列をfalseに評価して、TRUE (1)を返します。

<$isFalse("false")$>

整数5は1より大きいと評価して、FALSE (0)を返します。

<$isFalse(5>1)$>

等式の結果をゼロとして評価し、TRUE (1)を返します。

<$isFalse(1-1)$>

文字列等価文をtrueとして評価し、FALSE (0)を返します。

<$isFalse(strEquals("abc","abc"))$>

関連項目

A.184 is Field Excluded

メタデータ・フィールドが除外されることを指定します。

タイプおよび使用方法

出力

  • フィールドが除外された場合、TRUEを返します。

  • フィールドが除外されない場合、FALSEを返します。

例

メタデータ・フィールドが除外されるかどうかを判別します。

<$if isCustomExcluded or (isCustomRelocated and not isRelocated) or isExcluded or (isFieldHidden and not isFormSubmit)$>
    <$isFieldExcluded = 1$>
<$endif$>

関連項目

A.185 isFieldHidden

メタデータ・フィールドが非表示になることを指定します。

タイプおよび使用方法

出力

  • フィールドが非表示になる場合、TRUEを返します。

  • フィールドが非表示にならない場合、FALSEを返します。

例

メタデータ・フィールドが非表示になるかどうかを判別します。

<$if isHidden or isCustomHidden$>
    <$isFieldHidden = 1$>
<$else$>
    <$isFieldHidden = ""$>
<$endif$>

関連項目

A.186 isFieldInfoOnly

メタデータ・フィールドが情報専用フィールドあることを指定します。

タイプおよび使用方法

出力

  • フィールドが情報専用フィールドである場合、TRUEを返します。

  • フィールドが情報専用フィールドではない場合、FALSEを返します。

例

メタデータ・フィールドが情報専用であるかどうかを判別します。

<$if isInfo or isCustomInfo or isFieldHidden or isInfoOnly$>
    <$isFieldInfoOnly = 1$>
<$else$>
    <$isFieldInfoOnly = ""$>
<$endif$>

関連項目

A.187 isFieldMemo

メタデータ・フィールドがメモ・フィールドあることを指定します。

タイプおよび使用方法

出力

  • フィールドがメモ・フィールドである場合、TRUEを返します。

  • フィールドがメモ・フィールドではない場合、FALSEを返します。

例

フィールドがメモ・フィールドであるかどうかを判別します。

<@dynamichtml compute_std_entry_type_info@>
<$if not hasOptionList and #active.fieldType like "Memo"$>
    <$isFieldMemo = 1$>
<$else$>
    <$isFieldMemo = ""$>
<$endif$>
<@end@>

関連項目

A.188 IsFilePresent

現在表示中のページが、コンテンツ情報ページでRevision History表の作成中にループされるリビジョンを対象としているかどうかを確認します。

タイプおよび使用方法

出力

  • 現在のリビジョンと同じリビジョンでループしている場合、TRUEを返します。

  • 現在のリビジョンとは別のリビジョンでループしている場合、FALSEを返します。

例

現在のリビジョンでループしている場合、リビジョン番号はプレーン・テキストとして表示されます。現在のリビジョン以外でループしている場合、リビジョン番号はアクティブ・ボタンとして表示されます。

<@dynamichtml doc_rev_info@>
<$if IsFilePresent$>
  <td width=10% align=center><span class=strongHighlight><$dRevLabel$></span></td>
  <td nowrap width=30%><span class=strongHighlight><$dInDate$></span></td>
  <td nowrap width=30%><span class=strongHighlight>
    <$if dOutDate$><$dOutDate$><$else$><$lc("wwNone")$><$endif$></span></td>
      <td width=20%><span class=strongHighlight>
      <$rptDisplayMapValue("StatusList", dStatus)$></span></td>
    <$else$>
  <td width=10%><form action="<$HttpCgiPath$>" method=GET>
  <input type=hidden name=IdcService value="DOC_INFO">
  <input type=hidden name=dID value="<$dID$>">
  <input type=hidden name=dDocName value="<$dDocName$>">
  <input type=submit value="       <$dRevLabel$>      ">
  </form></td>
...
<@end@>

A.189 isFormSubmit

現在のページが送信可能なHTMLフォームであるかどうかを指定します。

TRUEに設定した場合、現在のページは送信可能なHTMLフォームです。

FALSEに設定した場合、現在のページは送信可能なHTMLフォームではありません。

タイプおよび使用方法

出力

  • ページが送信可能なHTMLフォームである場合、TRUEを返します。

  • ページが送信可能なHTMLフォームでない場合、FALSEを返します。

例

ページの一番上に設定する使用例:

isFormSubmit=1

ページが送信可能なHTMLフォームでない場合、フィールド・キャプションの後にコロンが1つ追加されます。

<@dynamichtml std_field_caption@>
    <span class=<$fieldCaptionStyle$>>
    <$fieldCaption$><$if not isFormSubmit$><$":"$><$endif$>
    </span>
<@end@>

A.190 IsFullTextIndexed

インデクサがコンテンツ・アイテムを全文索引作成したかどうかを確認します。

タイプおよび使用方法

出力

  • コンテンツ・アイテムが全文索引作成された場合、TRUEを返します。

  • コンテンツ・アイテムが全文索引作成されなかった場合、FALSEを返します。

例

コンテンツ・アイテムが全文索引作成されている場合、指定されたURLが設定されます。

<$if IsFullTextIndexed$>
    <a href="<$redirect$>">
<$endif$>

A.191 isHidden

メタデータ・フィールドをユーザーに対して非表示にしますが、フィールドは非表示データとしてページにインクルードされます。

タイプおよび使用方法

出力

  • メタデータ・フィールドがページで非表示になる場合、TRUEを返します。

  • メタデータ・フィールドがページで非表示にならない場合、FALSEを返します。

例

現在のメタデータ・フィールドをユーザーに対して非表示にします。

<$isHidden=1$>

現在のメタデータ・フィールドに対するisHiddenのアクティブ値に応じて、カスタム変数を設定します。

<$isCustomHidden = getValue("#active", fieldName & ":isHidden")$>
    <$if isHidden or isCustomHidden$>
<$isFieldHidden = 1$>
<$else$>
    <$isFieldHidden = ""$>
<$endif$>

関連項目

A.192 isInfo

現在のページが情報専用ページであるかどうかを指定します。

TRUEに設定した場合、現在のページは情報専用ページとして特定されます。

FALSEに設定した場合、現在のページは情報専用ページとして特定されません。

タイプおよび使用方法

出力

  • ページが情報専用ページである場合、TRUEを返します。

  • ページが情報専用ページでない場合、FALSEを返します。

例

ページの一番上に設定する使用例:

isInfo=1

スクリプトとしての使用例:

<$if isInfo$>
    <$captionFieldWidth="30%"$>
    <$captionEntryWidth="70%"$>
<$elseif isEditMode$>
    <$captionFieldWidth="20%"$>
    <$captionEntryWidth="80%"$>
<$endif$>

A.193 isInfoOnly

メタデータ・フィールドを、入力フィールドとしてではなく、情報専用として表示します。

タイプおよび使用方法

出力

  • メタデータ・フィールドが情報専用として表示される場合、TRUEを返します。

  • メタデータ・フィールドが編集可能な場合、FALSEを返します。

例

現在のメタデータ・フィールドを情報専用として表示します。

<$isInfoOnly=1$>

現在のメタデータ・フィールドに対するisInfoOnlyのアクティブ値に応じて、カスタム変数を設定します。

<<$isCustomInfo = getValue("#active", fieldName & ":isInfoOnly")$>
<$if isInfo or isCustomInfo or isFieldHidden or isInfoOnly$>
    <$isFieldInfoOnly = 1$>
<$else$>
    <$isFieldInfoOnly = ""$>
<$endif$>

関連項目

A.194 IsIntranetAuthOnly

デフォルト認可タイプをintranetに設定します。

TRUEに設定すると、Webサーバー・フィルタは認可タイプがintranetであるとみなします。ユーザーが初めてコンテンツ・サーバー・インスタンスにログインしてCGI URLにアクセスすると、Oracleデータベース・セキュリティでなくNTLMセキュリティが使用されます。

FALSEに設定すると、いかなる認可タイプも前提されません。

デフォルトはFALSEです。

タイプおよび使用方法

場所

IntradocDir/config/config.cfg

例

構成エントリとしての使用例:

IsIntranetAuthOnly=true

A.195 IsJava

コンテンツ・サーバーWebページのローカル・データを表示します。

この変数は、ページのフラグとして、またはサービス・コールのパラメータとして設定できます。

タイプおよび使用方法

出力

TRUEに設定した場合、DataBinderにあるローカル・データをHDAフォーマットで返します。

例

コンテンツ・サーバーWebページのコードにインクルードされた場合、ページのローカル・データが表示されます。

<$IsJava=1$>

コンテンツ・サーバーのURLにインクルードされた場合、「新規チェックイン」ページのローカル・データが表示されます。

http://myinstance.com/idcplg/idc_cgi_isapi-instance.dll?IdcService=CHECKIN_NEW_FORM&IsJava=1

A.196 isLayoutEnabled()

特定のレイアウトがインストールされ、有効になっているかどうかの判別に使用します。

タイプおよび使用方法

パラメータ

1つのパラメータとしてレイアウトのIDを取ります。

例

std_resources.htmファイルの場合:

<$if isLayoutEnabled("Trays")$><$do Publish=1$><$endif$>

A.197 isLinkActive

ユーザー名などの指定された条件に基づいて、チェックインまたは検索に対するプロファイルの表示にこのプロファイルを含めるかどうかを判別するために、Idoc Scriptによって使用されます。指定された条件がtrueに評価される場合、isLinkActiveの値はtrue (1)に設定されて、プロファイルは使用可能なプロファイルのリストに含まれます。

タイプおよび使用方法

パラメータ

パラメータは存在せず、評価された条件に基づいて1または0 (trueまたはfalse)が設定されるだけです。

例

句が1つのみの条件セットのデフォルト・スクリプトがあるとします。ユーザー名が"guest"と一致する場合、isLinkActiveは1に設定され、プロファイルはそのユーザーの使用可能なプロファイルのリストに含まれます。

<$if getUserValue("dName") like "guest"$> 
<$isLinkActive=1$> 
<$endif$>

A.198 IsLocalSearchCollectionID

コンテンツ・アイテムがローカル検索コレクションにあるかどうかを確認します。ローカル検索コレクションの中でコンテンツ・アイテムのコンテンツIDを検索します。

タイプおよび使用方法

出力

  • コンテンツ・アイテムがローカル・コレクションにある場合、TRUEを返します。

  • コンテンツ・アイテムがローカル・コレクションに見つからない場合、FALSEを返します。

例

コンテンツ・アイテムがローカル・コレクションからのものであるかどうかを評価します。

<@dynamichtml searchapi_define_result_doc_parameters@>
<$exec IsLocalSearchCollection="1"$>
<$if not IsLocalSearchCollectionID$>
    <!--Collection has external ID-->
<$exec IsLocalSearchCollection=""$>

A.199 IsLoggedIn

現在のユーザーがログインしているかどうかを確認します。

タイプおよび使用方法

出力

  • ユーザーがログインしている場合は、TRUEを返します。

  • ユーザーがログインしていない場合は、FALSEを返します。

例

関数を実行する前に、ユーザーがログインしていて、電子メール・アドレスを持っているかどうかを確認します。

<@dynamichtml subscription_action_script@>
function allowSubscription(form)
    {<$if IsLoggedIn$>
    <$if IsUserEmailPresent$>
    <$else$>
…}
<@end@>

A.200 IsMac

クライアント・ブラウザがMacintoshオペレーティング・システムで実行しているかどうかを確認します。

タイプおよび使用方法

出力

  • クライアント・ブラウザがMacで実行している場合、TRUEを返します。

  • クライアント・ブラウザがMacで実行していない場合、FALSEを返します。

例

ブラウザがMacで実行している場合、別のURLにリダイレクトします。 

<$if IsMac$>
    <a href="<$redirect$>">
<$endif$>

A.201 IsMaxRows

「処理中コンテンツ」ページまたは「レポート」ページにMaxQueryRows設定の許容値を超える結果が表示されているかどうかを確認します。詳細は、『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のMaxQueryRowsに関する項を参照してください。

タイプおよび使用方法

出力

  • 結果数が許容される行数よりも多い場合、TRUEを返します。

  • 結果数が許容される行数よりも少ない場合、FALSEを返します。

例

最大行数を超えた場合、エラー・メッセージを返します。

<$elseif IsMaxRows$>
<table border=0 cellpadding=1 cellspacing=1 width="100%">
    <tr>
    <span class=smallHighlight><$lc("wwOutputLimitedByMaxRows")$>
    </span>
</tr>
</table>

A.202 isMultiOption

メタデータ・フィールドのオプション・リストで複数の値が選択できることを指定します。

タイプおよび使用方法

出力

  • フィールドが複数選択オプション・リストである場合、TRUEを返します。

  • フィールドが複数選択オプション・リストではない場合、FALSEを返します。

例

フィールドが複数選択オプション・リストであることを指定します。

<$isMultiOption=1$>

オプション・リストのタイプを決定します。

<$if #active.fieldOptionListType like "*multi*"$>
    <$exec isMultiOption=1$>
<$elseif #active.fieldOptionListType like "access*"$>
    <$exec isAccessList=1$>
    <$exec isStrictList=1$>
<$elseif not (#active.fieldOptionListType like "*combo*")$>
    <!--Strict choice-->
    <$exec isStrictList=1$>
<$endif$>

関連項目

A.203 IsMultiPage

検索結果に対して複数のページが必要かどうかを確認します。この変数は、 ResultCount 入力変数により定義される1ページ当たりの表示行数(デフォルトは25)に依存します。

タイプおよび使用方法

出力

  • 検索結果数が1ページ当たりの許容行数よりも多い場合、TRUEを返します。

  • 検索結果数が1ページ当たりの許容行数よりも少ない場合、FALSEを返します。

例

行数を評価して、複数のページが必要かどうかを判別します。

<$IsMultiPage$>

A.204 isNew

コンテンツ・アイテムが新規であるか、またはリビジョンであるかどうかを確認します。この変数は、CHECKIN_NEW_FORMおよびCHECKIN_SIMILAR_FORMの各標準サービスによってTRUEに設定されます。

タイプおよび使用方法

出力

  • コンテンツ・アイテムが新規である場合、TRUEを返します。

  • コンテンツ・アイテムが既存のコンテンツ・アイテムのリビジョンである場合、FALSEを返します。

例

コンテンツ・アイテムが新規である場合、指定されたサービスが実行されます。

<$if isNew$>
    <input type=hidden name=IdcService value="CHECKIN_NEW">
<$endif$>

コンテンツ・アイテムがリビジョンである場合、元のコンテンツ・アイテム作成者が使用されます。

<$if not isNew$>value="<$dDocAuthor$>"<$endif$>

コンテンツ・アイテムが新規である場合、現在のユーザーのデフォルト・アカウントが使用されます。

<$if isNew$>
    <$defaultAccounts$>
<$endif$>

A.205 IsNotLatestRev

リビジョンがチェックイン対象の最後のリビジョンであるかどうかを確認します。これは、必ずしも最後にリリースされたリビジョンとはかぎりません。

タイプおよび使用方法

出力

  • コンテンツ・アイテムがチェックイン対象の最新のリビジョン以外である場合、TRUEを返します。

  • コンテンツ・アイテムがチェックイン対象の最新のリビジョンである場合、FALSEを返します。

例

最新のリビジョンを確認します。

<$IsNotLatestRev$>

関連項目

A.206 IsNotSyncRev

リビジョンID (dID)の比較を実行することにより、クライアント・コンピュータのファイルが最新のリビジョンと一致するかどうかを確認します。

この変数は通常、コンテンツ・アイテムのローカル・コピーが最新リビジョンに更新されていない場合に、エラー・メッセージを表示するために使用します。

この変数は、クライアント側の製品(Desktopなど)とのインタフェースとして使用します。

タイプおよび使用方法

出力

  • リビジョンが一致しない場合、TRUEを返します。

  • リビジョンが一致する場合、FALSEを返します。

例

最新リビジョンとの一致を確認して、エラー・メッセージを表示します。

<$if IsNotSyncRev$>
The local copy of this content item has not been updated to the latest revision. 
    Use Get Native File or Check Out to update your local copy of <$dDocName$>.
<$endif$>

A.207 IsOverrideFormat

ユーザーがチェックイン時に別の変換フォーマットを選択できるようにします。

TRUEに設定した場合、チェックイン・ページの「プライマリ・ファイル」および「代替ファイル」に対して「フォーマット」オプション・リストが表示されます。

デフォルトはFALSEです。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • フィールド表示

場所

  • 「システム・プロパティ」、「オプション」タブ、「チェックイン時にフォーマットのオーバーライドを許可」

  • 「管理」、「管理サーバー」、「一般構成」メニュー・オプション、「チェックイン時のフォーマットのオーバーライドを許可する」

  • IntradocDir/config/config.cfg

例

構成設定の使用例:

IsOverrideFormat=true

Idoc Scriptとして、フォーマットのオーバーライド関数の値を返します。

<$IsOverrideFormat$>

A.208 IsPageDebug

すべてのインクルードのトレースを有効にして、Idoc Scriptのeval関数をコールします。

eval関数のコンテンツと動的に割り当てられたすべてのインクルードも、トレースの一部として表示されます。トレースは、includeコールまたはevalコールのネストされたレベルごとに1つの+文字ずつインデントされます。トレースでは、すべてのエラー・メッセージ(ネストされた場所情報を含まない)と、Idoc Scriptのすべてのtrace関数コールの出力も表示されます。

注意:

この設定は、Internet Explorerバージョン6ではサポートされていません。

タイプおよび使用方法

出力

トレースの結果は、Webページの一番下に表示されるデバッグ・トレースからアクセス可能なデバッグ・メニュー・ツールバー・オプションを介して表示できます。

デバッグ・トレースをクリックしてデバッグ・メニュー・ツールバーを表示し、次のオプションのいずれかをクリックします。

要素 説明

「すべて非表示」

開いているデバッグ・ポップアップをすべて非表示にします。

「Idocスクリプト・トレース」

コールされるすべてのインクルードのツリー構造ビューを表示します。

「リクエスト・バインダ」

ローカル・データおよびResultSetに関する情報を表示します。リクエスト・バインダはサーバーに送信されるDataBinder、つまり、サービス名とすべてのサービス固有のパラメータです。見出しをクリックして、詳細情報のビューを展開します。

「レスポンス・バインダ」

ローカル・データおよびResultSetに関する情報を表示します。レスポンス・バインダは、サービスの処理直後、ただしレスポンス・ページ生成前のDataBinderです。見出しをクリックして、詳細情報のビューを展開します。

「最終ページ・バインダ」

ローカル・データおよびResultSetに関する情報を表示します。最終ページ・バインダは、ページの生成中にDataBinderで変更された内容を反映しています。見出しをクリックして、詳細情報のビューを展開します。

「JavaScriptログ」

デフォルト設定値Verboseが指定されているロガー・コンソール・ウィンドウを表示します。チェックボックスを選択して、次の各オプション、「情報」、「警告」、「エラー」、「時間」、「ウィンドウ」、「トレース」、「グローバル」、「スキーマ」、「JavaScript」、「LogReader」を表示します。「一時停止」または「クリア」をクリックして、ロガー・コンソールに表示される情報の速度と量を制御します。

コンテンツ・サーバーとのAPIレベルの相互作用については、リクエスト・バインダとレスポンス・バインダを参照してください。たとえば、SOAPリクエストを実行したり、その他のサービスに基づくAPIを使用するときには、最終ページ・バインダの情報は意味がなくなります。IsJava=1をリクエストに追加すると、レスポンス・バインダがHDAフォーマットで返されます。

カスタマイズ、ページの生成などに関しては、最終ページ・バインダを参照して、レスポンス・バインダとの相違を判別することもできます。

例

コンテンツ・サーバーのconfig.cfgファイルで構成設定として使用されるため、サーバー全体に適用されます。

IsPageDebug=1

Webブラウザで、「アドレス」フィールドでページのURLの末尾に追加される場合:

&IsPageDebug=1

テンプレート・ページまたはIdoc Scriptインクルードで使用される場合:

<$IsPageDebug=1$>

関連項目

A.209 IsPromptingForLogin

コンテンツ・サーバー・インスタンスがログインを確認するように設定されているか、またはログインがプログラムによって処理中であるかどうかを確認します。

Cookieログイン・ページでユーザーがまだログインしていないために最後のリクエストが失敗したような状況で、この変数はTRUEに設定されます。

タイプおよび使用方法

出力

  • コンテンツ・サーバー・インスタンスがログインを確認するように設定されている場合、TRUEを返します。

  • ログインがプログラムによって処理中である場合、FALSEを返します。

例

サーバーがログインを確認するように設定されているかどうかを評価します。

<$IsPromptingForLogin$>

A.210 IsProxiedServer

コンテンツ・サーバー・インスタンスがプロキシ設定されたサーバーであると指定します。

TRUEに設定した場合、コンテンツ・サーバー・インスタンスはプロキシ設定されたサーバーです。

マスター・コンテンツ・サーバー・インスタンスの場合、デフォルトはありません。

プロキシ設定されたコンテンツ・サーバー・インスタンスの場合、デフォルトはTRUEです。

タイプおよび使用方法

場所

IntradocDir/config/config.cfg

例

構成エントリとしての使用例:

IsProxiedServer=true

A.211 isQuery

現在のページが検索ページかどうかを指定します。

TRUEに設定した場合、現在のページが検索ページとして特定されます。

FALSEに設定した場合、現在のページは検索ページとして特定されません。

タイプおよび使用方法

出力

  • ページが検索ページである場合、TRUEを返します。

  • ページが検索ページでない場合、FALSEを返します。

例

ページの一番上に設定する使用例:

isQuery=1

スクリプトとしての使用例:

<$if isCheckin or isUpdate or isQuery$>
    <$isFormSubmit = 1$>
    <$if not isQuery$>
<$isEditMode = 1$>
<$formName = "Checkin"$>
    <$endif$>
    <$else$>
<$isFormSubmit = ""$>
<$isEditMode = ""$>
<$endif$>

A.212 isRelocated

インクルードの評価中にローカル変数がTRUEに設定されていないかぎり、メタデータ・フィールドを除外します。

この変数は通常、メタデータ・フィールドにカスタムの場所を設定するために使用します。フィールドをページ上で複数回定義することができ、実際に生成されるフィールドの場所はこの変数の値に依存します。

タイプおよび使用方法

出力

  • メタデータ・フィールドがページのその場所にインクルードされる場合、TRUEを返します。

  • メタデータ・フィールドがページのその場所から除外される場合、FALSEを返します。

例

現在のメタデータ・フィールドをページにインクルードします。

<$isRelocated=1$>

現在のメタデータ・フィールドに対するisRelocatedのアクティブ値に応じて、カスタム変数を設定します。

<$isCustomExcluded = getValue("#active", fieldName & ":isExcluded")$>
<$isCustomRelocated = getValue("#active", fieldName & ":isRelocated")$>
<$if isCustomExcluded or (isCustomRelocated and not isRelocated) or isExcluded or (isFieldHidden and not isFormSubmit)$>
    <$isFieldExcluded = 1$>
<$endif$>

関連項目

A.213 IsRequestError

StatusCode変数を評価することにより、コンテンツ・サーバー・インスタンスにリクエスト・エラー状態が存在するかどうかを確認します。

StatusCodeが負の数値(-1)に設定された場合、コンテンツ・サーバー・インスタンスにリクエスト・エラー状態が存在します。

リクエスト・エラー状態が存在する場合の標準的な動作は、現在のページの表示を中止して、エラー・ページを置換することです。

タイプおよび使用方法

出力

  • コンテンツ・サーバー・インスタンスにリクエスト・エラー状態が存在する場合(StatusCode = -1)、TRUEを返します。

  • コンテンツ・サーバー・インスタンスにリクエスト・エラー状態が存在しない場合(StatusCodeが負の数値以外)、FALSEを返します。

例

リクエスト・エラー状態を評価します。

<$IsRequestError$>

関連項目

A.214 isRequired

メタデータ・フィールドの値が必須であるかどうかを指定します。

TRUEに設定した場合、メタデータ・フィールドは必須です。

FALSEに設定した場合、メタデータ・フィールドはオプションです。

タイプおよび使用方法

出力

  • メタデータ・フィールドが必須である場合、TRUEを返します。

  • メタデータ・フィールドがオプションである場合、FALSEを返します。

例

dDocTitle メタデータ・フィールドを必須フィールドとして定義します。

<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1,
    fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle")$>

関連項目

A.215 IsSavedQuery

問合せが現在のユーザーのポータル・ナビゲーション・バーに保存されたかどうかを確認します。

タイプおよび使用方法

出力

  • 現在の問合せが保存されている場合、TRUEを返します。

  • 現在の問合せが保存されていないか、問合せが見つからない場合、FALSEを返します。

例

問合せのステータスを評価します。

<$IsSavedQuery$>

A.216 IsSoap

コンテンツ・サーバーWebページのローカルSOAPデータを表示します。

この変数は、ページのフラグとして、またはサービス・コールのパラメータとして設定できます。

タイプおよび使用方法

出力

TRUEに設定した場合、基礎となるSOAPコードをXMLフォーマットで返します。

例

コンテンツ・サーバーWebページのコードにインクルードされた場合:

<$IsSoap=1$>

コンテンツ・サーバーURLにインクルードされた場合:

http://myinstance.com/idcplg/idc_cgi_isapi-instance.dll?IdcService=CHECKIN_NEW_FORM&IsSoap=1

A.217 isStrictList

メタデータ・フィールドのオプション・リストでは複数の値が選択できないことを指定します。

タイプおよび使用方法

出力

  • フィールドが複数選択オプション・リストではない場合、TRUEを返します。

  • フィールドが複数選択オプション・リストである場合、FALSEを返します。

例

フィールドが複数選択オプション・リストではないことを指定します。

<$isStrictList=1$>

オプション・リストのタイプを決定します。

<$if #active.fieldOptionListType like "*multi*"$>
    <$exec isMultiOption=1$>
<$elseif #active.fieldOptionListType like "access*"$>
    <$exec isAccessList=1$>
    <$exec isStrictList=1$>
<$elseif not (#active.fieldOptionListType like "*combo*")$>
    <!--Strict choice-->
    <$exec isStrictList=1$>
<$endif$>

関連項目

A.218 IsSubAdmin

現在のユーザーが少なくとも1つの管理アプリケーションに対して副管理者権限を持っているかどうかを確認します。

タイプおよび使用方法

出力

  • ユーザーが副管理者権限を持っている場合、TRUEを返します。

  • ユーザーが副管理者権限を持っていない場合、FALSEを返します。

例

関数を実行する前に、ユーザーがログインしていて、副管理者権限を持っているかどうかを確認します。

<@dynamichtml subscription_action_script@>
    function allowSubscription(form)
    {
    <$if IsLoggedIn$>
    <$if IsSubAdmin$>
    <$else$>
    …
    }
<@end@>

A.219 IsSun

クライアント・ブラウザがSunシステムで実行しているかどうかを確認します。

タイプおよび使用方法

出力

  • クライアント・ブラウザがSunで実行している場合、TRUEを返します。

  • クライアント・ブラウザがSunで実行していない場合、FALSEを返します。

例

ブラウザがSunで実行している場合、別のURLにリダイレクトします。

<$if IsSun$>
    <a href="<$redirect$>">
<$endif$>

A.220 IsSysManager

現在のユーザーがsysmanagerロールを持っているかどうか、つまり、コンテンツ・サーバー管理へのアクセス権を持っているかどうかを確認します。この変数は通常、特定のナビゲーション・リンクを条件付きで表示するために使用します。

タイプおよび使用方法

出力

  • ユーザーがsysmanagerロールを持っている場合、TRUEを返します。

  • ユーザーがロールを持っていない場合、FALSEを返します。

A.221 isTrue()

文字列または式がTRUEとして評価されるかどうかを確認します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、評価される文字列または式です。

出力

パラメータが文字列の場合:

  • 文字列がT、t、Y、yで始まるか、1の場合、TRUEを返します。

  • 文字列がその他の文字で始まる場合、FALSEを返します。

パラメータが文字列以外の場合:

  • 値が0以外の場合、TRUEを返します。

  • 値が0の場合、FALSEを返します。

例

文字列をyesに評価して、TRUE (1)を返します。

<$isTrue("yes")$>

整数5は1より大きいと評価して、TRUE (1)を返します。

<$isTrue(5>1)$>

等式の結果をゼロとして評価し、FALSE (0)を返します。

<$isTrue(1-1)$>

文字列等価文をtrueとして評価し、TRUE (1)を返します。

<$isTrue(strEquals("abc","abc"))$>

関連項目

A.222 isUpdate

現在のページがコンテンツ情報更新ページかどうかを指定します。

TRUEに設定した場合、現在のページがコンテンツ情報更新ページとして特定されます。

FALSEに設定した場合、現在のページがコンテンツ情報更新ページとして特定されません。

タイプおよび使用方法

出力

  • 現在のページがコンテンツ情報更新ページである場合、TRUEを返します。

  • 現在のページがコンテンツ情報更新ページではない場合、FALSEを返します。

例

ページの一番上に設定する使用例:

isUpdate=1

スクリプトとしての使用例:

<$if isCheckin or isUpdate or isQuery$>
    <$isFormSubmit = 1$>
    <$if not isQuery$>
        <$isEditMode = 1$>
        <$formName = "Checkin"$>
    <$endif$>
    <$else$>
        <$isFormSubmit = ""$>
        <$isEditMode = ""$>
<$endif$>

A.223 isUploadFieldScript

JavaScript内でインクルードが使用中であることを指定します。メタデータ・フィールドのアップロード方法の決定に使用します。

TRUEに設定した場合、インクルードがJavaScript内で使用中です。

FALSEに設定した場合、インクルードがJavaScript内で使用中です。

タイプおよび使用方法

出力

  • インクルードがJavaScript内で使用中である場合、TRUEを返します。

  • インクルードがJavaScript内で使用されていない場合、FALSEを返します。

例

JavaScript Wrapperを定義するインクルードに設定します。

<@dynamichtml std_upload_java_script@>
    <script language="JavaScript">
    // Java script for uploading.
    <$isUploadFieldScript = 1$>
    <$include std_upload_info_script$>
    <$isUploadFieldScript = ""$>
    </script>
<@end@>

スクリプトとしての使用例:

<$if isUploadFieldScript$>
    <$defaultFieldInclude = "std_file_entry"$>
<$else$>
    <$defaultFieldInclude = "std_nameentry_row"$>
    <$fieldCaptionInclude = "std_field_caption"$>
    <$fieldEntryInclude = "std_file_entry"$>
<$endif$>

A.224 IsUploadSockets

アップロード・ソケットを使用する必要があるかどうかを判別するために、Uploadアプレットによって使用されます。

これは内部フラグであり、ユーザー構成を対象としていません。

タイプおよび使用方法

出力

  • アップロード・ソケットがUploadアプレットで使用するように定義されている場合、TRUEを返します。

  • アップロード・ソケットを使用する必要がない場合、FALSEを返します。

例

N/A

A.225 IsUserEmailPresent

現在のユーザーに対して電子メール・アドレスが定義されているかどうかを確認します。

タイプおよび使用方法

出力

  • ユーザーに対して電子メール・アドレスが定義されている場合、TRUEを返します。

  • ユーザーに対して電子メール・アドレスが定義されていない場合、FALSEを返します。

例

関数を実行する前に、ユーザーがログインしていて、電子メール・アドレスを持っているかどうかを確認します。

<@dynamichtml subscription_action_script@>
    function allowSubscription(form)
    {
    <$if IsLoggedIn$>
    <$if IsUserEmailPresent$>
    <$else$>
    …
    }
<@end@>

A.226 isUserOverrideSet()

ユーザーが他のユーザー向けにコンテンツをチェックインできるようにします。

これは、チェックイン・ページの「作成者」オプション・リストに影響します。デフォルトでは、管理者のみが、チェックイン時に別のユーザーを作成者として指定できます。

タイプおよび使用方法

パラメータ

唯一のパラメータは値TRUEまたはFALSEです。

出力

ユーザーのオーバーライドが有効になっている場合、TRUEに評価します。

例

別のユーザーが作成者として指定されているコンテンツ・アイテムを、ユーザーがチェックインできるようになります。

<$isUserOverrideSet(true)$>

関連項目

A.227 isValidateFile()

Uploadアプレットのパラメータとして使用されます。この変数は、アップロードするファイルが存在することを検証します。使用するには、std_page.htmリソース・ファイル内のstd_multiupload_applet_definitionインクルードに定義されているアプレットの定義を上書きするコンポーネントを作成する必要があります。

タイプおよび使用方法

例

構成エントリとしての使用例:

isValidateFile=true

A.228 isVerboseTrace

コアでセクションがトレースされているかどうかを確認します。詳細トレースによって、完全なレポートが生成されます。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • デバッグ

出力

  • トレースが「詳細」に設定されている場合、TRUEを返します。

  • トレースが他のデバッグ・レベルに設定されている場合、FALSEを返します。

例

<$isVerboseTrace()$>

関連項目

A.229 IsWindows

クライアント・ブラウザがWindowsオペレーティング・システムで実行しているかどうかを確認します。

タイプおよび使用方法

出力

  • クライアント・ブラウザがWindowsで実行している場合、TRUEを返します。

  • クライアント・ブラウザがWindowsで実行していない場合、FALSEを返します。

例

ブラウザがWindowsで実行している場合、別のURLにリダイレクトします。

<$if IsWindows$>
    <a href="<$redirect$>">
<$endif$>

A.230 IsWorkflow

チェックイン・ページのコンテンツ・アイテムがワークフロー内にあるかどうかを確認します。

タイプおよび使用方法

出力

  • コンテンツ・アイテムがワークフロー内にある場合、TRUEを返します。

  • コンテンツ・アイテムがワークフロー内にない場合、FALSEを返します。

A.231 IsXml

URLでTRUEに設定されたときのHTMLフォームのRawダンプをHCSPファイルまたはHCSFファイルに表示します。これは、フォーム・データを抽出したり、フォームをリモート・アプリケーションから送信したりする場合に役立ちます。

タイプおよび使用方法

出力

  • フォームに含まれているXMLデータを返します。

関連項目

A.232 isZoneSearchField

この関数は、全文検索用のフィールドの指定に使用します。

タイプおよび使用方法

パラメータ

確認されるフィールドの名前。

A.233 js()

"..." JavaScriptリテラル文字列宣言で使用するように文字列をフォーマット化します。

この関数は、二重引用符を一重引用符に変更するなどの文字列操作を実行します。

タイプおよび使用方法

パラメータ

唯一のパラメータは文字列です。

出力

JavaScript文字列宣言で使用するようにフォーマット化された文字列を返します。

例

JavaScript文字列宣言で使用するために文字列variablestringをフォーマット化します。

<$js("variablestring")$>

A.234 jsFilename()

スキーマで使用されます。オペレーティング・システムとJava Script(エンコード機能を実行)で必要とされる有効なファイル名文字列の中に非ASCII文字が含まれている可能性のある文字列をエンコードします。

タイプおよび使用方法

パラメータ

唯一のパラメータは、エンコードする文字列です。

出力

エンコードされた文字列を返します。

例

<$jsFilename(fileName)$>

A.235 Json

コンテンツ・サーバーWebページのローカル・データを表示します。

この変数は、ページのフラグとして、またはサービス・コールのパラメータとして設定できます。

タイプおよび使用方法

出力

TRUEに設定した場合、JavaScriptオブジェクト内のDataBinderにあるローカル・データを、JSON (JavaScript Over Network)仕様に準拠して返します。

例

コンテンツ・サーバーWebページのコードにインクルードされた場合、ページのローカル・データが表示されます。

<$Json=1$>

コンテンツ・サーバーのURLにインクルードされた場合、「新規チェックイン」ページのローカル・データが表示されます。

http://myinstance.com/idcplg/idc_cgi_isapi-instance.dll?IdcService=CHECKIN_NEW_FORM&Json=1

A.236 lastEntryTs

ワークフロー・ステップに最後に入った時間のタイムスタンプを取得します。

この変数は条件文の作成に使用できますが、ハードコード化したり変更したりしないようにしてください。

最後のエントリ時間がコンパニオン・ファイルの中でローカライズされ、キーに保持されます。

<step_name>@<workflow_name>.lastEntryTs

タイプおよび使用方法

出力

dateCurrentにより定義されたフォーマットでタイムスタンプを返します。

例

次のコードではLastEntryというジャンプを定義します。これは、親ワークフローに出て、最後にステップに入ったときが1週間以上前であったかどうかをレビューアに通知します。

<$if parseDate(wfCurrentGet("lastEntryTs")) < parseDate(dateCurrent(-7))$>
    <$wfSet("WfJumpName","LastEntry")$>
    <$wfSet("WfJumpTargetStep",wfExit(0,0))$>
    <$wfSet("WfJumpEntryNotifyOff","0")$>
<$endif$>

A.237 lc()

現在のユーザーのロケールに基づいてローカライズ文字列の値を取得します。

タイプおよび使用方法

パラメータ

1つの必須パラメータと任意の数のオプション・パラメータを取ります。

  • 最初のパラメータはローカライズ・キー(apLabelHelpまたはwwMyStringなど)です。

  • オプション・パラメータは、ローカライズされた文字列内の中カッコで囲まれた引数(たとえば、{1})に従って解決される式です。

出力

  • 現在のユーザーのロケールに対するローカライズ文字列の値を返します。

  • 値が見つからない場合、文字列ID(wwMyStringなど)を返します。

例

検索ページでメタデータ検索演算子のオプションを取得します。

<select name="op" >
    <option value="Contains"><$lc("wwContains")$>
    <option value="Matches"><$lc("wwMatches")$>
    <option value="Starts"><$lc("wwStarts")$>
    <option value="Ends"><$lc("wwEnds")$>
    <option selected value="Substring"><$lc("wwSubstring")$>
</select>

通知電子メールworkflow startedの件名行を設定します。ワークフローの名前(dWfName)がMarketingである場合、英語の結果値はWorkflow 'Marketing' has been startedとなります。

<@dynamichtml wf_started_subject@>
    <$lc("wwWfStarted", dWfName)$>
<@end@>

A.238 lcCaption()

文字列をキャプションに折り返す機能。この場合は通常、文字列の右にコロンが1つ入ります。右から左に読む言語の場合(ヘブライ語、アラビア語など)、コロンは文字列の左に入ります。

タイプおよび使用方法

パラメータ

1つの必須パラメータを取ります。

  • 折り返す文字列。

  • オプション・パラメータは、ローカライズされた文字列内の中カッコで囲まれた引数(たとえば、{1})に従って解決される式です。

A.239 LmDefaultLayout()

使用するデフォルトのレイアウト(「トレイ」、「トップ・メニュー」など)を定義します。

デフォルトのインストール値は「トレイ」です。

タイプおよび使用方法

場所

IntradocDir/config/config.cfg

例

LmDefaultLayout=Top Menus

A.240 LmDefaultSkin()

使用するデフォルトのスキン(Oracle、Oracle2など)を定義します。

タイプおよび使用方法

場所

IntradocDir/config/config.cfg

例

LmDefaultSkin=Oracle

A.241 lmGetLayout()

ユーザーにより選択されたレイアウト(「トレイ」、「トップ・メニュー」など)を取得します。

タイプおよび使用方法

パラメータ

なし。

例

<$lmGetLayout()$>

関連項目

A.242 lmGetSkin()

ユーザーにより選択されたスキンを取得します。

タイプおよび使用方法

パラメータ

なし。

例

<$lmGetSkin()$>

関連項目

A.243 loadCollectionInfo()

検索コレクションのメタデータをロードします。

検索コレクションに関するメタデータをロードするために、検索サービスで使用されます。

この関数は、ユーザー構成を対象としていません。

タイプおよび使用方法

パラメータ

1つのパラメータとして、ロードされる検索コレクションの名前を取ります。

出力

なし。

例

検索コレクション情報をロードします。

<$loadCollectionInfo(collection_name)$>

A.244 loadDocMetaDefinition()

DocMetaDefinitionデータベース表をResultSetとしてアクティブ・データにロードします。

DocMetaDefinitionデータベース表は、ロードした後でループできます。

タイプおよび使用方法

パラメータ

なし。

出力

なし。

例

DocMetaDefinition表をResultSetとしてアクティブ・データにロードします。 

<$loadDocMetaDefinition()$>

A.245 loadDocumentProfile()

ページ表示のトリガー値で指定されたように、コンテンツ・プロファイルをロードします。これは、「検索」、「チェックイン」、「情報」および「更新」の各ページの表示中にコールされます。この関数はリクエストに応じてコールされるため、コールされたときのページによってアクション(検索、情報など)が決定します。

この情報はコンテキストに依存します。isCheckin、isUpdate、isQueryまたはisInfoの各変数はローカル・データに設定され、ロードおよび表示されるページにloadDocumentProfile関数を送ります。

タイプおよび使用方法

パラメータ

なし。

出力

なし。

例

<$loadDocumentProfile()$>

関連項目

A.246 loadEnterpriseSearchCollections

この関数は、Enterprise Searchで問い合わせることができるリモート・コンテンツ・サーバー・インスタンスのリストを表示するために使用されるResultSet EnterpriseSearchCollectionsをロードします。このデータは検索ページで使用され、ユーザーがどのサーバーに問い合わせるべきかを選択できるようにします。

タイプおよび使用方法

パラメータ

次のパラメータを取ります。ゼロに設定すると、自動的に検索されるサーバーの名前がResultSetに含まれません。

A.247 loadEnterpriseSearchResults

この関数は、ページのいくつかのResultSetの名前を変更してEnterprise Searchをサポートするようにします。ResultSet EnterpriseSearchResultsでループするときに使用されます。ResultSetを特定のサーバーから読み込んで、その名前をSearchResultsに変更します。これにより、検索結果ページで使用されるIdocScriptを簡素化できます。

タイプおよび使用方法

パラメータ

なし

A.248 loadSchemaData()

スキーマResultSetのデータを現在のデータ・バインダのローカル・データにロードします。

タイプおよび使用方法

パラメータ

この関数は、ゼロ、1つまたは2つのパラメータを取ることができます。

  • 渡された引数がゼロの場合は、データ・バインダにアクティブResultSetの行のデータを入力します。戻り値はありません。

  • 渡される引数が1つの場合、その引数は現在行から値を取得するResultSetの名前です。戻り値はありません。

  • 2つの引数が渡される場合は、最初の引数としてResultSetの名前、2番目の引数としてロードするデータ・オブジェクトを特定するキーが渡されます。データが存在しない場合は0を返し、データが存在する場合は1を返します。戻り値に基づいてスクリプトを条件付きで実行するために、True()またはFalse()を使用します。

例

<$loadSchemaData()$>

関連項目

A.249 loadSearchOperatorTables()

演算子名の完全なセットと検索構文との間のマッピングをロードします。「検索」ページで使用します。

タイプおよび使用方法

パラメータ

なし。

出力

演算子名に関連付けられた式(検索演算子マップ)を返します。

例

<$loadSearchOperatorTables()$>

A.250 loadUserMetaDefinition()

この関数は、カスタム・ユーザー・メタデータ定義をロードします。これは、ResultSetとしてページに置かれるUserMetaDefinition表に存在します。これは、管理者がユーザー・メタデータをコンテンツ・サーバー・インスタンスにマップできるように、LDAP管理ページで使用されます。

タイプおよび使用方法

パラメータ

なし。

A.251 LocalGroupServer

NTLMセキュリティのために、ローカル・グループがグローバル(ドメイン)グループのように扱われるWindows Serverを指定します。

UseLocalGroups設定をTRUEにすると、この設定で指定されたWindows Server上のローカル・グループが、デフォルト・マスター・ドメインのグローバル(ドメイン)グループと同様に、ロールおよびアカウントにマップされます。

デフォルトは、デフォルト・マスター・ドメインのドメイン・コントローラです。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • 外部セキュリティ

場所

  • NTドメイン・セキュリティの構成ページ、「ローカル・グループ・サーバー」

  • instance_dir/data/users/config/filter.hda

例

構成エントリとしての使用例:

LocalGroupServer=server1

関連項目

  • Oracle WebCenter Content構成リファレンスのUseLocalGroupsに関する項

A.252 localPageType

この関数は、ライブラリ・フォルダにあるページのページ・タイプを返します。これはディレクトリまたは問合せページである場合があります。この関数は通常、Layout Manager APIで使用されます。「トレイ」が選択されたレイアウトの場合、この関数はライブラリのページのツリー・ビューの構築に使用されます。

タイプおよび使用方法

パラメータ

1つのパラメータとして、ツリー・ビューの構成に使用するデータ・リンクを取ります。

A.253 MajorRevSeq

リビジョン番号のメジャー・シーケンスを定義します。

メジャー・リビジョンのラベル・シーケンスを返します(構成設定の値を返します)。

文字列を返します。

デフォルトは1-99です。

タイプおよび使用方法

場所

  • 「システム・プロパティ」、「オプション」タブ、「メジャー・リビジョンのラベル・シーケンス」

  • 「管理」、「管理サーバー」、「一般構成」メニュー・オプション、「メジャー・リビジョンのラベル・シーケンス」

  • IntradocDir/config/config.cfg

例

構成設定の使用例:

MajorRevSeq=A-Z

スクリプトとして、構成設定の値を返します。

<$MajorRevSeq$>

関連項目

A.254 MaxCollectionSize

1度のバッチでインデクサに渡すファイル数を定義します。

有効範囲は1～65535です。

大型の索引コレクションの場合は、値2000をお薦めします。値が小さくなると、索引作成のパフォーマンスが非効率になります。

1度のバッチで処理されるファイル数を返します。

デフォルトは25です。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • 索引付け

場所

  • 「リポジトリ・マネージャ」、「インデクサ」タブ、「構成」、「1度のインデクサ・バッチで処理されるコンテンツ・アイテム数」

  • IntradocDir/config/config.cfg

例

構成設定として、バッチ・サイズを定義します。

MaxCollectionSize=25

スクリプトとして、構成ファイルから値を返します。

<$MaxCollectionSize$>

A.255 maxLength

メタデータ・フィールドで許容される最大文字数を設定します。

タイプおよび使用方法

出力

フィールドの最大長を返します。

例

フィールドの最大長を100文字に設定します。

<$maxLength=100$>

現在のフィールド長に基づき、カスタム・フィールド長を指定します。

<$customFieldLength = getValue("#active", fieldName & ":maxLength")$>

A.256 MinorRevSeq

リビジョン番号のマイナー・シーケンスを定義します。

マイナー・リビジョンのラベル・シーケンスを返します(構成設定の値を返します)。

文字列を返します。

タイプおよび使用方法

場所

  • 「システム・プロパティ」、「オプション」タブ、「マイナー・リビジョンのラベル・シーケンス」

  • 「管理」、「管理サーバー」、「一般構成」メニュー・オプション、「マイナー・リビジョンのラベル・シーケンス」

  • IntradocDir/config/config.cfg

例

構成設定の使用例:

MinorRevSeq=a-c

スクリプトとして、構成設定の値を返します。

<$MinorRevSeq$>

関連項目

A.257 MSIE

クライアント・ブラウザがMicrosoft Internet Explorerであるかどうかを確認します。

タイプおよび使用方法

出力

  • クライアント・ブラウザがInternet Explorerである場合、TRUEを返します。

  • クライアント・ブラウザがInternet Explorerではない場合、FALSEを返します。

例

ブラウザがInternet Explorer以外の場合、別のURLにリダイレクトします。

<$if not MSIE$>
    <a href="<$redirect$>">
<$endif$>

A.258 MultiUpload

複数ファイルのアップロード・アプレットを有効にします。

TRUEに設定した場合、アップロード・アプレットが有効になり、複数のファイルを1つのコンテンツ・アイテムとして圧縮してチェックインできるようになります。

FALSEに設定した場合、アップロード・アプレットは無効になります。デフォルトはFALSEです。

「チェックイン」ページでアップロード・アプレットを表示するには、「ユーザー・プロファイル」ページで「アップロード・アプレットを有効にする」を選択し、「更新」をクリックします。チェックインが始まると、アプレットに進行状況バーが表示されます。

config.cfgファイルのDisableHttpUploadChunkingは、デフォルトでtrueに設定されています。チャンクを有効にするには、DisableHttpUploadChunking=falseに設定します。ただし、チャンクが有効な場合、requestauditトレースでは、アップロードされたすべてのチャンクに対して次の出力が表示されます。

requestaudit 11.15 15:55:47.835 IdcServerThread-32 CHUNKED_UPLOAD
dUser=sysadmin][IsJava=1] 8.361(secs)

チャンクをトリガーするために必要なファイルの大きさを指定するには、AppletChunkThresholdを設定します。このデフォルトは、1MBで、1MBで十分であれば設定する必要はありません。

AppletChunkThreshold=10000000

チャンク・サイズを指定するには、AppletChunkSizeを設定します(この値もデフォルトは1MBです)。1MBのチャンクでよい場合は、設定する必要はありません。

AppletChunkSize=10000000

チャンクを有効にしてアップロード・アプレットからアップロードするには、CHUNKED_UPLOADサービスが使用されます。このサービスでは、アップロードの各チャンクを取得し、ucm/vault/~tempディレクトリに配置します。チャンクがアップロードされると、各チャンクはメイン・ファイルに追加されます。アップロードが完了すると、ファイルはボールトの適切な場所に移動されます。

大きなファイルのアップロードのチャンクは、アップロード時にネットワークの問題が発生した場合に障害が発生した時点から再試行できる利点があります(アップロード全体を最初から開始する必要がありません)。

CHUNKED_UPLOAD POSTリクエスト本体のサンプルを次に示します。

注意:

大カッコで囲まれている部分は説明であり、実際のリクエストの一部ではありません。このリクエスト本体は、1つのファイルのアップロードのみを行います。

図A-1 CHUNKED_UPLOAD POSTリクエスト本体のサンプル

図A-1の説明
「図A-1 CHUNKED_UPLOAD POSTリクエスト本体のサンプル」の説明

コンテンツ・サーバーの出力にchunkedrequestトレースを表示するには、config.cfgファイルの設定を有効にして、「システム監査情報」ページでトレース・セクションのchunkedrequestを有効にします。

ChunkedRequestTrace=true

chunkedrequestトレース出力は次の例のような出力になります。TranedSizeは、「トランザクションされたサイズ」またはこれまでにアップロードされたサイズの合計を示すことに注意してください。

chunkedrequest 11.15 15:55:47.780 IdcServerThread-32 In doUpload()
chunkedrequest 11.15 15:55:47.780 IdcServerThread-32 TranedSize: 15000000
chunkedrequest 11.15 15:55:47.780 IdcServerThread-32 Retrieve Session: 983887704
chunkedrequest 11.15 15:55:47.831 IdcServerThread-32 Leaving doUpload()
chunkedrequest 11.15 15:55:47.831 IdcServerThread-32 Register new entry in ChunkSessionManager.
chunkedrequest 11.15 15:55:47.831 IdcServerThread-32 SessionID: 983887704TimeOut: 213222ms.
chunkedrequest 11.15 15:55:47.831 IdcServerThread-32 Session 983887704 is inserted in timeout queue at index 0
requestaudit 11.15 15:55:47.835 IdcServerThread-32 CHUNKED_UPLOAD [dUser=sysadmin][IsJava=1] 8.361(secs)

タイプおよび使用方法

場所

  • 「システム・プロパティ」、「オプション」タブ、「アップロード・アプレットを有効にする」

  • 「管理」、「管理サーバー」、「一般構成」メニュー・オプション、「アップロード・アプレットを有効にする」

  • IntradocDir/config/config.cfg

例

構成設定として、アップロード・アプレットを有効にします。

MultiUpload=true

スクリプトとして、アップロード・アプレットの条件を評価します。

<$MultiUpload$>

関連項目

A.259 NoMatches

検索問合せから一致が見つかったかどうかを確認します。

通常、検索結果ページでのメッセージの表示に使用します。

タイプおよび使用方法

出力

  • 一致が見つからなかった場合、TRUEを返します。

  • 一致が見つかった場合、FALSEを返します。

例

問合せから一致が見つからなかった場合、テキストを表示します。

<$if NoMatches$>
    <p><font face="arial" size="2">
    Found no matches out of <$TotalDocsProcessed$> documents searched matching the query.</p>
<$endif$>

A.260 noMCPrefill

MultiCheckinコンポーネントでメタデータ・フィールドに事前移入する必要がないことを指定します。

この変数は、カスタムHCSTページやコントリビューション・フォルダのコンポーネント・ページなどの特殊なページで使用できます。

TRUEに設定した場合、MultiCheckinコンポーネントはメタデータ・フィールドに事前移入しません。

FALSEに設定した場合、MultiCheckinコンポーネントによってメタデータ・フィールドが事前移入されます。

タイプおよび使用方法

出力

  • MultiCheckinコンポーネントがメタデータ・フィールドに事前移入しない場合は、TRUEを返します。

  • MultiCheckinコンポーネントがメタデータ・フィールドに事前移入する場合は、FALSEを返します。

例

ページの一番上近くに設定します。

noMCPrefill=1

スクリプトとしての使用例:

<$noMCPrefill$>

A.261 NotificationQuery

この設定によって、期限切れコンテンツを検索する自動問合せの条件を定義します。

NotificationQueryが設定されていない場合、デフォルト値は、次の7日間で期限が切れるすべてのコンテンツです。

タイプおよび使用方法

パラメータ

使用する問合せがパラメータになります。この問合せには、次のいずれかが使用できます。サンプルの問合せの詳細は、次の例の項を参照してください。

  • Idoc Scriptから作成されたIdoc Script問合せ。

  • URLエンコードによる問合せ。これは、検索を実行したときにWebブラウザのアドレスに表示されるURLを使用します。

  • 検索変数を定義するプレーン・テキスト問合せ。

場所

IntradocDir/config/config.cfg

例

Idoc Scriptの例

データベースの索引付けとともに使用した場合、次の問合せでは、7日間のうちに期限が切れるすべてのドキュメントについて電子メールで通知されます。

NotificationQuery=dOutDate < '<$dateCurrent(7)$>'>

URLエンコードによる例

次の問合せでは、2007年8月1日をすぎると期限が切れるすべてのコンテンツが返されます。QueryText部分で始まるブラウザのアドレス行のURLがコピーされます。

NotificationQuery=QueryText=dOutDate+%3C+%608%2F1%2F06%60&SearchProviders= [...}

プレーン・テキスト問合せ

次の問合せでは、2007年8月1日をすぎると期限が切れるすべてのコンテンツが返されます。

NotificationQuery=8/1/07

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のEnableExpirationNotifierに関する項

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のNotificationIntervalInDaysに関する項

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のNotificationMaximumに関する項

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のNotifyExtrasに関する項

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のNotifyTimeに関する項

A.262 OneMatch

検索問合せから一致が1つだけ見つかったかどうかを確認します。

通常、検索結果ページでのメッセージの表示に使用します。

タイプおよび使用方法

出力

  • 一致が1つだけ見つかった場合、TRUEを返します。

  • 一致が見つからなかったか、2つ以上の一致が見つかった場合、FALSEを返します。

例

検索問合せから一致が1つだけ見つかった場合、テキストを表示します。

<$if OneMatch$>
    <p><font face="arial" size="2">
    Found <$TotalRows$> document matching the query.</p>
<$endif$>

A.263 optionListKey

オプション・リストの値が含まれているResultSet列の名前を指定します。

タイプおよび使用方法

出力

オプション・リスト、ResultSet列の値を返します。

例

dFormatをDocFormats ResultSetの列として指定し、チェックイン・ページの標準のFormatフィールドに対してオプション・リストの値を取得します。

<@dynamichtml std_override_format_field@>
<$if not isInfo and IsOverrideFormat$>
<$fieldIsOptionList = 1, optionListResultSet = "DocFormats", 
    optionListKey = "dFormat", 
    optionListValueInclude = "std_override_format_option_value", 
    addEmptyOption = 1, emptyOptionLabel = lc("wwEmptyFormatOption")$>
<$include std_display_field$>
<$endif$>
<@end@>7

関連項目

A.264 optionListName

オプション・リストの名前を指定します。

標準のメタデータ・フィールドの場合、これは内部オプション・リストの名前になります。詳細は、「内部オプション・リスト」を参照してください。

カスタム・メタデータ・フィールドの場合、これは接尾辞.optionsの付いたフィールドの名前になります。

タイプおよび使用方法

出力

オプション・リスト名を返します。

例

フィールドが1人だけのユーザーに制限されていない場合、オプション・リスト名はdocAuthorsに設定されます。

<$if SingleUser$>
    <$isInfoOnly = 1$>
  <$else$>
    <$fieldIsOptionList = 1, optionListName = "docAuthors"$>
    <$if HasExternalUsers$><$fieldOptionListType= "combo"$>
    <$endif$>
<$endif$>

デフォルトのオプション・リスト・スクリプトを定義します。

<$if optionsAllowPreselect and fieldValue$>
    <$defaultOptionListScript = "<$optList " & optionListName & ":fieldValue$>"$>
<$else$>
    <$defaultOptionListScript = "<$optList " & optionListName & ":noselected$>"$>
<$endif$>

関連項目

A.265 optionListResultSet

オプション・リストの値が含まれているResultSetの名前を指定します。

タイプおよび使用方法

出力

オプション・リストResultSetを返します。

例

DocFormatsを検索ページの標準のFormatフィールドに対するオプション・リストResultSetとして指定します。

<@dynamichtml std_format_fields@>
<$if ClientControlled or dFormat or dExtension$>
<$fieldName = "dFormat", fieldCaption = lc("wwNativeFormat"),
    optionListResultSet = "DocFormats"$> <$include std_display_field$>
<$fieldName = "dExtension", fieldCaption = lc("wwNativeExtension"), 
    fieldWidth = 10$>
<$include std_display_field$>
<$endif$>
<@end@>

ResultSetをループすることにより、オプション・リストが作成されます。

<@dynamichtml compute_resultset_option_list_script@>
    <$if not optionListKey$>
<$optionListKey = fieldName$>
    <$endif$>
    <$defaultOptionListScript = "<$loop " & optionListResultSet & "$>" & 
    "<$inc('std_resultset_option_list_item')$>" & "<$endloop$>"$>
<@end@>

関連項目

A.266 optionListScript

この変数が空以外の値に設定されている場合、フィールドのオプション・リストを表示する際にeval関数が使用されます。この変数によって、オプション・リスト(defaultOptionListScript変数により定義)の標準的な実装をオーバーライドすることができます。

タイプおよび使用方法

出力

  • 値が空以外の場合、TRUEを返します。

  • 値が空の文字列の場合、FALSEを返します。

例

オプション・リストの作成用にカスタム・スクリプトを定義します。

<$customOptionListScript = getValue("#active", fieldName & ":optionListScript")$>

関連項目

A.267 optionListValueInclude

オプション・リストの値を定義するインクルードを指定します。

タイプおよび使用方法

出力

インクルードのコードを返します。

例

オプション・リストの値のインクルードとしてstd_override_format_option_valueを指定します。

<@dynamichtml std_override_format_field@>
<$if not isInfo and IsOverrideFormat$>
<$fieldIsOptionList = 1, optionListResultSet = "DocFormats", 
    optionListKey = "dFormat", 
    optionListValueInclude = "std_override_format_option_value", 
    addEmptyOption = 1, emptyOptionLabel = lc("wwEmptyFormatOption")$>
<$include std_display_field$>
<$endif$>
<@end@>
<@dynamichtml std_override_format_option_value@>
<$dDescription$>
<@end@>

ResultSetのオプション・リストでのオプションの表示に使用するインクルードを指定します。

<@dynamichtml std_resultset_option_list_item@>
<$curValue = getValue("#active", optionListKey)$>
<option value="<$curValue$>" <$if optionsAllowPreselect and strEquals(curValue, fieldValue)$>selected<$endif$>>
<$if optionListValueInclude$>
<$inc(optionListValueInclude)$>
<$else$>
<$curValue$>
<$endif$>
<@end@>

関連項目

A.268 optionsAllowPreselect

メタデータ・フィールドのオプション・リストに最後の値を事前設定できることを指定します。

タイプおよび使用方法

出力

  • オプション・リストが事前設定できる場合、TRUEを返します。

  • オプション・リストが事前設定できない場合、FALSEを返します。

例

オプション・リストが事前設定できることを指定します。

<$optionsAllowPreselect=1$>

オプション・リストが事前設定されるかどうかを判別します。

<$if optionsAllowPreselect and fieldValue$>
<$defaultOptionListScript = "<$optList " & optionListName & ":fieldValue$>"$>
<$else$>
<$defaultOptionListScript = "<$optList " & optionListName & ":noselected$>"$>
<$endif$>

A.269 optList()

オプション・リストを生成します。

この関数は、コンテンツ・サーバー・ページでのオプション・リストの作成に広範に使用されます。

この関数は、loadMetaOptionsListをコールするサービスとともに使用した場合のみ、出力を生成します。

タイプおよび使用方法

パラメータ

1つのパラメータと、そのパラメータに対する1つのオプションの引数を取ります。

唯一のパラメータはフィールド名、オプション・リスト・キーまたは変数です。

  • フィールド名 の構文は<$optList fieldName$>です。カスタム・メタデータ・フィールドの場合、フィールド名は <$optList xFieldName.options$>に解決されます。または、接尾辞.optionsを直接指定することもできます。

  • オプション・リスト・キーの構文は<$optList ListName$>です。

    • 標準のメタデータ・フィールドの場合、ListNameは内部オプション・リスト(docAuthorsなど)の名前になります。詳細は、内部オプション・リストを参照してください。

    • カスタム・メタデータ・フィールドの場合、ListNameはオプション・リスト・キー(FieldNameListなど)の名前になります。

  • 変数 の構文は<$optList variable$>です。変数は、フィールド名またはオプション・リスト・キーに解決される必要があります。

  • 次のいずれかのオプションの引数がパラメータに追加できます。

    • :noselected: オプション・リストが表示されるときに、値は選択されません。

    • :fieldValue: fieldValue変数により指定された値がオプション・リストのデフォルト値として選択されます。

出力

値リストを返します。

例

次のスクリプトでは、内部のdocAuthorsリストから指定可能な作成者のリストが生成されます。

<$optList docAuthors$>

次のスクリプトでは、xRegion列のメタデータ・フィールドで指定されたオプションのリストが生成されます。

<$optList xRegion.options$>

次のスクリプトでは、変数optionListName からオプション・リストが生成されて、デフォルト値が指定されます。

<$if optionsAllowPreselect and fieldValue$>
    <$defaultOptionListScript = "<$optList " & optionListName & ":fieldValue$>"$>
<$else$>
    <$defaultOptionListScript = "<$optList " & optionListName & ":noselected$>"$>
<$endif$>

関連項目

A.270 PageParent

ライブラリ内のディレクトリ・ページに親ページがあるかどうかを確認します。

タイプおよび使用方法

出力

  • 現在のディレクトリ・ページが別のディレクトリ・ページの子(サブフォルダ)である場合、TRUEを返します。

  • ディレクトリ・ページが子(サブフォルダ)ではない場合、FALSEを返します。

例

ディレクトリ・ページがサブフォルダであるかどうかを確認します。

<$PageParent$>

A.271 parseDataEntryDate()

日付を解析しますが、代替解析フォーマットを使用するためにフェイルオーバー・ロジックを適用します。

日付は、標準の比較演算子とともに使用した場合にミリ秒に変換されます。たとえば、式 (60*60*1000) は1時間と同等です。

この関数は通常、多数の秒、分、時、日を表す乗算式を使用して現在の時刻を調節する場合に使用します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、解析される式です。

出力

Java日付オブジェクトを返します。これは、表示用に文字列に変換されます。

例

<$parseDataEntryDate$>

A.272 parseDate

日付/時間を解析して算術評価が実行できるようにします。

日付は、標準の比較演算子とともに使用した場合にミリ秒に変換されます。たとえば、式 (60*60*1000) は1時間と同等です。

この関数は通常、多数の秒、分、時、日を表す乗算式を使用して現在の時刻を調節する場合に使用します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、解析される式です。

出力

Java日付オブジェクトを返します。これは、表示用に文字列に変換されます。

例

次の式はそれぞれ、過去のある1日の日付と時間を返します。

<$parseDate(dateCurrent(-1))$>
<$parseDate(dateCurrent()-(24*60*60*1000))$>
<$dateCurrent(-1)$>
<$dateCurrent()-(24*60*60*1000)$>

1時間後の時刻を返します。1行目では、時間乗算式を使用して1時間が加算され、カスタム変数に時間と日付を割り当てて、出力を抑制します。2行目では、カスタム変数を参照して、時間のみを表示することを定義します。

<$exec my_customParseTime parseDate(dateCurrent()+(1000*60*60))$>
<$formatTimeOnly(my_customParseTime)$>

1年後の日付を返します。1行目では、時間乗算式を使用して1年が加算され、カスタム変数に時間と日付を割り当てて、出力を抑制します。2行目では、カスタム変数を参照して、日付のみを長いフォーマットで表示することを定義します。

<$exec my_customParseTime parseDate(dateCurrent()+(1000*60*60*24*365))$>
<$formatTimeOnly(my_customParseTime)$>

このスクリプトでは、7日後の日付が有効期限日より大きいかどうかを評価し、trueの場合はユーザーにメッセージを返します。

<$if dOutDate$>
    <$if dateCurrent(7) > parseDate(dOutDate)$>
Content item expires in one week.
     <$endif$>
<$endif$>

このスクリプトでは、カスタマイズされたワークフローのジャンプに対して条件文の中で parseDate を使用します。このスクリプトでは、このステップに最後に入ったのが4日前であった場合、ワークフローwf_lateの最初のステップに進んで、戻りステップが次のステップになるように設定することを指定します。

<$if parseDate(wfCurrentGet("lastEntryTs")) < dateCurrent(‐4)$>
    <$wfSet("wfJumpName", "lateJump")$>
    <$wfSet("wfJumpTargetStep", "step_1@wf_late")$>
    <$wfSet("wfJumpReturnStep", wfCurrentStep(1))$>
    <$wfSet("wfJumpEntryNotifyOff", "0")$>
<$endif$>

関連項目

A.273 parseDateWithPattern()

日付/時間を指定された日付/時間パターンに解析します。

日付は、標準の比較演算子とともに使用した場合にミリ秒に変換されます。たとえば、式 (60*60*1000) は1時間と同等です。

この関数は通常、多数の秒、分、時、日を表す乗算式を使用して現在の時刻を調節する場合に使用します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、コンテンツ・サーバー・インスタンスにより使用される日付文字列、または、parseDate関数またはdateCurrent関数を使用して作成された日付オブジェクトです。

  • 2番目のパラメータは日付/時間パターン(例: MM/dd/yyyy)であり、これは標準的なJava SimpleDateFormatパターン文字列です。

出力

Java日付オブジェクトを返します。これは、表示用に文字列に変換されます。

例

現在の日付/時間を、パターンにより指定されたフォーマット(例: Wed, 4 Jul 2001 12:08:56 -0700)で表示します。

<$parseDateWithPattern(dateCurrent(),"EEE, d MMM yyyy HH:mm:ss Z")$>

関連項目

A.274 PATH_INFO

この設定は廃止されています。Webサーバー・フィルタでは、この情報は送信されなくなりました。

CGIコンピュータへのファイル・システム・パスに関する追加情報を取得します。

仮想パスがPATH_TRANSLATED変数によって返されるときに、このパスの末尾にある追加情報もすべてPATH_INFOとして返されます。

この変数は、現在のゲートウェイ・プログラム・リクエスト固有のものです。

タイプおよび使用方法

出力

文字列として追加の仮想パス情報を返します。

例

追加のCGIパス情報を取得します。

<$PATH_INFO$>

関連項目

A.275 PATH_TRANSLATED

たとえば、CGIコンピュータへのファイル・システム・パスを取得します。

c:/domain/weblayout/idcplg/idc_cgi_isapi-idcm1.dll.

この変数は、現在のゲートウェイ・プログラム・リクエスト固有のものです。

タイプおよび使用方法

出力

文字列として仮想パスを返します。

例

CGIパスを取得します。

<$PATH_TRANSLATED$>

A.276 pneNavigation()

左のサイドバー・ナビゲーションを有効にします。

タイプおよび使用方法

パラメータ

名前/値のペアとして設定します。

pneNavigation=1

デフォルトは1(有効)です。

この関数を無効にするには、null文字列に設定する必要があります。

出力

TRUEまたはFALSEに評価します。

例

サイドバー・ナビゲーションを有効にします。

<$pneNavigation=1$>

サイドバー・ナビゲーションを強制的にオフにするには、次のようにnull文字列に設定します。

<$pneNavigation=""$>

この定義を1またはnull文字列以外に設定すると無効になり、サイドバー・ナビゲーションは無効になりません。

<$pneNavigation=0$>

A.277 proxiedBrowserFullCgiWebUrl

プロキシ設定されたコンテンツ・サーバー・インスタンスの完全なCGIパスを返します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、プロキシ設定されたコンテンツ・サーバー・インスタンスの相対Webルートです。この値は、HttpRelativeWebRoot設定にあります。

出力

指定されたプロキシの完全なCGIパスを文字列として返します。

例

http://<localhost/idcplg/idc_cgi_isapi-idcm1.dll/intradoc4/pxsを返します。

<$proxiedBrowserFullCgiWebUrl("/intradoc4/")$>

関連項目

A.278 proxiedCgiWebUrl

プロキシ設定されたコンテンツ・サーバー・インスタンスのCGIパスを返します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、プロキシ設定されたコンテンツ・サーバー・インスタンスの相対Webルートです。この値は、HttpRelativeWebRoot設定にあります。

出力

指定されたプロキシのCGIパスを文字列として返します。

例

/idcplg/idc_cgi_isapi-idcm1.dll/intradoc4/pxsを返します。

<$proxiedCgiWebUrl("/intradoc4/")$>

関連項目

A.279 QUERY_STRING

問合せに関してURLのデリミタ?の後に続く文字列を取得します。

この変数は、現在のCGIリクエストに固有のものです。

タイプおよび使用方法

出力

文字列として問合せ情報を返します。

例

ページまたはログへの情報出力としての使用例:

QUERY_STRING=IdcService=GET_DOC_PAGE&Action=GetTemplatePage&Page=STD_QUERY_PAGE

Idoc Script文または評価の一部としての使用例:

<$if QUERY_STRING$>
<!--statement-->

A.280 regexMatches()

一致を実行する正規表現を使用して、特定のパターンの文字列を検索します。正規表現の構成には、文字、文字クラスおよびその他のクラスと限定子を含めることができます。クラス・パターンのJava APIの詳細は、http://www.oracle.com/technetwork/java/index.htmlを参照してください。

この機能は、JVM 1.4以降のみで使用可能です。これは、WebCenter Contentバージョン7.0以降のデフォルト・バージョンになります。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、一致する文字列です。

  • 2番目のパラメータは式です。

例

次の例では、文字列が式に一致していないため、FALSEが返されます。

<$regexMatches("abcdef","abc")$>

次の例ではワイルドカードが存在しているため、TRUEが返されます。ドット・アスタリスク(.*)変換のかわりにアスタリスク(*)などの標準のワイルドカードを使用した場合、一致は失敗します。

<$regexMatches("abcdef", ".*abc.*")$>

関連項目

A.281 regexReplaceAll()

一致および置換を実行する正規表現を使用して、特定のパターンの文字列を検索します。正規表現の構成には、文字、文字クラスおよびその他のクラスと限定子を含めることができます。クラス・パターンのJava APIの詳細は、http://www.oracle.com/technetwork/java/index.htmlを参照してください。

この機能は、JVM 1.4以降のみで使用可能です。これは、WebCenter Contentバージョン11.1.1.7.0以降のデフォルト・バージョンになります。

正規表現のすべてのインスタンスを置換文字列に置き換えます。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータは元の文字列です。

  • 2番目のパラメータは、一致する文字列です。

  • 3番目のパラメータは置換文字列です。

例

次の例ではxyzdef xyzdefを返します。

<$regexReplaceAll("abcdef abcdef","abc","xyz")$>

関連項目

A.282 regexReplaceFirst()

一致および置換を実行する正規表現を使用して特定のパターンの文字列を検索し、最初のインスタンスを置換文字列に置き換えます。正規表現の構成には、文字、文字クラスおよびその他のクラスと限定子を含めることができます。クラス・パターンのJava APIの詳細は、http://www.oracle.com/technetwork/java/index.htmlを参照してください。

この機能は、JVM 1.4以降のみで使用可能です。これは、WebCenter Contentバージョン11.1.1.7.0以降のデフォルト・バージョンになります。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータは元の文字列です。

  • 2番目のパラメータは、一致する文字列です。

  • 3番目のパラメータは置換文字列です。

例

次の例ではxyzdef abcdefを返します。

<$regexReplaceFirst("abcdef abcdef","abc","xyz")$>

関連項目

A.283 REMOTE_ADDR

リクエストを行うリモート・ホストのIPアドレスを返します。

この変数は、現在のゲートウェイ・プログラム・リクエスト固有のものです。

タイプおよび使用方法

出力

文字列としてIPアドレスを返します。

例

ページまたはログへの情報出力としての使用例: 

REMOTE_ADDR=207.0.0.1

Idoc Script文または評価の一部としての使用例: 

<$if REMOTE_ADDR$>
<!--statement-->

関連項目

A.284 REMOTE_HOST

リクエストを行うリモート・ホストの名前を返します。

この変数は、現在のゲートウェイ・プログラム・リクエスト固有のものです。

タイプおよび使用方法

出力

  • 文字列としてホスト名を返します。

  • サーバーがホスト名を認識していない場合は、文字列としてREMOTE_ADDRの値が返されます。

例

ページまたはログへの情報出力としての使用例: 

REMOTE_HOST=207.0.0.1

Idoc Script文または評価の一部としての使用例:

<$if REMOTE_HOST$>
<!--statement-->

関連項目

A.285 REQUEST_METHOD

リクエストの作成に使用されたメソッドを取得します。

この変数は、現在のゲートウェイ・プログラム・リクエスト固有のものです。

タイプおよび使用方法

出力

文字列としてリクエスト・メソッドを返します。

例

ページまたはログへの情報出力としての使用例:

REQUEST_METHOD=GET

Idoc Script文または評価の一部としての使用例:

<$if REQUEST_METHOD$>
<!--statement-->

A.286 requiredMsg

チェックイン時に必須メタデータ・フィールドに値が指定されていない場合に表示されるエラー・メッセージを指定します。

タイプおよび使用方法

出力

文字列としてエラー・メッセージを返します。

例

dDocTitle メタデータ・フィールドの必須フィールドのエラー・メッセージを、ローカライズされた文字列wwSpecifyTitleとして定義します。

<$fieldName = "dDocTitle", fieldCaption = lc("wwTitle"), isRequired = 1, fieldType = "BigText", requiredMsg = lc("wwSpecifyTitle")$>

関連項目

A.287 ResultsTitle

検索結果ページのタイトルを定義します。

Webレイアウト・エディタはこの変数を使用して、検索結果ページに名前を付け、そのページの一番上に見出しを表示します。

使用方法

出力

文字列としてページのタイトルを返します。

例

HDAエントリとして、検索結果ページに次のように名前が付けられます。

@Properties LocalData
ResultsTitle=Content Items
@end

スクリプトとして、定義された名前を返します。 

<$if ResultsTitle$>ResultsTitle=<$url(ResultsTitle)$>

A.288 rptDisplayMapValue()

この関数は内部使用専用です。

この関数は、内部キー・コードのローカライズされた文字列表記を返します。これらのキー・コードは、コンテンツ・アイテムのステータスおよび状態フラグの格納に使用されます。この関数は、内部状態の説明を表示するために、「コンテンツ情報」ページと各ワークフロー・ページで使用されます。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • キーが格納される表の名前。

  • ローカライズされるキー。

A.289 rs()

この関数は、ResultSetの名前が付けられているResultSetを返します。実際に返されるオブジェクトがResultSetであるため、他の関数の戻り値に対して実行できないアクションが、この戻り値では実行可能になります。特に、ループ構文を結果に適用することができます。

タイプおよび使用方法

パラメータ

この関数に指定されるパラメータはresultSetNameであり、これは返されるResultSetの名前です。

出力

見つかった場合はResultSetオブジェクト、見つからない場合はnull。

例

MyResultSetがResultSetの名前であるとした場合、次の構文を使用してResultSetでループすることができます。

<$loop rs("MyResultSet")$>... Script inside loop ...<$endloop$>

この関数は、Idoc Script関数のコール時に変数を一時的に割り当てる際にも使用できます。特に、次の例では、コール中にMyResultSetによりポイントされたものと同じResultSetをポイントするために一時的に変数rsParamを割り当てて、リソース・インクルードmy_includeをインクルードします。rs関数の結果が変数に割り当てられた場合、その変数にはResultSetに対する共有ポインタが指定されて、rsCreateReferenceをコールした場合と同じ効果が得られます。

<$inc("my_include", rsParam=rs("MyResultSet"))$>

A.290 rsAddFields()

新しいフィールドをResultSetに追加します。この関数は、フィールドがまだ存在していない場合のみフィールドを追加します。setValue(...)でも新しいフィールドを追加できますが、これはResultSetが空ではなく、現在の有効行にある場合のみに使用できることに注意してください。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、追加された新規フィールド(列)を取得するResultSetの名前です。

  • 2番目のパラメータは、追加するフィールド(追加される列名)のカンマ区切りリストです。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$rsAddFields(rsName, fieldsList)$>

A.291 rsAddFieldsWithDefaults()

新しいフィールドを既存のResultSetに追加します。rsAddFieldsとは異なり、この関数には、追加されるどのフィールドに対してもデフォルト値を指定できる機能があります。rsAddFieldsWithDefaultsでは、フィールド内の既存のデータが上書きされることはありません。新しいフィールドがResultSetに追加されるだけです。

タイプおよび使用方法

パラメータ

次の表に、この関数のパラメータを示します。

パラメータ 説明

resultSetName

ResultSetの名前。

newFields

ResultSetに追加するフィールドのカンマ区切りリスト。指定されたフィールドのうち、ResultSet内に既存のものはすべて無視されます。

defaultValues

各行の新規フィールドに対して設定されたデフォルト値のオプションのカンマ区切りリスト。このリストの値はそれぞれ、newFieldsリストの同じ位置にある新規フィールドに対応しています。デフォルト値を設定するときにカンマを入れる必要がある場合は、カンマとして'^'が使用できます。defaultValuesリストがnewFieldsリストよりも長いまたは短い場合、この関数は余分のデフォルト値を無視するか、未指定のデフォルト値に対して空の文字列を使用します。

出力

なし。

例

フィールドの追加

<$rsCreateResultSet("MyList", "field1,field2,field3")$><$rsAppendRowValues("MyList", "A,B,C,D,E,F")$><$rsAddFieldsWithDefaults("MyList", "field4,field5,field6")$>

この基本的な例では、MyListというResultSetを作成し、いくつかの値を設定した後で、さらに3つのフィールドを、デフォルト値を設定せずにMyListに追加します。この結果得られる表は次のようになります。

field1 field2 field3 field4 field5 field6

A

B

C

D

E

F

デフォルトを指定したフィールドの追加

<$rsCreateResultSet("MyList", "field1,field2,field3")$><$rsAppendRowValues("MyList", "A,B,C,D,E,F")$><$rsAddFieldsWithDefaults("MyList", "field4,field5,field6", "X,Y,Z")$>

ここでは、新規フィールドのデフォルト値を定義します。この結果得られる表は次のようになります。

field1 field2 field3 field4 field5 field6

A

B

C

X

Y

Z

D

E

F

X

Y

Z

フィールドがすでに存在する場合

<$rsCreateResultSet("MyList", "field1,field2,field3")$><$rsAppendRowValues("MyList", "A,B,C,D,E,F")$><$rsAddFieldsWithDefaults("MyList", "field1,field4,field5", "X,Y,Z")$>

この場合は、すでにMyListに存在するフィールドを追加しようとしています。このアクションは完全に無視され、旧フィールドの値が保存されます。この結果得られる表は次のようになります。

field1 field2 field3 field4 field5

A

B

C

X

Y

D

E

F

X

Y

指定したデフォルト値が少ない場合

<$rsCreateResultSet("MyList", "field1,field2,field3")$><$rsAppendRowValues("MyList", "A,B,C,D,E,F")$><$rsAddFieldsWithDefaults("MyList", "field4,field5,field6", "X,Y")$>

この例では、すべてのフィールドに対して十分なデフォルト値がデフォルト値リストにないことに留意してください。この場合は、未指定の列に対して空白が入力されるだけです。

field1 field2 field3 field4 field5 field6

A

B

C

X

Y

D

E

F

X

Y

関連項目

A.292 rsAddRowCountColumn()

この関数では、それぞれの行の値がその行の行カウントである新規フィールドを追加します。カウントは0から始まります。この関数は、XMLデータ・アイランドのResultSet(.hcspファイル内)に対してrsSort(...)を使用する直前に使用して、元の行の場所を保存する場合に役立ちます。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、新しい行カウント列が設定されるように変更されるResultSetの名前です。

  • 2番目のパラメータは、その行カウントを保持するフィールドの名前です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$rsAddRowCountColumn(rsName, countFieldName)$>

A.293 rsAppend()

この関数はrsMergeと同様の特性を備えていますが、マージおよびテスト条件がない点が異なります。ResultSet rsNameSourceのすべての行がResultSet rsNameTargetに追加されます。さらに、rsNameTargetにはなく、rsNameSourceにあるすべてのフィールドがrsNameTargetに追加されます。ResultSetの簡単な組合せを実行する場合に役立ちます。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、マージによって変更が生じるResultSetです。

  • 2番目のパラメータは、ターゲットに追加される行のあるResultSetです。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$rsAppend("targetRsetName", "sourceRsetName")$>

関連項目

A.294 rsAppendNewRow()

ResultSetの末尾に新しい行を追加します。現在の行は影響を受けません。

タイプおよび使用方法

パラメータ

唯一のパラメータは、新しい行を受け取るResultSetの名前です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗するか、ResultSetが空の場合、FALSEを返します。

例

<$rsAppendNewRow("SearchResults")$>

A.295 rsAppendRowValues()

ResultSetに新しい行を追加するユーティリティ関数。値リストは、行に分割される値のカンマ区切りリスト(各値をエンコードするためにエスケープ規則、',' -> '^', '^' -> '#^', '#' -> '##'を使用)です。n個のフィールドはResultSet内のフィールド数であると仮定します。n個のフィールドの値をカウントして新しい行を作成し、次のn個のフィールドの値を取り込んで次の1行を作成するというようにして、値リストが行に分割されていきます。値の数がn個のフィールドの正確な倍数でない場合は、最後の行のフィールド値が空の文字列でパディングされます。この関数は、Idoc Scriptを使用してResultSetを簡潔にハードコード化する場合に役立ちます。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、新しい行を取得するResultSetの名前です。

  • 2番目のパラメータは、新規に追加する値です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$rowValues = "a1, b1, a2, b2"$>
<$rsCreateResultSet("ResultSet1", "ColumnA,ColumnB")$>
<$rsAppendRowValues("ResultSet1", rowValues$>
<table border=2>
    <tr><td>ColumnA</td><td>ColumnB</td></tr>
    <$loop ResultSet1$>
    <tr><td><$ColumnA$></td><td><$ColumnB$></td>
</tr>
<$endloop$>
</table>

この結果得られるHTMLは次のようになります。

列A 列B

A1

B1

A2

B2

A.296 rsCopyFiltered()

この関数は、1つのResultSetから選択された行のみをコピーして、別のResultSetを作成します。名前がrsNameTargetである前出のResultSetはすべて置換されます。filterPatternのパターンに対するテストを使用してfilterFieldの各行の値をテストすることにより、行が選択されます。パターン一致は、Idoc Scriptのlike演算子で使用するものと同じです。

タイプおよび使用方法

パラメータ

次の4つのパラメータをとります。

  • 最初のパラメータは、コピーする行のあるResultSetです。

  • 2番目のパラメータは、コピーによって新規に作成されたResultSetです。

  • 3番目のパラメータは、テストされるフィールドの名前です。

  • 4番目のパラメータは、行をコピーする必要があるかどうかの確認に適用されるパターン一致です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$rsCopyFiltered(rsNameSource, rsNameTarget, filterField, filterPattern)$>

A.297 rsCreateReference()

この関数は、リクエスト・データ内の既存のResultSetに対する共有参照のあるIdoc Script変数を設定します。

タイプおよび使用方法

パラメータ

この関数には、次のパラメータが指定されています。

パラメータ 説明

sourceResultSet

既存のResultSetの名前。

targetResultSet

まったく同じResultSetに対する参照を共有する変数の名前。

出力

成功した場合、TRUEを返します。

例

<$MyResultSet.field2$>および<$MyResultSetAlias.field2$>の現在の値は両方とも文字Eになります。

<$rsCreateResultSet("MyResultSet", "field1,field2,field3")$>
<$rsAppendRowValues("MyResultSet", "A,B,C,D,E,F")$>
<$rsCreateReference("MyResultSet", "MyResultSetAlias")$>
<$rsNext("MyResultSetAlias")$>

A.298 rsCreateResultSet()

fieldList内のフィールドのリストを使用して初期化されたResultSetを作成します。すべてのフィールドはstring型として設定されます。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、作成するResultSetの名前です。

  • 2番目のパラメータは、フィールドのカンマ区切りリストです。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$rsCreateResultSet(rsName, fieldList)$>

A.299 rsDeleteRow()

ResultSet内の現在の行を削除します。現在の行が次の行に進みます(または、ResultSetの末尾行が削除された場合、ResultSetの末尾の後をポイントします)。

タイプおよび使用方法

パラメータ

唯一のパラメータは、現在の行が削除されるResultSetの名前です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗するか、ResultSetが空の場合、FALSEを返します。

例

<$rsDeleteRow("Folders")$>

A.300 rsDocInfoRowAllowDisclosure()

ResultSetの現在行により参照されるコンテンツ・アイテムのURLの表示が現在のユーザーに許可されるかどうかを確認します。

この関数は、コンテンツ・アイテムの問合せによって生成されたResultSetのURLを選択的に表示する場合に役立ちます。

タイプおよび使用方法

パラメータ

唯一のパラメータは、コンテンツ・アイテムに関する情報が現在行に含まれているResultSetの名前です。

出力

  • ユーザーに対してコンテンツ・アイテムのURLの表示が許可される場合、TRUEを返します。

  • ユーザーに対してコンテンツ・アイテムのURLの表示が許可されない場合、またはResultSetが空の場合、FALSEを返します。

例

ユーザーがresultSet1の現在行にあるコンテンツ・アイテムのURLを表示できるかどうかを確認します。

<$rsDocInfoRowAllowDisclosure("resultSet1")$>

A.301 rsExists()

ResultSetが存在するかどうかを確認します。

タイプおよび使用方法

パラメータ

1つのパラメータとしてResultSetの名前を取ります。

出力

  • ResultSetが見つかった場合、TRUEを返します。

  • ResultSetが存在しないか空の場合、FALSEを返します。

例

<$if rsExists("resultSet1")$>
    code to execute if TRUE
<$endif$>

A.302 rsFieldByIndex()

ゼロから始めて、指定された列索引にあるフィールドの名前を取得します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • ResultSetの名前。

  • 索引番号。

例

<$rsFieldName = rsFieldByIndex("resultSet1", "2")$>

A.303 rsFieldExists()

指定されたResultSetに特定のフィールドが含まれているかどうかを確認します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 検索されるResultSetの名前。

  • 見つける必要のあるフィールドの名前。

出力

  • フィールドが見つかった場合、TRUEを返します。

  • フィールドが存在しない場合、FALSEを返します。

例

<$if rsFieldExists("resultSet1", "FieldName1")$>
    code to execute if TRUE
<$endif$>

A.304 rsFindRowPrimary()

一致する値を見つけるために、ResultSetの最初の列を検索します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、最初の列が検索の対象となるResultSetの名前です。

  • 2番目のパラメータは、検索対象の値です。

出力

  • 指定された値が指定されたResultSetの最初の列に見つかった場合、TRUEを返します。

  • 指定された値が見つからない場合、FALSEを返します。

例

value1に一致する値が見つかるまで、resultSet1の最初の列を検索します。

<$rsFindRowPrimary("resultSet1","value1")$>

A.305 rsFirst()

ResultSet内の最初の行に移動します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、ResultSetの名前です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗するか、ResultSetが空の場合、FALSEを返します。

例

SearchResults ResultSetを最初の行に進めます。

<$exec rsFirst("SearchResults")$>

A.306 rsInsertNewRow()

操作中のResultSetの現在行の直前に行を挿入します。新しい行が現在行になります。

タイプおよび使用方法

パラメータ

唯一のパラメータは、新しい行が挿入されるResultSetの名前です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$rsInsertNewRow("SearchResults")$>

A.307 rsIsRowPresent()

ResultSetの現在行のステータスを確認します。

タイプおよび使用方法

パラメータ

1つのパラメータとしてResultSetの名前を取ります。

出力

  • ResultSetが現在有効な行にある場合、TRUEを返します。

  • 有効な行にない場合、FALSEを返します。

例

<$if rsIsRowPresent("resultSet1")$>
    code to execute if TRUE
<$endif$>

A.308 rsLoopInclude()

この関数は、1行ごとに1回リソース・インクルードを実行しながら、ResultSetでループします。このインクルードの実行中、ResultSetは一時的にアクティブになります(標準的な<$loop ...$>構成の場合と同じです)。

タイプおよび使用方法

パラメータ

この関数には、次のパラメータが指定されています。

パラメータ 説明

ResultSetName

ループするResultSetの名前。

includeName

実行するリソース・インクルードの名前。

出力

リソース・インクルードの各種反復を組み合わせた出力。

例

<$rsLoopInclude(resultSetName, includeName)$>

A.309 rsLoopSingleRowInclude()

この関数は、1つのリソース・インクルードを実行する間に、ResultSetを一時的にアクティブにプロモートします。これはrsLoopIncludeと非常によく似た動作をしますが、ResultSetの現在行に対してインクルードが実行されるのは1回のみです。

タイプおよび使用方法

パラメータ

この関数には、次のパラメータが指定されています。

パラメータ 説明

ResultSetName

アクティブにするResultSetの名前。

includeName

実行するリソース・インクルードの名前。

出力

リソース・インクルードの出力。

例

<$rsLoopSingleRowInclude(resultSetName, includeName)$>

関連項目

A.310 rsMakeFromList()

オプション・リストから単一列のResultSetを作成します。

タイプおよび使用方法

パラメータ

2つの必須パラメータと1つのオプションのパラメータを取ります。

  • 最初のパラメータは、作成されるResultSetの名前です。

  • 2番目のパラメータは、既存のオプション・リストの名前です(例: docAccountsまたはxMyCustomField.options)。

  • 3番目のオプションのパラメータは、ResultSet列の名前です。値が指定されていない場合、列名のデフォルトはrowになります。

出力

列を1つ持つResultSetを作成します。この列には、指定されたオプション・リストの値が移入されます。

例

2つのResultSet、ListAおよびListBをsecurityGroupsおよびdocAuthorsの各オプション・リストから作成します。

<$lista = "securityGroups"$>
<$rsMakeFromList("ListA", lista)$>
<$rsMakeFromList("ListB", "docAuthors", "name")$>
<table border=2>
    <tr><td>Security Groups</td><td>Authors</td></tr>
    <tr>
        <td><$loop ListA$><$row$><br>
        <$endloop$></td>
        <td><$loop ListB$><$name$><br>
        <$endloop$></td>
    </tr>
</table>

ResultSetsは次のようになります。

@ResultSet ListA
1
row
Public
Secure
@end
@ResultSet ListB
1
name
hchang
pkelly
sysadmin
user1
@end

この結果得られるHTMLは次のような表になります。

ListA ListB

セキュリティ・グループ

Authors

セキュリティ・グループ

hchang

パブリック

okelly

セキュア

sysadmin

セキュア

user1

関連項目

A.311 rsMakeFromString()

文字列から単一列のResultSetを作成します。

タイプおよび使用方法

パラメータ

2つの必須パラメータと1つのオプションのパラメータを取ります。

  • 最初のパラメータは、作成されるResultSetの名前です。

  • 2番目のパラメータは、解析される文字列のカンマ区切りリスト(例: a,b,c,d)、または値としてカンマ区切り文字列を持つ変数です。

  • 3番目のオプションのパラメータは、ResultSet列の名前です。値が指定されていない場合、列名のデフォルトはrowになります。

出力

列を1つ持つResultSetを作成します。この列には、指定された文字列の値が移入されます。

例

2つのResultSet、StringAおよびStringBを作成します。

<$stringa = "a,b,c,d"$>
<$rsMakeFromString("StringA", stringa)$>
<$rsMakeFromString("StringB", "A,B,C,D", "name")$>
<table border=2>
    <tr><td>StringA</td><td>StringB</td></tr>
    <tr>
        <td><$loop StringA$><$row$><br>
        <$endloop$></td>
        <td><$loop StringB$><$name$><br>
        <$endloop$></td>
    </tr>
</table>

ResultSetsは次のようになります。

@ResultSet StringA
1
row
a
b
c
d
@end
@ResultSet StringB
1
name
A
B
C
D
@end

この結果得られるHTMLは次のような表になります。

Stringa Stringb

A

A

B

B

C

C

D

D

関連項目

A.312 rsMerge()

1つのResultSetの行を別のResultSetにマージします。rsCommonFieldフィールドにあるrsNameSource ResultSetの値がrsNameTargetの行にある同じフィールドの値と一致する場合、その行は置換されます。そうでない場合は、rsNameSourceの行が追加されます。rsNameTargetに同じ値で一致する行が複数存在する場合は、最初の行のみが置換されます。その行は、一致する行のあるrsNameSourceの最後の行によって置換されます。ResultSet rsNameSourceのフィールドのうち、rsNameTargetに存在しないフィールドはすべてrsNameTargetの新しいフィールドとして追加されます。この関数は、複数の一致による問題が生じるのを避けるために、rsCommonFieldフィールドで一意の値のみを持つResultSetで最もよく機能します。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータ(rsNameTarget)は、マージによって変更が生じるResultSetです。

  • 2番目のパラメータ(rsNameSource)は、ターゲットにマージされる行のあるResultSetです。

  • 3番目のパラメータ(rsCommonField)は、両方の結果セットにあって、マージの基準として使用されるフィールドです。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$rsMerge(rsNameTarget, rsNameSource, commonField$>

関連項目

A.313 rsMergeDelete()

rsMergeReplaceOnlyと類似していますが、ResultSet rsNameTargetの一致する行が置換されるのではなく、削除される点が異なります。これは、別のResultSetにすでに存在する行をResultSetから削除する場合に役立ちます。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータ(rsNameTarget)は、マージによって変更が生じるResultSetです。

  • 2番目のパラメータ(rsNameSource)は、ターゲットにマージされる行のあるResultSetです。

  • 3番目のパラメータ(rsCommonField)は、両方の結果セットにあって、rsNameTargetから削除する行のテストとして使用されるフィールドです。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$rsMergeDelete(rsNameTarget, rsNameSource, rsCommonField)$>

A.314 rsMergeReplaceOnly()

rsMergeと類似していますが、行は置換されるだけであり、ResultSet rsNameTargetに追加されません。さらに、rsNameSourceの新規フィールドはrsNameTargetに追加されません。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータ(rsNameTarget)は、マージによって変更が生じるResultSetです。

  • 2番目のパラメータ(rsNameSource)は、ターゲットにマージされる行のあるResultSetです。

  • 3番目のパラメータ(rsCommonField)は、両方の結果セットにあって、マージの基準として使用されるフィールドです。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$rsMergeReplaceOnly(rsNameTarget, rsNameSource, rsCommonField) $>

A.315 rsNext()

ResultSet内の次の行に移動します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、ResultSetの名前です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗するか、ResultSetが空の場合、FALSEを返します。

例

SearchResults ResultSetを次の行に進めます。

<$exec rsNext("SearchResults")$>

A.316 rsNumFields()

ResultSetにあるフィールド数を示します。これは、rsFieldByIndexと併用する場合に役立ちます。

タイプおよび使用方法

パラメータ

1つのパラメータとしてResultSetの名前を取ります。

出力

フィールド数を返します。

例

<$numFields = rsNumFields("resultSet1")$>

関連項目

A.317 rsNumRows()

ResultSetにある行数を示します。

タイプおよび使用方法

パラメータ

1つのパラメータとしてResultSetの名前を取ります。

出力

行数を返します。

例

<$numRows = rsNumRows("resultSet1")$>

A.318 rsRemove()

ResultSetを削除します。

タイプおよび使用方法

パラメータ

1つのパラメータとしてResultSetの名前を取ります。

例

<$rsRemove("resultSet1")$>

A.319 rsRename()

ResultSetの名前を変更します。

変数を使用して新しいResultSet名を定義する場合は、rsFirst、rsNextおよび#isRowPresentを使用して新しいResultSet変数を手動でループする必要があります。次に例を示します。

<$rsNewName="MySearchResults"$>
<$rsRename("SearchResults", rsNewName)$>
    <$rsFirst(rsNewName)$>
    <$loopwhile getValue(rsNewName, "#isRowPresent")$>
        <!--output code-->
        <$rsNext(rsNewName)$>
    <$endloop$>

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、既存のResultSetの名前です。

  • 2番目のパラメータは、新しいResultSetの名前です。ResultSetがすでに存在している場合、コールは失敗します。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

SearchResults ResultSetの名前をMySearchResultsに変更します。

<$rsRename("SearchResults", "MySearchResults")$>

A.320 rsRenameField()

ResultSetのフィールド名を変更します。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータは、名前を変更するフィールドのあるResultSetの名前です。

  • 2番目のパラメータは、フィールドの現在の名前です。

  • 3番目のパラメータは、フィールドの新しい名前です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

warehouse ResultSetのinvoiceフィールドの名前をoutlaysに変更します。 

<$exec rsRenameField("warehouse", "invoice", "outlays")$>

A.321 rsSetRow()

ResultSet内の指定された行に移動します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、ResultSetの名前です。

  • 2番目のパラメータは、行番号です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗するか、ResultSetが空の場合、FALSEを返します。

例

SearchResults ResultSetを10番目の行に進めます。

<$exec rsSetRow("SearchResults",10)$>

A.322 rsSort()

ResultSetを特定の列でソートします。

タイプおよび使用方法

パラメータ

次の4つのパラメータをとります。次に例を示します。

rsSort(rsName,sortCol,sortType,sortOrder)
パラメータ 説明

rsName

ResultSetの名前。

sortCol

ソート基準となる列の名前。

sortType

ソートのタイプ(デフォルトはint):

string: アルファベット順にソート

int: 数値でソート

date: 日付別にソート

sortOrder

ソート順(デフォルトはasc):

asc: 昇順

desc: 降順

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗するか、ResultSetが空の場合、FALSEを返します。

例

SearchResults ResultSetをコンテンツIDにより降順でソートします。

<$rsSort("SearchResults","dDocName","string","desc")$>

A.323 rsSortTree()

XMLデータ構造(ノード、親ノード、深さ属性のあるもの)の表現であるResultSetをソートします。

タイプおよび使用方法

パラメータ

7つのパラメータをとります。次に例を示します。

rsSortTree(rsName,itemIdCol,parentIdCol,nestLevelCol,sortCol,sortType,sortOrder)
パラメータ 説明

rsName

ResultSetの名前。

itemIdCol

各ノードの一意のIDが含まれている列の名前。

parentIdCol

親ノード(存在する場合)のIDが含まれている列の名前。

nestLevelCol

各ノードのネスト・レベル(深さ)が含まれている列の名前。

sortCol

ソート基準となる列の名前。

sortType

ソートのタイプ(デフォルトはint):

string: アルファベット順にソート

int: 数値でソート

date: 日付別にソート

sortOrder

ソート順(デフォルトはasc):

asc: 昇順

desc: 降順

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗するか、ResultSetが空の場合、FALSEを返します。

例

discussionPosts ResultSetをitemNumber列によって昇順でソートします。

<$rsSortTree("discussionPosts", "discussionPosts!itemNumber", 
    "discussionPosts!parentNumber", "dpItemNestLevel", 
    "discussionPosts!itemNumber", "int", "asc")$>

A.324 SafeDir

余分のコンテンツ・サーバー・ファイルがContent Serverアナライザ・ユーティリティによって移動される場所を取得します。

デフォルトは、IdcAnalyzeLogDir設定により指定されたログ・ディレクトリにあるサブディレクトリです。

この変数は設定可能ではありません。

タイプおよび使用方法

例

スクリプトとして、構成設定の値を返します。

<$SafeDir$>

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のIdcAnalyzeLogDirに関する項

A.325 SCRIPT_NAME

CGIリンク・ファイルへの相対パスを取得します。

CGIリンク・ファイルは、オペレーティング・システムおよびWebサーバーごとに異なるWebサーバー・セキュリティ・フィルタの実行可能ファイルです。たとえば、Solarisの場合のファイル名はnph-idc_cgi.exeです。

タイプおよび使用方法

出力

文字列として相対パスを返します。

例

ページまたはログへの情報出力としての使用例: 

SCRIPT_NAME=/idcplg/idc_cgi_isapi-instance>.dll

Idoc Script文または評価の一部としての使用例:

<$if SCRIPT_NAME$>
<!--statement-->

A.326 SelfRegisteredAccounts

自己登録ユーザーに指定されるデフォルトのアカウントと権限を定義します。

これはカンマ区切りリストです。

アカウント別の権限を、アカウント名の後にカッコに入れて指定する必要があります。

#noneエントリは、アカウントが割り当てられていないコンテンツ・アイテムに権限を付与します。#allエントリでは、すべてのアカウントに権限が与えられます。

デフォルト値はありません。

文字列としてアカウントのリストを返します。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • 内部セキュリティ

場所

IntradocDir/config/config.cfg

例

構成設定の使用例: 

SelfRegisteredAccounts=#none(RWDA),USERS/<$NewUser$>,BOS(R)

スクリプトとして、文字列として定義済アカウント情報を返します。

<$SelfRegisteredAccounts$>

関連項目

A.327 SelfRegisteredRoles

自己登録ユーザーに指定されるデフォルトのロールを定義します。

これはカンマ区切りリストです。

デフォルト値はありません。

文字列としてロールを返します。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • 内部セキュリティ

場所

IntradocDir/config/config.cfg

例

構成設定の使用例:

SelfRegisteredRoles=guest,salesRole

スクリプトとして、文字列として定義済ロールを返します。

<$SelfRegisteredRoles$>

関連項目

A.328 SERVER_NAME

自己参照URLに表示されるようなホスト名、DNSエイリアスまたはWebサーバーのIPアドレスを取得します。

この変数はリクエスト固有ではなく、すべてのリクエストに対して設定されます。

タイプおよび使用方法

出力

文字列としてサーバー情報を返します。

例

ページまたはログへの情報出力としての使用例: 

SERVER_NAME=centralserver

Idoc Script文または評価の一部としての使用例: 

<$if SERVER_NAME$>
<!--statement-->

A.329 SERVER_PORT

リクエストが送信されたWebサーバーのポート番号を取得します。

この変数は、現在のゲートウェイ・プログラム・リクエスト固有のものです。

タイプおよび使用方法

出力

文字列としてポート番号を返します。

例

ページまたはログへの情報出力としての使用例:

SERVER_PORT=80

Idoc Script文または評価の一部としての使用例:

<$if SERVER_PORT$>
<!--statement-->

A.330 SERVER_PROTOCOL

受信リクエストのプロトコルとリビジョンを返します。

この変数は、現在のゲートウェイ・プログラム・リクエスト固有のものです。

タイプおよび使用方法

出力

文字列をprotocol/revisionのフォーマットで返します。

例

ログへの情報出力としての使用例: 

SERVER_PROTOCOL=HTTP/1.0

Idoc Script文または評価の一部としての使用例:

<$if SERVER_PROTOCOL$>
<!--statement-->

A.331 SERVER_SOFTWARE

この設定は、バージョン7.0以降では廃止されています。

Webサーバー・フィルタでは、この情報は送信されなくなりました。

リクエストに回答しているWebサーバー・ソフトウェアの名前とバージョンを返します。

これは、ゲートウェイを実行しているサーバーでもあります。

この変数はリクエスト固有ではなく、すべてのリクエストに対して設定されます。

タイプおよび使用方法

出力

文字列をname/versionのフォーマットで返します。

例

ページまたはログへの情報出力としての使用例:

SERVER_SOFTWARE=Microsoft-IIS/4.0

Idoc Script文または評価の一部としての使用例:

<$if SERVER_SOFTWARE$>
<!--statement-->

A.332 setContentType()

返されたページに対してコンテンツ・タイプを設定し、ブラウザがそのページを適切にレンダリングできるようにします。たとえば、text/plain、application/excelまたはtext/xmlというコンテンツ・タイプ(ファイル形式タイプまたはMIMEタイプ)です。

タイプおよび使用方法

パラメータ

唯一のパラメータはコンテンツ・タイプです。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$setContentType("text/plain")$>

A.333 setCookie

ブラウザにCookie値を設定します。

セッション情報、または匿名ユーザーに関する情報の保持に使用します。

有効期限を渡して、指定した時間にCookieが期限切れになるようにすることもできます。

注意:

セキュア・データをCookieに格納しないでください。悪質なユーザーによってサイトにCookieが設定されるリスクがあるため、Cookieの使用を制限してください。

タイプおよび使用方法

パラメータ

この関数は、次の3つのパラメータを取ることができます。

  • 最初のパラメータは、Cookieの名前です。

  • 2番目のパラメータは、設定される値です。

  • 3番目のパラメータは、Cookieの期限切れを指定する有効期限インジケータです。

例

次の例では、Cookie myCounterがユーザーのブラウザに設定され、ユーザーがこのページにアクセスすると値が増分されます。このCookieは1日で期限切れになります。

<$myCounter=getCookie("myCounter")$>
<$if not myCounter$>
    <$myCounter=1$>
<$endif$>
Num times loaded: <$myCounter$>
<$setCookie("myCounter", myCounter+1, dateCurrent(1))$>

関連項目

A.334 setExpires()

この関数は、ページの有効期限の絶対時間の設定に使用できます。これは、存続期間が長く、頻繁にリクエストされる可能性のあるページで使用するのが最適です。クライアントとサーバー間の時間同期化の問題により、特に存続期間の短いキャッシュの場合は全面的に信頼できるわけではありません。データは、受入れ可能なHTTP日付フォーマットの1つに従って設定する必要があります。

詳細は、次のW3プロトコルを参照してください。

http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3

タイプおよび使用方法

パラメータ

唯一のパラメータは、HTTPが必要とするフォーマットの絶対日付であり、この後でページをリフレッシュする必要のある日付です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

この設定により、ページは指定された絶対時間に期限切れになります。タイムスタンプはすべてGMTタイムゾーン内である必要があります。 

<$setExpires("Sat, 02 Aug 2003 24:00:00 GMT")$>

これは、他のIdoc Script関数を使用して現在の日付から14日後に有効期限を設定する方法です。

<$date=formatDateWithPattern(dateCurrent(14), "EEE, dd MMM yyyy")$>
<$setExpires(date & " 24:00:00 GMT"))$> >

関連項目

A.335 setHttpHeader()

この関数は、任意のHTTPヘッダーの設定に使用できます。値にはCache-Control、Content-Type、Last-Modifiedまたはその他の受入れ可能なHTTPヘッダーがありますが、これに限られるものではありません。

詳細は、次のW3プロトコルを参照してください。

http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3

タイプおよび使用方法

パラメータ

2つのパラメータをとります。次に例を示します。

setHttpHeader(headerName, headerValue)
パラメータ 説明

headerName

有効なHTTPヘッダーの名前。

headerValue

ヘッダーの値。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

この例ではコンテンツ・タイプがXMLに設定され、渡されたXSLTを使用してブラウザでレンダリングできるようになります。 

<$setHttpHeader("Content-Type", "text/xml")$>

関連項目

A.336 setMaxAge()

この関数は、ページの有効期限の絶対時間の設定に使用できます。これは、存続期間が長く、頻繁にリクエストされる可能性のあるページで使用するのが最適です。クライアントとサーバー間の時間同期化の問題により、特に存続期間の短いキャッシュの場合は全面的に信頼できるわけではありません。データは、受入れ可能なHTTP日付フォーマットの1つに従って設定する必要があります。

詳細は、次のW3プロトコルを参照してください。

http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3

タイプおよび使用方法

パラメータ

唯一のパラメータは、このページの存続期間(単位: 秒)です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

この場合は、ページのコンテンツが即時に期限切れになります。 

<$setMaxAge(0)$>

この例では、このページのキャッシュ存続期間が10分に設定され、この時間の終了後にページを必ずリフレッシュする必要があることをブラウザに通知します。 

<$setMaxAge(600)$>
<$setHttpHeader("Cache-Control", "must-revalidate")$>

関連項目

A.337 setResourceInclude()

インクルードを定義します。

この関数により、動的に構成されたスクリプトをインクルードに割り当てることができます(eval関数でこのようなスクリプトを解析し、評価できる場合と同様です)。

指定されたインクルードがすでに存在している場合は、新しいスクリプトでsuperキーワードを使用して既存のインクルードを参照することができます。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、インクルードの名前です。

  • 2番目のパラメータは、インクルードのコンテンツを定義する文字列です。この文字列には、Idocスクリプトを含めることができます。

出力

インクルードを解析できなかった場合は0を返し、解析できる場合は1を返します。

この動作を抑制するには、execを使用します。

例

文字列「My name is resource include」を使用して、スクリプトを動的に構成します。 

<$setResourceInclude("my_name","My name is <$my_name$>")$>

superキーワードを使用して、std_display_fieldインクルードを変更します。

<$myInclude="<span class='field'><$include super.std_display_field$></span>"
<$setResourceInclude("std_display_field",myInclude)$>

次の例では、返される結果が抑制されます。

<$exec setResourceInclude("std_display_field",myInclude)$>

A.338 setValue()

ターゲットとして、#localまたはResultSetの名前のいずれでも使用できます。ターゲットが#localである場合、パラメータnameは、パラメータvalueによって設定される値のあるローカル・データ変数の名前を識別します。ターゲット領域が空ではなく、#localではない場合、パラメータtargetによって指定されたResultSetのフィールドが設定されます。ResultSetが存在していて、現在有効な現在行にある場合、その行にある特定の列の値(パラメータnameにより指定された列)はパラメータvalueの値を使用して設定されます。フィールドが現在ResultSetの一部でない場合、そのフィールドは新しい列としてそのResultSetに追加され、値が設定されます。ターゲットResultSetが有効な行にない場合、この関数の効果はありません(ただし、内部例外がサーバー出力で報告されます)。この関数はgetValue()と対照的である必要があります。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータは、設定されるターゲット領域(#localまたはResultSetの名前のいずれか)です。

  • 2番目のパラメータは、設定される値を保持するキーの名前(ローカル変数またはResultSetフィールドのいずれか)です。

  • 3番目のパラメータは、設定される値です。

出力

  • この関数が成功した場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

<$setValue(target, name, value)$>

A.339 SharedWeblayoutDir

パスを、プロキシ設定されたコンテンツ・サーバー・インスタンスのweblayoutディレクトリに指定します。

通常この設定は、マスター・コンテンツ・サーバー・インスタンスに、プロキシ設定されたコンテンツ・サーバー・インスタンス上で/weblayout/help/および/weblayout/images/ディレクトリを複製したくない場合を指示するために使用されます。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • ディレクトリとパス

場所

IntradocDir/config/config.cfg

例

構成エントリとしての使用例:

SharedWeblayoutDir=c:/stellent/weblayout/

A.340 SingleGroup

現在のリビジョンがBasicワークフロー内のコントリビュータ・ステップにあるかどうかを評価します。

タイプおよび使用方法

出力

  • リビジョンがコントリビュータ・ステップにある場合、TRUEを返します。

  • リビジョンがコントリビュータ・ステップにない場合、FALSEを返します。

例

リビジョンがコントリビュータ・ステップにあるかどうかを評価します。

<$if not SingleGroup$>

A.341 SourceID

現在の動的サーバー・ページのコンテンツIDを指定します。

この変数は、ref:dIDと同じ値を返します。詳細は、「動的サーバー・ページのメタデータ参照」を参照してください。

タイプおよび使用方法

出力

文字列としてコンテンツIDを返します。

例

現在のHCSFページの値にdID変数を設定します。

<input type=hidden name="dID" value="<$SourceID$>">

A.342 StatusCode

最後の関数コールが成功したか、または失敗したかを指定します。この変数は、サービス・コールの終わりに設定されます。

一部の関数では、成功した場合にこの変数をゼロ(0)に設定します。

一部の関数では、失敗した場合にこの変数を負の数値(-1)に設定します。通常はabortToErrorPage関数をコールして、最新の関数コールによるStatusMessage値とともにエラー・ページが表示されます。

タイプおよび使用方法

出力

  • 最後の関数コールが成功した場合、0を返します。

  • 最後の関数コールが失敗した場合、-1を返します。

例

現在のステータス・コードを返します。

<$StatusCode$>

関連項目

A.343 StatusMessage

最後の関数コールに対するエラー・メッセージを定義します。この変数はサービス・コールの終わりに設定されますが、サービス・コール中の設定が可能です。

この変数は通常、abortToErrorPage関数のコール時にエラー・ページに表示されます。

タイプおよび使用方法

出力

  • 最後の関数コールが成功した場合、OKを返します。

  • 最後の関数コールが失敗した場合、ローカライズされたエラー・メッセージを返します。

例

現在のステータス・メッセージを返します。

<$StatusMessage$>

関連項目

A.344 stdSecurityCheck()

標準のセキュリティ・モデルに基づき、現在のユーザーがリクエストされたコンテンツ・アイテムへのアクセス権を持っているかどうかを確認します。

標準の(または、デフォルトの)セキュリティ・モデルでユーザーに対してコンテンツ・アイテムへのアクセス権が許可されるかどうかを判別するために、アクティブなデータが確認されます。これにより、セキュリティのカスタム実装では標準のセキュリティ・モデルがベースラインとして引き続き実行可能になります。

タイプおよび使用方法

パラメータ

なし。

出力

  • 現在のユーザーにコンテンツ・アイテムへのアクセス権がある場合、TRUEを返します。

  • 現在のユーザーにコンテンツ・アイテムへのアクセス権がない場合、FALSEを返します。

例

ユーザーの権限レベルを、リクエストされたコンテンツ・アイテムと比較します。

<$stdSecurityCheck()$>

A.345 strCenterPad()

文字列の両サイドに同等のスペースを埋め込みます。文字列のそれぞれのサイドに同数のスペースを追加して、文字列が少なくとも指定された長さになるようにします。必要に応じて、文字列の長さに1文字が追加されます。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは文字列です。

  • 2番目のパラメータは文字列長です。

出力

両サイドにスペースを加えた文字列を返します。

例

フォーム<space><space>inf<space><space>を使用して、それぞれのサイドに同数のスペースを埋め込み、7文字の長さの文字列を作成します。

<$strCenterPad("inf", 7)$>

フォーム<space><space><space>inf<space><space><space>を使用して、それぞれのサイドに同数のスペースを埋め込み、9文字の長さの文字列を作成します。

<$strCenterPad("inf", 8)$>

フォーム<space><space><space>inf<space><space><space>を使用して、それぞれのサイドに同数のスペースを埋め込み、9文字の長さの文字列を作成します。

<$strCenterPad("inf", 9)$>

A.346 strCommaAppendNoDuplicates()

この関数は、既存の文字列に新しいトークンを追加します。カンマ1つと新しいトークンを加えた文字列が返されます。文字列にトークンがすでに存在している場合、トークンは追加されません。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは文字列です。

  • 2番目のパラメータはトークンです。

例

<$myString = strCommaAppendNoDuplicates(myString, "A")$>
<$myString = strCommaAppendNoDuplicates(myString, "B")$>
<$myString = strCommaAppendNoDuplicates(myString, "C")$>
<$myString = strCommaAppendNoDuplicates(myString, "A")$>
<$myString = strCommaAppendNoDuplicates(myString, "B")$>

A.347 strConfine()

文字列を最大長に制限し、必要に応じてパディングを追加します。

文字列が指定された長さと等しいか、それより短い場合は、影響を受けません。

文字列が指定された長さよりも長い場合は短縮され、指定された長さに等しくなるように3つのパディング文字が追加されます。パディングに使用する文字は、StrConfineOverflowChars変数を変更することによって指定できます。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは文字列です。

  • 2番目のパラメータは最大文字列長です。

出力

文字列を返します。

例

文字列を制限し、フォームin<dot><dot><dot>を使用して3つのパディング文字(ドット)を追加し、5文字の長さの文字列を作成します。

<$strConfine("inform", 5)$>

文字列を制限し、フォームi<dot><dot><dot><dot>を使用してパディング文字(ドット)を追加し、5文字の長さの文字列を作成します。

<$strConfine("i", 5)$>

文字列を最大10文字の長さに制限して、この6文字の文字列が影響を受けないようにします。

<$strConfine("inform", 10)$>

文字列を最大6文字の長さに制限して、この6文字の文字列が影響を受けないようにします。

<$strConfine("inform", 6)$>

関連項目

A.348 StrConfineOverflowChars

文字列のパディング文字を定義します。

strConfine Idoc Script関数によってパディング用に使用される文字を定義します。

デフォルトはピリオド(ドット)です。

タイプおよび使用方法

  • 『Oracle Fusion Middleware Oracle WebCenter Contentの構成リファレンス』に説明する構成変数。

  • 文字列

場所

IntradocDir/config/config.cfg

例

構成エントリとしての使用例:

StrConfineOverflowChars=.

関連項目

A.349 strEquals()

2つの文字列が、大/小文字の区別も含めて同等であるかどうかを確認します。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは文字列です。

  • 2番目のパラメータは、最初のパラメータと比較される文字列です。

出力

  • 文字列が同等である場合、TRUEを返します。

  • 文字列が同等でない場合、FALSEを返します。

例

文字列が同等であるかどうかを評価して、TRUE (1)を返します。

<$strEquals("Home","Home")$>

文字列が同等であるかどうかを評価して、FALSE (0)を返します。

<$strEquals("home","Home")$>

関連項目

A.350 strEqualsIgnoreCase()

2つの文字列が、大/小文字の区別を含めないで同等であるかどうかを確認します。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは文字列です。

  • 2番目のパラメータは、最初のパラメータと比較される文字列です。

出力

  • 文字列が同等である場合、TRUEを返します。

  • 文字列が同等でない場合、FALSEを返します。

例

文字列が同等であるかどうかを評価して、TRUE (1)を返します。 

<$strEqualsIgnoreCase("home","Home")$>

文字列が同等であるかどうかを評価して、FALSE (0)を返します。

<$strEqualsIgnoreCase("home","page")$>

関連項目

A.351 strGenerateRandom()

この関数は、16進文字のランダム文字列を生成します。lengthパラメータによって指定された数の文字を出力します。長さが指定されていない場合は、16文字がデフォルトになります。

タイプおよび使用方法

パラメータ

パラメータとして文字列の長さを取ります。

A.352 strIndexOf()

文字列が別の文字列の部分文字列であるかどうかを判別します。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは文字列です。

  • 2番目のパラメータは、使用可能な部分文字列です。

出力

  • 2番目の文字列が最初の文字列の部分文字列である場合は、最初の文字列内で部分文字列が始まる箇所を示した索引値を返します。最初の文字の索引値は 0です。

  • 2番目の文字列が最初の文字列の部分文字列でない場合は、-1の値を返します。

例

xyがxyzの部分文字列であるかどうかを評価して、索引値0を返します。

<$if strIndexOf("xyz","xy") >=0$> check for substring <$endif$>

yzがxyzの部分文字列であるかどうかを評価して、索引値-1を返します。

<$if strIndexOf("xyz","yz") >=0$> check for substring <$endif$>

abがxyzの部分文字列であるかどうかを評価して、索引値-1を返し、これが部分文字列ではないことを示します。

<$if strIndexOf("xyz","ab") >=0$> check for substring <$endif$>

A.353 strLeftFill()

文字列の左サイドに文字を充填して、文字列を指定された長さにします。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータは文字列です。

  • 2番目のパラメータは充填文字です。

  • 3番目のパラメータは長さです。

出力

必要に応じて指定された文字を左に充填した文字列を返します。

例

文字Zを左サイドの10個のスペースに充填して、文字列sleepをフォーマット化します。この例では、文字列ZZZZZsleepを返します。

<$strLeftFill("sleep",'Z',10)$>

文字列sleepを返します。

<$strLeftFill("sleep",'Z',4)$>

A.354 strLeftPad()

文字列の左に余分のスペースを埋め込んで、文字列を指定された長さにします。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは文字列です。

  • 2番目のパラメータは長さです。

出力

必要に応じてスペースを左に充填した文字列を返します。

例

フォーム<space><space>infを使用して左に余分なスペースを埋め込み、5文字の長さの文字列を作成します。

<$strLeftPad("inf", 5)$>

文字列informationを返します。

<$strLeftPad("information", 5)$>

A.355 strLength()

文字列の長さを評価します。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

唯一のパラメータは文字列です。

出力

整数値。

例

文字列homeの長さを評価して、整数4を返します。

<$strLength("home")$>

A.356 strLower()

文字列をすべて小文字でフォーマット化します。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

唯一のパラメータは文字列です。

出力

すべて小文字の文字列を返します。

例

文字列Homeを評価して、homeを返します。

<$strLower("Home")$>

A.357 strRemoveWs()

文字列から空のスペースを削除します。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

唯一のパラメータは文字列です。

出力

スペースのない文字列を返します。

例

文字列homeとして、文字列h o m eをフォーマット化します。

<$strRemoveWs("h o m e")$>

A.358 strReplace()

既存の部分文字列を別の部分文字列に置換します。

置換する部分文字列が複数存在する場合、それらはすべて新しい部分文字列に置換されます。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータは、置換が実行される文字列です。

  • 2番目のパラメータは、置換される部分文字列です。

  • 3番目のパラメータは、既存の部分文字列を置換する部分文字列です。

出力

文字列を返します。

例

語classifiedをrestrictedに置換した結果、文字列This document is restrictedが生成されます。

<$strReplace("This document is classified.","classified","restricted")$>

日付のスラッシュをピリオドに置換して、フォーム6.20.2001の日付を生成します。

<$strReplace(formatDateOnly(dateCurrent()),"/",".")$>

A.359 strReplaceIgnoreCase()

既存の部分文字列を別の部分文字列に置換して、大/小文字を区別せずに検索を実行します。

置換する部分文字列が複数存在する場合、それらはすべて新しい部分文字列に置換されます。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータは、置換が実行される文字列です。

  • 2番目のパラメータは、置換される部分文字列です。

  • 3番目のパラメータは、既存の部分文字列を置換する部分文字列です。

出力

文字列を返します。

例

<$hello = "Hello world! I love the world!"$>
<$strReplaceIgnoreCase(hello, "WORLD", "universe")$>

A.360 strRightFill()

文字列の右サイドに文字を充填して、文字列を指定された長さにします。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータは文字列です。

  • 2番目のパラメータは充填文字です。

  • 3番目のパラメータは長さです。

出力

必要に応じて指定された文字を右に充填した文字列を返します。

例

文字Zを右サイドの10個のスペースに充填して、文字列sleepをフォーマット化します。この例では、文字列sleepZZZZZを返します。

<$strRightFill("sleep",'Z',10)$>

文字列sleepを返します。

<$strRightFill("sleep",'Z',4)$>

A.361 strRightPad()

文字列の右に余分のスペースを埋め込んで、文字列を指定された長さにします。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは文字列です。

  • 2番目のパラメータは長さです。

出力

必要に応じてスペースを右に充填した文字列を返します。

例

フォームinf<space><space>を使用して右に余分なスペースを埋め込み、5文字の長さの文字列を作成します。

<$strRightPad("inf", 5)$>

文字列informationを返します。

<$strRightPad("information", 5)$>

A.362 strSubstring()

文字列から部分文字列を取得します。

最初の文字の索引値は0です。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

次の2つまたは3つのパラメータを取ります。

  • 最初のパラメータは文字列です。

  • 2番目のパラメータは、開始索引を表す数字です。

  • 3番目のオプションのパラメータは、終了索引を表す数字です。

出力

部分文字列を返します。

  • 終了索引パラメータが指定されている場合は、開始索引の文字で始まり、終了索引の前の文字で終わる部分文字列が返されます。

  • 終了索引パラメータが指定されていない場合は、開始索引から文字列の終わりまでの部分文字列が返されます。

例

文字列の最初の2文字myを取得します。

<$strSubstring("mystring",0,2)$>

2番目の文字の後の文字列stringを取得します。 

<$strSubstring("mystring",2)$>

関連項目

A.363 strTrimWs()

文字列の最初と最後からスペースを削除します。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

唯一のパラメータは文字列です。

出力

先行スペースまたは後続スペースのない文字列を返します。

例

文字列" homepage "を文字列homepageとしてフォーマット化します。

<$strTrimWs(" homepage ")$>

A.364 strUpper()

文字列をすべて大文字でフォーマット化します。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

唯一のパラメータは文字列です。

出力

すべて大文字の文字列を返します。

例

文字列Homeを評価し、HOMEを返します。

<$strUpper("Home")$>

A.365 SysAdminAddress

システム管理者の電子メール・アドレスを定義します。

これは、ワークフロー通知電子メールおよびコンテンツ・サーバー・インスタンスから送信されるサブスクリプション通知電子メールで使用されるアドレスです。

文字列を返します。

デフォルト値はありません。

タイプおよび使用方法

場所

  • 「システム・プロパティ」、「インターネット」タブ、「管理者の電子メール・アドレス」

  • 「管理」、「管理サーバー」、「インターネットの構成」メニュー・オプション、「管理者の電子メール・アドレス」

  • IntradocDir/config/config.cfg

例

構成設定の使用例:

SysAdminAddress=admin@example.com

スクリプトとして、構成設定の値を返します。

<$SysAdminAddress$>

関連項目

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のMailServerに関する項

  • 『Oracle Fusion Middleware Oracle WebCenter Content構成リファレンス』のSmtpPortに関する項

A.366 TemplateClass

現在のページに対するテンプレートの分類を取得します。

この変数により、テンプレートのアイデンティティに基づいてテンプレートに条件付きコンテンツを作成できます。この変数をテンプレート・ページの中で使用して、サーバーにより配信されたページの配信元を判別します。

標準テンプレートの場合、この変数は、templates.hdaファイル内のIntradocTemplates表のclass列で定義されます。

検索結果テンプレートの場合、この変数はResultsに評価します。

レポート・テンプレートの場合、この変数はReportsに評価します。

動的サーバー・ページの場合、この変数は通常はIdcDynamicFileです。

タイプおよび使用方法

出力

文字列を返します。

例

このマークアップでは、テンプレート情報の表がページに表示されます。

<TABLE>
    <TR><TD>Template Name</TD>
    <TD><$TemplateName$></TD></TR>
    <TR><TD>Template Class</TD>
    <TD><$TemplateClass$></TD></TR>
    <TR><TD>Template Type</TD>
    <TD><$TemplateType$></TD></TR>
    <TR><TD>Template File Path</TD>
    <TD><$TemplateFilePath$></TD></TR>
</TABLE>

関連項目

A.367 TemplateFilePath

テンプレートの実際のロード元のパスを取得します。

この変数により、テンプレートのアイデンティティに基づいてテンプレートに条件付きコンテンツを作成できます。この変数をテンプレート・ページの中で使用して、サーバーにより配信されたページの配信元を判別します。

タイプおよび使用方法

出力

文字列としてパスを返します。

例

このマークアップでは、テンプレート情報の表がページに表示されます。

<TABLE>
    <TR><TD>Template Name</TD>
    <TD><$TemplateName$></TD></TR>
    <TR><TD>Template Class</TD>
    <TD><$TemplateClass$></TD></TR>
    <TR><TD>Template Type</TD>
    <TD><$TemplateType$></TD></TR>
    <TR><TD>Template File Path</TD>
    <TD><$TemplateFilePath$></TD></TR>
</TABLE>

関連項目

A.368 TemplateName

現在のページに対するテンプレートの内部名を取得します。たとえば、DOC_INFOまたはCHECKIN_NEW_FORMです。

この変数により、テンプレートのアイデンティティに基づいてテンプレートに条件付きコンテンツを作成できます。この変数をテンプレート・ページの中で使用して、サーバーにより配信されたページの配信元を判別します。

タイプおよび使用方法

出力

文字列としてテンプレート名を返します。

例

このマークアップでは、テンプレート情報の表がページに表示されます。

<TABLE>
    <TR><TD>Template Name</TD>
    <TD><$TemplateName$></TD></TR>
    <TR><TD>Template Class</TD>
    <TD><$TemplateClass$></TD></TR>
    <TR><TD>Template Type</TD>
    <TD><$TemplateType$></TD></TR>
    <TR><TD>Template File Path</TD>
    <TD><$TemplateFilePath$></TD></TR>
</TABLE>

関連項目

A.369 TemplateType

現在のページのテンプレート・タイプを指定します。

この変数により、テンプレートのアイデンティティに基づいてテンプレートに条件付きコンテンツを作成できます。この変数をテンプレート・ページの中で使用して、サーバーにより配信されたページの配信元を判別します。

標準テンプレートの場合、この変数は、templates.hdaファイル内のIntradocTemplates表のformtype列で定義されます。

検索結果テンプレートの場合、この変数は、templates.hdaファイル内のSearchResultTemplates表のformtype列で定義されます。

レポート・テンプレートの場合、この変数は、reports.hdaファイル内のIntradocReports表のdatasource列で定義されます。

動的サーバー・ページの場合、この変数はhcsp または hcsfのいずれかです。

タイプおよび使用方法

出力

文字列としてテンプレート・タイプを返します。

例

このマークアップでは、テンプレート情報の表がページに表示されます。 

<TABLE>
    <TR><TD>Template Name</TD>
    <TD><$TemplateName$></TD></TR>
    <TR><TD>Template Class</TD>
    <TD><$TemplateClass$></TD></TR>
    <TR><TD>Template Type</TD>
    <TD><$TemplateType$></TD></TR>
    <TR><TD>Template File Path</TD>
    <TD><$TemplateFilePath$></TD></TR>
</TABLE>

関連項目

A.370 toInteger()

文字列を整数に変換します。

注意:

文字列連結、文字列挿入、単純比較の場合は、特殊文字列演算子に説明する文字列演算子を使用します。

タイプおよび使用方法

パラメータ

唯一のパラメータは文字列です。

出力

整数値。文字列が数字に評価されなかったり、整数以外に評価される場合は、エラーがスローされます。

例

文字列4を整数に変換して、値4を返します。

<$toInteger("4")$>

A.371 trace()

デバッグまたはトレース・メッセージのログをIsPageDebug出力に記録できるようにします。メッセージをコンソールまたはシステム・ログに出力することもできます。

タイプおよび使用方法

パラメータ

1つの必須パラメータと2つのオプションのパラメータを取ります。

  • 最初のパラメータは、出力されるメッセージです。次のいずれかの値を使用できます。

    • 文字列。文字列が唯一のパラメータとして渡される場合は、この関数を実行するためにIsPageDebug変数を設定する必要があります。文字列は累積デバッグ・トレースに追加されます。

    • #local: 現在のすべてのローカル変数のダンプを準備します。

    • #all: すべてのローカル・データ、ResultSetおよび環境データの完全なHDAダンプを準備します。

  • 2番目の(オプションの)パラメータは、メッセージがリレーされる場所です。次の値が指定できます。

    • #console: コンソールに表示します。

    • #log: メッセージのログをHTMLログ・ファイルに記録します。

    • 変数の名前(StatusMessageなど)。この場合、メッセージは現在の値に追加されます。

  • 3番目の(オプションの)パラメータは適切なトレーシング・セクション用であり、場所パラメータが#consoleに設定されている場合のみ関連します。

例

次の例では、文字列messageが、常にログされるシステム・コンソールにログとして記録されます。

<$trace("message", "#console")$>

次の例では、文字列messageが、pagecreationトレーシング・セクションにあるシステム・コンソールにログとして記録されます。

<$trace("message", "#console", "pagecreation")$>

次の例では、文字列messageがHTMLコンテンツ・サーバーのログ・ファイルにログとして記録されます。

<$trace("message", "#log")$>

次の例では、すべてのローカル変数とその値がシステム・コンソールにダンプされます。

<$trace("#local", "#console")$>

次の例では、すべてのローカル変数、ResultSetおよび環境変数がシステム・コンソールにダンプされます。

<$trace("#all", "#console")$>

次の例では、すべてのデータが変数MyTraceDumpにダンプされ、あとでページに表示できます。これは、HCSP開発者がコンソール・ログの表示に際して適切なアクセス権を持っていない場合などに役立ちます。

<$trace("#all", "MyTraceDump")$>
<$MyTraceDump$>

関連項目

A.372 UploadApplet

複数ファイルのアップロード・アプレットを有効にします。

注意:

この設定は、Uploadアプレットのカスタム・レガシー・バージョン専用です。標準のMultiUpload変数が有効になっているときには、これを有効にしないでください。

TRUEに設定した場合、アップロード・アプレットが有効になり、複数のファイルを1つのコンテンツ・アイテムとして圧縮してチェックインできるようになります。

FALSEに設定した場合、アップロード・アプレットは無効になります。

デフォルトはFALSEです。

タイプおよび使用方法

場所

IntradocDir/config/config.cfg

例

構成設定として、アップロード・アプレットを有効にします。

UploadApplet=true

スクリプトとして、アップロード・アプレットの条件を評価します。

<$UploadApplet$>

関連項目

A.373 url()

URLで使用するように文字列をフォーマット化します。

この関数は、空白と予約文字をエスケープ・シーケンスに変換します。

タイプおよび使用方法

パラメータ

唯一のパラメータは文字列です。

出力

URLで使用するようにフォーマット化された文字列を返します。

例

文字列home pageをhome%20pageとしてフォーマット化します。

<$url("home page")$>

文字列home/pageをhome%2fpageとしてフォーマット化します。

<$url("home/page")$>

文字列home?pageをhome%3fpageとしてフォーマット化します。

<$url("home?page")$>

A.374 urlEscape7Bit()

この関数は、文字列パラメータのURLエンコード化バージョンを返します。これはurl関数と類似していますが、7ビット・クリーン(ASCII)以外の文字のみをエンコードします。したがって、この関数は同じ文字列上で繰り返しコールできます。

url関数を使用して文字列をダブル・エンコードする場合、すべての%文字は%25にエンコードされます。

タイプおよび使用方法

パラメータ

唯一のパラメータは文字列です。

出力

URLで使用するようにフォーマット化された文字列を返します。

例

<$path = "mÿ fïlë.txt"$>
20fïlë.txt = <$url(path)$>
mÿ%2520fïlë.txt = <$url(url(path))$>
m%ff%20f%efl%eb.txt = <$urlEscape7Bit(url(path))$>
m%ff%20f%efl%eb.txt= <$urlEscape7Bit(urlEscape7Bit(url(path)))$>

関連項目

A.375 UseHtmlOrTextHighlightInfo

全文検索キーワードの強調表示が有効になっているかどうか、およびこのファイル形式(PDF、HTMまたはTXTなど)で強調表示がサポートされているかどうかを確認します。

EnableDocumentHighlightの設定がTRUEである場合、キーワードの強調表示は有効になっています。

タイプおよび使用方法

出力

  • 強調表示が有効になっている場合、TRUEを返します。

  • 強調表示が有効になっていない場合、FALSEを返します。

例

検索キーワードの強調表示ステータスを返します。

<$UseHtmlOrTextHighlightInfo$>

関連項目

A.376 UserAccounts

現在のユーザーが割り当てられているアカウントのカンマ区切りリストを取得します。

  • #none エントリは、アカウントが割り当てられていないコンテンツ・アイテムに対する権限を示します。

  • #all エントリは、すべてのアカウントに対する権限を示します。

タイプおよび使用方法

出力

文字列としてアカウント・リスト・タイプを返します。

例

次に例を示します。

UserAccounts=BOS,SEA,MSP/Gen

このマークアップでは、ユーザー変数がページに表示されます。

<$if UserName$>
    Logon Name: <$UserName$><BR>
    User Name: <$UserFullName$><BR>
    E-mail Address: <$UserAddress$><BR>
    Accounts: <$UserAccounts$><BR>
<$endif$>

A.377 UserAddress

現在のユーザーの電子メール・アドレスを取得します。

タイプおよび使用方法

出力

文字列として電子メール・アドレスを返します。

例

このマークアップでは、ユーザー変数がページに表示されます。

<$if UserName$>
    Logon Name: <$UserName$><BR>
    User Name: <$UserFullName$><BR>
    E-mail Address: <$UserAddress$><BR>
    Default Account: <$UserDefaultAccount$><BR>
<$endif$>

A.378 UserAppRights

現在のユーザーのアプリケーション権利を確認します。

タイプおよび使用方法

出力

ユーザーの権利を指定するビット・フラグ番号を返します。

管理アプリケーション ビット・フラグ

ユーザー管理

1

Webレイアウト・エディタ

2

リポジトリ・マネージャ

4

ワークフロー管理

8

構成マネージャ

16

Archiver

32

例

現在のユーザーのアプリケーション権利を表示します。

<$UserAppRights$>

たとえば、次のように組み合わせると次の番号が生成されます。

  • ユーザー管理 + Webレイアウト・エディタ = 3

  • リポジトリ・マネージャ + ワークフロー管理 + アーカイバ = 44

  • 6つのアプリケーションすべて = 63

関連項目

A.379 UserDefaultAccount

現在のユーザーのデフォルトのアカウントを取得します。

タイプおよび使用方法

出力

文字列としてアカウント名を返します。

例

このマークアップでは、ユーザー変数がページに表示されます。

<$if UserName$>
    Logon Name: <$UserName$><BR>
    User Name: <$UserFullName$><BR>
    E-mail Address: <$UserAddress$><BR>
    Default Account: <$UserDefaultAccount$><BR>
<$endif$>

A.380 UserFullName

現在のユーザーのフルネーム。

タイプおよび使用方法

出力

  • 文字列としてユーザーのフルネームを返します。

  • ユーザーがログインしていない場合は、文字列anonymousを返します。

例

このマークアップでは、ユーザー変数がページに表示されます。

<$if UserName$>
    Logon Name: <$UserName$><BR>
    User Name: <$UserFullName$><BR>
    E-mail Address: <$UserAddress$><BR>
    Default Account: <$UserDefaultAccount$><BR>
<$endif$>

A.381 userHasAccessToAccount()

ユーザーが特定の権限レベルで名前付きアカウントへのアクセス権を持っている場合、この関数はTRUEを返します。権限は、次のようにアクセス・レベルを1文字で表記したものです。

  • R: 読取り。1として指定されます。

  • W: 書込み。2として指定されます。

  • D: 削除。4として指定されます。

  • A: 管理。8として指定されます。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータはアカウント名です。

  • 2番目のパラメータは、確認されるアクセス・レベルです。

出力

  • 現在のユーザーに指定されたアクセス権がある場合、TRUEを返します。

  • ユーザーに指定されたアクセス権がない場合、FALSEを返します。

例

ユーザーが指定されたアカウントの読取りアクセス権を持っているかどうかを評価します。

<$userHasAccessToAccount("profile_account", 1)$>

ユーザーが指定されたアカウントの読取りおよび書込みアクセス権を持っているかどうかを評価します。

<$userHasAccessToAccount("profile_account", 3)$>

A.382 userHasGroupPrivilege()

ユーザーが指定されたグループに対して指定された権限を持っている場合、TRUEを返します。権限は、次のようにアクセス・レベルを1文字で表記したものです。

  • R: 読取り

  • W: 書込み

  • D: 削除

  • A: 管理

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 確認されるセキュリティ・グループ。

  • 確認されるアクセス・レベル。

出力

  • 現在のユーザーに指定されたアクセス権がある場合、TRUEを返します。

  • ユーザーに指定されたアクセス権がない場合、FALSEを返します。

例

ユーザーが指定されたロールを持っているかどうかを評価します。

<$userHasGroupPrivilege("Public", "R")$>
<$userHasGroupPrivilege("Secure", "A")$>

A.383 userHasRole()

現在のユーザーが特定のロールを持っているかどうかを確認します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、ロールの名前です。

出力

  • 現在のユーザーが指定されたロールを持っていない場合、TRUEを返します。

  • ユーザーが指定されたロールを持っていない場合、FALSEを返します。

例

ユーザーが指定されたロールを持っているかどうかを評価します。

<$userHasRole("admin")$>

A.384 UserIsAdmin

現在のユーザーが管理アプレットの権利を持っているかどうかを確認します。

タイプおよび使用方法

出力

  • ユーザーが管理権を持っている場合、TRUEを返します。

  • ユーザーが管理権を持っていない場合、FALSEを返します。

例

ユーザーの管理権を評価します。

<$UserIsAdmin$>

関連項目

A.385 UserLanguageID

ユーザーの優先言語を表す2文字のコード(たとえば、enは英語、frはフランス語、jaは日本語)を返します。

これは、ローカライズ・コンテンツのURLを構成する場合に役立ちます。

タイプおよび使用方法

出力

優先言語のコードを返します。

A.386 UserLocaleId

ユーザーのロケールのフルネーム(たとえば、English-US、English-UK、Japaneseなど)を返します。

ロケールには、言語、日付、数値フォーマットに関する情報が含まれています。

タイプおよび使用方法

出力

優先言語の名前を返します。

A.387 UserName

現在のユーザーのユーザー名を取得します。

タイプおよび使用方法

出力

  • 文字列としてユーザー名を返します。

  • ユーザーがログインしていない場合は、文字列anonymousに評価します。

例

このマークアップでは、ユーザー変数がページに表示されます。

<$if UserName$> Logon Name: <$UserName$><BR>
    User Name: <$UserFullName$><BR>
    E-mail Address: <$UserAddress$><BR>
    Default Account: <$UserDefaultAccount$><BR>
<$endif$>

A.388 UserRoles

現在のユーザーが属しているロールのカンマ区切りリストを取得します。

タイプおよび使用方法

出力

文字列としてユーザー・ロール・リストを返します。

例

次に例を示します。

PublicContributor,ClassifiedConsumer

ユーザー・ロールのリストを参照します。

<$if UserRoles$>
    <$include optional_field$>
<$endif$>

A.389 UseSelfRegistration

ユーザーが独自のユーザー・プロファイルを作成できるようにします。

  • 自己登録したユーザーはグローバル・ユーザーです。

  • SelfRegisteredRolesとSelfRegisteredAccountsを使用して、自己登録したユーザーにデフォルトのロールとアカウントを設定できます。

  • TRUEに設定すると、ポータル・ナビゲーション・バーの「ログイン」リンクの下に「自己登録」リンクが表示されます。(リンクが表示されるには、ポータル・ページをWebレイアウト・エディタで更新する必要があります。)

デフォルトはFALSEです。

使用方法

場所

IntradocDir/config/config.cfg

例

構成設定の使用例:

UseSelfRegistration=true

スクリプトとして、構成設定の値を返します。

<$UseSelfRegistration$>

関連項目

A.390 UseSSL

Secure Sockets Layer (SSL)を有効にします。

  • この設定は、変数HttpWebRootおよびHttpCgiPathに影響します。

  • SSL対応のWebサーバーを使用している場合のみ、Secure Sockets Layerを使用します。

  • TRUEに設定した場合、SSL (httpではなくhttps)が使用されます。

デフォルトはFALSEです。

タイプおよび使用方法

場所

  • 「システム・プロパティ」、「インターネット」タブ、「Secure Sockets Layerの使用」

  • IntradocDir/config/config.cfg

例

構成設定として、SSLを有効にします。

UseSSL=true

スクリプトとして、構成設定の値を返します。

<$UseSSL$>

関連項目

A.391 UseXmlUrl

検索キーワードの強調表示がXMLドキュメントに対して有効になっているかどうかを確認します。TRUEに設定した場合、キーワード検索の実行時にXML URLが構成されます。

タイプおよび使用方法

出力

  • XMLキーワードの強調表示が有効になっている場合、TRUEを返します。

  • XMLキーワードの強調表示が有効になっていない場合、FALSEを返します。

例

XMLドキュメントに対する検索キーワードの強調表示のステータスを返します。

<$UseXmlUrl$>

関連項目

A.392 utGetValue()

指定されたパーソナライズ(ユーザー・トピック)ファイルからユーザー・プロパティの値を返します。

ユーザー・トピック・ファイルは、IntradocDir/data/users/profiles/us/username/ディレクトリに置かれているHDAファイルです。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、ユーザー・トピックHDAファイルの名前です。

  • 2番目のパラメータは、ユーザー・トピック・ファイルで定義されたプロパティの名前です。

出力

指定されたユーザー・トピック・ファイルのプロパティの値を返します。

例

現在のユーザーのpne_portal.hdaファイルにあるemailFormatプロパティの値を返します。

<$utGetValue("pne_portal","emailFormat")$>

関連項目

A.393 utLoad()

パーソナライズ(ユーザー・トピック)ファイルをロードして、utGetValue関数とutLoadResultSet関数で使用できるようにします。

ユーザー・トピック・ファイルは、IntradocDir/data/users/profiles/us/username/ディレクトリに置かれているHDAファイルです。

タイプおよび使用方法

パラメータ

唯一のパラメータは、ユーザー・トピックHDAファイルの名前です。

例

現在のユーザーのwf_in_queue.hdaファイルをロードして、他のユーザー・トピック関数が使用できるようにします。

<$utLoad("wf_in_queue")$>

関連項目

A.394 utLoadDocumentProfiles()

コンテンツ・プロファイルに対するユーザーの現在のMy Check InリンクおよびMy Searchリンクに関する情報の取得に使用します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • ユーザー・トピック名。

  • パーソナライズ・リンクでユーザーが使用できるコンテンツ・プロファイルが含まれているResultSetの名前。

例

<$utLoadDocumentProfiles("pne_portal", "PneDocumentProfiles")

関連項目

A.395 utLoadResultSet()

パーソナライズ(ユーザー・トピック)ファイルで指定されたResultSetをDataBinderにロードします。

ユーザー・トピック・ファイルは、IntradocDir/data/users/profiles/us/username/ディレクトリに置かれているHDAファイルです。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、ユーザー・トピックHDAファイルの名前です。

  • 2番目のパラメータは、ユーザー・トピック・ファイルで定義されたResultSetの名前です。

出力

  • ResultSetが正常にDataBinderにロードされた場合、TRUEを返します。

  • 関数が失敗した場合、FALSEを返します。

例

SavedQueries ResultSetを、現在のユーザーのpne_portal.hdaファイルからDataBinderにロードします。

<$utLoadResultSet("pne_portal","SavedQueries")$>

関連項目

A.396 valueStyle

メタデータ・フィールドの値のスタイルを指定します。

次のSPANスタイルは通常、値に使用します。これらは、WC_CONTENT_ORACLE_HOME/shared/config/resources/std_page.htmリソース・ファイルにあるstd_style_declarationインクルードで定義されます。

  • tableEntry

  • xxsmall

  • strongHighlight

タイプおよび使用方法

出力

値スタイルの名前を返します。

例

値スタイルを設定します。

<$if isFieldInfoOnly$>
    <$if valueStyle$>
        <$fieldValueStyle = valueStyle$>
    <$else$>
        <$fieldValueStyle = "tableEntry"$>
    <$endif$>
<$endif$>

Downloadアプレットが使用されるときに、フィールド値にxxsmallスタイルを使用します。

<$if useDownloadApplet$>
    <$valueStyle="xxsmall", fieldValue = strTrimWs(inc("download_file_by_    applet_form_content"))$>
<$else$>
    <$fieldValue = strTrimWs(inc("doc_file_get_copy"))$>
<$endif$>

関連項目

A.397 WebProxyAdminServer

管理サーバーがコンテンツ・サーバー・インスタンスを管理するかどうかを定義します。

  • TRUEに設定すると、コンテンツ・サーバー・インスタンスは管理サーバーによって直接管理されます。

  • FALSEに設定すると、コンテンツ・サーバー・インスタンスは管理サーバーによって直接管理されません。(ただし、コンテンツ・サーバー・インスタンスが異なるインスタンスの管理サーバーによって管理されることはありえます。)

  • マスター・コンテンツ・サーバー・インスタンスの場合、デフォルトはTRUEです。

  • プロキシ設定されたコンテンツ・サーバー・インスタンスの場合、デフォルトはFALSEです。

タイプおよび使用方法

場所

IntradocDir/config/config.cfg

例

構成エントリとしての使用例:

WebProxyAdminServer=false

A.398 wfAction

現在リビジョンで実行されているアクションを取得します。

  • この変数はワークフロー・ステップの終了イベント後に設定されるため、通常は次のステップの入力イベントの際に評価されます。

  • 次の操作を指定できます。

    • APPROVE

    • REJECT

    • CHECKIN

    • CONVERSION

    • META_UPDATE

    • TIMED_UPDATE

    • RESUBMIT

タイプおよび使用方法

出力

文字列としてアクションの名前を返します。

例

リビジョンが却下されている最中である場合、元の作成者に通知します。

<$if wfAction like "REJECT"$>
    <$wfSet("wfJumpName", "notifyAuthor")$>
    <$wfSet("wfJumpEntryNotifyOff", "0")$>
    <$wfNotify(dDocAuthor, "user")$>
<$endif$>

リビジョンが現在承認中であっても、xDeptのメタデータ値がHRでない場合は、承認が終了して、エラー・ページが表示されます。

<$if wfAction like "APPROVE" and not(xDept like "HR")$>
    <$abortToErrorPage("The revision is not in HR.")$>
<$endif$>

A.399 wfAddActionHistoryEvent()

イベントをワークフローのコンパニオン・データ内のWorkflowActionHistory表に挿入します。この関数には、3つのパラメータが必須です。行のその他の値は、計算されるか、ローカル・データから継承されます。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータはワークフロー・アクションです。

  • 2番目のパラメータは、アクションに関連付けられたメッセージです。

  • 3番目のパラメータは、現在のワークフロー・ステップのユーザーのカンマ区切りリストです。現在のリストを計算する関数については、wfComputeStepUserList()を参照してください。

関連項目

A.400 wfAdditionalExitCondition

現在のステップに定義されている終了条件を取得します。

タイプおよび使用方法

出力

文字列として終了条件を返します。

例

IdcHomeDir/resources/core/templates/workflow_info.htmテンプレート・ページにある次のコードは、「ワークフロー・ステップ情報」ページでの終了条件の表示に使用します。

<$wfDisplayCondition(dWfName, currentStepName, "wfAdditionalExitCondition")$>

この変数の標準的な終了条件は、次のようになります。

dSecurityGroup like "Secure"

A.401 wfAddUser()

ワークフロー・ステップのレビューア・リストにユーザー、エイリアスまたはワークフロー・トークンを追加します。この関数はトークン内でのみ使用できます。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータはユーザー名、エイリアスまたはトークン名を指定します。

  • 2番目のパラメータは、タイプとしてユーザーまたはエイリアスのいずれかを指定します。

例

ユーザーmjonesをレビューアとして追加します。

<$wfAddUser("mjones", "user")$>

元の作成者のトークンとhrエイリアスをレビューアとして追加します。

<$wfAddUser(dDocAuthor, "user")$>
<$wfAddUser("hr", "alias")$>

A.402 wfComputeStepUserList()

ワークフロー内の現在のステップからユーザーのリストを計算します。

タイプおよび使用方法

出力

ユーザーのカンマ区切りリストを返します。

関連項目

A.403 wfCurrentGet()

コンパニオン・ファイルからローカル状態値を取得します。

タイプおよび使用方法

パラメータ

唯一のパラメータはキーです。

出力

コンパニオン・ファイルからローカル状態値を返します。

例

ローカル・キー<step_name>@<workflow_name>.myKeyの値を返します。

<$wfCurrentGet("myKey")$>

関連項目

A.404 wfCurrentSet()

コンパニオン・ファイルのキーのローカル状態値を設定します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータはキーです。

  • 2番目のパラメータは値です。

例

キー<step_name>@<workflow_name>.myKey to myValueを設定します。

<$wfCurrentSet("myKey", "myValue")$>

関連項目

A.405 wfCurrentStep()

現在のステップに関連するステップ名を取得します。

タイプおよび使用方法

パラメータ

唯一のパラメータは、現在のステップに関連するステップ数を表す整数です。

出力

  • ステップ名を返します。

  • ワークフローの最初または最後に到達すると、それぞれ最初のステップ名または最後のステップ名を返します。

例

現在のステップ名を返します。

<$wfCurrentStep(0)$>

直前のステップ名を返します。

<$wfCurrentStep(-1)$>

次のステップ名を返します。

<$wfCurrentStep(1)$>

実際に次のステップに移動するには、次の例に示すようにジャンプを設定する必要があります。

<$wfSet("wfJumpName", "move to next step")$> 
<$wfSet("wfJumpTargetStep", wfCurrentStep(1))$> 
<$wfSet("wfJumpEntryNotifyOff", "0")$>

A.406 wfDisplayCondition()

ワークフロー・ステップの終了条件を取得します。

タイプおよび使用方法

パラメータ

次の3つのパラメータをとります。

  • 最初のパラメータはワークフロー名です。

  • 2番目のパラメータはステップ名です。

  • 3番目のパラメータは、表示される終了条件です。

出力

終了条件式を返します。

例

IdcHomeDir/resources/core/templates/workflow_info.htmテンプレート・ページにある次のコードは、「ワークフロー・ステップ情報」ページでの終了条件の表示に使用します。

<$wfDisplayCondition(dWfName, currentStepName, "wfAdditionalExitCondition")$>

ここで、

  • dWfNameは、ワークフロー名の内部変数です。

  • currentStepNameは、ステップ名の内部変数であるdWfNameと同等になるように、前もってテンプレート・ページに設定されます。

  • wfAdditionalExitConditionは、終了条件式の内部変数です。標準的な終了条件の出力は、次のようになります。

    dSecurityGroup like "Secure"

A.407 wfExit()

ワークフロー・ステップを終了します。この関数では、関数のパラメータに従ってワークフロー内の特定のステップにリビジョンを移動させ、親リスト情報をリセットします。ワークフローを完全に終了するには、wfExit(100,100)または、リビジョンが親ワークフローに戻った後でワークフロー内の最後のステップを確実に通過するパラメータを使用します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、巻き戻すジャンプ数を指定します。

  • 2番目のパラメータは、最初のパラメータによって決定されたステップに対するターゲット・ステップを指定します。

例

ワークフロー内の親ステップに退出します。

<$wfExit(0,0)$>

直前のジャンプ・ステップに戻ります。

<$wfExit(1,0)$>

直前のジャンプ・ステップに戻って、ワークフロー内の次のステップに移動します。

<$wfExit(1,1)$>

A.408 wfGet()

コンパニオン・ファイルから状態値を取得します。

タイプおよび使用方法

パラメータ

唯一のパラメータは状態キーです。

出力

コンパニオン・ファイルから状態値を返します。

例

現在のジャンプ名を返します。 

<$wfGet("wfJumpName")$>

関連項目

A.409 wfGetStepTypeLabel

この関数は内部ワークフローのステップタイプを取得し、判読可能なラベルに変換します。たとえば、:C:CA:CE:は3つの状態、:C: (コントリビューション)、:CA: (自動コントリビュートまたは元の作成者ステップ)および:CE: (リビジョンの編集)を示しています。このIdoc Script関数の適用後、ラベルが「自動コントリビュータ」、「リビジョンの編集」になる場合があります。

指定可能な現在の状態は、次のとおりです。

状態 説明

:CA:

自動コントリビューション・ステップ、またはすべての管理者定義ワークフロー・ステップの前に発生するステップ(元の作成者がドキュメント却下を処理)。

:CE:

現在のリビジョンを編集します。すべての編集が現在のリビジョンに置き換わります。

:CN:

新規リビジョンを作成します。すべての編集によって新規リビジョンが作成されます。

:R:

レビューします。ドキュメントの承認または却下が可能です。

:C:

コントリビューション。ドキュメントの編集が可能です。

ワークフローのドキュメント・ステップの状態には、そのステップに対してtrueであるすべての状態が、複数の値をコロン(:)で区切って(余分のコロンは削除されます)1つのフィールドとして結合されて指定されています。したがって、新規リビジョンを作成するコントリビュータ/レビューアのステップには、状態:R:C:CE:が指定されます。順序は関係ありませんが、:C:は、 :CE:の存在によって推定できる場合であっても、存在している必要があります(ステップがコントリビュータ・ステップであることも含意しています)。値:C:は現在のワークフロー・ステップの機能を正確に表し、コンテンツ・サーバーは含意のルール(:CE: -> :C:)を追求しないため、ワークフロー・ステップではコア・コントリビュータ・タイプのアクティビティ(チェックアウトまたはチェックアウトを元に戻すなど)が許可されないという文により、コンテンツ・サーバー・システムは、:C:は存在しないものと判断します(:CE:が存在している場合でも)。

タイプおよび使用方法

パラメータ

唯一のパラメータは、内部ワークフロー・ステップのタイプの値です。

例

<$wfGetStepTypeLabel(stepType)$>

A.410 wfIsFinishedDocConversion()

現在のアクションの終了後にドキュメントがGENWWWにないかどうかを示します。

このIdoc Script関数がtrueを返した場合、変換プロセスが終了して、コンテンツ・アイテムはGENWWWに存在しなくなります。

タイプおよび使用方法

出力

  • ドキュメントの変換が終了している場合、TRUEを返します。

  • コンテンツ・アイテムがまだGENWWWにあり、変換が終了していない場合、FALSEを返します。

例

<$wfIsFinishedDocConversion()$>

A.411 wfIsNotificationSuppressed()

このワークフローが現在、特定のワークフロー・イベントに対してすべてのワークフロー通知を抑止している場合、TRUEを返します。現在のアクションが終了するまで、またはwfSetSuppressNotification関数を使用して通知が再有効化されるまで、キュー内のワークフローと電子メールへの通知も抑止の対象となります。

通知の抑止は一時的なものです。後続のワークフロー・アクションに対して通知が有効になっていたり、存続が許可されている場合、現在のステップ用に送信されていない通知がすべて送信され、キュー内のワークフローは適宜更新されます。

タイプおよび使用方法

出力

  • 通知が抑止されている場合、TRUEを返します。

  • 通知が抑止されていない場合、FALSEを返します。

例

<$wfIsNotificationSuppressed()$>

関連項目

A.412 wfIsReleasable()

ドキュメントが、ワークフローに関するかぎり、リリースされるかどうかを示します。ドキュメントがまだGENWWにあるかDONEになっている場合でも、このIdoc Script関数がtrueを返す場合、ワークフローはドキュメントのリリースを妨げません。falseが返される場合、ドキュメントはワークフローからリリースするように許可されるまでリリースされません。このIdoc Script関数はパラメータを取りません。存在している可能性のあるすべてのドキュメント情報のアクティブなリリース状態値を評価します(Idoc Scriptの条件では、#active.dReleaseStateが値Eではないかどうかを確認します)。

タイプおよび使用方法

出力

  • ドキュメントがリリース可能である場合、TRUEを返します。

  • コンテンツ・アイテムがリリース可能でない場合、FALSEを返します。たとえば、コンテンツ・アイテムがチェックイン・プロセスおよび変換プロセス(または、その一方)を完了していない場合があります。

例

<$wfIsReleasable()$>

A.413 wfJumpEntryNotifyOff

ジャンプ開始通知のオンとオフを切り替えます。

  • この変数がTRUEの場合、ジャンプの開始時にレビューアに通知されません。

  • この変数がFALSEの場合、ジャンプの開始時にレビューアに通知されます。

タイプおよび使用方法

出力

TRUEまたはFALSEを返します。

例

次のコードでは、ステップ開始通知が0に設定されます。これは、ジャンプに入ると即時にレビューアに通知されることを意味します。

<$wfSet("wfJumpEntryNotifyOff","0")$>

A.414 wfJumpMessage

ジャンプに入ったときにユーザーに送信される通知電子メールに含まれるメッセージを定義します。

  • メッセージが指定されていない場合、電子メールのメッセージには電子メール・テンプレートの情報のみが含まれます。

  • ジャンプ・メッセージには、eval関数を使用して実行する必要のあるIdocスクリプトを含めることができます。次に例を示します。

    <$eval(dDocName)$> is ready for your review.

タイプおよび使用方法

出力

文字列としてメッセージを返します。

例

次のコードでは、ジャンプに入ると同時にユーザーに通知される電子メール・メッセージの中にメッセージThis is the message textが組み入れられます。

<$wfSet("wfJumpMessage","This is the message text")$>

関連項目

A.415 wfJumpName

現在のジャンプの名前を取得します。

タイプおよび使用方法

出力

文字列としてジャンプ名を返します。

例

次のコードでは、現在のジャンプの名前をMyJumpに設定します。

<$wfSet("wfJumpName","MyJump")$>

A.416 wfJumpReturnStep

現在のジャンプの後でワークフローが終了すると同時にリビジョンが戻る親ワークフロー内のステップの名前を返します。

  • この戻りステップは、リビジョンがジャンプ先であるワークフロー内の最後のステップを適切に完了し、ワークフローを通常に終了した場合のみ、適用されます。したがって、この戻りステップは、リビジョンが別のワークフローにジャンプするときには適用されません。

  • コンパニオン・ファイルでは、戻りステップはローカル・キーに格納されます。

    <step_name>@<workflow_name>.returnStep

タイプおよび使用方法

出力

文字列としてステップ名を返します。

例

次のコードでは、戻りステップを親ワークフロー内の次のステップとして設定します。

<$wfSet("wfJumpReturnStep",wfCurrentStep(1))$>

A.417 wfJumpTargetStep

条件が満たされた場合にリビジョンがジャンプするステップの名前を取得します。

ターゲット・ステップは、シンボルを使用して(wfCurrentStep(1)など)、または明示的に(MyStep@MyWorkflowなど)参照できます。ステップ・イベント・スクリプトではシンボルによる参照を使用することを強くお薦めします。こうすることで、スクリプトの変更と再使用が容易になります。

タイプおよび使用方法

出力

文字列としてステップ名を返します。

例

次のコードでは、ターゲット・ステップを明示的に設定します。ジャンプ条件が満たされた場合、リビジョンはMarketingワークフロー内のstep_1というステップにジャンプします。

<$wfSet("wfJumpTargetStep","step_1@Marketing")$>

次のコードでは、シンボルを使用してターゲット・ステップを設定します。ジャンプ条件が満たされた場合、リビジョンは現在のワークフロー内の最初のステップにジャンプします。

<$wfSet("wfJumpTargetStep",WfStart)$>

A.418 wfLoadDesign()

この関数は、ワークフローの既存ステップまたはワークフローの終了条件に関する情報の取得に使用します。

この関数はIntradocDir/data/workflow/design/workflowname.hdaファイルをロードして、ワークフローに関する設計情報が含まれているResultSetを返します。The workflownameの値はdWfName変数の値に対応しており、通常はワークフロー・ページ、電子メール・テンプレート、ジャンプ・スクリプトで使用できます。

タイプおよび使用方法

パラメータ

1つのパラメータとしてワークフローの名前を取ります。

出力

ResultSetとして情報を返します。

例

<$wfLoadDesign(WorkflowName)$>

A.419 wfMailSubject

ワークフローの電子メール通知の件名行を定義します。

件名行が指定されていない場合、電子メールでは、通知のタイプ(レビュー、却下またはワークフロー開始)に応じたデフォルトの件名が使用されます。

件名文字列にIdocスクリプトをインクルードすることができます。

タイプおよび使用方法

出力

文字列として件名行を返します。

例

元の作成者に件名行Content has been releasedを使用して通知します。

<$wfMailSubject="File <$dDocName$> has been released"$>
<$wfNotify(dDocAuthor, "user")$>

関連項目

A.420 wfMessage

ワークフローの電子メール通知に含まれるメッセージを定義します。

メッセージが指定されていない場合、電子メールでは、通知のタイプ(レビュー、却下またはワークフロー開始)に応じたデフォルトのメッセージが使用されます。

メッセージ文字列にIdocスクリプトをインクルードすることができます。

タイプおよび使用方法

出力

文字列としてメッセージを返します。

例

元の作成者にメッセージContent has been releasedを使用して通知します。

<$wfMessage="File <$dDocName$> has been released"$>
<$wfNotify(dDocAuthor, "user")$>

関連項目

A.421 wfNotify()

指定されたユーザー、エイリアスまたはワークフロー・トークンに電子メール・メッセージを送信します。

変数wfMailSubjectおよびwfMessageを設定して、通知メッセージをカスタマイズすることができます。

タイプおよび使用方法

パラメータ

2つのパラメータと、3番目として1つのオプションのパラメータを取ります。

  • 最初のパラメータは、通知の対象となるユーザー名、エイリアスまたはトークンを指定します。

  • 2番目のパラメータは、タイプとしてユーザー、エイリアスまたはトークンのいずれかを指定します。

  • オプションの3番目のパラメータは、メッセージの作成に使用する電子メール・テンプレートの名前を指定します。(テンプレートの定義については、IdcHomeDir/resources/core/templates/templates.hdaファイルを参照してください。)

例

元の作成者に通知します。

<$wfNotify(dDocAuthor, "user")$>

IdcHomeDir/resources/core/templates/reject_mail.htmファイルをテンプレートとして使用して、myAliasエイリアス内のすべてのユーザーに通知します。

<$wfNotify("myAlias", "alias", "WF_REJECT_MAIL")$>

関連項目

A.422 wfParentList

これまでにリビジョンがアクセスしたワークフロー・ステップのリスト(親リスト)を取得します。これにより、ジャンプが発生した場所と、エラー、却下または終了時のステップの巻き戻し方法をシステムに通知します。

この変数は条件文の作成に使用できますが、ハードコード化したり変更したりしないようにしてください。

エラー、却下または終了によって親リストが巻き戻された場合はステップがリストから削除されるため、親リストは完全なステップ履歴を反映していないことがあります。

親リストはグローバルであり、ステップ名でローカライズされることはありません。

親リスト内のステップは、最新のステップを最初にして表示されます。ステップはシャープ記号(#)で区切られています。ステップ名の前にあるアスタリスク(*)は、ジャンプ・ステップであることを示します。次に例を示します。

Step_B@Workflow_2#*Step_A@Workflow_2#Step_1@Workflow_1

タイプおよび使用方法

出力

文字列として親リストを返します。

例

親リストの使用法の1つとして、ワークフロー・スクリプトのテスト中にコンテンツ・アイテムによってアクセスされるジャンプをシミュレートすることができます。たとえば、「テスト」タブまたは「スクリプトの編集」画面でコンテンツ・アイテムを選択して、「アイテムのワークフロー状態のロード」をクリックすると、次の行が生成されます。

wfParentList=step_1@Marketing#contribution@Marketing

A.423 wfReleaseDocument

現在ワークフローによってロックされているドキュメントについて、ワークフローにすべての未処理のドキュメント・リビジョンをリリースさせます。このようにリリースされたリビジョンは索引作成エンジンによって自由に評価できるため、リリースされたリビジョンの1つを全文索引作成することもできます。

この関数は、ワークフロー・イベント全体を実行するワークフロー・ステップをIdoc Scriptで評価するというコンテキストでのみ使用できます。ドキュメントがワークフローによってすでにリリースされている場合、この関数は効果を発揮しません。この関数でドキュメントがワークフローを終了することはありません。

ドキュメントに対して作成された新規リビジョンはすべて、「ロックされた」(リリース不可の)状態に戻ります。つまり、この関数は現在のリビジョンをリリースしますが、新規に作成されるリビジョンには適用されません。この関数はパラメータを取らず、結果を返すことはありません。これは、現在アクティブなワークフロー・ドキュメントに作用します。

タイプおよび使用方法

例

<$wfReleaseDocument()$>

A.424 wfSet()

コンパニオン・ファイルに特定の値のキーを設定します。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータはキーです。

  • 2番目のパラメータは値です。

例

キーwfJumpNameをMyJumpに設定します。

<$wfSet("wfJumpName", "MyJump")$>

関連項目

A.425 wfSetSuppressNotification()

ワークフロー通知が現在のアクション(チェックイン、更新、再送信など)の実行時に送信されるかどうかを示す内部フラグを設定します。

この抑止は、電子メールおよびキュー内のワークフローの更新に適用されます。この関数のもう1つの使用法として、ドキュメントの変換が終了するまでワークフロー通知を抑止することができます。これにより、ドキュメントの変換終了時にドキュメントが自動コントリビュータ・ワークフローのステップを越えないようにすることができます。

タイプおよび使用方法

パラメータ

1つのパラメータとして内部フラグを取ります。1 (TRUE)に設定した場合、通知が抑止されます。0 (FALSE)に設定した場合、通知は抑止されません。

例

<$wfSetSuppressNotification(1)$>

関連項目

A.426 WfStart

リビジョンを現在のワークフローの最初のステップに送信します。この変数は大文字のWで始まることに注意してください。

タイプおよび使用方法

例

ジャンプのターゲット・ステップがワークフローを再開するように設定します。

<$wfSet("wfJumpTargetStep",WfStart)$>

A.427 wfUpdateMetaData()

ワークフローの現在のコンテンツ・アイテム・リビジョンのメタデータ値を定義します。

wfUpdateMetaData関数は、カスタム・メタデータ・フィールドの更新のみに使用できます。この関数を使用して、標準の、事前定義フィールドを更新することはできません。

タイプおよび使用方法

パラメータ

次の2つのパラメータを取ります。

  • 最初のパラメータは、メタデータ・フィールドの名前です。

  • 2番目のパラメータは、メタデータ・フィールドの値です。

例

「コメント」フィールドの値として「This is my comment.」を定義します。

<$wfUpdateMetaData("xComments", "This is my comment.")$>

A.428 xml()

XMLで使用するように文字列をフォーマット化します。

この関数は、英数字以外の文字を、文字を表す適切なXMLシーケンスに置換します。たとえば、アンパサンド"&"文字は"&amp;"シーケンスに置換されます。

文字列の中に二重引用符文字を使用する場合、バックスラッシュ"\"を二重引用符の前に付けてそれを文字として表示する必要があります。エスケープ・フラグとしてバックスラッシュを使用しない場合、二重引用符は文字列の終わりとして解釈されます。

タイプおよび使用方法

パラメータ

唯一のパラメータは文字列です。

出力

URLで使用するようにフォーマット化された文字列を返します。

例

アンパサンドをエスケープして、XMLフォーマットの文字列「Me &amp; you」を返します。

<$xml("Me & you.")$>

英数字以外の文字をエスケープして、XMLフォーマットの文字列「Test the &quot;, &gt;, and &lt; characters」を返します。

<$xml("Test the \", >, and < characters.")$>
前
前へ 		次
次へ
目次へ移動
目次