« オブジェクトの指定方法   |   式の組み立て »

使用可能メソッド

設計者 管理者

各オブジェクトで使用できるメソッドは、以下の通りです。

ディメンション群

メソッド 引数
（省略可の場合、[] で囲む）		 機能

item
第 1 引数

文字列: ディメンションラベル

指定されたラベルをもつディメンションを返します。

  • Dimensions.item("#ACCOUNT") は Dimensions!#ACCOUNT と同じ意味です。

  • 該当するオブジェクトが存在しない場合、 空オブジェクトについて が返されます。

cur

（なし）

現在のディメンション を返します。cur はメンバリスト中のメンバ選択式内でのみ有効なオブジェクトを返します。返されるオブジェクトはそのメンバリストが適用されているディメンションです。

  • Dimensions.cur は Dimensions!@cur と同じ意味です。

  • 該当するオブジェクトが存在しない場合、 空オブジェクトについて が返されます。

ディメンション

メソッド 引数
（省略可の場合、[] で囲む）		 機能

label

（なし）

ディメンションのラベルを返します。

name
[第 1 引数]

文字列: ロケール
(fusion_place >= 14.1)

ディメンションの 名称 を返します。

ロケールを指定した場合、そのロケールでの 名称 を返します。
日本語は "ja" 、英語は "en" となります。ユーザーが言語を追加した場合、その言語も指定可能です。
指定した言語での名称が無い場合はエラーとはならず、空文字列を返します。⚠

例）

  #ACCOUNT.name("en") & "/" & #ACCOUNT.name("ja")

desc

（なし）

ディメンションの 説明 を返します。

item
第 1 引数

文字列: メンバラベル

指定されたラベルをもつメンバを返します。

  • #ACCOUNT.item("SALES") は #ACCOUNT!SALES と同じ意味です。

  • 該当するオブジェクトが存在しない場合、 空オブジェクトについて が返されます。

cur

（なし）

現在のメンバ を返します。

  • #ACCOUNT.cur は #ACCOUNT!@cur と同じ意味です。

  • 該当するオブジェクトが存在しない場合、 空オブジェクトについて が返されます。

pov

（なし）

視点メンバ を返します。

  • #ACCOUNT.pov は #ACCOUNT!@pov と同じ意味です。

  • 該当するオブジェクトが存在しない場合、 空オブジェクトについて が返されます。

rkey

（なし）

責任範囲指定キーメンバ を返します。

  • #ACCOUNT.rkey は #ACCOUNT!@rkey と同じ意味です。

  • 該当するオブジェクトが存在しない場合、 空オブジェクトについて が返されます。

メンバ

メソッド 引数
（省略可の場合、[] で囲む）		 機能

label

（なし）

メンバのラベルを返します。

name
[第 1 引数]

文字列: ロケール
(fusion_place >= 14.1)

メンバの 名称 を返します。

ロケールを指定した場合、そのロケールでの 名称 を返します。
日本語は "ja" 、英語は "en" となります。ユーザーが言語を追加した場合、その言語も指定可能です。
指定した言語での名称が無い場合はエラーとはならず、空文字列を返します。⚠

例）

  #ACCOUNT!@cur.name("en") & "/" & #ACCOUNT!@cur.name("ja")

desc

（なし）

メンバの 説明 を返します。

item
第 1 引数

文字列: プロパティラベル

指定されたラベルをもつプロパティの値を返します。

  • #ACCOUNT!SALES.item("#ACTIVE") は #ACCOUNT!SALES!#ACTIVE と同じ意味です。

  • 該当するオブジェクトが存在しない場合、 空オブジェクトについて が返されます。

is_child_of
第 1 引数

メンバオブジェクト

メソッド呼び出し先メンバが、引数で与えられたメンバの子（直下のメンバ）である場合 TRUE を返します。以外のときは FALSE を返します。

例）

  #ACCOUNT!@cur.is_child_of(#ACCOUNT!#SALES)  (1)
1 現在の勘定科目メンバが SALES というラベルを持つ勘定科目の子である場合にのみ TRUE を返します。

is_descendent_of
第 1 引数

メンバオブジェクト

メソッド呼び出し先メンバが、引数で与えられたメンバの子孫（自分自身及びその直接・間接の子）である場合 TRUE を返します。以外のときは FALSE を返します。

例）

  #ACCOUNT!@cur.is_descendent_of(#ACCOUNT!#SALES)  (1)
1 現在の勘定科目メンバが SALES というラベルを持つ勘定科目の子孫である場合にのみ TRUE を返します。

ancestor
第 1 引数

メンバオブジェクト: 共通祖先メンバオブジェクト

第 2 引数

文字列: メンバ分類プロパティラベル

第 3 引数

文字列: メンバ分類プロパティ値

メソッド呼び出し先メンバの祖先メンバ（自分自身及びその直接・間接の親）のうち、指定された条件を満たすメンバをひとつ返します。そのようなメンバが複数ある場合、そのうち最も下位にあるメンバを返します。

条件は、第 2 引数と第 3 引数で指定します。詳細は メンバ分類プロパティによるメンバ絞り込み をご覧ください。

例）

  DEPT!@cur.ancestor(DEPT!ALL, "DEPT_TYPE", "DIV") (1)
1 部門/DEPT ディメンションにおける 現在のメンバ の親メンバのうち ALL メンバ以下のメンバツリーに属し、かつ 部門タイプ/DEPT_TYPE プロパティ値が 事業部/DIV のメンバを返します。

lowest_common_ancestor
第 1 引数

メンバオブジェクト: メンバオブジェクト 1

第 2 引数

メンバオブジェクト: メンバオブジェクト 2

第 3 引数

文字列: メンバ分類プロパティラベル

第 4 引数

文字列: メンバ分類プロパティ値

特定のメンバツリー内で２つのメンバの共通の祖先メンバを検索して返します。このメソッドが適用されるメンバが、検索範囲であるメンバツリーの頂点です。

条件は、第 3 引数と第 4 引数で指定します。詳細は メンバ分類プロパティによるメンバ絞り込み をご覧ください。条件に合致するメンバが複数ある場合は、そのうち、最下位のものを返します。

例）

  DEPT!ALL.lowest_common_ancestor(DEPT!@CUR, DEPT!@POV, "#LEAF", "FALSE") (1)
1 部門/DEPT ディメンションにおける ALL メンバの子孫のうち、DEPT!@CUR と DEPT!@POV の共通の祖先で、かつ リーフ区分プロパティ値が リーフでない（FALSE） であるメンバを返します。

shares_ancestors_with
第 1 引数

メンバオブジェクト

第 2 引数

論理値: 検索対象をアクティブな先祖に限定するかどうかを指定する論理値

第 3 引数

文字列: メンバ分類プロパティラベル

第 4 引数

文字列: メンバ分類プロパティ値

メソッド呼び出し先メンバと、引数で与えられたメンバが、指定された条件を満たす共通の祖先メンバ（自分自身及びその直接・間接の親）を持つかどうかを判定します。条件に該当する祖先メンバが存在する場合 TRUE を返します。以外のときは FALSE を返します。

第 2 引数

検索対象を 使用中 [1] の祖先に限定するとき TRUE を指定します。限定しないときは FALSE を指定します。

その他の条件は、第 3 引数と第 4 引数で指定します。詳細は メンバ分類プロパティによるメンバ絞り込み をご覧ください。

例）

  DEPT!@cur.shares_ancestors_with(DEPT!@pov, TRUE, "DEPT_TYPE", "DIV") (1)
1 部門/DEPT ディメンションにおける 現在のメンバ と 視点メンバ が、共通の事業部に属する場合のみ TRUE を返します。ただし 部門タイプ/DEPT_TYPE プロパティ値が 事業部/DIV なら、その部門は事業部である、という前提です。
1. 使用区分プロパティの値が「使用中」である意。

メンバ分類プロパティによるメンバ絞り込み

ディメンションメンバに関するメソッドのいくつかは、引数で与えられる メンバ分類プロパティラベル と メンバ分類プロパティ値 を用いて、対象メンバの絞り込みを行います。その際の絞り込み条件は以下の通りです：

  1. メンバ分類プロパティラベルが空白値なら、絞り込みは行われません。

  2. メンバ分類プロパティラベルに #LABEL と指定すると、メンバラベルを検査対象として絞り込みを行います。

  3. 以外の場合、メンバ分類プロパティラベルで指定されるプロパティの値を検査対象として絞り込みを行います。

  4. 検査においては、2 の場合、メンバのラベルが、また 3 の場合にはプロパティ値が、メンバ分類プロパティ値 に指定された値パターンと合致した場合、検査合格と判定します。メンバ分類プロパティ値 には、ワイルドカード文字 ? 及び * を使用できます。? は任意の 1 文字と合致し、* は任意の文字列と合致します。

異なるディメンションに属するメンバ間の関係の判定可否

メンバに関するメソッドのいくつかは、メンバ間の関係を判定します。これらのメソッドには、メソッドの適用対象及び引数として複数のメンバが与えられます。これら複数のメンバは、原則として同一のディメンションに属している必要があります。

ただし、上記の例外として、それら複数のメンバの属するディメンションの内容が同じである場合は、これらのメソッドで、異なるディメンションのメンバ間の関係を判定することが出来ます。なお、2 つのディメンションの「内容が同じ」とは、いずれかがいずれかを 借用 しているか、あるいは、両者が同一のディメンションを借用していることを言います。

これらのメソッドの返し値がメンバオブジェクトである場合もあります。その場合、返されるメンバオブジェクトの属するディメンションは、メソッドの適用対象であるメンバオブジェクトのディメンションとなります。

プロパティ

メソッド 引数
（省略可の場合、[] で囲む）		 機能

label

（なし）

プロパティ値のラベルを返します。

name
[第 1 引数]

文字列: ロケール
(fusion_place >= 14.1)

プロパティ値の 名称 を返します。

ロケールを指定した場合、そのロケールでの 名称 を返します。
日本語は "ja" 、英語は "en" となります。ユーザーが言語を追加した場合、その言語も指定可能です。
指定した言語での名称が無い場合はエラーとはならず、空文字列を返します。⚠

例）

  #ACCOUNT!@cur!#DRCR.name("en")

desc

（なし）

プロパティ値の 説明 を返します。

元帳群

メソッド 引数
（省略可の場合、[] で囲む）		 機能

item
第 1 引数

文字列: 元帳ラベル

指定されたラベルをもつ元帳を返します。

  • Ledgers.item("PL") は Ledgers!PL と同じ意味です。

  • 該当するオブジェクトが存在しない場合、 空オブジェクトについて が返されます。

cur

（なし）

現在アクセス中のセルに結び付けられた元帳を返します。

  • Ledgers.cur は Ledgers!@CUR と同じ意味です。

元帳

メソッド 引数
（省略可の場合、[] で囲む）		 機能

label

（なし）

元帳のラベルを返します。

name
[第 1 引数]

文字列: ロケール
(fusion_place >= 14.1)

プロパティ値の 名称 を返します。

ロケールを指定した場合、そのロケールでの 名称 を返します。
日本語は "ja" 、英語は "en" となります。ユーザーが言語を追加した場合、その言語も指定可能です。
指定した言語での名称が無い場合はエラーとはならず、空文字列を返します。⚠

例）

  Leders!@cur.name("en")

desc

（なし）

元帳の 説明 を返します。

元帳版群

メソッド 引数
（省略可の場合、[] で囲む）		 機能

item
第 1 引数

文字列: 元帳版キー

指定された元帳版キーをもつ元帳版を返します。

  • Editions.item("PUBLIC") は Editions!PUBLIC と同じ意味です。

  • 該当するオブジェクトが存在しない場合、 空オブジェクトについて が返されます。

cur

（なし）

現在アクセス中の元帳版を返します。

  • Editions.cur は Editions!@CUR と同じ意味です。

元帳版

メソッド 引数
（省略可の場合、[] で囲む）		 機能

key

（なし）

元帳版のキー を返します。

owner_label

（なし）

元帳版の所有者である業務責任単位のラベルを返します。

具体的には、元帳版が、 業務プロセス管理機能により生成された「各業務責任単位のワークスペース版」 であるときのみ、ピリオドで元帳版キーを分割した場合の最後のパートを返します。それ以外の元帳版の場合、空文字列を返します。
なお、 提出パッケージの元帳版 についても、当メソッドは空文字列を返す点にご留意ください。

is_submission

（なし）

元帳版が提出パッケージを表すものであるとき TRUE を、以外の時 FALSE を返します。

セル範囲

メソッド 引数
（省略可の場合、[] で囲む）		 機能

total
[セル選択条件が指定可能]

セル範囲に含まれるドキュメントセルの値の集計値を返します。数値は 借方+, 増加+ として集計し、範囲に数値以外があれば、エラー値 #VALUE を返します。範囲にエラー値 #VALUE!, #N/A 等が含まれていればそのエラー値が返されます。

max
(fusion_place >= 10.0)
[セル選択条件が指定可能]

セル範囲に含まれるドキュメントセルの値の最大値を返します。数値は 借方+, 増加+ として判断します。範囲に数値以外がある場合、範囲にエラー値 #VALUE!, #N/A 等が含まれる場合、当該値はスキップします。

min
(fusion_place >= 10.0)
[セル選択条件が指定可能]

セル範囲に含まれるドキュメントセルの値の最小値を返します。数値は 借方+, 増加+ として判断します。範囲に数値以外がある場合、範囲にエラー値 #VALUE!, #N/A 等が含まれる場合、当該値はスキップします。

is_empty

（なし）

セル範囲に含まれるすべてのセルが空である場合 TRUE を返し、以外の場合 FALSE を返します。
数値セルは、値がゼロであるとき、またその時のみ空であるとみなされ、以外のセルは、値が空文字列であるとき、またその時のみ空であるとみなされます。

is_protected

（なし）

セル範囲に含まれるすべてのセルが入力不可である場合 TRUE を返し、以外の場合 FALSE を返します。

is_open

（なし）

セル範囲に含まれるすべてのセルについて、 期間がオープン されている場合 TRUE を返し、以外の場合 FALSE を返します。

value

（なし）

セル範囲の 左上隅のセルの値 を返します。値が数値の場合は 借方+, 増加+ として符号付けした値が返されます。表示されているテキスト値と符号が異なることがあるので注意して下さい。

text

（なし）

セル範囲の 左上隅のセルに表示されているままの文字列値 を返します。同セルの値が数値であっても、text メソッドは文字列値を返すので注意して下さい。

count
(fusion_place >= 12.1)
[セル選択条件が指定可能]

セル範囲に含まれるドキュメントセルの数値セルの個数を返します。範囲に数値以外があれば、当該値はスキップします。範囲にエラー値 #VALUE! , #N/A 等が含まれていればそのエラー値が返されます。ループ仕様の表示条件「データ無しのときは非表示」設定によって結果が変わりますので注意して下さい。

average
(fusion_place >= 12.1)
[セル選択条件が指定可能]

セル範囲に含まれるドキュメントセルの値の平均（算術平均）を返します。数値は 借方+, 増加+ として集計し、範囲に数値以外があれば、エラー値 #VALUE を返します。範囲にエラー値 #VALUE!, #N/A 等が含まれていればそのエラー値が返されます。

集約メソッドにおけるセル範囲の選択条件指定( fusion_place >= 14.1 )

totalメソッドなどの集約メソッドでは、セル範囲の選択条件を引数に指定する事で、選択範囲を絞り込むことが出来ます。指定可能なメソッドは上表の通りです。

  • 呼び出し形式

    メソッドの呼び出し形式は、以下のようになります。（total メソッドを例にしていますが他のメソッドも同様です）

      [集約対象範囲].total（条件範囲, 条件）

    条件は、対にしていくつでも与えることができます。

      [集約対象範囲].total（条件範囲1, 条件1, 条件範囲2, 条件2,…）
集約対象範囲と条件範囲は、含まれる列数、行数それぞれが一致していなければなりません。 一致していない場合、集約メソッドは、エラー値「#VALUE」を返します。

  • 条件の書式

    条件には、数値または文字列が指定可能です。文字列の場合、先頭に比較のための等号・不等号（ =,<>,>,>=,<,<= ）が使用可能です。

      [PRODUCT::LABEL1,LABEL2].total(
      [PRODUCT::LABEL1,LABEL2],"<=10")
      [PRODUCT::LABEL1,LABEL2].total(
      [PRODUCT::LABEL1,LABEL2],"=EIGYO")

    符号を指定しない場合は「=」が付された場合と同様に解釈されます。

      [PRODUCT::LABEL1,LABEL2].total(
       [PRODUCT::LABEL1,LABEL2],5)
      [PRODUCT::LABEL1,LABEL2].total(
       [PRODUCT::LABEL1,LABEL2],"")

    = および <> に続く文字列は、ワイルドカード文字 * と ? を使用できます。* は任意の文字列と合致し、? は任意の 1 文字と合致します。

      [PRODUCT::LABEL1,LABEL2].total(
      [PRODUCT::LABEL1,LABEL3], "<>AA*"  )
      [PRODUCT::LABEL1,LABEL2].total(
      [PRODUCT::LABEL1,LABEL3], "BB???"  )

    ワイルドカード文字を、ワイルドカードとしてではなく * や ? という文字自体として扱いたい場合は、直前に ~ (チルダ) を付すことで、エスケープできます。

      [PRODUCT::LABEL1,LABEL2].total(
      [PRODUCT::LABEL1,LABEL3], "AB~*X")
    チルダがエスケープ文字とみなされるのは、* か ? の少なくともいずれか一文字を含む文字列の中においてのみです。例えば "AB*~X" という文字列は、"AB*X" と同じ意味になりますが、"AB~X" という文字列は、 ABX ではなく "AB~X" という文字列と解釈されます。

空オブジェクトについて

ディメンション、メンバ、プロパティ、元帳などのオブジェクトを返す各種メソッドや関数では、該当するオブジェクトが存在しないことが式の記述時に確定している場合、その式はエラーになります。

例えば、ディメンションの Item メソッドは、ラベルを引数に取りますが、ラベルの値が式の記述時に確定しており、かつ、そのラベルに該当するメンバがその時点で存在しない場合、その式はエラーとなります。

一方、該当するオブジェクトの有無が実行時に確定する場合、対象のオブジェクトが存在しなければ、こうしたメソッドや関数は「空オブジェクト」を返します。

空オブジェクトは、ラベルと名称が空文字列であることで判定できます。したがって、返されたオブジェクトのラベルが空文字列であれば、条件を満たすオブジェクトは存在しないと判断できます。

上記記述が該当するメソッド

オブジェクト メソッド

ディメンション群

cur, item

ディメンション

item, cur, pov, rkey

ディメンションメンバ

item, lowest_common_ancestor, ancestor

元帳群

item

上記記述が該当する関数

find_in_path

なお、元帳版群オブジェクトの Item メソッドは、上記の例外で、引数に指定された元帳版キーをもつ元帳版の存否に関わらず、その元帳版キーをもつ元帳版オブジェクトを返します（そのような元帳版が実際に生成されるわけではありません）。

オブジェクトの名称と言語について

fusion_place の各オブジェクトの名称は多言語です。テキスト式の name メソッドで返される名称は、そのうち「現在選択されている言語」について登録されている名称です。現在選択されている言語に関して名称が登録されていなければ、英語での名称が返されます。

「現在選択されている言語」は状況により異なります。名称が画面表示される場合、「現在の言語」は、メニューで選択されている 表示言語 です。サーバ側での処理などに際しては、クライアント側で指定された言語が適用される場合と、一律に、英語が適用される場合があります。それぞれの処理に関する解説において適宜触れていますので、ご留意ください。

元帳マスク、アクセス許可タイプ、フォームでの書き込み対象値の算出、バリデーションルール、インポート仕様での算出式など、データ表示以外の目的でテキスト式を使う場合、名称を使用することは推奨されません。

オブジェクトの「説明」について

オブジェクトの 説明 とは、オブジェクトのラベルと名称を適宜組合せて表示するものです。説明の表示方法は [マネージャ] / [ブラウザ] / [コントリビュータ] のメニューの オプション  オブジェクト表示 で選択できます。画面表示に関わらない処理においては、説明としては名称が選択されているものとみなされます。サーバ側での計算処理などでは、この規則により常に名称が説明となるので、ご留意ください。説明の表示言語には名称と同じ規則が適用されます。

元帳マスク、アクセス許可タイプ、フォームでの書き込み対象値の算出、バリデーションルール、インポート仕様での算出式など、データ表示以外の目的でテキスト式を使う場合、説明を使用することは推奨されません。

⚠ 引数なしの Name メソッドでは、現在選択されている言語に対応する名称が無かった場合、「 多言語対応 」の項に記述された規則に従って、代替的な言語（ロケール）での名称が選択されるが、 引数として言語を指定した場合、当該言語での名称が無ければ空文字列が返さます。