Oracle® Smart View for Office

開発者ガイド

E88265-03(原本部品番号:E86040-04)

2017年11月

Oracle Smart View for Office開発者ガイド

E88265-03

Copyright © 2004, 2017, Oracle and/or its affiliates All rights reserved.

原本著者: EPM情報開発チーム

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

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

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

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

このソフトウェアもしくはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアもしくはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(redundancy)、その他の対策を講じることは使用者の責任となります。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

OracleおよびJavaはOracle Corporationおよびその関連企業の登録商標です。その他の名称は、それぞれの所有者の商標または登録商標です。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

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

目次

権利および著作権情報

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

ドキュメントのフィードバック

1 Smart View開発者ガイドについて

2 VBA関数について

- 必要な知識

- VBA関数の場所

- VBA関数のコード・サンプルの使用

- 64ビット・バージョンでのVBA関数

- VBAのパラメータ

- VBAの戻り値(エラー・コード)

- Smart ViewでのSpreadsheet Toolkit VBAアプリケーションの使用

- VBA関数タイプ

- VBA関数 - アルファベット順のリスト

3 メニュー関数

- メニュー関数について

- HypMenuVAbout

- HypMenuVAdjust

- HypMenuVBusinessRules

- HypMenuVCalculation

- HypMenuVCascadeNewWorkbook

- HypMenuVCascadeSameWorkbook

- HypMenuVCellText

- HypMenuVCollapse

- HypMenuVConnect

- HypMenuVCopyDataPoints

- HypMenuVExpand

- HypMenuVFunctionBuilder

- HypMenuVInstruction

- HypMenuVKeepOnly

- HypMenuVLRO

- HypMenuVMemberInformation

- HypMenuVMemberSelection

- HypMenuVMigrate

- HypMenuVOptions

- HypMenuVPasteDataPoints

- HypMenuVPivot

- HypMenuVPOVManager

- HypMenuVQueryDesigner

- HypMenuVRedo

- HypMenuVRefresh

- HypMenuVRefreshAll

- HypMenuVRefreshOfflineDefinition

- HypMenuVRemoveOnly

- HypMenuVRulesOnForm

- HypMenuVRunReport

- HypMenuVSelectForm

- HypMenuVShowHelpHtml

- HypMenuVSubmitData

- HypMenuVSupportingDetails

- HypMenuVSyncBack

- HypMenuVTakeOffline

- HypMenuVUndo

- HypMenuVVisualizeinExcel

- HypMenuVZoomIn

- HypMenuVZoomOut

- HypExecuteMenu

- HypHideRibbonMenu

- HypHideRibbonMenuReset

4 一般関数

- 一般関数について

- HypShowPanel

- HypGetVersion

- HypListApplications

- HypListDatabases

- HypGetLastError

- HypShowPov

- HypSetMenu

- HypCopyMetaData

- HypDeleteMetaData

- HypIsDataModified

- HypIsSmartViewContentPresent

- HypIsFreeForm

- HypUndo

- HypRedo

- HypPreserveFormatting

- HypRemovePreservedFormats

- HypSetAliasTable

- HypGetSubstitutionVariable

- HypSetSubstitutionVariable

- HypGetDatabaseNote

- HypGetSheetInfo

5 接続関数

- 接続関数について

- HypConnect

- HypUIConnect

- HypConnected

- HypConnectionExists

- HypCreateConnection

- HypCreateConnectionEx

- HypModifyConnection

- HypDisconnect

- HypDisconnectAll

- HypDisconnectEx

- HypGetSharedConnectionsURL

- HypSetSharedConnectionsURL

- HypIsConnectedToSharedConnections

- HypRemoveConnection

- HypSetSSO

- HypInvalidateSSO

- HypResetFriendlyName

- HypSetActiveConnection

- HypSetAsDefault

- HypSetConnAliasTable

6 アド・ホック関数

- アド・ホック関数について

- HypPerformAdhocOnForm

- HypRetrieve

- HypRetrieveRange

- HypRetrieveNameRange

- HypCreateRangeGrid

- HypModifyRangeGridName

- HypGetNameRangeList

- HypRetrieveAllWorkbooks

- HypExecuteQuery

- HypSubmitData

- HypSubmitSelectedRangeWithoutRefresh

- HypSubmitSelectedDataCells

- HypPivot

- HypPivotToGrid

- HypPivotToPOV

- HypKeepOnly

- HypRemoveOnly

- HypZoomIn

- HypZoomOut

7 フォーム関数

- フォームについて

- HypOpenForm

8 セル関数

- セル関数について

- HypGetDimMbrsForDataCell

- HypCell

- HypFreeDataPoint

- HypGetCellRangeForMbrCombination

- HypGetDataPoint

- HypIsCellWritable

- HypSetCellsDirty

- HypDeleteAllLROs

- HypDeleteLROs

- HypAddLRO

- HypUpdateLRO

- HypListLROs

- HypRetrieveLRO

- HypExecuteDrillThroughReport

- HypGetDrillThroughReports

9 POV関数

- POV関数について

- HypSetPOV

- HypGetBackgroundPOV

- HypSetBackgroundPOV

- HypGetPagePOVChoices

- HypSetPages

- HypGetMembers

- HypSetMembers

- HypGetActiveMember

- HypSetActiveMember

- HypGetDimensions

- HypSetDimensions

10 計算スクリプトおよびビジネス・ルール関数

- 計算スクリプトおよびビジネス・ルール関数について

- HypListCalcScripts

- HypExecuteCalcScript

- HypListCalcScriptsEx

- HypExecuteCalcScriptEx

- HypGetCalcScript

- HypExecuteCalcScriptString

- HypDeleteCalc

11 計算、連結および換算関数

- 計算、連結および換算関数について

- HypCalculate

- HypCalculateContribution

- HypConsolidate

- HypConsolidateAll

- HypConsolidateAllWithData

- HypForceCalculate

- HypForceCalculateContribution

- HypForceTranslate

- HypTranslate

12 メンバー問合せ関数

- メンバー問合せ関数について

- HypFindMember

- HypFindMemberEx

- HypGetAncestor

- HypGetChildren

- HypGetParent

- HypIsAttribute

- HypIsDescendant

- HypIsAncestor

- HypIsExpense

- HypIsParent

- HypIsChild

- HypIsUDA

- HypOtlGetMemberInfo

- HypQueryMembers

- HypGetMemberInformation

- HypGetMemberInformationEx

13 オプション関数

- オプション関数について

- HypGetGlobalOption

- HypSetGlobalOption

- HypGetSheetOption

- HypSetSheetOption

- HypGetOption

- HypSetOption

- HypDeleteAllMRUItems

14 動的リンク関数

- 動的リンク・ビューについて

- 動的リンク・ビューの設定

- マクロの自動実行

- HypUseLinkMacro

- HypSetLinkMacro

- HypGetLinkMacro

- HypGetSourceGrid

- HypDisplayToLinkView

- HypGetConnectionInfo

- HypSetConnectionInfo

- HypGetRowCount

- HypGetColCount

- HypGetPOVCount

- HypGetRowItems

- HypSetRowItems

- HypGetColItems

- HypSetColItems

- HypGetPOVItems

- HypSetPOVItems

15 MDX問合せ関数

- MDXについて

- HypExecuteMDXEx

16 Oracle Journals for Financial Managementの関数

- Oracle Journals for Financial Managementの関数について

- RegAsmを使用したOracle JournalsのVBA関数の登録

- Oracle Journals for Financial Managementの関数を使用する準備

- Oracle Journals for Financial Management拡張機能オブジェクトのインスタンス化

- Oracle Journals for Financial Management拡張機能の関数

- ListJournals

- OpenJournal

- SetJournalProperty

- ListTemplates

- CreateJournal

- SaveJournal

- PerformAction

- ValidateJournal

17 Oracle Analytics Cloudの関数

- Oracle Analytics Cloudの関数について

- Oracle Analytics Cloudの関数を使用する準備

- Oracle Smart View BI拡張機能オブジェクトのインスタンス化

- Oracle Smart View BI拡張機能の関数

- InsertView

- EditPrompts

- EditPagePrompts

- GetPagePrompts

- DeleteView

- AnalysisProperties

- DirProperties

- InvokeMenu

- CopyView

- PasteView

18 Oracle BI EEの関数

- Oracle BI EEの関数について

- Oracle BI EEの関数を使用する準備

- Oracle Smart View BI拡張機能オブジェクトのインスタンス化

- Oracle Smart View BI拡張機能の関数

- InsertView

- EditPrompts

- EditPagePrompts

- GetPagePrompts

- DeleteView

- AnalysisProperties

- DirProperties

- InvokeMenu

- CopyView

- PasteView

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

アクセシビリティに関するオラクル社の取組みの詳細は、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)を参照してください。

Oracleサポートへのアクセス

サポートをご契約のお客様には、My Oracle Supportを通して電子支援サービスを提供しています。詳細は、http://www.oracle.com/pls/topic/lookup?ctx=acc&id=infoを参照してください。聴覚に障害のある方は、http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trsを参照してください。

ドキュメントのフィードバック

このドキュメントに関するフィードバックを提供するには、電子メールをepmdoc_ww@oracle.comに送信するか、Oracle Help Centerのトピックで目次の下にあるフィードバック・ボタンをクリックします(スクロール・ダウンしてボタンを表示する必要がある場合があります)。

次のソーシャル・メディア・サイトで、EPM Information Developmentをフォローしてください。

LinkedIn - http://www.linkedin.com/groups?gid=3127051&goback=.gmp_3127051

Twitter - http://twitter.com/hyperionepminfo

Facebook - http://www.facebook.com/pages/Hyperion-EPM-Info/102682103112642

Google+ - https://plus.google.com/106915048672979407731/#106915048672979407731/posts

YouTube - https://www.youtube.com/user/EvolvingBI

1 Smart View開発者ガイドについて

『Oracle Smart View for Office開発者ガイド』では、Oracle Smart View for Officeのアプリケーションを開発するために使用できるMicrosoft Visual Basic for Applications (VBA)関数について説明します。このリファレンスは、サポートされるVBA関数の詳しい情報と例を必要とする上級ユーザーを対象としています。

2 VBA関数について

関連トピック

- 必要な知識

- VBA関数の場所

- VBA関数のコード・サンプルの使用

- 64ビット・バージョンでのVBA関数

- VBAのパラメータ

- VBAの戻り値(エラー・コード)

- Smart ViewでのSpreadsheet Toolkit VBAアプリケーションの使用

- VBA関数タイプ

- VBA関数 - アルファベット順のリスト

必要な知識

Oracle Smart View for Officeでは、Microsoft ExcelのVisual Basic Editorを使用して、Microsoft Visual Basic for Applications (VBA)関数を使用した一般的なタスクのカスタマイズおよび自動化が可能です。

この章の情報を使用してSmart ViewのVBAアプリケーションを開発するには、次の実用的な知識が必要です。

- Smart ViewおよびSmart Viewが組織でどのように使用されるか

- Visual BasicまたはVBAプログラミング言語

- VBA開発環境としてのExcel Visual Basic Editor

VBA関数の場所

Oracle Smart View for OfficeのVBA関数はすべて、smartview.basファイルに格納されており、デフォルトではEPM_ORACLE_HOME/smartview/binにあります。これらの関数を利用するには、smartview.basをVisual Basic Editorモジュールにインポートし、このモジュールをプログラムのVBA関数のソースとして使用します。

VBA関数のコード・サンプルの使用

このガイドでは、各VBA関数のサンプルを示します。このようなコード・サンプルをVisual Basic Editorモジュールにコピーすることもできますが、モジュールにインポートされるsmartview.basを関数宣言のソースとして使用することをお薦めします。これは、配列を含む宣言の場合に特に重要です。「VBA関数の場所」を参照してください。

コード・サンプルをコピーして貼り付ける場合には、常にこのガイドのHTMLバージョンを使用します。PDFファイルからコピーすると、コード内の文字が消失する可能性があります。

64ビット・バージョンでのVBA関数

64ビット・バージョンのMicrosoft Officeを使用している場合、VBA関数の宣言は32ビット・バージョンとは少し異なります。64ビット・バージョンでは、宣言でDeclareキーワードの後にPtrSafeが含まれます。次に例を示します。

- 32ビット・バージョン: Public Declare Function HypMenuVAbout Lib "HsAddin" () As Long

- 64ビット・バージョン: Public Declare PtrSafe Function HypMenuVAbout Lib "HsAddin" () As Long.

Oracle Smart View for Officeインストールで提供されるsmartview.basファイルによって、適切な宣言文が自動的に含まれます。

注意:

このガイドのコード・サンプルに含まれているのは、Officeの32ビット・バージョン用の宣言です。64ビット・バージョンを使用している場合は、PtrSafeを宣言に組み込む必要があります。

VBAのパラメータ

ほとんどのVBA関数では、1つ以上のパラメータの値を指定する必要があります。表2-1に、パラメータのタイプと、各タイプに有効な値を示します。

表2-1 VBAのパラメータ

パラメータ

値

テキスト

引用符で囲んだ語、句または名前。次に例を示します。

- "Smart View"

- "[Book2.xls]Sheet1"

ブール

- True

- False

範囲オブジェクト

1つのセル、行、または列、1つ以上のセルの選択、または三次元範囲アドレスを、引用符で囲んだもの。次に例を示します。

- RANGE("A1")

- RANGE("A1:B2")

- RANGE("G:G,I:I,K:K")

- RANGE("A1:B5,C1:C10,D5:L8")

- RANGE("Sheet1!C3:R20,Sheet2!C3:R20")

数値

引用符もカンマも含まない1つの数値。次に例を示します。

- 1

- 2.5

- 50000

文字列のリスト

カンマで区切られたテキスト値のリスト。例: "Qtr1", "Actual", "Oregon"

定数

smartview.basで事前定義済の定数

デフォルト値

- Null

- Empty

注意:

多くのパラメータには、NullまたはEmptyが指定された場合に関数で使用するデフォルト値またはデフォルト動作があります。そのようなパラメータに値を指定しない場合は、NullまたはEmptyを使用します。そのようなパラメータのデフォルト値については、各関数の説明を参照してください。

VBAの戻り値(エラー・コード)

Oracle Smart View for OfficeのVBA関数は、表2-2のいずれかの値を戻して、関数が成功したか失敗したかを示します。

- 戻り値ゼロ(0)は、関数が正常に実行されたことを示します。

- 戻り値1または2は、関数が条件付きで正常に実行されたことを示します。

- 負数の戻り値は、クライアントの問題を示します。

- 戻り値4は、サーバーの問題を示します。

注意:

戻り値は、通常、エラー・コードとして参照されます。

表2-2 戻り値(エラー・コード)とその説明

戻り値

名前

説明

4

SS_ERR_ERROR

データ・プロバイダ固有のエラー、または値にマップできない一般的なエラー。

2

SS_NO_GRID_ON_SHEET_BUT_FUNCTIONS_SUBMITTED

関数は正常に実行されましたが、送信された関数シートにグリッドが含まれていませんでした。

1

SS_SHEET_NOT_CONNECTED_BUT_FUNCTIONS_SUBMITTED

関数は正常に実行されましたが、送信された関数シートが接続されていませんでした。

0

SS_OK

関数が正常に実行されました。

-1

SS_INIT_ERR

初期化エラー。

-2

SS_TERM_ERR

終了エラー。

-3

SS_NOT_INIT

初期化エラー。

-4

SS_NOT_CONNECTED

スプレッドシートがサーバーに未接続です。

-5

SS_NOT_LOCKED

スプレッドシートがロックされていません。

-6

SS_INVALID_SSTABLE

スプレッドシートが不安定になりました。

-7

SS_INVALID_SSDATA

スプレッドシートに無効なデータが含まれています。

-8

SS_NOUNDO_INFO

元に戻す操作の情報が存在しません。

-9

SS_CANCELED

操作が取り消されました。

-10

SS_GLOBALOPTS

未使用。

-11

SS_SHEETOPTS

未使用。

-12

SS_NOTENABLED

元に戻す操作が使用可能ではありません。

-13

SS_NO_MEMORY

使用可能なメモリー・リソースが不足しています。

-14

SS_DIALOG_ERROR

適切なダイアログ・ボックスを表示できませんでした。

-15

SS_INVALID_PARAM

関数に無効なパラメータが含まれています。

-16

SS_CALCULATING

計算が実行中です。

-17

SS_SQL_IN_PROGRESS

非推奨設定。

-18

SS_FORMULAPRESERVE

スプレッドシートが式の保持モードであるため操作を実行できません。

-19

SS_INTERNALSSERROR

指定したシートでは操作を実行できません。

-20

SS_INVALID_SHEET

現行シートを判別できません。

-21

SS_NOACTIVESHEET

スプレッドシート名が指定されずアクティブなシートが選択されていません。

-22

SS_NOTCALCULATING

計算が実行されていないため計算を取り消せません。

-23

SS_INVALIDSELECTION

選択パラメータが無効です。

-24

SS_INVALIDTOKEN

未使用。

-25

SS_CASCADENOTALLOWED

カスケード・リスト・ファイルを作成できない、またはスプレッドシートを他の文書に埋め込んだ状態でカスケードを試行しています。

-26

SS_NOMACROS

ライセンスによりスプレッドシート・マクロが実行できません。

-27

SS_NOREADONLYMACROS

ライセンスの制約により、データベースを更新するスプレッドシート・マクロを実行できません。

-28

SS_READONLYSS

読取り専用ライセンスのためデータベースを更新できません。

-29

SS_NOSQLACCESS

非推奨設定。

-30

SS_MENUALREADYREMOVED

メニューはすでに削除されています。

-31

SS_MENUALREADYADDED

メニューはすでに追加されています。

-32

SS_NOSPREADSHEETACCESS

未使用。

-33

SS_NOHANDLES

未使用。

-34

SS_NOPREVCONNECTION

未使用。

-35

SS_LROERROR

未使用。

-36

SS_LROWINAPPACCESSERR

未使用。

-37

SS_DATANAVINITERR

未使用。

-38

SS_PARAMSETNOTALLOWED

未使用。

-39

SS_SHEET_PROTECTED

指定されたワークシートは保護されています。ワークシートの保護を解除して操作を再試行してください。

-40

SS_CALCSCRIPT_NOTFOUND

計算スクリプトが見つかりませんでした。

-41

SS_NOSUPPORT_PROVIDER

プロバイダがサポートされていません。

-42

SS_INVALID_ALIAS

別名が無効です。

-43

SS_CONN_NOT_FOUND

接続が見つかりませんでした。

-44

SS_APS_CONN_NOT_FOUND

Provider Services接続が見つかりませんでした。

-45

SS_APS_NOT_CONNECTED

Provider Servicesが接続されていません。

-46

SS_APS_CANT_CONNECT

Provider Servicesが接続できません。

-47

SS_CONN_ALREADY_EXISTS

接続がすでに存在しています。

-48

SS_APS_URL_NOT_SAVED

Provider Services URLが保存されていません。

-49

SS_MIGRATION_OF_CONN_NOT_ALLOWED

接続の移行が許可されません。

-50

SS_CONN_MGR_NOT_INITIALIZED

接続マネージャが初期化されていません。

-51

SS_FAILED_TO_GET_APS_OVERRIDE_PROPERTY

Provider Servicesのオーバーライド・プロパティの取得に失敗しました。

-52

SS_FAILED_TO_SET_APS_OVERRIDE_PROPERTY

Provider Servicesのオーバーライド・プロパティの設定に失敗しました。

-53

SS_FAILED_TO_GET_APS_URL

Provider Services URLの取得に失敗しました。

-54

SS_APS_DISCONNECT_FAILED

Provider Servicesの切断に失敗しました。

-55

SS_OPERATION_FAILED

操作が失敗しました。

-56

SS_CANNOT_ASSOCIATE_SHEET_WITH_CONNECTION

シートと接続を関連付けできません。

-57

SS_REFRESH_SHEET_NEEDED

ワークシートのリフレッシュが必要です。

-58

SS_NO_GRID_OBJECT_ON_SHEET

シートにグリッド・オブジェクトがありません。

-59

SS_NO_CONNECTION_ASSOCIATED

接続が関連付けられていません。

-60

SS_NON_DATA_CELL_PASSED

データ・セルが渡されていません。

-61

SS_DATA_CELL_IS_NOT_WRITABLE

データ・セルは書込み可能ではありません。

-62

SS_NO_SVC_CONTENT_ON_SHEET

シートにSmart Viewコンテンツがありません。

-63

SS_FAILED_TO_GET_OFFICE_OBJECT

Officeオブジェクトの取得に失敗しました。

-64

SS_OP_FAILED_AS_CHART_IS_SELECTED

チャートが選択されているため操作が失敗しました。

-65

SS_EXCEL_IN_EDIT_MODE

Excelが編集モードになっています。

-66

SS_SHEET_NON_SMARTVIEW_COMPATIBLE

シートにSmart Viewとの互換性がありません。

-67

SS_APP_NOT_STANDALONE

アプリケーションがスタンドアロンではありません。

-68

SS_SMART_VIEW_DISABLED

Smart Viewが使用不可です。

-69

SS_VBA_DEPRECATED

関数が非推奨になっています。

-70

SS_OPERATION_NOT_SUPPORTED_IN_MULTIGRID_MODE

操作は複数グリッド・モードのワークシートではサポートされません。

-71

SS_INVALID_MEMBER

メンバー名が無効です。HypGetMemberInformationで使用されます。

-72

SS_NO_SV_NAME_RANGE

名前付き範囲を使用できません。HypGetNameRangeListで使用されます。

-73

SS_AMBIGUOUS_MENU

メニュー・アイテムが不明のために解決できませんでした。HypExecuteMenu、HypHideRibbonMenuおよびHypHideRibbonMenuResetで使用されます。

Smart ViewでのSpreadsheet Toolkit VBAアプリケーションの使用

Oracle Hyperion Essbase Spreadsheet Toolkitで作成されたVBAアプリケーションは、次の変更を行うことで、Oracle Smart View for Officeに変換できます。

- Spreadsheet Toolkit関数のEssV接頭辞を、Hypに置き換えます。たとえば、EssVRemoveOnlyをHypRemoveOnlyに変更します。

- Spreadsheet Toolkitメニュー関数のEssMenuV接頭辞を、HypMenuVに置き換えます。たとえば、EssMenuVZoomInをHypMenuVZoomInに変更します。

- essxlvba.txtの宣言をsmartview.basの宣言に置き換えます。

VBA関数タイプ

- メニュー関数は、Oracle Smart View for Officeのメニューおよびリボンのコマンドに相当します。「メニュー関数」を参照してください。

- 一般関数は、通常はSmart Viewのリボンまたは「オプション」ダイアログ・ボックスから実行されるアクションの実行、オプションの設定または情報の取得を行います。「一般関数」を参照してください。

- 接続関数は、データ・プロバイダへの接続に関連するアクションを実行します。「接続関数」を参照してください。

- アド・ホック関数は、ズーム、データの取得と送信、ピボットなどのアド・ホック操作を実行します。「アド・ホック関数」を参照してください。

- フォーム関数は、データ・フォームを開きます。「フォーム関数」を参照してください。

- セル関数は、データ・セルとその内容に関する操作の実行と情報の取得を行います。「セル関数」を参照してください。

- POV関数は、POVの設定を指定または取得します。「POV関数」を参照してください。

- 計算スクリプトおよびビジネス・ルール関数は、計算スクリプトとビジネス・ルールを実行したり、リストを取得します。「計算スクリプトおよびビジネス・ルール関数」を参照してください。

- 計算、連結および換算関数は、Oracle Hyperion Financial Managementアプリケーションのデータに対して、これらの操作を実行します。「計算、連結および換算関数」を参照してください。

- メンバー問合せ関数は、メンバーに関する世代、レベル、属性およびその他の情報を取得します。「メンバー問合せ関数」を参照してください。

- オプション関数は、グローバル・オプションとシート・オプション、あるいはその両方に関する情報を設定および取得し、MRUアイテムの削除を可能にします。「オプション関数」を参照してください。

- 動的リンク関数は、動的リンクを介して別のウィンドウに表示されるデータ・ポイント詳細を設定または取得します。「動的リンク関数」を参照してください。

- MDX問合せ関数は、結果がワークシートに表示されないMDX問合せを実行します。「MDX問合せ関数」を参照してください。

- Oracle Journalsの関数では、Smart ViewのFinancial Managementの仕訳機能をサポートしています。「Oracle Journals for Financial Managementの関数」を参照してください。

- Oracle Analytics Cloudの関数では、Oracle Analytics Cloudデータ・ソースに接続している場合のSmart View操作をサポートしています。「Oracle Analytics Cloudの関数」を参照してください

- Oracle BI EEの関数がSmart Viewの操作をサポートするのは、Oracle Business Intelligence Enterprise Editionデータ・ソースに接続している場合です。「Oracle BI EEの関数」を参照してください。

注意:

「VBA関数 - アルファベット順のリスト」も参照してください。

VBA関数 - アルファベット順のリスト

表2-3 VBA関数 - アルファベット順のリスト

VBA関数

適用可能なデータ・ソース

AnalysisProperties

Oracle Analytics Cloud

AnalysisProperties

Oracle Business Intelligence Enterprise Edition

CopyView

Oracle Analytics Cloud

CopyView

Oracle BI EE

CreateJournal

Oracle Hyperion Financial Management、およびFinancial ManagementのOracle Journals拡張機能

DeleteView

Oracle Analytics Cloud

DeleteView

Oracle BI EE

DirProperties

Oracle Analytics Cloud

DirProperties

Oracle BI EE

EditPagePrompts

Oracle Analytics Cloud

EditPagePrompts

Oracle BI EE

EditPrompts

Oracle Analytics Cloud

EditPrompts

Oracle BI EE

GetPagePrompts

Oracle Analytics Cloud

GetPagePrompts

Oracle BI EE

HypAddLRO

Oracle Analytics Cloud - Essbase、Oracle Essbase

HypCalculate

Financial Management

HypCalculateContribution

Financial Management (アド・ホックのみ)

HypCell

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Oracle Hyperion Planning、Financial Management

HypConnect

Essbase、Planning、Financial Management

HypConnected

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypConnectionExists

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypConsolidate

Financial Management (アド・ホックのみ)

HypConsolidateAll

Financial Management (アド・ホックのみ)

HypConsolidateAllWithData

Financial Management (アド・ホックのみ)

HypCreateConnection

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management、Oracle Hyperion Reporting and Analysis

HypCreateConnectionEx

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management、Reporting and Analysis

HypCopyMetaData

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypDeleteAllLROs

Oracle Analytics Cloud - Essbase、Essbase、

HypDeleteAllMRUItems

すべて

HypDeleteCalc

Oracle Analytics Cloud - Essbase、Essbase

HypDeleteLROs

Oracle Analytics Cloud - Essbase、Essbase

HypDeleteMetaData

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management、Reporting and Analysis

HypDisconnect

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypDisconnectAll

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypDisconnectEx

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypDisplayToLinkView

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypExecuteCalcScript

Oracle Analytics Cloud - Essbase、Essbase

HypExecuteCalcScriptEx

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning

HypExecuteCalcScriptString

Essbase

HypExecuteMenu

すべて

HypExecuteDrillThroughReport

Essbase

HypExecuteMDXEx

Oracle Analytics Cloud - Essbase、Essbase

HypExecuteQuery

Oracle Analytics Cloud - Essbase、Essbase

HypFindMember

Oracle Analytics Cloud - Essbase、Essbase

HypFindMemberEx

Oracle Analytics Cloud - Essbase、Essbase

HypForceCalculate

Financial Management

HypForceCalculateContribution

Financial Management (アド・ホックのみ)

HypForceTranslate

Financial Management (アド・ホックのみ)

HypFreeDataPoint

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetActiveMember

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetAncestor

Oracle Analytics Cloud - Essbase、Essbase

HypGetBackgroundPOV

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetCalcScript

Essbase

HypGetCellRangeForMbrCombination

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetChildren

Oracle Analytics Cloud - Essbase、Essbase

HypGetColCount

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypGetColItems

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypGetConnectionInfo

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypGetDatabaseNote

Oracle Analytics Cloud - Essbase、Essbase

HypGetDataPoint

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetDimensions

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetDimMbrsForDataCell

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetDrillThroughReports

Essbase

HypGetGlobalOption

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetLastError

すべて

HypGetLinkMacro

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypGetMemberInformation

Oracle Analytics Cloud - Essbase、Essbase

HypGetMemberInformationEx

Oracle Analytics Cloud - Essbase、Essbase

HypGetMembers

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetNameRangeList

Oracle Analytics Cloud - Essbase、Essbase

HypGetOption

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetPagePOVChoices

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetParent

Oracle Analytics Cloud - Essbase、Essbase

HypGetPOVCount

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypGetPOVItems

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypGetRowCount

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypGetRowItems

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypGetSharedConnectionsURL

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetSheetInfo

すべて

HypGetSheetOption

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypGetSourceGrid

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypGetSubstitutionVariable

Oracle Analytics Cloud - Essbase、Essbase

HypGetVersion

すべて

HypHideRibbonMenu

すべて

HypHideRibbonMenuReset

すべて

HypInvalidateSSO

シングル・サインオン(SSO)をサポートするすべてのプロバイダ

HypIsAncestor

Oracle Analytics Cloud - Essbase、Essbase、

HypIsAttribute

Oracle Analytics Cloud - Essbase、Essbase

HypIsCellWritable

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypIsChild

Oracle Analytics Cloud - Essbase、Essbase

HypIsConnectedToSharedConnections

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypIsDataModified

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypIsDescendant

Oracle Analytics Cloud - Essbase、Essbase

HypIsExpense

Oracle Analytics Cloud - Essbase、Essbase

HypIsFreeForm

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypIsParent

Oracle Analytics Cloud - Essbase、Essbase

HypIsSmartViewContentPresent

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypIsUDA

Oracle Analytics Cloud - Essbase、Essbase

HypKeepOnly

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypListApplications

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypListCalcScripts

Oracle Analytics Cloud - Essbase、Essbase

HypListCalcScriptsEx

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypListDatabases

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning

HypListLROs

Oracle Analytics Cloud - Essbase、Essbase

HypMenuVAbout

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVAdjust

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVBusinessRules

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning

HypMenuVCalculation

Oracle Analytics Cloud - Essbase、Essbase、Financial Management (アド・ホックのみ)

HypMenuVCascadeNewWorkbook

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning

HypMenuVCascadeSameWorkbook

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning

HypMenuVCellText

Oracle Planning and Budgeting Cloud、Planning、Financial Management

HypMenuVCollapse

Oracle Planning and Budgeting Cloud (フォームのみ)、Planning (フォームのみ)

HypMenuVConnect

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVCopyDataPoints

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVExpand

Oracle Planning and Budgeting Cloud (フォームのみ)、Planning (フォームのみ)

HypMenuVFunctionBuilder

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVInstruction

Oracle Planning and Budgeting Cloud (フォームのみ)、Planning (フォームのみ)、Financial Management (フォームのみ)

HypMenuVKeepOnly

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypMenuVLRO

Oracle Analytics Cloud - Essbase、Essbase

HypMenuVMemberInformation

Oracle Analytics Cloud - Essbase、Essbase

HypMenuVMemberSelection

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVMigrate

Financial Management

HypMenuVOptions

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVPasteDataPoints

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVPivot

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypMenuVPOVManager

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVQueryDesigner

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypMenuVRedo

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypMenuVRefresh

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVRefreshAll

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVRefreshOfflineDefinition

Oracle Planning and Budgeting Cloud、Planning

HypMenuVRemoveOnly

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypMenuVRulesOnForm

Oracle Planning and Budgeting Cloud (フォームのみ)、Planning (フォームのみ)

HypMenuVRunReport

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypMenuVSelectForm

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVShowHelpHtml

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVSubmitData

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypMenuVSupportingDetails

Oracle Planning and Budgeting Cloud、Planning

HypMenuVSyncBack

Oracle Planning and Budgeting Cloud、Planning

HypMenuVTakeOffline

Oracle Planning and Budgeting Cloud、Planning

HypMenuVUndo

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypMenuVVisualizeinExcel

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypMenuVZoomIn

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypMenuVZoomOut

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypModifyConnection

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypModifyRangeGridName

Oracle Analytics Cloud - Essbase、Essbase

HypOpenForm

Oracle Planning and Budgeting Cloud、Planning、Financial Management

HypOtlGetMemberInfo

Oracle Analytics Cloud - Essbase、Essbase

HypPerformAdhocOnForm

Oracle Planning and Budgeting Cloud、Planning

HypPivot

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypPivotToGrid

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypPivotToPOV

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypPreserveFormatting

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypQueryMembers

Oracle Analytics Cloud - Essbase、Essbase

HypRedo

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypRemoveConnection

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypRemoveOnly

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypRemovePreservedFormats

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypResetFriendlyName

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypRetrieve

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypRetrieveAllWorkbooks

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypRetrieveLRO

Oracle Analytics Cloud - Essbase、Essbase

HypRetrieveNameRange

Oracle Analytics Cloud - Essbase、Essbase

HypRetrieveRange

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypSetActiveConnection

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetActiveMember

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetAliasTable

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning

HypSetAsDefault

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetBackgroundPOV

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetCellsDirty

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetColItems

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning

HypSetConnAliasTable

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetConnectionInfo

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypSetDimensions

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypSetGlobalOption

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetLinkMacro

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypSetMembers

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetMenu

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetOption

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetPages

Oracle Planning and Budgeting Cloud (フォームのみ)、Planning (フォームのみ)、Financial Management (フォームのみ)

HypSetPOV

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypSetPOVItems

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypSetRowItems

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypSetSharedConnectionsURL

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetSheetOption

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSetSSO

シングル・サインオン(SSO)をサポートするすべてのプロバイダ

HypSetSubstitutionVariable

Oracle Analytics Cloud - Essbase、Essbase

HypShowPanel

すべて

HypShowPov

すべて

HypSubmitData

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management

HypSubmitSelectedDataCells

Oracle Analytics Cloud - Essbase、Essbase

HypSubmitSelectedRangeWithoutRefresh

Oracle Analytics Cloud - Essbase、Essbase

HypTranslate

Financial Management (アド・ホックのみ)

HypUIConnect

Oracle Analytics Cloud、Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud、Essbase、Planning、Financial Management、Oracle BI EE

HypUndo

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypUpdateLRO

Oracle Analytics Cloud - Essbase、Essbase

HypUseLinkMacro

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypZoomIn

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

HypZoomOut

Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Essbase、Planning (アド・ホックのみ)、Financial Management (アド・ホックのみ)

InsertView

Oracle Analytics Cloud

InsertView

Oracle BI EE

InvokeMenu

Oracle Analytics Cloud

InvokeMenu

Oracle BI EE

ListJournals

Financial Management、およびFinancial ManagementのOracle Journals拡張機能

ListTemplates

Financial Management、およびFinancial ManagementのOracle Journals拡張機能

OpenJournal

Financial Management、およびFinancial ManagementのOracle Journals拡張機能

PasteView

Oracle Analytics Cloud

PasteView

Oracle BI EE

PerformAction

Financial Management、およびFinancial ManagementのOracle Journals拡張機能

SaveJournal

Financial Management、およびFinancial ManagementのOracle Journals拡張機能

SetJournalProperty

Financial Management、およびFinancial ManagementのOracle Journals拡張機能

ValidateJournal

Financial Management、およびFinancial ManagementのOracle Journals拡張機能

3 メニュー関数

関連トピック

- メニュー関数について

- HypMenuVAbout

- HypMenuVAdjust

- HypMenuVBusinessRules

- HypMenuVCalculation

- HypMenuVCascadeNewWorkbook

- HypMenuVCascadeSameWorkbook

- HypMenuVCellText

- HypMenuVCollapse

- HypMenuVConnect

- HypMenuVCopyDataPoints

- HypMenuVExpand

- HypMenuVFunctionBuilder

- HypMenuVInstruction

- HypMenuVKeepOnly

- HypMenuVLRO

- HypMenuVMemberInformation

- HypMenuVMemberSelection

- HypMenuVMigrate

- HypMenuVOptions

- HypMenuVPasteDataPoints

- HypMenuVPivot

- HypMenuVPOVManager

- HypMenuVQueryDesigner

- HypMenuVRedo

- HypMenuVRefresh

- HypMenuVRefreshAll

- HypMenuVRefreshOfflineDefinition

- HypMenuVRemoveOnly

- HypMenuVRulesOnForm

- HypMenuVRunReport

- HypMenuVSelectForm

- HypMenuVShowHelpHtml

- HypMenuVSubmitData

- HypMenuVSupportingDetails

- HypMenuVSyncBack

- HypMenuVTakeOffline

- HypMenuVUndo

- HypMenuVVisualizeinExcel

- HypMenuVZoomIn

- HypMenuVZoomOut

- HypExecuteMenu

- HypHideRibbonMenu

- HypHideRibbonMenuReset

メニュー関数について

VBAのメニュー関数は、Oracle Smart View for Officeのメニューおよびリボンのコマンドに相当します。これらのメニュー関数の必要条件は、メニュー・コマンドの必要条件と同じです。たとえば、あるメニュー・コマンドを使用するためにOracle Essbaseサーバーへのログインが必要な場合は、同等のVBAコマンドを使用する際にもEssbaseサーバーへのログインが必要です。

HypMenuVAbout

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Planning and Budgeting Cloud、Oracle Hyperion Financial Management

説明

HypMenuVAbout()は、「ヘルプ」の「バージョン情報」画面を開きます。

構文

HypMenuVAbout()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVAbout Lib "HsAddin" () As Long
Sub MAbout()
X=HypMenuVAbout()
End Sub

HypMenuVAdjust

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVAdjust()は、「データの調整」ダイアログ・ボックスを開きます。

構文

HypMenuVAdjust()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVAdjust Lib "HsAddin" () As Long
Sub MAdjust()
X=HypMenuVAdjust()
End Sub

HypMenuVBusinessRules

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning

説明

HypMenuVBusinessRules()は、「ビジネス・ルール」ダイアログ・ボックスを開きます。

構文

HypMenuVBusinessRules()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVBusinessRules Lib "HsAddin" () As Long
Sub MBusinessRules()
X=HypMenuVBusinessRules()
End Sub

HypMenuVCalculation

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypMenuVCalculation()は、「計算スクリプト」ダイアログ・ボックスを開きます。

構文

HypMenuVCalculation()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVCalculation Lib "HsAddin"() As Long
Sub MCalc()
X=HypMenuVCalculation()
End Sub

HypMenuVCascadeNewWorkbook

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning

説明

HypMenuVCascadeNewWorkbook()は、「メンバー選択」ダイアログ・ボックスを開き、新たに開かれるExcelワークブックのワークシートに対してカスケード・プロセスを開始します。

構文

HypMenuVCascadeNewWorkbook()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVCascadeNewWorkbook Lib "HsAddin" () As Long
Sub MCascadeNewWorkbook()
X=HypMenuVCascadeNewWorkbook()
End Sub

HypMenuVCascadeSameWorkbook

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning

説明

HypMenuVCascadeSameWorkbook()は、「メンバー選択」ダイアログ・ボックスを開き、同じワークブックに対してカスケード・プロセスを開始します。

構文

HypMenuVCascadeSameWorkbook()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVCascadeSameWorkbook Lib "HsAddin" () As Long
Sub MCascadeSameWorkbook()
X=HypMenuVCascadeSameWorkbook()
End Sub

HypMenuVCellText

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVCellText()は、「セル・コメント」ダイアログ・ボックスを開きます。

構文

HypMenuVCellText()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVCellText Lib "HsAddin" () As Long

Sub MCellText()
X=HypMenuVCellText()
End Sub

HypMenuVCollapse

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud (フォームのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning (フォームのみ)

説明

HypMenuVCollapse()は、選択したセルの全レベルの詳細を縮小します。

構文

HypMenuVCollapse()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVCollapse Lib "HsAddin" () As Long
Sub MHypMenuVCollapse()
X=HypMenuVCollapse()
End Sub

HypMenuVConnect

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVConnect()は、Smart Viewパネルを開き、ユーザーがデータ・プロバイダに接続できるようにします。

構文

HypMenuVConnect()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypMenuVConnect Lib "HsAddin"() As Long
Sub MConn()
X=HypMenuVConnect()
End Sub

HypMenuVCopyDataPoints

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVCopyDataPoints()は、WordまたはPowerPointに貼り付けるデータ・ポイントをExcelからコピーします。「HypMenuVPasteDataPoints」も参照してください。

構文

HypMenuVCopyDataPoints()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVCopyDataPoints Lib "HsAddin" () As Long
Sub MCopyDataPoints()
X=HypMenuVCopyDataPoints()
End Sub

HypMenuVExpand

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud (フォームのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning (フォームのみ)

説明

HypMenuVExpand()は、選択したセルの全レベルの詳細を表示します。

構文

HypMenuVExpand()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVExpand Lib "HsAddin" () As Long
Sub MExpand()
X=HypMenuVExpand()
End Sub

HypMenuVFunctionBuilder

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVFunctionBuilder()は、関数ビルダーを開きます。

構文

HypMenuVFunctionBuilder()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVFunctionBuilder Lib "HsAddin" () As Long
Sub MFunctionBuilder()
X=HypMenuVFunctionBuilder()
End Sub

HypMenuVInstruction

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud (フォームのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning (フォームのみ)、Oracle Hyperion Financial Management (フォームのみ)

説明

HypMenuVInstruction()は、「指示」ダイアログ・ボックスを開きます。

構文

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

戻り値

HypMenuVInstruction()

例

Public Declare Function HypMenuVInstruction Lib "HsAddin" () As Long
Sub MInstruction()
X=HypMenuVInstruction()
End Sub

HypMenuVKeepOnly

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypMenuVKeepOnly()は、シート内で選択したメンバー(アクティブ・セル)またはメンバー範囲のみを保持します。

構文

HypMenuVKeepOnly()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypMenuVKeepOnly Lib "HsAddin"() As Long
Sub MKeepOnly()
X=HypMenuVKeepOnly()
End Sub

HypMenuVLRO

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypMenuVLRO()は、「リンク・オブジェクト」ダイアログ・ボックスを開きます。

構文

HypMenuVLRO()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVLRO Lib "HsAddin" () As Long
Sub MLRO()
X=HypMenuVLRO()
End Sub

HypMenuVMemberInformation

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypMenuVMemberInformation()は、「メンバー情報」ダイアログ・ボックスを開きます。

構文

HypMenuVMemberInformation()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVMemberInformation Lib "HsAddin" () As Long
Sub MMemberInformation()
X=HypMenuVMemberInformation()
End Sub

HypMenuVMemberSelection

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVMemberSelection()は、「メンバー選択」ダイアログ・ボックスを開きます。

構文

HypMenuVMemberSelection()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVMemberSelection Lib "HsAddin" () As Long
Sub MMemberSelection()
X=HypMenuVMemberSelection()
End Sub

HypMenuVMigrate

データ・プロバイダ・タイプ: Oracle Hyperion Financial Management

説明

HypMenuVMigrate()は、アクティブ・ワークブックの移行やバッチの移行を行うためのFinancial Management移行ユーティリティを起動します。

構文

HypMenuVMigrate (vtOption, vtOutput)

ByVal vtOption As Variant

ByRef vtOutput As Variant

パラメータ

vtOption: 起動される移行ユーティリティを示す番号:

1 - Financial Managementのアクティブ・ワークブックの移行

2 - Financial Managementのバッチの移行

vtOutput: 出力パラメータ。移行結果を戻します。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVMigrate Lib "HsAddin" (ByVal vtOption As Variant, ByRef vtOutput As Variant) As Long

Sub MigrateHFM()
sts = HypMenuVMigrate(1, out)
MsgBox (out)
MsgBox (sts)
End Sub

HypMenuVOptions

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

データ・プロバイダ・タイプ:

説明

HypMenuVOptions()は、「オプション」ダイアログ・ボックスを開きます。

構文

HypMenuVOptions()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypMenuVOptions Lib "HsAddin"() As Long
Sub MOptions()
X=HypMenuVOptions()
End Sub

HypMenuVPasteDataPoints

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVPasteDataPoints()は、ExcelからWordまたはPowerPointにデータ・ポイントを貼り付けます。「HypMenuVCopyDataPoints」も参照してください。

構文

HypMenuVPasteDataPoints()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVPasteDataPoints Lib "HsAddin" () As Long
Sub MVPasteDataPoints()
X=HypMenuVPasteDataPoints()
End Sub

HypMenuVPivot

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypMenuVPivot()は、選択したセルに関連するメンバーをピボットします。

構文

HypMenuVPivot()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypMenuVPivot Lib "HsAddin"() As Long
Sub MPivot()
X=HypMenuVPivot()
End Sub

HypMenuVPOVManager

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVPOVManager()は、POVマネージャを開きます。

構文

HypMenuVPOVManager()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVPOVManager Lib "HsAddin" () As Long
Sub MPOVManager()
X=HypMenuVPOVManager()
End Sub

HypMenuVQueryDesigner

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypMenuVQueryDesigner()は、クエリー・デザイナを開きます。

構文

HypMenuVQueryDesigner()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypMenuVQueryDesigner Lib "HsAddin"() As Long
Sub MDesigner()
X=HypMenuVQueryDesigner ()
End Sub

HypMenuVRedo

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypMenuVRedo()は、「元に戻す」操作の逆を実行します。

構文

HypMenuVRedo()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVRedo Lib "HsAddin" () As Long
Sub MRedo()
X=HypMenuVRedo()
End Sub

HypMenuVRefresh

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVRefresh()は、アクティブなワークシートをリフレッシュします。

構文

HypMenuVRefresh()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypMenuVRefresh Lib "HsAddin"() As Long
Sub MRetrieve()
X=HypMenuVRefresh()
End Sub

HypMenuVRefreshAll

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVRefreshAll()は、Excelワークブック内の接続されているすべてのワークシートのデータをリフレッシュします。

構文

HypMenuVRefreshAll()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVRefreshAll Lib "HsAddin" () As Long
Sub MRefreshAll()
X=HypMenuVRefreshAll()
End Sub

HypMenuVRefreshOfflineDefinition

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning

説明

HypMenuVRefreshOfflineDefinition()は、オフライン・データ・フォームの定義とデータをリフレッシュします。

構文

HypMenuVRefreshOfflineDefinition()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVRefreshOfflineDefinition Lib "HsAddin" () As Long
Sub MRefreshOfflineDefinition()
X=HypMenuVRefreshOfflineDefinition()
End Sub

HypMenuVRemoveOnly

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypMenuVRemoveOnly()は、シート内で選択したメンバーまたはメンバー範囲のみを削除します。

構文

HypMenuVRemoveOnly()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypMenuVRemoveOnly Lib "HsAddin"() As Long
Sub MRemoveOnly()
X=HypMenuVRemoveOnly()
End Sub

HypMenuVRulesOnForm

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud (フォームのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning (フォームのみ)

説明

HypMenuVRulesOnForm()は、「フォームに関する規則」ダイアログ・ボックスを開きます。

構文

HypMenuVRulesOnForm()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVRulesOnForm Lib "HsAddin" () As Long
Sub MRulesOnForm()
X=HypMenuVRulesOnForm()
End Sub

HypMenuVRunReport

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypMenuVRunReport()は、クエリー・デザイナで設計したレポートを実行します。

構文

HypMenuVRunReport()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVRunReport Lib "HsAddin" () As Long
Sub MRunReport()
X=HypMenuVRunReport()
End Sub

HypMenuVSelectForm

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVSelectForm()は、「フォームの選択」ダイアログ・ボックスを開きます。

構文

HypMenuVSelectForm()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVSelectForm Lib "HsAddin" () As Long
Sub MSelectForm()
X=HypMenuVSelectForm()
End Sub

HypMenuVShowHelpHtml

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVShowHelpHtml()は、オンライン・ヘルプを起動します。

構文

HypMenuVShowHelpHtml(vtHelpPage)

ByVal vtHelpPage As Variant

パラメータ

vtHelpPage: ヘルプを起動するHTMLファイルの名前。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVShowHelpHtml Lib "HsAddin" (ByVal vtHelpPage As Variant) As Long
Sub MShowHelpHtml()
X=HypMenuVShowHelpHtml("SVPBC-over_olh_6")
End Sub

HypMenuVSubmitData

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypMenuVSubmitData()は、変更されたデータ(HypSetCellsDirtyでダーティとしてマークされたデータ)を、サーバー上のアクティブ・データベースに送信します。

構文

HypMenuVSubmitData()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypMenuVSubmitData Lib "HsAddin"() As Long
Sub MSubmit()
X=HypMenuVSubmitData()
End Sub

HypMenuVSupportingDetails

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning

説明

HypMenuVSupportingDetails()は、「サポート詳細」ダイアログ・ボックスを開きます。

構文

HypMenuVSupportingDetails()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVSupportingDetails Lib "HsAddin" () As Long
Sub MSupportingDetails()
X=HypMenuVSupportingDetails()
End Sub

HypMenuVSyncBack

データ・プロバイダ・タイプ: Oracle Hyperion Planning

説明

HypMenuVSyncBack()は、オフラインPlanningデータ・フォームからサーバーにデータを同期します。

構文

HypMenuVSyncBack()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVSyncBack Lib "HsAddin" () As Long
Sub MSyncBack()
X=HypMenuVSyncBack()
End Sub

HypMenuVTakeOffline

データ・プロバイダ・タイプ: Oracle Hyperion Planning

説明

HypMenuVTakeOffline()は、オフライン化ウィザードを起動します。

構文

HypMenuVTakeOffline()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVTakeOffline Lib "HsAddin" () As Long
Sub MTakeOffline()
X=HypMenuVTakeOffline()
End Sub

HypMenuVUndo

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypMenuVUndo()は、直前のデータベース・ビューを復元します。

構文

HypMenuVUndo()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVUndo Lib "HsAddin" () As Long
Sub MUndo()
X=HypMenuVUndo()
End Sub

HypMenuVVisualizeinExcel

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypMenuVVisualizeinExcel()は、データ・ポイントがWordまたはPowerPointにコピーされたExcelスプレッドシートを取得します。

構文

HypMenuVVisualizeinExcel()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypMenuVVisualizeinExcel Lib "HsAddin" () As Long
Sub MVisualizeinExcel()
X=HypMenuVVisualizeinExcel()
End Sub

HypMenuVZoomIn

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypMenuVZoomIn()は、「オプション」ダイアログ・ボックスで指定されたオプションに従って、データを展開表示します。

構文

HypMenuVZoomIn()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypMenuVZoomIn Lib "HsAddin"() As Long
Sub MZoomIn()
X=HypMenuVZoomIn()
End Sub

HypMenuVZoomOut

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypMenuVZoomOut()は、データを縮小表示します。

構文

HypMenuVZoomOut()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypMenuVZoomOut Lib "HsAddin"() As Long
Sub MZoomOut()
X=HypMenuVZoomOut()
End Sub

HypExecuteMenu

データ・プロバイダ・タイプ: すべて

説明

HypExecuteMenu()は、指定されたメニューまたはリボンのアイテムを実行します。

HypExecuteMenuを使用できるのは、ボタン、分割ボタン、メニュー、動的メニュー、トグル・ボタン(拡張機能用のトグル・ボタンはサポートされません)の各コントロールのみです。

構文

HypExecuteMenu (vtSheetName, vtMenuName) As Long

ByVal vtSheetName As Variant

ByVal vtMenuName As Variant

パラメータ

vtSheetName: 入力パラメータ。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMenuName: 入力パラメータ。実行するメニュー・アイテムの名前。

- 複数のリボンまたはメニューに表示されるアイテムの場合は、正確に指定するために、->という文字を使用してリボンのタイトル(Office 2007以降)をアイテム名の前に付加する必要があります。たとえば、Oracle Smart View for Officeのリボンの「リフレッシュ」とOracle Essbaseのリボンの「リフレッシュ」を区別するには、Smart View->RefreshまたはEssbase->Refreshを使用します。同じデータ・プロバイダまたは拡張機能のリボン内で重複するアイテムは使用できません。

- アクションに関連付けられたアイテムのみがサポートされます。たとえば、「パネル」はSmart Viewパネルを開くため、使用できます。「接続」は、アクションに関連付けられていないため使用できません。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。この関数の一般的なエラー・コードには、-15 (無効なパラメータ)と-73 (あいまい: メニュー名を解決できませんでした。)があります。

例

「リフレッシュ」の場合

Public Declare Function HypExecuteMenu Lib "HsAddin" (ByVal vtSheetName As Variant,ByVal vtMenuName As Variant) As Long
Sub Example_ExecuteMenu()
sts = HypExecuteMenu("Sheet1", "Panel")  'returns 0
sts = HypExecuteMenu(Empty, "Smart View->Refresh") 'returns 0
sts = HypExecuteMenu("Sheet1", "Refresh")  'returns -73(ambiguity)
sts = HypExecuteMenu("Sheet1", "Connections")  'returns -15(invalid parameter because "Connections" is not associated with an action)
End Sub

英語以外の言語を使用している場合、vtMenuNameには、Smart Viewのメニュー名のローカライズされた値が必要です。

たとえば、フランス語を使用している場合、vtMenuNameでは、Smart Viewの「リフレッシュ」にフランス語の値を使用します。次の例は、「リフレッシュ」に対応する英語とフランス語のパラメータ定義を比較しています。

英語:

sts = HypExecuteMenu(Empty, "Smart View->Refresh")

フランス語:

sts = HypExecuteMenu(Empty, "Smart View->Actualiser")

リフレッシュせずに送信の場合

Sub TestEssbaseSubmitData()
sts = HypExecuteMenu(Empty, "Essbase->Submit Data Without Refresh")
Debug.Print (sts)
End Sub

「データ範囲の送信」の場合

Sub TestEssbaseSubmitData()
sts = HypExecuteMenu(Empty, "Essbase->Submit Data Range")
Debug.Print (sts)
End Sub

HypHideRibbonMenu

データ・プロバイダ・タイプ: すべて

説明

リボン・メニューおよびメニュー・アイテムを非表示にします。シートの入力に基づいて、コンテキスト・リボン・メニューおよびメニュー・アイテムも非表示にします。

Smart Viewのリボンのカスタマイズは、どのシートにも適用できます。コンテキスト・リボンのカスタマイズはシート・ベースです。

この関数は、Office 2007以上でサポートされています。

構文

Public Declare Function HypHideRibbonMenu Lib "HsAddin" (ByVal vtSheetName As Variant, ParamArray vtMenus() As Variant) As Long

ByVal vtSheetName As Variant

ParamArray vtMenus() As Variant

パラメータ

vtSheetName: リボン・メニューおよびメニュー・アイテムを非表示にするシート名を含む入力変数。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMenus: 非表示にするリボン・メニュー名およびメニュー・アイテム名を含む入力変数。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。この関数の一般的なエラー・コードは-73 (あいまいさ)です。

例

Sub HideMenus()

sts = HypHideRibbonMenu ("Sheet1", "Smart View->Submit Data", "Panel")

sts = HypHideRibbonMenu("Sheet1", "Smart View->Refresh->Refresh")
‘Hides the submenu item Refresh under the Refresh split button

sts = HypHideRibbonMenu("Sheet1", "Essbase->POV", "Smart View->Copy", "Essbase->Same Workbook")
‘Hides menu items for different ribbons on the same sheet

End Sub

HypHideRibbonMenuReset

データ・プロバイダ・タイプ: すべて

説明

HypHideRibbonMenuを使用して、シートで非表示になっているリボン・メニューおよびメニュー・アイテムの可視性をリセットします。

この関数は、Office 2007以上でサポートされています。

構文

Public Declare Function HypHideRibbonMenuReset Lib "HsAddin" (ByVal vtSheetName As Variant) As Long

ByVal vtSheetName As Variant

パラメータ

vtSheetName: 非表示のメニューおよび非表示のメニュー・アイテムを表示される状態にリセットするシート名を含む入力変数。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Sub HideMenuReset()

sts = HypHideRibbonMenuReset ("Sheet1")
‘Resets the visibility of menus and menu items hidden on this sheet

End Sub

4 一般関数

関連トピック

- 一般関数について

- HypShowPanel

- HypGetVersion

- HypListApplications

- HypListDatabases

- HypGetLastError

- HypShowPov

- HypSetMenu

- HypCopyMetaData

- HypDeleteMetaData

- HypIsDataModified

- HypIsSmartViewContentPresent

- HypIsFreeForm

- HypUndo

- HypRedo

- HypPreserveFormatting

- HypRemovePreservedFormats

- HypSetAliasTable

- HypGetSubstitutionVariable

- HypSetSubstitutionVariable

- HypGetDatabaseNote

- HypGetSheetInfo

一般関数について

一般VBA関数は、通常はSmart Viewのリボンまたは「オプション」ダイアログ・ボックスから実行されるアクションの実行、オプションの設定または情報の取得を行います。

HypShowPanel

データ・プロバイダ・タイプ: すべて

説明

HypShowPanel ()は、Smart Viewパネルの表示/非表示を切り替えます。非表示になっているSmart Viewパネルが表示されるのは、ユーザーがSmart Viewのリボンで「パネル」を選択するか、HypShowPanelを実行する場合のみです。

構文

HypShowPanel Lib (bShow)

ByVal bShow As Boolean

パラメータ

bShow: Smart Viewパネルを表示する場合は、Trueに設定します。Smart Viewパネルを非表示にするには、Falseに設定します

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Smart Viewパネルを表示するには:

Public Declare Function HypShowPanel Lib "HsAddin" (ByVal bShow As Boolean) As Long
Sub Example_HypShowPanel()
sts = HypShowPanel(True)
End Sub

Smart Viewパネルを非表示にするには:

Public Declare Function HypShowPanel Lib "HsAddin" (ByVal bShow As Boolean) As Long
Sub Example_HypShowPanel()
sts = HypShowPanel(False)
End Sub

HypGetVersion

データ・プロバイダ・タイプ: すべて

説明

HypGetVersion()は、インストールされているOracle Smart View for Officeのバージョンについて次の情報を取得し、バージョン情報ファイルを作成します。

- 製品のバージョン番号

- ビルド番号

- ビルド日付

- ビルド・バージョン

構文

HypGetVersion (vtID, vtValueList, vtVersionInfoFileCommand)

ByVal vtID As Variant

ByRef vtValueList As Variant

ByVal vtVersionInfoFileCommand As Variant

パラメータ

vtID: 入力パラメータ。情報が必要なID。次の定数または文字列のいずれか、あるいは空にすることができます。

- BUILD_DATEまたは"BUILD DATE"

- BUILD_NUMBERまたは"BUILD NO"

- BUILD_VERSIONまたは"VERSION"

- PRODUCT_IDまたは"PRODUCT" ID

- Empty: 空にすると、バージョン情報ファイルのすべての情報がカンマ区切り値として出力リストに含まれます。

vtValueList: 出力パラメータ。配列リストまたは必要な値

vtVersionInfoFileCommand: 入力パラメータ。vtIDが空の場合に、バージョン情報ファイルを保存または起動するためのコマンドID (数値)。使用可能な値を次に示します。

- 0 - 何も行いません

- 1 - バージョン情報ファイルを保存します

- 2 - バージョン情報ファイルを起動します

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します

例

ビルド・バージョンを表示するメッセージ・ボックスを作成するには:

Public Declare Function HypGetVersion Lib "HsAddin" (ByVal vtID As Variant, ByRef vtValueList As Variant, ByVal vtVersionInfoFileCommand As Variant) As Long
Sub Example_HypGetVersion()
sts = HypGetVersion(BUILD_VERSION, version, 0)
MsgBox version(0)
End Sub

バージョン情報ファイルでバージョン情報の取得と保存を行うには:

Public Declare Function HypGetVersion Lib "HsAddin" (ByVal vtID As Variant, ByRef vtValueList As Variant, ByVal vtVersionInfoFileCommand As Variant) As Long
Sub Example_HypGetVersion()
sts = HypGetVersion("", versioninfo, 1) 'saves version info file in user directory and gets array
inf = versioninfo(0) 'gets the information in 0th array element
End Sub

HypListApplications

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypListApplications()では、要求したプロバイダにアプリケーションおよびその説明のリストを取得します。

構文

HypListApplications (vtURL, vtServerName, vtUserName, vtPassword, vtApplications, vtAppsDescriptions)

ByVal vtURL As Variant

ByVal vtServerName As Variant

ByVal vtUserName As Variant

ByVal vtPassword As Variant

ByRef vtApplications As Variant

ByRef vtAppsDescriptions As Variant

パラメータ

vtURL: プロバイダのURL

vtServerName: サーバー名

vtUserName: ユーザー名

vtPassword: パスワード

vtApplications: アプリケーションのリスト

vtAppsDescriptions: アプリケーションの説明のリスト

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

この例では、HypListApplications関数とHypListDatabases関数を組み合せて使用しています。

Sub test()

Dim url As Variant
Dim srv As Variant
Dim SSO As Variant
Dim uname As Variant
Dim pswd As Variant
Dim app As Variant
Dim Applist As Variant
Dim AppDescList As Variant
Dim AppCubeList As Variant

'Essbase
url = "http://<server>:<port>/aps/SmartView"
app = "Sample"
srv = "EssbaseCluster-1"
uname = "admin"
pswd = "password"

ss = HypConnect("Sheet1", "admin", "ppp", "Conn123")
ss = HypListApplications(url, srv, uname, pswd, Applist, AppDescList)
ss = HypListDatabases(url, srv, uname, pswd, app, AppCubeList)

MsgBox (ss)

End Sub

HypListDatabases

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning

説明

HypListDatabases()では、要求したプロバイダにアプリケーションに存在するキューブ(データベース)のリストを取得します。

構文

HypListDatabases (vtURL, vtServerName, vtUserName, vtPassword, vtApplication, vtApplicationCubeList)

ByVal vtURL As Variant

ByVal vtServerName As Variant

ByVal vtUserName As Variant

ByVal vtPassword As Variant

ByVal vtApplication As Variant

ByRef vtApplicationCubeList As Variant

パラメータ

vtURL: プロバイダのURL

vtServerName: サーバー名

vtUserName: ユーザー名

vtPassword: パスワード

vtApplication: アプリケーション名

vtApplicationCubeList: キューブ(データベース)のリスト

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

この例では、HypListApplications関数とHypListDatabases関数を組み合せて使用しています。

Sub test()

Dim url As Variant
Dim srv As Variant
Dim SSO As Variant
Dim uname As Variant
Dim pswd As Variant
Dim app As Variant
Dim Applist As Variant
Dim AppDescList As Variant
Dim AppCubeList As Variant

'Essbase
url = "http://<server>:<port>/aps/SmartView"
app = "Sample"
srv = "EssbaseCluster-1"
uname = "admin"
pswd = "password"

ss = HypConnect("Sheet1", "admin", "ppp", "Conn123")
ss = HypListApplications(url, srv, uname, pswd, Applist, AppDescList)
ss = HypListDatabases(url, srv, uname, pswd, app, AppCubeList)

MsgBox (ss)

End Sub

HypGetLastError

データ・プロバイダ・タイプ: すべて

説明

HypGetLastError()は、Smart Viewに格納された最後のエラー・メッセージを戻します。これは、サーバーに格納されているエラー・メッセージを取得します(VBA関数から戻されるエラー・メッセージは、サーバーから取得するメッセージと一致しないことがあります)。

構文

HypGetLastError (vtErrorCode, vtErrorMessage, vtErrorDescription)

ByRef vtErrorCode As Variant

ByRef vtErrorMessage As Variant

ByRef vtErrorDescription As Variant

パラメータ

vtErrorCode: エラー・コード番号

vtErrorMessage: エラー・メッセージ

vtErrorDescription: エラーの説明

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypGetLastError Lib "HsAddin" (ByRef vtErrorCode As Variant, ByRef vtErrorMessage As Variant, ByRef vtErrorDescription As Variant) As Long
Sub Example_HypGetLastError
ReturnValue = HypGetLastError(ErrorCodeValue, ErrorMessageValue, ErrorDescriptionValue)
End Sub

HypShowPov

データ・プロバイダ・タイプ: すべて

説明

HypShowPov()は、POVツールバーの表示/非表示を切り替えます。

構文

HypShowPov(bShowPov)

ByVal bShowPov As Boolean

パラメータ

bShowPov: POVツールバーを表示する場合は、Trueに設定します。POVツールバーを非表示にするには、Falseに設定します。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypShowPov Lib "HsAddin" (ByVal bShowPov As Boolean) As Long
Sub Example_HypShowPov()
X=HypShowPov(True)
End Sub

HypSetMenu

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

Excel 2007および2010で、HypSetMenu()は、Oracle Smart View for Officeとデータ・プロバイダのリボンの表示/非表示を切り替えます。

構文

HypSetMenu(bSetMenu)

ByVal bSetMenu As Boolean

パラメータ

bSetMenu: リボンまたはメニューを表示する場合は、Trueに設定します。メニューまたはリボンを非表示にするには、Falseに設定します。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します

例

Declare Function HypSetMenu Lib "HsAddin" (ByVal bSetMenu As Boolean) As Long
Sub Example_HypSetMenu()
X=HypSetMenu(True)
End Sub

HypCopyMetaData

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypCopyMetaData()は、ワークシート間でメタデータをコピーします。

構文

HypCopyMetaData (vtSourceSheetName, vtDestinationSheetName)

ByVal vtSourceSheetName As Variant

ByVal vtDestinationSheetName As Variant

パラメータ

vtSourceSheetName: コピーするデータを含むワークシートの名前

vtDestinationSheetName: 宛先のワークシートの名前

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypCopyMetaData Lib "HsAddin" (ByVal vtSourceSheetName As Variant, ByVal vtDestinationSheetName As Variant) As Long
Sub Example_HypCopyMetaData()
Dim LRet As Long
LRet = HypCopyMetaData ("Sheet1", "Sheet2")
End Sub

HypDeleteMetaData

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management、Oracle Hyperion Reporting and Analysis

説明

HypDeleteMetaData()は、次の3つのいずれかのモードで、ワークブックからOracle Smart View for Officeメタデータを削除します。

- モード1 - 指定されたワークシート・ストレージからのみ、すべてのSmart Viewメタデータを削除します

- モード2 - 指定されたワークブック・ストレージからのみ、すべてのSmart Viewメタデータを削除します

- モード3 - 指定されたワークブック・ストレージとすべてのワークシート・ストレージから、すべてのSmart Viewメタデータを削除します

構文

HypDeleteMetaData(vtDispObject, vtbWorkbook, vtbClearMetadataOnAllSheetsWithinWorkbook)

vtDispObject As Variant

vtbWorkbook As Variant

vtbClearMetadataOnAllSheetsWithinWorkbook As Variant

パラメータ

vtDispObject: メタデータを削除する対象を示す、ワークシートまたはワークブックのディスパッチ・オブジェクト。Nullが渡された場合、vtbWorkbookによりアクティブなワークシートまたはアクティブなワークブックのどちらかが判断され、操作が実行されます。

vtbWorkbook: ブール値。ワークシート・ディスパッチまたはワークブック・ディスパッチを渡したことを示します。vtDispObjectにNullが渡されている場合、このフラグによって、メタデータの削除対象がアクティブなワークシートかアクティブなワークブックかが判断されます。

vtbClearMetadataOnAllSheetsWithinWorkbook: ブール値。Smart Viewメタデータをワークブック内のすべてのシートから削除するように指定します。vtbWorkbookがTrueに設定されている場合にのみ使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypDeleteMetaData Lib "HsAddin" (ByVal vtDispObject As Variant, ByVal vtbWorkbook As Variant, ByVal vtbClearMetadataOnAllSheetsWithinWorkbook As Variant) As Long

Sub Example_HypDeleteMetaData()
Dim Ret As Long
Dim Workbook As Workbook
Dim Sheet As Worksheet

Set Workbook = ActiveWorkbook
Set Sheet = ActiveSheet

'Ret = HypDeleteMetaData(oSheet, False, True)      'Mode 1
Ret = HypDeleteMetaData(oWorkbook, True, False)  'Mode 2
'Ret = HypDeleteMetaData(oWorkbook, True, True)   'Mode 3

MsgBox    (Ret)

End Sub

HypIsDataModified

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypIsDataModified()は、変更されたものの送信されていないデータ・セルがないかどうかを判別します。

構文

HypIsDataModified (vtSheetName)

By Val vtSheetName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

戻り値

変更されたものの送信されていないデータ・セルがワークシートに含まれる場合はTrueを戻し、それ以外の場合はFalseを戻します。

例

Public Declare Function HypIsDataModified Lib "HsAddin" (ByVal vtSheetName As Variant)As Boolean
Sub Example_HypIsDataModified()
Dim oRet As Boolean
oRet = HypIsDataModified(Empty)
MsgBox (oRet)
End Sub

HypIsSmartViewContentPresent

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypIsSmartViewContentPresent()は、シートにOracle Smart View for Officeコンテンツが含まれているかどうかを判別します。

構文

HypIsSmartViewContentPresent(vtSheetName, vtTypeOfContentsInSheet])

ByVal vtSheetName As Variant

ByRef vtTypeOfContentsInSheet

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtTypeOfContentsInSheet: 出力パラメータ。ワークシート上のコンテンツのタイプを戻します。使用可能な値は次のような列挙型です。

Enum TYPE_OF_CONTENTS_IN_SHEET
EMPTY_SHEET
ADHOC_SHEET
FORM_SHEET
INTERACTIVE_REPORT_SHEET
End Enum

戻り値

ワークシートにSmart Viewコンテンツが含まれている場合はTrueを戻し、それ以外の場合はFalseを戻します。

例

Public Declare Function HypIsSmartViewContentPresent Lib "HsAddin" (ByVal vtSheetName As Variant, ByRef vtTypeOfContentsInSheet As TYPE_OF_CONTENTS_IN_SHEET) As Boolean

Sub Example_HypIsSmartViewContentPresent()
Dim Ret As Boolean
Dim vtTypeOfContentsInSheet As TYPE_OF_CONTENTS_IN_SHEET
Dim SheetName As String
Dim SheetDisp As Worksheet

SheetName = Empty
Set SheetDisp = Worksheets("Sheet1")
Ret = HypIsSmartViewContentPresent (Empty, ContentType)
End Sub

HypIsFreeForm

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypIsFreeForm()は、ワークシートがフリー・フォーム・モードかどうかを判別します。

構文

HypIsFreeForm (vtSheetName)

By Val vtSheetName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

戻り値

ワークシートがフリー・フォーム状態の場合はTrueを戻し、それ以外の場合はFalseを戻します。

例

Public Declare Function HypIsFreeForm Lib "HsAddin" (ByVal vtSheetName As Variant) As Boolean
Sub Example_HypIsFreeForm()
Dim oRet As Boolean
oRet = HypIsFreeForm(Empty)
MsgBox (oRet)
End Sub

HypUndo

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypUndo()は、「ズーム・イン」、「ズーム・アウト」、「選択項目のみ保持」、「選択項目のみ削除」または「リフレッシュ」操作の前の状態にワークシートのデータベース・ビューを戻します。

構文

HypUndo (vtSheetName)

ByVal vtSheetName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypUndo Lib "HsAddin" (ByVal vtSheetName As Variant) As Long
Sub Example_HypUndo()
X=HypUndo(Sheet1)
End Sub

HypRedo

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypRedo()は、「元に戻す」操作の前の状態にデータベース・ビューを戻します。

構文

HypRedo (vtSheetName)

ByVal vtSheetName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypRedo Lib "HsAddin" (ByVal vtSheetName As Variant) As Long
Sub Example_HypRedo()
X=HypRedo(Sheet1)
End Sub

HypPreserveFormatting

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypPreserveFormatting()は、ズーム・インによって作成されたセルにグリッドのフォーマットを適用します。

構文

HypPreserveFormatting (vtSheetName, vtSelectionRange)

ByVal vtSheetName As Variant

ByVal vtSelectionRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelectionRange: フォーマットを保持するセル(複数可)の範囲。複数の範囲がサポートされます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypPreserveFormatting Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtSelectionRange As Variant) As Long

Sub Example_HypPreserveFormatting()

Dim oRet As Long
Dim oSheetName As String
Dim oSheetDisp As Worksheet

oSheetName = Empty
Set oSheetDisp = Sheet1
oRet = HypPreserveFormatting ("", oSheetDisp.Range("B2"))

MsgBox (oRet)

End Sub

HypRemovePreservedFormats

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypRemovePreservedFormats()は、保持されているフォーマットを削除します。

注意:

元のフォーマットが適用される前にリフレッシュする必要があります。

構文

HypRemovePreservedFormats (vtSheetName, vtbRemoveAllCapturedFormats,vtSelectionRange)

ByVal vtSheetName As Variant

ByVal vtbRemoveAllCapturedFormats As Variant

ByVal vtSelectionRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtbRemoveAllCapturedFormats: 選択した範囲に保持されているすべてのフォーマットを削除する場合は、Trueに設定します。それ以外の場合は、Falseに設定します。Trueに設定すると、次に続くパラメータの値は使用されないため、ユーザーはvtSelectionRangeにNullを渡すことができます。)

vtSelectionRange: フォーマットを保持するセル(複数可)の範囲。複数の範囲がサポートされます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypRemovePreservedFormats Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtbRemoveAllCapturedFormats As Variant, ByVal vtSelectionRange As Variant) As Long

Sub Example_HypRemovePreservedFormats()

Dim Ret As Long
Dim SheetName As String
Dim SheetDisp As Worksheet

SheetName = "Sheet1"

Set oSheetDisp = Worksheets(SheetName)
'Ret = HypRemovePreservedFormats(Empty, False, SheetDisp.Range("B2"))
Ret = HypRemovePreservedFormats(Empty, True, Null)
MsgBox (oRet)

End Sub

HypSetAliasTable

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning

説明

HypSetAliasTable()は、選択したワークシートの別名表を設定します。

構文

HypSetAliasTable (ByVal vtSheetName As Variant, ByVal vtAliasTableName As Variant)

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtAliasTableName: 別名表の、テキストによる名前。vtAliasTableNameの形式には、"Default"、"Long Names"などがあります。

戻り値

正常に終了した場合は0、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypSetAliasTable Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtAliasTableName As Variant) As Long
Sub Example_SetAliasTable
sts = HypSetAliasTable(Empty,"Long Names")
End sub

HypGetSubstitutionVariable

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypGetSubstitutionVariable()は、Essbaseから代替変数およびその現在の値を取得します。

構文

HypGetSubstitutionVariable (vtSheetName, vtApplicationName, vtDatabaseName, vtVariableName, vtVariableNames, vtVariableValues)

ByVal vtSheetName As Variant

ByVal vtApplicationName As Variant

ByVal vtDatabaseName As Variant

ByVal vtVariableName As Variant

ByRef vtVariableNames As Variant

ByRef vtVariableValues As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtApplicationName: 代替変数を戻すアプリケーションの名前。NullまたはEmptyに設定されると、すべてのアプリケーションが考慮されます。

vtDatabaseName: 代替変数を戻すデータベースの名前。NullまたはEmptyに設定されると、すべてのデータベースが考慮されます。

vtVariableName: 取得される代替変数の名前。NullまたはEmptyに設定されると、変数のリスト全体が戻されます。

vtVariableNames: 代替変数名のリストを格納する出力結果ベクトル。マクロが正常に終了しなかった場合、コンテンツは不明になります。

vtVariableValues: 戻される各変数に対応する代替変数値のリストを格納する出力結果ベクトル。マクロが正常に終了しなかった場合、コンテンツは不明になります。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetSubstitutionVariable Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtApplicationName As Variant, ByVal vtDatabaseName As Variant, ByVal vtVariableName As Variant, ByRef vtVariableNames As Variant, ByRef vtVariableValues As Variant) As Long

Sub Example_HypGetSubstitutionVariable()
Dim sts As Long
sts = HypGetSubstitutionVariable(Empty, "Sample", "Basic", Empty, vtVarNameList, vtVarValueList)
End If
End Sub

HypSetSubstitutionVariable

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypSetSubstitutionVariable()は、Essbaseに代替変数を作成します。変数がすでに存在する場合は、その値が、新しく指定された値に設定されます。

構文

HypSetSubstitutionVariable (vtSheetName, vtApplicationName, vtDatabaseName, vtVariableName, vtVariableValue)

ByVal vtSheetName As Variant

ByVal vtApplicationName As Variant

ByVal vtDatabaseName As Variant

ByVal vtVariableName As Variant

ByVal vtVariableValue As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。NullまたはEmptyに設定されると、アクティブなワークシートが使用されます。

vtApplicationName: 新しい代替変数を作成するアプリケーションの名前。NullまたはEmptyに設定されると、変数のスコープはグローバルになります。

vtDatabaseName: 新しい変数を作成するデータベースの名前。NullまたはEmptyに設定されると、作成される変数のスコープは、指定されたアプリケーション内でグローバルになります。

vtVariableName: 作成する変数の名前。必須。

vtVariableValue: 変数に割り当てる値。必須。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypSetSubstitutionVariable Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtApplicationName As Variant, ByVal vtDatabaseName As Variant, ByVal vtVariableName As Variant, ByVal vtVariableValue As Variant) As Long

Sub Example_HypSetSubstitutionVariable
Dim X as Long
X = HypSetSubstitutionVariable(Empty, "Sample", "Basic", "Account", "100")
End Sub

HypGetDatabaseNote

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypGetDatabaseNote()は、Essbaseデータベース・ノートを取得します。

構文

HypGetDatabaseNote (vtSheetName, vtDBNote)

ByVal vtSheetName As Variant

ByRef vtDBNote As Variant

パラメータ

vtSheetName: 入力パラメータ。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDBNote: 出力パラメータ。取得するデータベース・ノート。

例

Public Declare Function HypGetDatabaseNote Lib "HsAddin" (ByVal vtSheetName As Variant, ByRef vtDBNote As Variant) As Long
Sub Example_HypGetDatabaseNote()
sts = HypGetDatabaseNote(Empty, DBNote)
MsgBox DBNote
End  Sub

HypGetSheetInfo

データ・プロバイダ・タイプ: すべて

説明

HypGetSheetInfo()では、要求されたワークシートに関する詳細情報を取得します。

構文

HypGetSheetInfo(vtSheetName, itemNameList, itemValueList)

ByVal vtSheetName As Variant

ByRef vtItemNameList As Variant

ByRef vtItemValueList As Variant

パラメータ

vtSheetName: シート名。Emptyが渡された場合、現在のワークシート情報が取得されます

vtItemNameList: シート情報のタイトルのリスト

vtItemValueList: シート情報のタイトルに対応する値のリスト

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Sub test()
Dim namelist As Variant
Dim vallist As Variant

ss = HypConnect("Sheet1", "admin", "password", "Conn123")
ss = HypRetrieve(“Sheet1”)
sts = HypGetSheetInfo("Sheet1", namelist, vallist)

End Sub

5 接続関数

関連トピック

- 接続関数について

- HypConnect

- HypUIConnect

- HypConnected

- HypConnectionExists

- HypCreateConnection

- HypCreateConnectionEx

- HypModifyConnection

- HypDisconnect

- HypDisconnectAll

- HypDisconnectEx

- HypGetSharedConnectionsURL

- HypSetSharedConnectionsURL

- HypIsConnectedToSharedConnections

- HypRemoveConnection

- HypSetSSO

- HypInvalidateSSO

- HypResetFriendlyName

- HypSetActiveConnection

- HypSetAsDefault

- HypSetConnAliasTable

接続関数について

接続関数は、データ・プロバイダへの接続に関連するアクションを実行します。

HypConnect

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

注意:

Cloudデータ・ソース: HypConnectはCloudデータ・ソースでサポートされていません。Cloudデータ・ソース(たとえば、Oracle Planning and Budgeting Cloudソース)に接続するには、HypUIConnect関数を使用する必要があります。「HypUIConnect」を参照してください

説明

HypConnect()は、データ・プロバイダにログインし、ワークシートをその接続に関連付けます。この接続を該当するシートに関連付けるためには、シートごとにHypConnect()を呼び出す必要があります。

構文

HypConnect (vtSheetName, vtUserName, vtPassword, vtFriendlyName)

ByVal vtSheetName As Variant

ByVal vtUserName As Variant

ByVal vtPassword As Variant

ByVal vtFriendlyName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtUserName: 有効なユーザー名

vtPassword: このユーザーのパスワード

vtFriendlyName: データ・プロバイダのわかりやすい接続名。これは、HypCreateConnectionによって作成された接続名です。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypConnect Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtUserName As Variant, ByVal vtPassword As Variant, ByVal vtFriendlyName As Variant) As Long

Sub Example_HypConnect()
X=HypConnect(Empty, UserName, Password, "My Sample Basic")
End Sub

HypUIConnect

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management、Oracle Business Intelligence Enterprise Edition

説明

オンプレミス・データ・ソース: オンプレミス・データ・ソースの場合で、HypUIConnect()は、ユーザー名とパスワードが指定されていない場合に、ユーザーに対して「データ・ソースに接続」ダイアログ・ボックスを表示します。すでに指定されている場合は表示しません。

Cloudデータ・ソースおよびオンプレミス・フォーム・ベース認証: フォーム・ベース認証を使用しているCloudデータ・ソースおよびオンプレミス・ソースの場合は、HypUIConnect VBA関数を使用して、既存のプライベート接続に接続する必要があります。HypUIConnect()では、ユーザーがログインする際に、ユーザー名、パスワードおよびドメインを入力する必要がある場合は常に、認証用のプロンプトが表示されます。

構文

HypUIConnect (vtSheetName, vtUserName, vtPassword, vtFriendlyName)

ByVal vtSheetName As Variant

ByVal vtUserName As Variant

ByVal vtPassword As Variant

ByVal vtFriendlyName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtUserName: 有効なユーザー名

vtPassword: このユーザーのパスワード

vtFriendlyName: データ・プロバイダの接続名

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare PtrSafe Function HypUIConnect Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtUserName As Variant, ByVal vtPassword As Variant, ByVal vtFriendlyName As Variant) As Long
HypUIConnect(Empty, UserName, Password, "My Connection")

HypConnected

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypConnected()は、シートの接続ステータスを提供します。

構文

HypConnected (vtSheetName)

ByVal vtSheetName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

戻り値

シートがプロバイダに接続されている場合はTrue、それ以外の場合はFalseを戻します。

例

Declare Function HypConnected Lib "HsAddin" (ByVal vtSheetName As Variant) As Variant

Sub Example_HypConnected
Dim X As Variant
X = HypConnected(Empty)
End sub

シートに接続している場合、値が-1の変数が戻され、VBAではTrueとして解釈されます。戻り値として-1を取得するには、変数(戻り値を取るもの)を数値型(Long、Integer、Doubleなど)として宣言する必要があります。次に示すスクリプトでこれを説明します。

Declare Function HypConnected Lib "HsAddin" (ByVal vtSheetName As Variant) As Variant
Sub Example_HypConnected()
Dim X As Integer 'Can also be Long or Double
X = HypConnected(Empty)  'Value of X will become -1 if Sheet1 is connected
End Sub

変数Xが定義されていない場合、VBAでは(定義されていないその他の変数も) Variant型として解釈されます。したがって、Sheet1が接続している場合、XはTrueに相当します。

変数Xがブール値として定義されている場合、戻り値は正確にTrueと表示されます。

HypConnectionExists

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypConnectionExists()は、Smart Viewパネルで表示されるすべての接続のリストに特定の接続名が存在するかどうかをチェックします。その特定の接続がアクティブ(接続済)であるかどうかは関係ありません。

構文

HypConnectionExists(vtFriendlyName)

ByVal vtFriendlyName As Variant

パラメータ

vtFriendlyName: すべての接続のリストで検索する接続の名前。大/小文字は区別されません。

戻り値

ブール値。戻り値は、正常に終了した場合はTRUE、それ以外の場合はFALSEです。

例

Declare Function HypConnectionExists Lib "HsAddin" (ByVal vtFriendlyName As Variant) As Variant

Sub Example_HypConnectionExists
Dim bIsConnection as Boolean
bIsConnection = HypConnectionExists ("Demo_Basic")
End sub

HypCreateConnection

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypCreateConnection()は、指定された情報からデータ・プロバイダへの接続を作成します。

構文

HypCreateConnection(vtSheetName, vtUserName, vtPassword, vtProvider, vtProviderURL, vtServerName, vtApplicationName, vtDatabaseName, vtFriendlyName, vtDescription)

ByVal vtSheetName As Variant

ByVal vtUserName As Variant

ByVal vtPassword As Variant

ByVal vtProvider As Variant

ByVal vtProviderURL As Variant

ByVal vtServerName As Variant

ByVal vtApplicationName As Variant

ByVal vtDatabaseName As Variant

ByVal vtFriendlyName As Variant

ByVal vtDescription As Variant

パラメータ

vtSheetName: 未使用

vtUserName: 有効なユーザー名

vtPassword: このユーザーのパスワード

vtProvider: データ・プロバイダ。サポートされるvtProviderのタイプを次に示します。

- Global Const HYP_ESSBASE = "Essbase"

- Global Const HYP_FINANCIAL_MANAGEMENT = "Hyperion Financial Management"

- Global Const HYP_PLANNING = "Planning"

- Global Const HYP_RA = "Hyperion Smart View Provider for Hyperion Reporting and Analysis"

注意:

グローバル定数HYP_ANALYTIC_SERVICES = "Analytic Provider Services"は非推奨になりました。

vtProviderURL: データ・プロバイダのURL

vtServerName: アプリケーションが存在するサーバーの名前

vtApplicationName: アプリケーション名

vtDatabaseName: データベース名

注意:

Financial Managementのみ: このパラメータは必須ですが、アプリケーション名は使用できません。かわりに、EmptyまたはNullをこのパラメータに使用します。

vtFriendlyName: データ・プロバイダの接続名

vtDescription: データ・プロバイダの説明

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypCreateConnection Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtUserName As Variant, ByVal vtPassword As Variant, ByVal vtProvider As Variant, ByVal vtProviderURL As Variant, ByVal vtServerName As Variant, ByVal vtApplicationName As Variant, ByVal vtDatabaseName As Variant, ByVal vtFriendlyName As Variant, ByVal vtDescription As Variant) As Long
Sub Example_HypCreateConnection()
X = HypCreateConnection(Empty, UserName, Password, HYP_ESSBASE, "http://localhost:13080/smartview/SmartView", "localhost", "Sample", "Basic", "My Connection", "Essbase_1")
End Sub

HypCreateConnectionEx

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypCreateConnectionExは、HypCreateConnectionの上位集合です。Smart Viewパネルを使用可能にする追加パラメータがあります。Smart Viewパネルでデータ・プロバイダを追加するPlanningユーザーは、HypCreateConnectionExを使用する必要があります。

Essbase、PlanningおよびFinancial Managementの場合、HypCreateConnectionExを使用して、ワークスペースURLを使用したプライベート接続を作成できます。

構文

HypCreateConnectionEx (vtProviderType, vtServerName, vtApplicationName, vtDatabaseName, vtFormName, vtProviderURL, vtFriendlyName, vtUserName, vtPassword, vtDescription, vtReserved1, vtReserved2)

ByVal vtProviderType As Variant

ByVal vtServerName As Variant

ByVal vtApplicationName As Variant

ByVal vtDatabaseName As Variant

ByVal vtFormName As Variant

ByVal vtProviderURL As Variant

ByVal vtFriendlyName As Variant

ByVal vtUserName As Variant

ByVal vtPassword As Variant

ByVal vtDescription As Variant

ByVal vtReserved1 As Variant (将来の使用のために予約済)

ByVal vtReserved2 As Variant (将来の使用のために予約済)

パラメータ

vtProviderType: データ・プロバイダ。サポートされるvtProviderTypeのタイプを次に示します。

- Global Const HYP_ESSBASE = "Essbase"

- Global Const HYP_PLANNING = "Planning"

- Global Const HYP_FINANCIAL_MANAGEMENT = "Financial Management"

- Global Const HYP_RA = "Hyperion Smart View Provider for Hyperion Reporting and Analysis"

vtServerName: アプリケーションが存在するサーバーの名前

vtApplicationName: アプリケーション名

vtDatabaseName: データベース名

vtFormName: データ・フォームの名前。Smart Viewパネルの「プライベート接続」にPlanningの接続を作成する際に必要です。

vtProviderURL: データ・プロバイダのURL。Smart ViewパネルでPlanningの接続を作成する際に必要です。

vtFriendlyName: データ・プロバイダの接続名

vtUserName: 有効なユーザー名

vtPassword: このユーザーのパスワード

vtDescription: データ・プロバイダの説明

注意:

Oracle Hyperion Reporting and Analysisの場合は、プロバイダURL、プロバイダ・タイプおよび接続名のみが必要です。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypCreateConnectionEx Lib "HsAddin" (ByVal vtProviderType As Variant, ByVal vtServerName As Variant,ByVal vtApplicationName As Variant,ByVal vtDatabaseName As Variant, ByVal vtFormName As Variant, ByVal vtProviderURL As Variant, ByVal vtFriendlyName As Variant, ByVal vtUserName As Variant, ByVal vtPassword As Variant, ByVal vtDescription As Variant, ByVal vtReserved1 As Variant, ByVal vtReserved2 As Variant) As Long

Sub Example_HypCreateConnectionEx()

Dim lRet As Long
lRet = HypCreateConnectionEx("Essbase", "server12", "Demo", "Basic", "", "", "My Demo", "Username", "Password", "", "", "")

lRet = HypCreateConnectionEx("Planning", "planqe14", "TotPlan", "", "/Forms/Smart View Forms/01 Product Revenue", "http://planqe14:8300/HyperionPlanning/SmartView", "My Planning VBA Conn", "UserName", "Password", "", "", "")

End Sub

HypModifyConnection

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypModifyConnection()を使用して、ワークブック、シート、範囲またはグリッドの接続情報を変更します。適用対象:

- 通常のアド・ホック・シート

- 複数グリッドのアド・ホック・シート

- フォーム・ベースのシート

構文

Private Declare PtrSafe Function HypModifyConnection Lib "HsAddin" (vtDocumentName, vtSheetName, vtGridName As Variant, vtServer, vtURL, vtApp, vtDB, vtConnParam) As Long

ByVal vtDocumentName As Variant

ByVal vtSheetName As Variant

ByVal vtGridName As Variant

ByVal vtServer As Variant

ByVal vtURL As Variant

ByVal vtApp As Variant

ByVal vtDB As Variant

ByVal vtConnParam As Variant

パラメータ

vtDocumentName: 関数を実行するワークブックの名前。vtDocumentNameがNullまたはEmptyの場合、アクティブなワークブックが使用されます。

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtGridName: 複数グリッド・ワークシート上のグリッドの名前範囲。vtGridNameがNullまたはEmptyで、シートが複数グリッド・シートの場合、シート上のすべてのグリッドの接続情報が変更されます。

vtServer: 新規サーバーの名前。アプリケーションは新規サーバーに存在する必要があります

vtURL: 新規データ・プロバイダのURL

vtApp: 新規アプリケーション名

vtDB: 新しいキューブまたはデータベース名

vtConnParam: その他のプロバイダ・パラメータ

注意:

接続の変更を保持するには、ワークブックを保存する必要があります。

例

Sub testModifyConnection()
'modify url in a particular workbook for all SV sheets
s = HypModifyConnection("testmultigrid.xlsm", "", "", "", "http://<server>:<port>/aps
/SmartView", "", "", "")
'modify app/db for a specific multi-grid in a workbook
s = HypModifyConnection("testmultigrid.xlsm", "Sheet1",
"Demo15FCFBC11_9D65_4555_94AC_6EDD429438B0_1", "", "", "NoUniq", "NoUniq", "")
'modify url for all sheets in active workbook
s = HypModifyConnection("", "", "", "", "http://<server>:<port>/aps/
SmartView", "", "", "")
'modify url in a particular sheet for active workbook
s = HypModifyConnection("", "Sheet1", "", "", "http://<server>:<port>/aps/
SmartView", "", "", "")
End Sub

HypDisconnect

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypDisconnect()は、データ・プロバイダからログアウトします。

構文

HypDisconnect(vtSheetName, bLogoutUser)

ByVal vtSheetName As Variant

ByVal bLogoutUser As Boolean

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

bLogoutUser: プロバイダ・セッションを切断してログアウトする場合は、Trueに設定します。デフォルト値はFalseです。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypDisconnect Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal bLogoutUser As Boolean) As Long

Sub Example_HypDisconnect()
X=HypDisconnect(Empty, True)
End Sub

HypDisconnectAll

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypDisconnectAllは、接続されているすべてのユーザーを切断し、ユーザー認証を無効化するセキュリティ対策です。「すべて切断」メニュー・アイテムに相当します。

構文

HypDisconnectAll()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypDisconnectAll Lib "HsAddin" () As Long
Sub Example_HypDisconnectAll()
sts = HypDisconnectAll()
End Sub

HypDisconnectEx

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypDisconnectExは、指定された接続を切断します。HypDisconnectの場合とは異なり、この接続が関連付けられている必要はありません。

構文

HypDisconnectEx (vtFriendlyName )

ByVal vtFriendlyName As Variant

パラメータ

vtFriendlyName: 切断する接続のわかりやすい名前

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypDisconnectEx Lib "HsAddin" (ByVal vtFriendlyName As Variant) As Long

Sub Example_HypDisconnectEx()
Dim lRet As Long
lRet = HypDisconnectEx("My Sample")
End Sub

HypGetSharedConnectionsURL

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetSharedConnectionsURL()は、使用される共有接続URLを戻します(「オプション」ダイアログ・ボックスにも表示されます)。

構文

HypGetSharedConnectionsURL (vtSharedConnURL)

ByRef vtSharedConnURL As Variant

パラメータ

vtSharedConnURL: 出力パラメータ。共有接続URL

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetSharedConnectionsURL Lib "HsAddin" (ByRef vtSharedConnURL As Variant) As Long
Sub Example_HypGetSharedConnectionsURL()
Dim lRet As Long
Dim conn As Variant
lRet = HypGetSharedConnectionsURL(conn)
MsgBox (lRet)
MsgBox (conn)
End Sub

HypSetSharedConnectionsURL

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetSharedConnectionsURL()は、構成ファイルおよび「オプション」ダイアログ・ボックスに共有接続URLを設定します。

構文

HypSetSharedConnectionsURL (vtSharedConnURL)

ByVal vtSharedConnURL As Variant

パラメータ

vtSharedConnURL: 設定する新しい共有接続URL。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypSetSharedConnectionsURL Lib "HsAddin" (ByVal vtSharedConnURL As Variant) As Long
Sub Example_HypSetSharedConnectionsURL()
Dim lRet As Long
lRet = HypSetSharedConnectionsURL("http://<server>:19000/workspace/SmartViewProviders")
End Sub

HypIsConnectedToSharedConnections

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypIsConnectedToSharedConnections()は、SmartViewが共有接続に接続されているかどうかを判別します。

構文

HypIsConnectedToSharedConnections ()

戻り値

戻り値: Smart Viewが共有接続に接続されている場合はTrue、それ以外の場合はFalse。

例

Declare Function HypIsConnectedToSharedConnections Lib "HsAddin" () As Variant
Sub Example_HypIsConnectedToSharedConnections()
Dim vtRet As Variant
vtRet = HypIsConnectedToSharedConnections ()
MsgBox(vtRet)
End Sub

HypRemoveConnection

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypRemoveConnection()は、Smart Viewパネルでの利用可能なOracle Smart View for Office接続のリストから、指定した接続を削除します。

構文

HypRemoveConnection(vtFriendlyName)

ByVal vtFriendlyName As Variant

パラメータ

vtFriendlyName: データ・プロバイダのわかりやすい接続名

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypRemoveConnection Lib "HsAddin" (ByVal vtFriendlyName As Variant) As Long

Sub Example_HypRemoveConnection()
X=HypRemoveConnection("My Connection")
End Sub

HypSetSSO

データ・プロバイダ・タイプ: シングル・サインオン(SSO)をサポートするすべてのプロバイダ

説明

HypSetSSO()では、Smart ViewにSSOトークンを設定します。SSOトークンは、設定するとユーザー名およびパスワードよりも優先されます。

構文

HypSetSSO(vtSSO)

ByVal vtSSO As Variant

パラメータ

vtSSO: SSOトークン

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Sub test()

SSO = <SSO token>
sts = HypDisconnectAll()
sts = HypSetSSO(SSO)
MsgBox (sts)

End Sub

HypInvalidateSSO

データ・プロバイダ・タイプ: シングル・サインオン(SSO)をサポートするすべてのプロバイダ

説明

HypInvalidateSSO()は、既存のSSOトークンを破棄します。

例

Declare Function HypInvalidateSSO Lib "HsAddin" () As Long
Sub Example_HypInvalidateSSO()
X = HypInvalidateSSO()
End Sub

HypResetFriendlyName

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypResetFriendlyNameは、わかりやすい名前を新しいものに変更します。Smart Viewパネルでわかりやすい接続名を変更するためには、Oracle Smart View for Officeがデータ・ソース・プロバイダに接続されている必要があります。

構文

HypResetFriendlyName (vtOldFriendlyName, vtNewFriendlyName)

By Val vtOldFriendlyName As Variant

By Val vtNewFriendlyName As Variant

パラメータ

vtOldFriendlyName: 元のわかりやすい接続名

vtNewFriendlyName: 新しいわかりやすい接続名

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypResetFriendlyName Lib "HsAddin" (ByVal vtOldFriendlyName As Variant, ByVal vtNewFriendlyName As Variant) As Long

Sub Example_HypResetFriendlyName()
Dim lRet As Long
lRet = HypResetFriendlyName("server2_Sample_Basic", "My Sample Basic")
End Sub

HypSetActiveConnection

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetActiveConnection()は、現在のアクティブなワークシートを、アクティブ接続のうちのいずれかに関連付けます。

注意:

HypSetActiveConnectionは、レポート・デザイナのオブジェクトを含むワークシートでは使用できません

構文

HypSetActiveConnection (vtFriendlyName)

ByVal vtFriendlyName As Variant

パラメータ

vtFriendlyName: 現在のアクティブなワークシートに関連付けるアクティブな接続のわかりやすい名前。大/小文字は区別されません。

戻り値

長整数。正常に終了した場合の戻り値は0です。それ以外の場合は該当するエラー・コードが戻されます。

例

Declare Function HypSetActiveConnection Lib "HsAddin" (ByVal vtFriendlyName As Variant) As Long

Sub Example_SetActiveConnection()
sts = HypSetActiveConnection ("Demo_Basic")
End sub

HypSetAsDefault

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetAsDefault()は、接続デフォルトを設定します。

構文

HypSetAsDefault (vtFriendlyName)

ByVal vtFriendlyName As Variant

パラメータ

vtFriendlyName: デフォルトとして設定するアクティブなプライベート接続の名前。これは、レジストリHKCU\Software\Hyperion Solutions\HyperionSmartView\Connectionsに値があるプライベート接続名であることが必要です

戻り値

正常に終了した場合の戻り値は0です。それ以外の場合は該当するエラー・コードが戻されます。

例

Public Declare Function HypSetAsDefault Lib "HsAddin" (ByVal vtFriendlyName As Variant) As Long

Sub Example_SetAsDefault()
sts = HypSetAsDefault("buildtie7_w32Simple_w32Simple")
MsgBox (sts)
End Sub

HypSetConnAliasTable

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning

説明

HypSetConnAliasTable()は、接続の別名表を設定します。この関数ではアクティブな接続が必要です。

構文

HypSetConnAliasTable (ByVal vtFriendlyName As Variant, ByVal vtAliasTableName As Variant)

パラメータ

vtFriendlyName: データ・プロバイダの接続名。たとえば、"MyConnection1"または"SampleBasic"。vtFriendlyNameがNullまたはEmptyの場合、エラーが戻されます。

vtAliasTableName: 別名表の名前で、形式には、"Default"、"Long Names"、"None""などがあります。このパラメータをNullまたはEmptyにすることはできません。別名を適用する必要がない場合は、パラメータ"None"を使用できます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypSetConnAliasTable Lib "HsAddin" (ByVal vtFriendlyName As Variant, ByVal vtAliasTableName As Variant) As Long

Sub Example_HypSetConnAliasTable
sts = HypSetConnAliasTable("SampleBasic","Long Names")
End sub

6 アド・ホック関数

関連トピック

- アド・ホック関数について

- HypPerformAdhocOnForm

- HypRetrieve

- HypRetrieveRange

- HypRetrieveNameRange

- HypCreateRangeGrid

- HypModifyRangeGridName

- HypGetNameRangeList

- HypRetrieveAllWorkbooks

- HypExecuteQuery

- HypSubmitData

- HypSubmitSelectedRangeWithoutRefresh

- HypSubmitSelectedDataCells

- HypPivot

- HypPivotToGrid

- HypPivotToPOV

- HypKeepOnly

- HypRemoveOnly

- HypZoomIn

- HypZoomOut

アド・ホック関数について

アド・ホック関数は、ズーム、データの取得と送信、ピボットなどのアド・ホック操作を実行します。

HypPerformAdhocOnForm

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning

説明

HypPerformAdhocOnForm()を使用すると、ExcelワークシートでPlanning Webフォームのアド・ホック分析を行うことができます。

構文

HypPerformAdhocOnForm(vtSheetName, vtFormName)

ByVal vtSheetName As Variant

ByVal vtFormName As Variant

パラメータ

vtSheetName: 入力変数。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtFormName: 入力変数。フル・パスを含むPlanning Webフォームの名前(例: /Forms/Financials/Financials Summary)

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypPerformAdhocOnForm Lib  "HsAddin" (ByVal  vtSheetName As Variant, ByVal  vtFormName  As Variant)  As Long
Sub Example_PerformAdhocOnForm
sts = HypPerformAdhocOnForm(Empty, "/Forms/Financials/Financials Summary")
End Sub

HypRetrieve

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypRetrieve()は、データベースからデータを取得します。

Essbaseのみ: HypRetrieveは、複数グリッド・ワークシートの作成をサポートしていません。かわりにHypRetrieveRangeを使用します。

構文

HypRetrieve(vtSheetName)

ByVal vtSheetName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypRetrieve Lib "HsAddin" (ByVal vtSheetName As Variant) As Long
Sub Example_HypRetrieve()
X=HypRetrieve(Empty)
End Sub

Public Declare Function HypRetrieve Lib "HsAddin" (ByVal vtSheetName As Variant) As Long
Sub Example_HypRetrieve()
X=HypRetrieve(Empty)
If X = 0 Then
MsgBox("Retrieve successful.")
Else
MsgBox("Retrieve failed.")
End If
End Sub

HypRetrieveRange

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypRetrieveRange()を使用すると、グリッド内またはワークシート内の選択したセル範囲または名前付きセル範囲をリフレッシュできます。選択したセル範囲または名前付きセル範囲は、有効なグリッド・レイアウトの形式にする必要があります。この関数で指定した範囲に、実際のグリッドに存在するより多くの行または列が含まれる場合、追加の行や列がコメントとして扱われ、グリッドの一部になります。

HypRetrieveRangeにより、「元に戻す」のバッファがクリアされるため、それ以降は「元に戻す」操作を使用できません。

Essbaseのみ: 複数グリッド・シートをリフレッシュまたは作成するには、HypCreateRangeGridを使用します。リリース11.1.2.5.610以降、HypRetrieveRange VBA関数の動作は、選択範囲のリフレッシュのみを行うように変更されています。11.1.2.5.610以降では、複数グリッド・シートの作成や追加範囲の作成は行われなくなります。

構文

HypRetrieveRange(vtSheetName,vtRange,vtFriendlyName)

ByVal vtSheetName As Variant

ByVal vtRange As Variant

ByVal vtFriendlyName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: リフレッシュする連続範囲。この範囲には、1つ以上のメンバー・セルとデータ・セルを含める必要があります。vtRangeがNullの場合は、ワークシート全体がリフレッシュされ、リフレッシュする範囲を取得するために、指定されたワークシートでGetUsedRangeが使用されます。

vtFriendlyName: 範囲のリフレッシュに使用される接続の、わかりやすい名前。Nullに設定されると、ワークシートに関連付けられたアクティブな接続を使用して、そのワークシート上の範囲がリフレッシュされます。接続が関連付けられていない場合は、エラーが戻されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

この例では、必要なデータ・ソースに接続済であることを想定しています。

Public Declare Function HypRetrieveRange Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant, ByVal vtFriendlyName As Variant) As Long
Worksheets("Sheet2").Names.Add name:="MyRange", RefersTo:="=$E$11:$F$28"
Sub Example_RetrieveRange
Worksheets("Sheet1").Names.Add name:="MyRange", RefersTo:="=$E$11:$F$28"
sts = HypRetrieveRange(Empty, range("E11:F28"), "Samp1")
'retrieve by regular range
sts = HypRetrieveRange(Empty, range("MyRange"), "Samp1")
'retrieve by named range
End sub

HypRetrieveNameRange

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypRetrieveNameRangeは、HypCreateRangeGridで作成されたグリッドをリフレッシュします。この関数は、Oracle Smart View for Officeの複数グリッドが定義された範囲名でのみ機能します。

「HypCreateRangeGrid」も参照してください。

構文

HypRetrieveNameRange (vtSheetName, vtGridName)

ByVal vtSheetName As Variant

ByVal vtGridName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtGridName: 入力パラメータ。リフレッシュする名前付き範囲またはグリッドの名前。名前付き範囲の形式: "'<Sheetname>'!<range name>"

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

例1

Public Declare Function HypRetrieveNameRange Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtGridName As Variant) As Long

Sub RetrieveAllRange()
'connect all required connections
sts = HypConnect("Sheet1", "UserName", "Password", "myserver_Sample_Basic")
'get list of named grids available
sts = HypGetNameRangeList("Sheet1", "", vtList)
'refresh each range one by one
For i = 0 To 2
sts = HypRetrieveNameRange("Sheet1", vtList(i))
Next i
End Sub

例2

グリッドの名前がわかっている場合:

Public Declare Function HypRetrieveNameRange Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtGridName As Variant) As Long
Sub Example_HypRetrieveNameRange()
sts = HypRetrieveNameRange("Sheet1", "'Sheet1'!DMDemo_Basic_2")
End Sub

HypCreateRangeGrid

データ・プロバイダ・タイプ: Oracle Essbase

説明

HypCreateRangeGrid()を使用すると、複数グリッドのワークシートで選択または指定した複数のセル範囲をリフレッシュできます。また、特定の場所にまだグリッドがない場合、これを使用して選択範囲にグリッドを追加することで、複数グリッドのシートを作成できます。この関数で指定した範囲に、実際のグリッドに存在するより多くの行または列が含まれる場合、追加の行や列がコメントとして扱われ、グリッドの一部になります。

ユーザーは、複数グリッド・ワークシートで複数のグリッドから選択した連続のセル範囲をリフレッシュできます。また、HypCreateRangeGridを使用して、複数グリッド・シートを作成することもできます(「例: 複数グリッド・シートの作成とリフレッシュ」を参照)。HypCreateRangeGridが実行されると、そのシートは複数グリッドのアド・ホック・シートになります。

単一グリッド・ワークシートから選択した連続のセル範囲をリフレッシュするには、HypRetrieveRangeを使用します。

構文

HypCreateRangeGrid(vtSheetName,vtRange,vtFriendlyName)

ByVal vtSheetName As Variant

ByVal vtRange As Variant

ByVal vtFriendlyName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: リフレッシュする連続範囲。各範囲には、1つ以上のメンバー・セルとデータ・セルを含める必要があります。vtRangeがNullの場合は、ワークシート全体がリフレッシュされ、リフレッシュする範囲を取得するために、指定されたワークシートでGetUsedRangeが使用されます。

vtFriendlyName: 範囲のリフレッシュに使用される接続の、わかりやすい名前。Nullに設定されると、ワークシートに関連付けられたアクティブな接続を使用して、そのワークシート上の範囲がリフレッシュされます。接続が関連付けられていない場合は、エラーが戻されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例: 複数グリッド・シートの作成とリフレッシュ

この例では、必要なデータ・ソースに接続済であることを想定しています。

Sub Example_CreateMultiGrid
'create sample-basic range grid
sts = HypCreateRangeGrid (Empty, range("E11:F13"), "SampleBasic1")
'create demo-basic range grid
sts = HypCreateRangeGrid (Empty, range("E17:G20"), "DemoBasic1")
End Sub

グリッドが作成されると、HypCreateRangeGridを呼び出して、シート内のグリッドの選択範囲を一度に1つずつリフレッシュできます。また、HypCreateRangeGridを使用して、シート内のすべてのグリッドをリフレッシュすることもできます。

HypModifyRangeGridName

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypModifyRangeGridName()を使用して、アクティブなワークブックに存在する複数グリッド・ワークシート上で指定された任意のグリッドの名前を変更します。

構文

Private Declare PtrSafe Function HypModifyRangeGridName Lib "HsAddin" (vtSheetName, vtGridName, vtNewGridName) As Long

ByVal vtSheetName As Variant

ByVal vtGridName As Variant

ByVal vtNewGridName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtGridName: 複数グリッド・ワークシート上のグリッドの名前範囲。このパラメータをNullまたはEmptyにすることはできません。

vtNewGridName: 複数グリッド・ワークシート上のグリッドの新しい名前範囲。このパラメータをNullまたはEmptyにすることはできません。

例

Sub modifyName()
s = HypModifyRangeGridName("Sheet1", "Demo15FCFBC11_9D65_4555_94AC_6EDD429438B0_1", "someNewGridName")
End Sub

HypGetNameRangeList

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypGetNameRangeListは、指定された接続の名前付きグリッドのリストを戻します。

構文

HypGetNameRangeList (vtSheetName, vtFriendlyName, vtNameList)

ByVal vtSheetName As Variant

ByVal vtFriendlyName As Variant

ByRef vtNameList As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtFriendlyName: 入力パラメータ。名前範囲リストを取得する接続名。Emptyに設定されると、シート内のすべての名前範囲リストを取得します。

vtNameList: 出力パラメータ。リスト出力。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypGetNameRangeList Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtFriendlyName As Variant, ByRef vtNameList As Variant) As Long
Sub Example_HypGetNameRangeList()
sts = HypGetNameRangeList("Sheet1", "stm10026_Sample_Basic", vtList)
End Sub

HypRetrieveAllWorkbooks

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypRetrieveAllWorkbooks()は、Excelの同じインスタンスから開いているすべてのワークブックをリフレッシュします。

構文

HypRetrieveAllWorkbooks()

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypRetrieveAllWorkbooks Lib "HsAddin" () As Long

Sub Example_HypRetrieveAllWorkbooks()
X=HypRetrieveAllWorkbooks()
End Sub

HypExecuteQuery

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypExecuteQuery()は、MDX問合せを実行し、結果をワークシート上に表示します。(問合せ結果をワークシート上に表示させない場合は、かわりにHypExecuteMDXExを使用します。)

構文

HypExecuteQuery (ByVal vtSheetName As Variant, ByVal vtMDXQuery As Variant) As Long

ByVal vtSheetName As Variant

ByVal vtMDXQuery

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMDXQuery: ワークシート上で実行するMDX問合せ文

戻り値

長整数。正常に終了した場合の戻り値は0です。それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypExecuteQuery Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMDXQuery As Variant) As Long

Sub Example_HypExecuteQuery ()
Dim vtQuery As Variant
vtQuery = "SELECT {([Jan])} on COLUMNS, {([East])} on ROWS"
sts = HypConnect (Empty, "Username", "Password", "Sample_Basic")
sts = HypExecuteQuery (Empty, vtQuery)
sts = HypDisconnect (Empty, True)
End sub

HypSubmitData

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSubmitData()は、指定したスプレッドシートの変更されたデータでデータベースを更新します。

注意:

- HypSubmitData()は、集約ストレージ・データベースまたはクラスタ環境ではサポートされません。

- データベースを更新できるかどうかは、送信者のアクセス権によって異なります。データを更新するためには、データベースに対して、少なくとも書込みアクセス権を持っている必要があります。

構文

HypSubmitData(vtSheetName)

ByVal vtSheetName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

戻り値

フォームの場合: フォームが正常に送信された場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

アド・ホックの場合: アド・ホック・グリッドが正常に送信され、HsSetVal関数(存在する場合)が実行されていた場合は0を戻します。シートは接続されていなかったが、HsSetVal関数(存在する場合)が実行されていた場合は1を戻します。シートにアド・ホック・グリッドはなかったが、HsSetVal関数(存在する場合)が実行されていた場合は2を戻します。それ以外の場合は、該当するエラー・コードを戻します。

例

Declare Function HypSubmitData Lib "HsAddin" (ByVal vtSheetName As Variant) As Long
Sub Example_HypSubmitData()
Worksheets(Empty).range("B2").value = 8023
Worksheets(Empty).range("B2").Select
sts = HypSubmitData(Empty)
End Sub

HypSubmitSelectedRangeWithoutRefresh

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypSubmitSelectedRangeWithoutRefresh()では、選択したデータ範囲のデータをそのまま使用してデータベースを更新します。選択範囲外のセルは無視され、それらのセルは上書き(またはリフレッシュ)されません。選択範囲は送信後に自動的にリフレッシュされないため、ユーザーは手動でグリッドをリフレッシュして、更新されたデータを取得する必要があります。送信を成功させるには、有効なグリッドを構成する範囲を選択する必要があります。一部の動作は、次に示したパラメータで制御できます。

注意:

- データベースを更新できるかどうかは、送信者のアクセス権によって異なります。データを更新するためには、データベースに対して、少なくとも書込みアクセス権を持っている必要があります。

- HypSubmitSelectedRangeWithoutRefresh関数を実行するには、この関数を呼び出す前に、シートがデータ・ソースに接続済であり、有効な範囲が選択されている必要があります。

- 通常の送信には、HypSubmitData関数の使用をお薦めします。

構文

HypSubmitSelectedRangeWithoutRefresh(vtSheetName)

ByVal vtSheetName As Variant

ByVal vtSubmitBlankCellsAsMissing As Variant

ByVal vtRefreshGridAfterSubmit As Variant

ByVal vtUseWholeSheet As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSubmitBlankCellsAsMissing: 未使用。サポートされているバージョンのOracle Hyperion Provider Servicesが使用可能になるまで、Falseに設定されている必要があります。Trueに設定されると、サポートされていないProvider Servicesエラーが発生します。

vtRefreshGridAfterSubmit: Trueに設定されると、選択したグリッドの結果が送信後に表示されます。送信操作が行われなかった場合、シートは更新されません。Falseに設定されると、送信のみが行われ、選択内容はリフレッシュされません。

vtUseWholeSheet: 複数グリッド・シートでは無視されます。単一のアド・ホック・グリッド・シートの場合、Trueに設定されると、シート全体のコンテンツが使用されます。Falseに設定されると、選択範囲をグリッド範囲として使用します。

戻り値

選択したセルが正常に送信された場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare PtrSafe Function HypSubmitSelectedRangeWithoutRefresh Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtSubmitBlankCellsAsMissing As Variant, ByVal vtRefreshGridAfterSubmit As Variant, ByVal vtUseWholeSheet) As Long

Sub SubmitFreeform()
sts = HypSubmitSelectedRangeWithoutRefresh("Sheet1", False, True, True)
'submits the whole grid in the sheet and refreshes the grid with result
sts = HypSubmitSelectedRangeWithoutRefresh("Sheet1", False, False, False)
'submits only the selected grid range and no refresh is performed,
'so the sheet content is left as is
End Sub

HypSubmitSelectedDataCells

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypSubmitSelectedDataCells()を使用すると、選択したデータ・セルを送信できます。

注意:

- フリー・フォーム・グリッドの場合、このVBA関数を使用すると、選択した空白セルを#Missingとして送信できます。

- データベースを更新できるかどうかは、送信者のアクセス権によって異なります。データを更新するためには、データベースに対して、少なくとも書込みアクセス権を持っている必要があります。

- HypSubmitSelectedDataCells関数を実行するには、この関数を呼び出す前に、シートがデータ・ソースに接続済であり、有効な範囲が選択されている必要があります。

- 通常の送信には、HypSubmitData関数の使用をお薦めします。

構文

HypSubmitSelectedDataCells(vtSheetName)

ByVal vtSheetName As Variant

ByVal vtDataRange as Variant

ByVal vtSubmitBlankCellsAsMissingInFreeFormGrid As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDataRange: 未使用。vtDataRangeが指定されている場合は無視されます。このパラメータがEmptyに設定されると、ワークシート上で選択済のセルが送信されます。

現在は、手動またはVisual Basicの範囲指定マクロを使用してシート上のデータ・セルを選択してから、HypSubmitSelectedDataCells()関数を実行する必要があります。

vtSubmitBlankCellsAsMissingInFreeFormGrid: フリー・フォーム・グリッドにのみ適用されます。Trueに設定されている場合、選択範囲内の空白セルはすべて#Missingとして送信されます。Falseに設定されている場合、空白セルはプロバイダで最後に保管された値に戻ります。

戻り値

選択したセルが正常に送信され、HsSetVal関数(存在する場合)が実行されていた場合は0を戻します。シートは接続されていなかったが、HsSetVal関数(存在する場合)が実行されていた場合は1を戻します。シートにアド・ホック・グリッドはなかったが、HsSetVal関数(存在する場合)が実行されていた場合は2を戻します。それ以外の場合は、該当するエラー・コードを戻します。

例

Sub SubmitRange()
'Example assumes sheet is already connected and the data
'cells to be submitted are already selected
sts = HypSubmitSelectedDataCells("Sheet1", Empty, True)
End Sub

HypPivot

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypPivot()は、選択したディメンションに基づいて、スプレッドシートの行と列を入れ替えます。

構文

HypPivot(vtSheetName, vtStart, vtEnd)

ByVal vtSheetName As Variant

ByVal vtStart As Variant

ByVal vtEnd As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtStart: ピボットの開始点となる単一セルを参照する範囲オブジェクト

vtEnd: ピボットの終点となる単一セルを参照する範囲オブジェクト

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypPivot Lib "HsAddin" (ByVal vtSheetName As Variant,  ByVal vtStart As Variant, ByVal vtEnd As Variant) As Long

Sub Example_HypPivot()
X=HypPivot(Empty, RANGE("B2"), RANGE("D1"))
If X = 0 Then
MsgBox("Pivot successful.")
Else
MsgBox("Pivot failed.")
End If
End Sub

HypPivotToGrid

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypPivotToGrid()は、選択したディメンションおよびメンバーを、POVからスプレッドシートのグリッドに移動します。

構文

HypPivotToGrid (vtSheetName, vtDimensionName, vtSelection)

ByVal vtSheetName As Variant

ByVal vtDimensionName As Variant

ByVal vtSelection As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDimensionName: ツールバーで現在選択されているディメンション

vtSelection: ピボットの開始点となる単一セルを参照する範囲オブジェクト。向きは、選択に基づいて計算されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypPivotToGrid Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtDimensionName As Variant, ByVal vtSelection As Variant) As Long

Sub Example_PivotGrid()
X = HypPivotToGrid(Empty, "Product", Range("E6"))
If X = 0 Then
MsgBox ("Pivot to grid successful.")
Else
MsgBox ("Pivot to grid failed.")
End If
End Sub

HypPivotToPOV

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypPivotToPOV()は、グリッドからPOVにピボットします。

構文

HypPivotToPOV (vtSheetName, vtSelection)

ByVal vtSheetName As Variant

ByVal vtSelection As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelection: ピボットの開始点となる単一セルを参照する範囲オブジェクト。向きは、選択に基づいて計算されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypPivotToPOV Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtSelection As Variant) As Long
Sub Example_HypPivotToPOV()
X=HypPivotToPOV(Empty, RANGE("E6"))
If X = 0 Then
MsgBox("Pivot to POV successful.")
Else
MsgBox("Pivot to POV failed.")
End If
End Sub

HypKeepOnly

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypKeepOnly()は、シート内で選択されたメンバーのみを保持し、選択されていないメンバーを削除します。

選択にはメンバー・セルのみを含め、データ・セルを含めることはできません。

構文

HypKeepOnly(vtSheetName, vtSelection)

ByVal vtSheetName As Variant

ByVal vtSelection As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelection: 保持するメンバーを参照する範囲オブジェクト。選択がNullまたはEmptyの場合、アクティブなセルが使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

1つのメンバー名のみを保持するには:

Public Declare Function HypKeepOnly Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtSelection As Variant) As Long

Sub Example_HypKeepOnly()
X=HypKeepOnly(Empty, RANGE("D2"))
If X = 0 Then
MsgBox("Keep Only successful.")
Else
MsgBox("Keep Only failed." + X)
End If
End Sub

複数のメンバー名を保持するには:

Public Declare Function HypKeepOnly Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtSelection As Variant) As Long

Sub Example_HypKeepOnly
X=HypKeepOnly(Empty, RANGE("D2:A5"))
If X = 0 Then
MsgBox("Keep Only successful.")
Else
MsgBox("Keep Only failed." + X)
End If
End Sub

HypRemoveOnly

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypRemoveOnly()は、ワークシートで選択されたメンバーのみを削除します。

選択にはメンバー・セルのみを含め、データ・セルを含めることはできません。

構文

HypRemoveOnly(vtSheetName, vtSelection)

ByVal vtSheetName As Variant

ByVal vtSelection As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelection: 削除するメンバーを参照する範囲オブジェクト。選択がNullまたはEmptyの場合、アクティブなセルが使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

1つのメンバー名のみを削除するには:

Public Declare Function HypRemoveOnly Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtSelection As Variant) As Long

Sub Example_HypRemoveOnly()
X=HypRemoveOnly(Empty, RANGE("D2"))
If X = 0 Then
MsgBox("Remove Only successful.")
Else
MsgBox("Remove Only failed." + X)
End If
End Sub

複数のメンバー名を削除するには:

Public Declare Function HypRemoveOnly Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtSelection As Variant) As Long

Sub Example_HypRemoveOnly()
X=HypRemoveOnly(Empty, RANGE("D2, A5"))
If X = 0 Then
MsgBox("Remove Only successful.")
Else
MsgBox("Remove Only failed." + X)
End If
End Sub

HypZoomIn

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypZoomIn()は、選択したメンバーに基づいて、Oracle Smart View for Officeからデータを取得して展開表示します。

構文

HypZoomIn(vtSheetName, vtSelection, vtLevel, vtAcross)

ByVal vtSheetName As Variant

ByVal vtSelection As Variant

ByVal vtLevel As Variant

ByVal vtAcross As Variant (未使用)

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelection: ズーム・インするメンバーを参照する範囲オブジェクト。選択がNullまたはEmptyの場合、アクティブなセルが使用されます。

vtLevel: ズームのレベルを示す数値。使用可能なレベルを次に示します。

- 0 = 次のレベル

- 1 = すべてのレベル

- 2 = 最下位レベル

- 3 = 兄弟(Oracle Hyperion Provider Servicesを使用しているEssbase 11.1.2.1.102以降の接続のみに使用可能)

- 4 = 同一レベル(Provider Servicesを使用しているEssbase 11.1.2.1.102以降の接続のみに使用可能)

- 5 = 同一世代(Provider Servicesを使用しているEssbase 11.1.2.1.102以降の接続のみに使用可能)

- 6 = 式(Provider Servicesを使用しているEssbase 11.1.2.1.102以降の接続のみに使用可能)

Nullの場合、Emptyまたは正しくない値が渡され、現在選択されているオプションが使用されます。

vtAcross: 未使用。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypZoomIn Lib "HsAddin" (ByVal vtSheetName As Variant,  ByVal vtSelection As Variant, ByVal vtLevel As Variant, ByVal vtAcross As Variant) As Long

Sub Example_HypZoomIn()
X=HypZoomIn(Empty, RANGE("B3"), 1, FALSE)
If X = 0 Then
MsgBox("Zoom successful.")
Else
MsgBox("Zoom failed.")
End If
End Sub

HypZoomOut

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypZoomOut()は、選択したメンバーに基づいて、データを縮小表示します。

構文

HypZoomOut(vtSheetName, vtSelection)

ByVal vtSheetName As Variant

ByVal vtSelection As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelection: ズーム・アウトするメンバーを参照する範囲オブジェクト。選択がNullまたはEmptyの場合、アクティブなセルが使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypZoomOut Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtSelection As Variant) As Long

Sub Example_HypZoomOut()
X=HypZoomOut(Empty, RANGE("B3"))
If X = 0 Then
MsgBox("Zoom out successful.")
Else
MsgBox("Zoom out failed.")
End If
End Sub

7 フォーム関数

関連トピック

- フォームについて

- HypOpenForm

フォームについて

フォームは、データベースにデータを入力でき、データまたは関連テキストを表示して分析できるグリッド表示です。 Oracle Hyperion Financial Managementでは、フォームは「データ・フォーム」と呼ばれます。

HypOpenForm

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypOpenForm ()は、指定されたフォームを開きます。

構文

HypOpenForm (vtSheetName, vtFolderPath, vtFormName, vtDimensionList(), vtMemberList())

ByVal vtSheetName As Variant

ByVal vtFolderPath As Variant

ByVal vtFormName As Variant

ByRef vtDimensionList() As Variant

ByRef vtMemberList() As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtFolderPath: フォルダのパス名

vtFormName: データ・フォームの名前

vtDimensionList(): 未使用

vtMemberList(): 未使用

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypOpenForm Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtFolderPath As Variant, ByVal vtFormName As Variant, ByRef vtDimensionList() As Variant, ByRef vtMemberList() As Variant) As Long

Sub Example_HypOpenForm()
Dim DimList() As Variant
Dim MemList() As Variant
sts = HypOpenForm(Empty, "/Forms/data1", "data1", DimList, MemList)
MsgBox (sts)
End Sub

8 セル関数

関連トピック

- セル関数について

- HypGetDimMbrsForDataCell

- HypCell

- HypFreeDataPoint

- HypGetCellRangeForMbrCombination

- HypGetDataPoint

- HypIsCellWritable

- HypSetCellsDirty

- HypDeleteAllLROs

- HypDeleteLROs

- HypAddLRO

- HypUpdateLRO

- HypListLROs

- HypRetrieveLRO

- HypExecuteDrillThroughReport

- HypGetDrillThroughReports

セル関数について

セル関数は、データ・セルとその内容に関する操作の実行と情報の取得を行います。

HypGetDimMbrsForDataCell

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetDimMbrsForDataCell()は、データ・セルに対するディメンション・メンバーのセット全体を取得します。これらのメンバーはグリッドに存在する必要があります。

構文

HypGetDimMbrsForDataCell (vtSheetName, vtCellRange, vtServerName, vtAppName, vtCubeName, vtFormName, vtDimensionNames, vtMemberNames)

ByVal vtSheetName As Variant

ByVal vtCellRange As Variant

ByRef vtServerName As Variant

ByRef vtAppName As Variant

ByRef vtCubeName As Variant

ByRef vtFormName As Variant

ByRef vtDimensionNames As Variant

ByRef vtMemberNames As Variant

パラメータ

vtSheetName: 入力変数。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtCellRange: 入力変数。セルの範囲(1セルのみ)

vtServerName: 出力変数。シート上の関連する接続が接続しているサーバーの名前

vtAppName: 出力変数。シート上の関連する接続が接続しているアプリケーションの名前

vtCubeName: 出力変数。シート上の関連する接続が接続しているキューブ/データベース(PlanningおよびOracle Planning and Budgeting Cloudの場合はプラン・タイプ)の名前

vtFormName: 出力変数。シート上の関連する接続が接続しているフォームの名前(アド・ホック・グリッドの場合、これは空の文字列として戻されます)

vtDimensionNames: 出力変数。ディメンション名の配列

vtMemberNames: 出力変数。メンバー名の配列

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

次の例を実行するには、oSheetNameに定義されたシートに有効なグリッドが含まれ、oSheetDisp.Rangeに定義されたセルまたはセル範囲が、グリッド内で有効なデータ・セルであることが必要です。

Public Declare Function HypGetDimMbrsForDataCell Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtCellRange As Variant, ByRef vtServerName As Variant, ByRef vtAppName As Variant, ByRef vtCubeName As Variant, ByRef vtFormName As Variant, ByRef vtDimensionNames As Variant, ByRef vtMemberNames As Variant) As Long

Sub Example_HypGetDimMbrsForDataCell()

Dim oRet As Long
Dim oSheetName As String
Dim oSheetDisp As Worksheet
Dim vtDimNames As Variant
Dim vtMbrNames As Variant
Dim vtServerName As Variant
Dim vtAppName As Variant
Dim vtCubeName As Variant
Dim vtFormName As Variant
Dim lNumDims As Long
Dim lNumMbrs As Long
Dim sPrintMsg As String

oSheetName = "Sheet1"
Set oSheetDisp = Worksheets("Sheet1")
oRet = HypGetDimMbrsForDataCell("", oSheetDisp.Range("valid data cell"), vtServerName, vtAppName, vtCubeName, vtFormName, vtDimNames, vtMbrNames)

If (oRet = SS_OK) Then
If IsArray(vtDimNames) Then
lNumDims = UBound(vtDimNames) - LBound(vtDimNames) + 1
End If

If IsArray(vtMbrNames) Then
lNumMbrs = UBound(vtMbrNames) - LBound(vtMbrNames) + 1
End If

sPrintMsg = "Number of Dimensions = " & lNumDims & "  Number of Members = " & lNumMbrs & " Cube Name - " & vtCubeName
MsgBox (sPrintMsg)
End If

End Sub

HypCell

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypCell()は、単一のメンバーの組合せについてセル値を取得します。

構文

HypCell(vtSheetName, ParamArray MemberList())

ByVal vtSheetName As Variant

ByVal ParamArray MemberList() As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

MemberList: データ値を取得するメンバーの組合せを説明する文字列のリスト。MemberListがNullまたはEmptyの場合、最上位レベルの値が使用されます。メンバーは"Dimension#Member"の形式で表されます。たとえば、"Year#Jan"や"Market#East"のようになります。

戻り値

正常に終了した場合は、データ・ポイントの値を戻します。シートを判別できない場合、またはシートがデータ・プロバイダに接続されていない場合は、#No Connectionを戻します。メンバーが正しくない場合は、無効なメンバーMemberNameまたはディメンションDimensionNameを戻します。

例

Declare Function HypCell Lib "HsAddin" (ByVal vtSheetName As Variant, ParamArray MemberList() As Variant) As Variant

Sub Example_HypCell()
Dim X As String
X=HypCell(Empty, "Year#Qtr1", "Scenario#Actual", "Market#Oregon")
If X = "#No Connection" Then
MsgBox("Not logged in, or sheet not active.")
Else
If Left(X, 15) = "#Invalid member" then
MsgBox("Member name incorrect.")
Else
MsgBox(X + " Value retrieved successfully.")
End If
End If
End Sub

注意:

戻されたデータ・ポイントの値が、自動的にスプレッドシート内のセルに配置されることはありません。この値をセルに配置するには、Visual BasicのSelectメソッドおよびActiveCellプロパティを使用します。詳細は、Visual Basicのドキュメントを参照してください。

HypFreeDataPoint

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypFreeDataPoint()は、HypGetDataPointで割り当てられたメモリーを解放します。

構文

構文

HypFreeDataPoint(vtInfo)

ByRef vtInfo As Variant

パラメータ

vtInfo: HypGetDataPointから戻されるVariant型の配列

戻り値

正常に終了した場合は0を戻します。正常に終了しなかった場合は-15 (「無効なパラメータ」)を戻します。

例

HypFreeDataPointの例は、「HypGetDataPoint」を参照してください。

HypGetCellRangeForMbrCombination

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetCellRangeForMbrCombination()は、選択したメンバーの組合せのセル範囲を取得します。

構文

HypGetCellRangeForMbrCombination (vtSheetName, vtDimNames, vtMbrNames, vtCellIntersectionRange)

By Val vtSheetName As Variant

ByRef vtDimNames As Variant

ByRef vtMbrNames As Variant

ByRef vtCellIntersectionRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDimNames: 入力変数。ディメンション名の配列

vtMbrNames: 入力変数。ディメンションに対応するメンバー名の配列(同じ順序)

vtCellIntersectionRange: 出力変数。グリッドのセルの範囲

戻り値

正常に終了した場合はSS_OKを戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypGetCellRangeForMbrCombination Lib "HsAddin" (ByVal vtSheetName As Variant, ByRef vtDimNames() As Variant, ByRef vtMbrNames() As Variant, ByRef vtCellIntersectionRange As Variant) As Long
Sub Example_HypGetCellRangeForMbrCombination()

Dim oRet As Long
Dim oSheetName As String
Dim oSheetDisp As Worksheet
Dim vtDimNames(3) As Variant
Dim vtMbrNames(3) As Variant
Dim vtReturnCellRange As Variant
Dim oRange As Range

'oSheetName = Empty
'Set oSheetDisp = Worksheets(oSheetName$)

vtDimNames(0) = "Measures"
vtDimNames(1) = "Market"
vtDimNames(2) = "Year"
vtDimNames(3) = "Product"
'vtDimNames(4) = ""

vtMbrNames(0) = "Sales"
vtMbrNames(1) = "New York"
vtMbrNames(2) = "Year"
vtMbrNames(3) = " Product"
'vtMbrNames(4) = ""

oRet = HypGetCellRangeForMbrCombination ("", vtDimNames, vtMbrNames, vtReturnCellRange)

If (oRet = 0) Then
Set oRange = vtReturnCellRange
End If
End Sub

HypGetDataPoint

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetDataPoint()は、単一データ・セルのメンバー情報を取得します。たとえば、セルB6におけるデータの交差を構成するメンバーを見つける場合、HypGetDataPointは、メンバーであるJanuary、California、Actual、Root Beer、Profitを戻します。

構文

HypGetDataPoint (vtSheetName, vtCell)

By Val vtSheetName As Variant

By Val vtCell As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtCell: メンバーの組合せ情報を取得する参照セル

戻り値

メンバー名の配列を戻します。

例

Declare Function HypGetDataPoint Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtCell As Variant) As Variant

Sub Example_HypGetDataPoint()
Dim vt As Variant
Dim cbItems As Variant
Dim i As Integer
Dim pMember As String
vt = HypGetDataPoint(Empty, range ("B3"))
If IsArray(vt) Then
cbItems = UBound(vt) - LBound(vt) + 1
MsgBox ("Number of elements = " + Str(cbItems))

For i = LBound(vt) To UBound(vt)
MsgBox ("Member = " + vt(i))
Next
X = HypFreeDataPoint(vt)
Else
MsgBox ("Return Value = " + Str(vt))
End If
End Sub

HypIsCellWritable

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypIsCellWritable()は、セルが書込み可能かどうかをチェックします。

構文

HypIsCellWritable (vtSheetName, vtCellRange)

ByVal vtSheetName As Variant

ByVal vtCellRange As Variant

パラメータ

vtSheetName: 入力パラメータ。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtCellRange: 出力パラメータ。書込み可能かどうかをチェックする必要のあるセルの範囲(1セルのみ)

戻り値

セルが書込み可能な場合はVARIANT_TRUEを戻し、それ以外の場合はVARIANT_FALSEを戻します。

例

Public Declare Function HypIsCellWritable Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtCellRange As Variant) As Boolean

Sub Example_HypIsCellWritable()

Dim oRet As Boolean
Dim oSheetName As String
Dim oSheetDisp As Worksheet

oSheetName = "Sheet1"
Set oSheetDisp = Worksheets(oSheetName$)
oRet = HypIsCellWritable (Empty, oSheetDisp.Range("G2"))

End Sub

HypSetCellsDirty

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetCellsDirty()は、データを送信するために選択したデータ範囲にダーティというマークを付けます。

構文

HypSetCellsDirty (vtSheetName, vtRange)

ByVal vtSheetName As Variant

ByVal vtRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: ダーティというマークを付けるVariant型のデータ範囲

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypSetCellsDirty Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant) As Long

Sub Example_HypSetCellsDirty()
X=HypSetCellsDirty (Empty, Range ("A3:B3"))
End Sub

HypDeleteAllLROs

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypDeleteAllLROs()は、すべてのリンク・レポート・オブジェクトをvtSelectionRangeパラメータで指定されたセルから削除します。

構文

HypDeleteAllLROs (vtSheetName, vtSelectionRange)

ByVal vtSheetName As Variant

ByVal vtSelectionRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelectionRange: このセル範囲からすべてのリンク・レポート・オブジェクトを削除します

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypDeleteAllLROs Lib "HsAddin" (ByVal vtSheetName As Variant,ByVal vtSelectionRange As Variant) As Long

Sub Example_HypDeleteAllLROs
sts = HypDeleteAllLROs("Sheet1", Range("B3"))
End Sub

HypDeleteLROs

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypDeleteLROs()は、1つ以上のリンク・レポート・オブジェクトをvtSelectionRangeパラメータで指定されたセルから削除します。

構文

HypDeleteLROs (vtSheetName, vtSelectionRange, vtLROIDs())

ByVal vtSheetName As Variant

ByVal vtSelectionRange As Variant

ByRef vtLROIDs() As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelectionRange: 入力変数。このセル範囲からすべてのリンク・レポート・オブジェクトを削除します

vtLROIDs(): 入力変数。削除するLRO IDの配列

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypDeleteLROs Lib "HsAddin" (ByVal vtSheetName As Variant,ByVal vtSelectionRange As Variant, ByRef vtLROIDs() As Variant) As Long

Sub Example_HypDeleteLROs()
Dim LROIDs(1)
LROIDs(0) = 1
LROIDs(1) = 2
sts = HypDeleteLROs("Sheet1", Range("B3"), LROIDs)
End Sub

HypAddLRO

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypAddLRO()は、リンク・レポート・オブジェクトをvtSelectionRangeパラメータで指定されたセルに追加します。追加されたリンク・レポート・オブジェクトを表示するには、「リンク・レポート・オブジェクト」ダイアログ・ボックスを開くか、HypListLROを使用する必要があります。

構文

HypAddLRO(vtSheetName, vtSelectionRange, vtlType, vtName, vtDescription)

ByVal vtSheetName As Variant

ByVal vtSelectionRange As Variant

ByVal vtlType As Variant

ByVal vtName As Variant

ByVal vtDescription As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelectionRange: 入力パラメータ。リンク・レポート・オブジェクトに関連付けるセルの範囲

vtlType: 入力パラメータ。定数として表されるリンク・レポート・オブジェクトのタイプ

- 1 - セル・ノート

- 2 - ファイル

- 3 - URL

vtName: 入力変数。ファイルの場所と、ファイル名およびURL情報。セル・ノートには使用されません。

vtDescription: 入力変数。セル・ノート、ファイルまたはURLの説明

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Public Declare Function HypAddLRO Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtSelectionRange As Variant, ByVal vtlType As Variant, ByVal vtName As Variant, ByVal vtDescription As Variant, ByRef vtLROIDs() As Variant) As Long
Sub Example_HypAddLRO()
sts = HypAddLRO("Sheet1", Range("B3"), 1, "", "Hello World")
End Sub

HypUpdateLRO

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypUpdateLRO()は、vtSelectionRangeパラメータで指定されたセルに関連付けられているリンク・レポート・オブジェクトを更新します。更新を表示するには、「リンク・レポート・オブジェクト」ダイアログ・ボックスを開くか、HypListLROを使用する必要があります。

構文

HypUpdateLRO(vtSheetName, vtSelectionRange, vtID,vtlType, vtName, vtDescription)

ByVal vtSheetName As Variant

ByVal vtSelectionRange As Variant

ByVal vtID As Variant

ByVal vtlType As Variant

ByVal vtName As Variant

ByVal vtDescription As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelectionRange: 入力変数。リンク・レポート・オブジェクトに関連付けるセルの範囲

vtID: 入力変数。更新するリンク・レポート・オブジェクトのID

vtlType: 入力変数。定数として表されるリンク・レポート・オブジェクトのタイプ

- 1 - セル・ノート

- 2 - ファイル

- 3 - URL

vtName: 入力変数。ファイルの場所と、ファイル名およびURL情報。セル・ノートには使用されません。

vtDescription: 入力変数。セル・ノート、ファイルまたはURLの説明

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Public Declare Function HypUpdateLRO Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtSelectionRange As Variant, ByVal vtID As Variant, ByVal vtlType As Variant, ByVal vtName As Variant, ByVal vtDescription As Variant) As Long

Sub Example_HypUpdateLRO
sts = HypUpdateLRO("Sheet1", Range("B3"), "2", 2, "d:\test2.txt", "linked object")
End Sub

HypListLROs

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypListLROs()は、vtSelectionRangeパラメータで指定されたセルに関連付けられているすべてのリンク・レポート・オブジェクトをリストします。

構文

HypListLROs (vtSheetName, vtSelectionRange, vtLRO)

ByVal vtSheetName As Variant

ByVal vtSelectionRange As Variant

ByRef vtLRO As LRO_Info

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelectionRange: 入力変数。このセル範囲のすべてのリンク・レポート・オブジェクトをリストします

vtLRO: 出力変数。リンク・レポート・オブジェクトの二次元配列

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypListLROs Lib "HsAddin" (ByVal vtSheetName As Variant,ByVal vtSelectionRange As Variant,ByRef vtLRO) As Long

Dim ObjectList As LRO_Info
Sub Example_HypListLROs()
sts = HypListLROs("Sheet1", Range("B3"), ObjectList)
End Sub

HypRetrieveLRO

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypRetrieveLRO()は、vtSelectionRangeパラメータで指定されたセルに関連付けられているリンク・レポート・オブジェクトを取得します。リンク・レポート・オブジェクトを表示するには、「リンク・レポート・オブジェクト」ダイアログ・ボックスを開くか、HypListLROを使用する必要があります。

構文

HypRetrieveLRO(vtSheetName, vtSelectionRange, vtID,vtlType, vtName, vtDescription)

ByVal vtSheetName As Variant

ByVal vtSelectionRange As Variant

ByVal vtID As Variant

ByVal vtName As Variant

ByVal vtDescription As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelectionRange: 入力変数。リンク・レポート・オブジェクトに関連付けるセルの範囲

vtID: 入力変数。取得するリンク・レポート・オブジェクトのID。これはHypListLROsの実行時に指定されます。

vtName: 出力変数。リンク・レポート・オブジェクトの名前

vtDescription: 出力変数。取得したリンク・レポート・オブジェクトの説明

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Public Declare Function HypRetrieveLRO Lib "HsAddin" (ByVal vtSheetName As Variant,ByVal vtSelectionRange As Variant,ByVal vtID As Variant,ByRef vtName As Variant,ByRef vtDescription As Variant) As Long

Sub Example_HypRetrieveLRO
sts = HypRetrieveLRO("Sheet1", Range("B3"), "1", vtName, vtDescription)
End Sub

HypExecuteDrillThroughReport

データ・プロバイダ・タイプ: Oracle Essbase

説明

HypExecuteDrillThroughReport()は、指定されたドリルスルー・レポートを実行します。「HypGetDrillThroughReports」も参照してください。

構文

HypExecuteDrillThroughReport(vtSheetName, vtSelectionRange, vtID, vtName, vtURL, vtURLTemplate, vtType)

ByVal vtSheetName As Variant

ByVal vtSelectionRange As Variant

ByVal vtID As Variant

ByVal vtName As Variant

ByVal vtURL As Variant

ByVal vtURLTemplate As Variant

ByVal vtType As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelectionRange: 入力変数。ドリルスルー・レポートを実行するセルの範囲

vtID: 入力変数。ドリルスルー・レポートの実行ID。これはHypGetDrillThroughReportsの実行時にサーバーから戻されます。

vtName: 入力変数。ドリルスルー・レポートの名前。これはHypGetDrillThroughReportsの実行時にサーバーから戻されます。

vtURL: 入力変数。ドリルスルー・レポートのURL。これはHypGetDrillThroughReportsの実行時にサーバーから戻されます。

vtURLTemplate: 入力変数。ドリルスルー・レポートのURLテンプレート。これはHypGetDrillThroughReportsの実行時にサーバーから戻されます。

vtType: 入力変数。ドリルスルー・レポートのタイプ。これはHypGetDrillThroughReportsの実行時にサーバーから戻されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypExecuteDrillThroughReport Lib "HsAddin" (ByVal vtSheetName As Variant,ByVal vtSelectionRange As Variant,ByVal vtID As Variant,ByVal vtName As Variant,ByVal vtURL As Variant,ByVal vtURLTemplate As Variant,ByVal vtType As Variant) As Long

Sub Example_HypExecuteDrillThroughReport()
sts = HypExecuteDrillThroughReport("Sheet3", Range("B3"), ids(0), names(0), "", "", "")
End Sub

HypGetDrillThroughReports

データ・プロバイダ・タイプ: Oracle Essbase

説明

HypGetDrillThroughReports()は、ドリルスルー・レポートのリストを取得します。「HypExecuteDrillThroughReport」も参照してください。

構文

HypGetDrillThroughReports(vtSheetName, vtSelectionRange, vtIDs, vtNames, vtURLs, vtURLTemplates, vtTypes)

ByVal vtSheetName As Variant

ByVal vtSelectionRange As Variant

ByVal vtIDs As Variant

ByVal vtNames As Variant

ByVal vtURLs As Variant

ByVal vtURLTemplates As Variant

ByVal vtTypes As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtSelectionRange: 取得するドリルスルー・レポートを含むセルの範囲

vtIDs: 出力変数。サーバーから戻されたIDの配列

vtNames: 出力変数。サーバーから戻された名前の配列

vtURLs: 出力変数。サーバーから戻されたURLの配列

vtURLTemplates: 出力変数。サーバーから戻されたURLテンプレートの配列

vtTypes: 出力変数。サーバーから戻されたタイプの配列

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypGetDrillThroughReports Lib "HsAddin" (ByVal vtSheetName As Variant,ByVal vtSelectionRange As Variant,ByRef vtIDs As Variant,ByRef vtNames As Variant,ByRef vtURLs As Variant,ByRef vtURLTemplates As Variant,ByRef vtTypes As Variant) As Long

Sub Example_HypGetDrillThroughReports()
sts = HypGetDrillThroughReports("Sheet3", Range("B3"), ids, names, urls, urltemplates, types)
End Sub

9 POV関数

関連トピック

- POV関数について

- HypSetPOV

- HypGetBackgroundPOV

- HypSetBackgroundPOV

- HypGetPagePOVChoices

- HypSetPages

- HypGetMembers

- HypSetMembers

- HypGetActiveMember

- HypSetActiveMember

- HypGetDimensions

- HypSetDimensions

POV関数について

POV関数は、POVの設定を指定または取得します。

HypSetPOV

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypSetPOV()は、選択したアド・ホック・ワークシートのPOVを設定します。この関数はデータ・フォームをサポートしません。フォームにはHypSetPagesを使用します。

より効率的にPOVを設定するには、HypSetPOVのかわりにHypSetDimensionsを使用できます。

構文

HypSetPOV(vtSheetName, ParamArray MemberList())

ByVal vtSheetName As Variant

ParamArray MemberList() As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

ParamArray MemberList(): データ値を取得するメンバーの組合せを説明する文字列のリスト。MemberListがNullまたはEmptyの場合、最上位レベルの値が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。アド・ホック・ワークシートではなくフォームに対してこの関数を使用すると、エラー-69 (非推奨VBA)が戻されます。

例

Declare Function HypSetPOV Lib "HsAddin" (ByVal vtSheetName As Variant, ParamArray MemberList() As Variant) As Long
Sub Example_HypSetPOV()
X=HypSetPOV (Empty,"Year#Qtr1", "Market#East")
End Sub

HypGetBackgroundPOV

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetBackgroundPOV()は、バックグラウンドPOVメンバーのリストを2つの文字列配列として戻します。一方の文字列配列にはPOVディメンション名が含まれます。もう一方にはメンバー名が含まれます。

構文

HypGetBackgroundPOV (vtFriendlyName, vtDimensionNames, vtMemberNames)

ByVal vtFriendlyName As Variant

ByRef vtDimensionNames As Variant

ByRef vtMemberNames As Variant

パラメータ

vtFriendlyName: 入力変数。データ・プロバイダの接続名。

vtDimensionNames: 出力変数。ディメンション名配列

vtMemberNames: 出力変数。メンバー名配列(POVディメンション当たり1メンバー)

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

この例では、ワークシートが接続されていることと、グリッドがあることを想定しています。

Public Declare Function HypGetBackgroundPOV Lib "HsAddin" (ByVal vtFriendlyName As Variant, ByRef vtDimensionNames As Variant, ByRef vtMemberNames As Variant) As Long
Sub Example_GetBackgroundPOV()
sts = con = HypGetBackgroundPOV("stm10026_Sample_Basic", vtDim, vtMem)
End Sub

HypSetBackgroundPOV

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetBackgroundPOV()は、POVマネージャの接続オブジェクト用のPOVを設定します。

構文

HypSetBackgroundPOV(vtFriendlyName, ParamArray MemberList())

ByVal vtFriendlyName As Variant

ParamArray MemberList() As Variant

パラメータ

vtFriendlyName: データ・プロバイダの接続名。

MemberList: データ値を取得するメンバーの組合せを説明する文字列のリスト。MemberListがNullまたはEmptyの場合、最上位レベルのHypSetDimensionsの値が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypSetBackgroundPOV Lib "HsAddin" (ByVal vtFriendlyName, ParamArray MemberList() As Variant) As Long

Sub Example_ypSetBackgroundPOV()
X=HypSetBackgroundPOV ("My Connection","Year#Qtr1", "Market#East")
End Sub

HypGetPagePOVChoices

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetPagePOVChoices()は、指定されたディメンションで使用可能なメンバー名およびメンバーの説明を戻します。

構文

HypGetPagePOVChoices(vtSheetName, vtDimensionName, vtMbrNameChoices, vtMbrDescChoices)

ByVal vtSheetName As Variant

ByVal vtDimensionName As Variant

ByRef vtMbrNameChoices As Variant

ByRef vtMbrDescChoices As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDimensionName: POVのディメンション名

vtMbrNameChoices: 出力パラメータ。メンバー名の配列

vtMbrDescChoices: 出力パラメータ。メンバーの説明の配列

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypGetPagePOVChoices Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtDimensionName As Variant, ByRef vtMbrNameChoices As Variant, ByRef vtMbrDescChoices As Variant) As Long
Sub Example_HypGetPagePOVChoices()
Dim mbrName As Variant
Dim mbrDesc As Variant
sts = HypGetPagePOVChoices(Empty, "Product", vtMbrNameChoices, vtMbrDescChoices)
MsgBox (sts)
End Sub

HypSetPages

Cloudデータ・プロバイダ・タイプ: Oracle Planning and Budgeting Cloud (フォームのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Hyperion Planning (フォームのみ)、Oracle Hyperion Financial Management (フォームのみ)

説明

HypSetPages()は、選択したシートのページ・メンバーを設定します。

構文

HypSetPages (ByVal vtSheetName, ParamArray MemberList())

ByVal vtSheetName As Variant

ParamArray MemberList() As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

ParamArray MemberList(): 必要なページ・メンバー・アイテムのリストをDimension#Current Memberの形式で表したもの。MemberListがNullまたはEmptyの場合、最上位レベルの値が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypSetPages Lib "HsAddin" (ByVal vtSheetName As Variant, ParamArray MemberList() As Variant) As Long

Sub Example_HypSetPages()
X=HypSetPages (Empty,"Entity#Operations","Scenario#Current")
End Sub

HypGetMembers

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetMembers()は、グリッドに存在する特定のディメンションに対して選択または使用したメンバーのリストを取得します。

Essbase、Oracle Analytics Cloud - Essbase、PlanningおよびOracle Planning and Budgeting Cloudの場合、メンバー名は選択した別名表に基づいています。

Financial Managementの場合、2番目の配列は説明を戻します。

POV(フォーム)、ページ(アド・ホック)およびユーザー変数の場合は、単一メンバーが戻されます。

ユーザー変数を一意に識別するには、ディメンション名ではなくユーザー変数名を指定します。

構文

HypGetMembers (vtSheetName, vtDimensionName, vtMbrNameChoices, vtMbrDescChoices)

ByVal vtSheetName As Variant

ByVal vtDimensionName As Variant

ByRef vtMbrNameChoices As Variant

ByRef vtMbrDescChoices As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDimensionName: 入力変数。選択したメンバー・リストを戻すディメンションの名前

vtMbrNameChoices: 出力変数。使用するメンバー名の配列

vtMbrDescChoices: 出力変数。メンバー名の説明の配列。Essbase、Oracle Analytics Cloud - Essbase、PlanningおよびOracle Planning and Budgeting Cloudの場合、これはメンバー名と同様です。このリストは、ディメンションが行または列ディメンションの場合に空になります。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

この例では、ワークシートが接続されていることと、グリッドがあることを想定しています。

Public Declare Function HypGetMembers Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtDimensionName As Variant, ByRef vtMbrNameChoices As Variant, ByRef vtMbrDescChoices As Variant) As Long
Sub Example_HypGetMembers()
sts = HypGetMembers("Sheet1", "Year", vtMbr, vtDes)
End Sub

HypSetMembers

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetMembers()は、アド・ホック・グリッドのPOVディメンションの選択リスト、およびFinancial Managementフォームの「ページ」リストを設定します。

この関数は、Planningフォームの「ページ」リストの設定には使用できず、行または列メンバーの設定にも使用できません。

ユーザーが送信したメンバー・リストは、設定前に検証されます。

構文

HypSetMembers (vtSheetName, vtDimensionName, ParamArray MemberList())

ByVal vtSheetName As Variant

ByVal vtDimensionName As Variant

ParamArray MemberList() As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDimensionName: 入力変数。選択したメンバー・リストを設定するディメンションの名前

MemberList: 入力変数。選択肢として設定するメンバー名の配列

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

この例では、ワークシートが接続されていることと、グリッドがあることを想定しています。注意: "InvalidMember"はエンティティ・ディメンションに属していないため、ディメンションの選択リストには含まれません。

Public Declare Function HypSetMembers Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtDimensionName As Variant, ParamArray MemberList() As Variant) As Long
Sub Example_HypSetMembers()
sts = HypSetMembers("Sheet1", "Entity", "Regional", "InvalidMember", "None")
End Sub

HypGetActiveMember

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

データ・プロバイダ・タイプ:

説明

HypGetActiveMember ()は、指定されたディメンションのアクティブ・メンバー名を戻します。ページ・ディメンション、POVディメンションおよびユーザー変数のアクティブ・メンバーは、アド・ホックまたはフォーム・ワークシートで取得できます。行ディメンションと列ディメンションは戻されません。

構文

HypGetActiveMember (vtDimName, vtMember)

ByVal vtDimName As Variant

ByRef vtMember As Variant

パラメータ

vtDimName: 入力変数。アクティブ・メンバーを取得するディメンション名

vtMember: 出力変数。戻されるアクティブ・メンバー名

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

この例では、ワークシートが接続されていることと、グリッドがあることを想定しています。

Public Declare Function HypGetActiveMember Lib "HsAddin" (ByVal vtDimName As Variant, ByRef vtMember As Variant) As Long
Sub Example_GetActiveMember()
sts =  HypGetActiveMember("Market", vtMem)
End Sub

HypSetActiveMember

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetActiveMember()は、指定されたディメンション(ページ、POVおよびユーザー変数)のアクティブ・メンバーを設定します。行ディメンションと列ディメンションには適用されません。

構文

HypSetActiveMember (vtDimName, vtMember)

ByVal vtDimName As Variant

ByVal vtMember As Variant

パラメータ

vtDimName: 入力変数。アクティブ・メンバーを変更または設定するディメンション名

vtMember: 入力変数。設定するアクティブ・メンバー

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

この例では、ワークシートが接続されていることと、グリッドがあることを想定しています。

Public Declare Function HypSetActiveMember Lib "HsAddin" (ByVal vtDimName As Variant, ByVal vtMember As Variant) As Long
Sub Example_HypSetActiveMember()
sts =  HypSetActiveMember("Market", "Washington")
End Sub

HypGetDimensions

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetDimensions()は、グリッド内のディメンション名を含む配列と、それぞれに対応するタイプを含む配列を戻します。HypGetDimensions()は、非推奨のHypGetPOV()関数のかわりに使用できます。

タイプ配列には、次の列挙を使用して識別できる5つの可能なタイプ(行、列、ページ、POV、ユーザー変数)があります。

Enum DIMENSION_TYPE
ROW_DIM = 0
COL = 1
POV = 2
PAGE = 3
USERVAR = 5
End Enum

ユーザー変数を一意に識別するには、ディメンション名ではなくユーザー変数名を使用します。

構文

HypGetDimensions (vtSheetName, vtMemberNames, vtType)

ByVal vtSheetName As Variant

ByRef vtMemberNames As Variant

ByRef vtType As Variant

パラメータ

vtSheetName: 入力パラメータ。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberNames: 出力変数。グリッドに存在するディメンション名の配列

vtType: 出力変数。それぞれのディメンションのタイプ情報

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

この例では、ワークシートが接続されていることと、グリッドがあることを想定しています。

Public Declare Function HypGetDimensions Lib "HsAddin" (ByVal vtSheetName As Variant, ByRef vtMemberNames As Variant, ByRef vtType As Variant) As Long
Sub Example_GetDimensions()
sts = HypGetDimensions("Sheet1", vtDim, vtType)
End Sub

HypSetDimensions

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetDimensions()は、グリッドのメタデータを再配置して、デフォルト・グリッド以外のアド・ホック・グリッド・レイアウトを指定します。この関数には、グリッド内のディメンション名を含む配列と、それぞれに対応するタイプを含む配列を指定します。

HypSetDimensions()が既存のアド・ホック・レポートで使用されている場合、グリッド全体のレイアウトが再配置され、コメント、式およびフォーマットは失われます。

構文

HypSetDimensions(vtSheetName, vtDimNames(), vtType())

ByVal vtSheetName() As Variant

ByRef vtDimNames() As Variant

ByRef vtType() As Variant)

パラメータ

vtSheetName: 入力パラメータ。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDimNames(): 入力パラメータ。グリッドに存在するディメンション名の配列

vtType(): 入力パラメータ。それぞれのディメンションのタイプ情報。使用可能な値を次に示します。

- 行ディメンション(ROW_DIM) = 0

- 列(COL) = 1

- POV (POV) = 2

- ページ・ディメンション(PAGE) = 3

- ユーザー変数(USERVAR) = 5

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

この例では、ワークシートが接続されていることを想定しています。

Public Declare Function HypSetDimensions Lib "HsAddin" (ByVal vtSheetName() As Variant, ByRef vtDimNames() As Variant, ByRef vtType() As Variant) As Long
Sub Example_HypSetDimensions()
Dim dims(3) As Variant
Dim types(3) As Variant
dims(0) = "Product"
dims(1) = "Market"
dims(2) = "Scenario"
dims(3) = "Measures"
types(0) = ROW_DIM
types(1) = COL
types(2) = POV
types(3) = POV
sts = HypSetDimensions("Sheet2", dims, types)
End Sub

10 計算スクリプトおよびビジネス・ルール関数

関連トピック

- 計算スクリプトおよびビジネス・ルール関数について

- HypListCalcScripts

- HypExecuteCalcScript

- HypListCalcScriptsEx

- HypExecuteCalcScriptEx

- HypGetCalcScript

- HypExecuteCalcScriptString

- HypDeleteCalc

計算スクリプトおよびビジネス・ルール関数について

計算スクリプトおよびビジネス・ルール関数は、計算スクリプトおよびビジネス・ルールを取得または実行します。

HypListCalcScripts

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypListCalcScripts()は、Essbaseサーバーに存在するすべての計算スクリプトをリストします。

構文

HypListCalcScripts (vtSheetName, vtScriptArray)

ByVal vtSheetName As Variant

ByRef vtScriptArray As Variant

パラメータ

vtSheetName: 入力パラメータ。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtScriptArray: 出力パラメータ。ビジネス・ルール・スクリプトの配列

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypListCalcScripts Lib "HsAddin" (ByVal vtSheetName As Variant, ByRef vtScriptArray As Variant) As Long
Sub Example_HypListCalcScripts()
Dim sts As Long
Dim paramList As Variant
sts = HypListCalcScripts(Empty, paramList)
If IsArray(paramList) Then
cbItems = UBound(paramList) - LBound(paramList) + 1
MsgBox ("Number of elements = " + Str(cbItems))
For i = LBound(paramList) To UBound(paramList)
MsgBox ("Member = " + paramList(i))
Next
Else
MsgBox ("Return Value = " + sts)
End If
End Sub

HypExecuteCalcScript

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypExecuteCalcScript()は、計算スクリプト(ビジネス・ルール・スクリプト)を使用して、サーバー側での計算を開始します。

構文

HypExecuteCalcScript (vtSheetName, vtCalcScript, vtSynchronous)

ByVal vtSheetName As Variant

ByVal vtCalcScript As Variant

ByVal vtSynchronous As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtCalcScript: サーバー上のデータベース・ディレクトリ内にある、実行する計算スクリプトの名前。デフォルトの計算スクリプトを実行するには、Defaultを使用します。

vtSynchronous: 未使用

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypExecuteCalcScript Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtCalcScript As Variant, ByVal vtSynchronous As Variant) As Long

Sub Example_HypExecuteCalcScript()
X = HypExecuteCalcScript (Empty, "Default", False)
If X = 0 Then
MsgBox("Calculation complete.")
Else
MsgBox("Calculation failed.")
End If
End Sub

HypListCalcScriptsEx

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning

説明

HypListCalcScriptsEx()は、すべてのビジネス・ルールをリストします。

注意:

詳細は、「HypExecuteCalcScriptEx」の「使用方法」を参照してください。

構文

HypListCalcScriptsEx (vtSheetName, vtbRuleOnForm, vtCubeNames, vtBRNames, vtBRTypes, vtBRHasPrompts, vtBRNeedsPageInfo, vtBRHidePrompts)

ByVal vtSheetName As Variant

ByVal vtbRuleOnForm As Variant

ByRef vtCubeNames As Variant

ByRef vtBRNames As Variant

ByRef vtBRTypes As Variant

ByRef vtBRHasPrompts As Variant

ByRef vtBRNeedsPageInfo As Variant

ByRef vtBRHidePrompts As Variant

パラメータ

vtSheetName: 入力パラメータ。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtbRuleOnForm: 入力パラメータ。シート上の開いているフォームにのみ関連付けられているビジネス・ルールをリストするかどうかを示すブール値。Falseに設定されると、アプリケーションに関連付けられているすべてのビジネス・ルールが戻されます。

vtCubeNames: 出力パラメータ。ビジネス・ルールに関連付けられているキューブ名の配列(PlanningおよびOracle Planning and Budgeting Cloudの場合はプラン・タイプ)

vtBRNames: 出力パラメータ。ビジネス・ルール名の配列

vtBRTypes: 出力パラメータ。ビジネス・ルール・タイプの配列

vtBRHasPrompts: 出力パラメータ。ビジネス・ルールに実行時プロンプト(RTP)があるかどうかを示すブール値の配列

vtBRNeedsPageInfo: 出力パラメータ。シートでのページ情報の実行がビジネス・ルールで必要かどうかを示すブール値の配列

vtBRHidePrompts: 出力パラメータ。ビジネス・ルールのRTPが非表示かどうかを示すブール値の配列

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypListCalcScriptsEx Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtbRuleOnForm As Variant, ByRef vtCubeNames As Variant, ByRef vtBRNames As Variant, ByRef vtBRTypes As Variant, ByRef vtBRHasPrompts As Variant, ByRef vtBRNeedsPageInfo As Variant, ByRef vtBRHidePrompts As Variant) As Long
Sub RunListCalcScriptsEx()
sts = HypListCalcScriptsEx(Empty, True, CubeName, BRNames, BRTypes, BRHasPrompts, BRNeedsPageInfo, BRHidePrompts)
End Sub

HypExecuteCalcScriptEx

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning

説明

HypExecuteCalcScriptEx()は、選択されたビジネス・ルールを実行します。

構文

HypExecuteCalcScriptEx(vtSheetName, vtCubeName, vtBRName, vtBRType, vtbBRHasPrompts, vtbBRNeedPageInfo, vtRTPNames(), vtRTPValues(), vtbShowRTPDlg, vtbRuleOnForm, vtbBRRanSuccessfully, vtCubeName, vtBRName, vtBRType, vtbBRHasPrompts, vtbBRNeedPageInfo, vtbBRHidePrompts, vtRTPNamesUsed, vtRTPValuesUsed )

ByVal vtSheetName As Variant

ByVal vtCubeName As Variant

ByVal vtBRName As Variant

ByVal vtBRType As Variant

ByVal vtbBRHasPrompts As Variant

ByVal vtbBRNeedPageInfo As Variant

ByRef vtRTPNames() As Variant

ByRef vtRTPValues() As Variant

ByVal vtbShowRTPDlg As Variant

ByVal vtbRuleOnForm As Variant

ByRef vtbBRRanSuccessfuly As Variant

ByRef vtCubeName As Variant

ByRef vtBRName As Variant

ByRef vtBRType As Variant

ByRef vtbBRHasPrompts As Variant

ByRef vtbBRNeedPageInfo As Variant

ByRef vtbBRHidePrompts As Variant

ByRef vtRTPNamesUsed As Variant

ByRef vtRTPValuesUsed As Variant

パラメータ

vtSheetName: 入力パラメータ。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtCubeName: 入力パラメータ。ビジネス・ルールに関連付けられているキューブ名(PlanningおよびOracle Planning and Budgeting Cloudの場合はプラン・タイプ)

vtBRName: 入力パラメータ。実行するビジネス・ルールの名前

vtBRType: 入力パラメータ。実行するビジネス・ルールのタイプ。有効な値は、graphical、ecs、sequenceおよびnativeです。

vtbBRHasPrompts: 入力パラメータ。ビジネス・ルールにRTPがあるかどうかを示すブール値

vtbNeedPageInfo: 入力パラメータ。ページ情報の実行がビジネス・ルールで必要かどうかを示すブール値(この情報は、HypListCalcScriptsExか、HypExecuteCalcScriptExの以前の実行から取得します)

vtRTPNames: 入力パラメータ。ビジネス・ルールに関連付けられているRTP名の配列

vtRTPValues: 入力パラメータ。RTP名に対応するRTP値の配列

vtbShowBRDlg: 入力パラメータ。「ビジネス・ルール」ダイアログを表示してユーザーにビジネス・ルールを選択させるか(True)、ビジネス・ルールを自動的に実行するか(False)を示すブール値。Trueに設定されると、ビジネス・ルールに関連するすべての入力パラメータは無視されます。推奨: ビジネス・ルールを初めて実行するときはTrueに設定し、その後はFalseに設定して同じビジネス・ルールの実行を自動化します。

vtbRuleOnForm: 入力パラメータ。アクティブ・シート上で開いているフォームにビジネス・ルールを関連付けるかどうかを示すブール値

vtbBRRanSuccessfully: 出力パラメータ。最後のビジネス・ルールが正常に実行されたかどうかを示すブール値

vtCubeName: 出力パラメータ。最後に実行されたビジネス・ルールに関連付けられているキューブ名(Planningの場合はプラン・タイプ)

vtBRName: 出力パラメータ。最後に実行されたビジネス・ルールの名前

vtBRType: 出力パラメータ。最後に実行されたビジネス・ルールのタイプ

vtbBRHasPrompts: 出力パラメータ。最後に実行されたビジネス・ルールにRTPがあるかどうかを示すブール値

vtbBRNeedPageInfo: 出力パラメータ。最後に実行されたビジネス・ルールでページ情報の実行が必要かどうかを示すブール値

vtbBRHidePrompts: 出力パラメータ。最後に実行されたビジネス・ルールに非表示のRTPがあるかどうかを示すブール値

vtRTPNames: 出力パラメータ。最後に実行されたビジネス・ルールの実行に使用されたRTP名の配列

vtRTPValues: 出力パラメータ。最後に実行されたビジネス・ルールの実行に使用されたRTP名に関連付けられているRTP値の配列

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypExecuteCalcScriptEx Lib "HsAddin" (ByVal vtSheetName As Variant,ByVal vtCubeName As Variant,ByVal vtBRName As Variant, ByVal vtBRType As Variant, ByVal vtbBRHasPrompts As Variant, ByVal vtbBRNeedPageInfo As Variant,ByRef vtRTPNames() As Variant,ByRef vtRTPValues() As Variant, ByVal vtbShowRTPDlg As Variant, ByVal vtbRuleOnForm As Variant, ByRef vtBRRanSuccessfully As Variant,ByRef vtCubeName As Variant,ByRef vtBRName As Variant, ByRef vtBRType As Variant, ByRef vtbBRHasPrompts As Variant, ByRef vtbBRNeedPageInfo As Variant, ByRef vtbBRHidePrompts As Variant, ByRef vtRTPNamesUsed As Variant, ByRef vtRTPValuesUsed As Variant) As Long

Sub Example_HypExecuteCalcScriptEx()

Dim oRet As Long
Dim oSheetName As StringDim oSheet As Worksheet
Dim vtCubeNames As Variant
Dim vtBRNames As Variant
Dim vtBRTypes As Variant
Dim vtBRHasPrompts As Variant
Dim vtBRNeedsPageInfo As Variant
Dim vtBRHidePrompts As Variant
Dim sAllCalcs As String
Dim sCalcName As String
Dim bNeedPageInfo As Variant
Dim vtInRTPNames() As Variant
Dim vtInRTPValues() As Variant
Dim vtOutRTPNames As Variant
Dim vtOutRTPValues As Variant
Dim vtbBRRanSuccessfully As Variant
Dim vtbBRRanSuccessfully2 As Variant
Dim vtOutCubeName As Variant
Dim vtOutBRName As Variant
Dim vtOutBRType As Variant
Dim bBRHasPrompts As Variant
Dim bBRNeedPageInfo As Variant
Dim bBRHidePrompts As Variant
Dim bShowDlg As Variant
Dim bRuleOnForm As Variant

'Set oSheet = ActiveSheet
'oSheetName = oSheet.Name
oSheetName = "Sheet3"

oRet = HypListCalcScriptsEx (oSheetName, False, vtCubeNames, vtBRNames, vtBRTypes, vtBRHasPrompts, vtBRNeedsPageInfo, vtBRHidePrompts)
If (oRet = 0) Then
If IsArray(vtBRNames) Then
lNumMbrs = (UBound(vtBRNames) - LBound(vtBRNames) + 1)
End If

sPrintMsg = "Number of Calc Scripts = " & lNumMbrs
MsgBox (sPrintMsg)

'Start Executing the Calc Script

bShowDlg = True
bRuleOnForm = False
iScript = 1

oRet = HypExecuteCalcScriptEx (oSheetName, vtCubeNames(iScript), vtBRNames(iScript),  vtBRTypes(iScript), vtBRHasPrompts(iScript), vtBRNeedsPageInfo(iScript), vtInRTPNames, vtInRTPValues, bShowDlg, bRuleOnForm, vtbBRRanSuccessfully, vtOutCubeName, vtOutBRName, vtOutBRType,bBRHasPrompts, bBRNeedPageInfo, bBRHidePrompts, vtOutRTPNames, vtOutRTPValues)
If (oRet = 0) Then
MsgBox ("Last BR ran successfully -  " & vtbBRRanSuccessfully)

If (vtbBRRanSuccessfully = True) Then
bShowDlg = False
bRuleOnForm = False

If IsArray(vtOutRTPNames) And IsArray(vtOutRTPValues) Then
lNumRTPNames = (UBound(vtOutRTPNames) - LBound(vtOutRTPNames) + 1)
lNumRTPVals = (UBound(vtOutRTPValues) - LBound(vtOutRTPValues) + 1)
End If

If (lNumRTPNames > 0) Then
ReDim vtInRTPNames(lNumRTPNames - 1) As Variant
ReDim vtInRTPValues(lNumRTPNames - 1) As Variant

For iRTPs = 0 To lNumRTPNames - 1
sBRName = vtOutRTPNames(iRTPs)
sBRVal = vtOutRTPValues(iRTPs)

vtInRTPNames(iRTPs) = sBRName
vtInRTPValues(iRTPs) = sBRVal
Next iRTPs
End If

oRet = HypExecuteCalcScriptEx (oSheetName, vtOutCubeName, vtOutBRName, vtOutBRType, bBRHasPrompts, bBRNeedPageInfo, vtInRTPNames, vtInRTPValues, bShowDlg, bRuleOnForm, vtbBRRanSuccessfully2, vtOutCubeName,  vtOutBRName, vtOutBRType, bBRHasPrompts, bBRNeedPageInfo, bBRHidePrompts, vtOutRTPNames, vtOutRTPValues)
MsgBox ("Automated BR ran successfully -  " & vtbBRRanSuccessfully2)
End If
Else
sPrintMsg = "Error - " & oRet
MsgBox (sPrintMsg)
End If
Else
sPrintMsg = "Error - " & oRet
MsgBox (sPrintMsg)
End If

End Sub

使用方法

HypExecuteCalcScriptExの前にHypListCalcScriptsExが呼び出されるかどうかに応じて、HypExecuteCalcScriptExは4つのモードで使用できます。

HypExecuteCalcScriptExの前にHypListCalcScriptsExを呼び出さない場合

HypExecuteCalcScriptExの前にHypListCalcScriptsExを呼び出さない場合は、HypListCalcScriptsExを初めて呼び出す際に、初回の使用のためにvtbShowBRDlgをTrueに設定し、その後でFalseに設定する必要があります。

- モード1: vtbShowBRDlgがTrueの場合:

- 入力引数: vtSheetName、vtCubeName、vtbRuleOnFormが使用されます。vtBRName、vtBRType、vtbBRHasPrompts、vtbNeedPageInfo、ppRTPNames、ppRTPValuesは無視されます。

- 動作: vtbRuleOnFormの値に応じて「ビジネス・ルール」ダイアログ・ボックスに使用可能なすべてのルールが表示されます。ユーザーが選択したビジネス・ルールを実行して「ビジネス・ルール」ダイアログ・ボックスを終了すると、そのビジネス・ルールの詳細が出力引数に設定され呼出し側に戻されます。

- 出力引数: すべての出力引数に値が設定されて呼出し側に戻され、呼出し側はそれらを後続の呼出しで使用できるようになります。

- モード2: vtbShowBRDlg引数がFalseの場合:

- 入力引数: すべての入力引数が使用されます。

- 動作: 「ビジネス・ルール」ダイアログ・ボックスが表示されません。ビジネス・ルールが自動的に実行され、適切なステータスが呼出し側に戻されます。

- 出力引数: 呼出し側には、その特定のビジネス・ルールを実行するためのすべての情報がすでにあり、情報を渡す必要がないため、すべての出力引数は変更されません。

HypExecuteCalcScriptExの前にHypListCalcScriptsExを呼び出す場合

HypExecuteCalcScriptExの前にHypListCalcScriptsExを呼び出す場合、HypListCalcScriptsExが呼び出された時点で、ユーザーはすべてのビジネス・ルールと実行時プロンプトに関する情報を取得します(該当する場合)。

ユーザーがRTPのないビジネス・ルールを実行する場合、vtbShowBRDlg引数にFalseを設定してHypExecuteCalcScriptExを呼び出し、他のすべての情報を入力引数として指定できます。

ユーザーがRTPのあるビジネス・ルールを実行する場合は、ビジネス・ルールとそのRTPを表示してユーザーがそのビジネス・ルールを実行するためのRTP値を選択できるよう、vtbShowBRDlgにTrueを設定してHypExecuteCalcScriptExを呼び出す必要があります。(Planningでは、表示されるRTPがない場合はビジネス・ルールのRTPフラグをTrueに設定しても差し支えありません。)

- モード3: キューブ名、ビジネス・ルール名およびビジネス・ルール・タイプが空としてHypExecuteCalcScriptExで渡された場合、「ビジネス・ルール」ダイアログ・ボックスが表示され、vtbRuleOnForm引数に応じてすべてのビジネス・ルールが表示されます。それ以外はすべてモード1と同じになります。

- モード4: キューブ名、ビジネス・ルール名、およびビジネス・ルール・タイプの値が指定されてHypExecuteCalcScriptExで渡された場合、「ビジネス・ルール」ダイアログ・ボックスが表示され、渡されたビジネス・ルール(指定されたキューブ名に対するビジネス・ルール名)のみがそのRTPとともに表示されます。それ以外はすべてモード1と同じになります。

HypGetCalcScript

データ・プロバイダ・タイプ: Oracle Essbase

説明

HypGetCalcScript()は、指定された計算スクリプトの計算スクリプト文字列を取得します。

HypExecuteCalcScriptStringとともに使用します。

この機能には、Oracle Hyperion Provider Services 11.1.2.4.017以上が必要です。

構文

HypGetCalcScript (vtSheetName, vtCalcScriptName, vtType, vtCalcScriptOutput)

ByVal vtSheetName As Variant

ByVal vtCalcScriptName As Variant

ByVal vtType As Variant

ByRef vtCalcScriptOutput As Variant

パラメータ

vtSheetName: 入力パラメータ。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用され、接続には指定されたシート名のデータ・ソースが使用されます。

vtCalcScriptName: 入力パラメータ。出力が必要な計算スクリプトの名前。

vtType: 入力パラメータ。計算スクリプト・ファイルのタイプ。有効な値は、1または2です。タイプ1はcscファイルを表し、タイプ2はrepファイルを表します。入力が正しくないと、タイプ1として処理されます。

vtCalcScriptOutput: 出力パラメータ。計算スクリプト文字列を戻す文字列。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Sub calcScrVBATest()

Sts = HypGetCalcScript("Sheet1", "rule1", 1, Script)

Param = "_mySales=222;"

Sts = HypExecuteCalcScriptString("Sheet1", Script, Param)

End Sub

HypExecuteCalcScriptString

データ・プロバイダ・タイプ: Oracle Essbase

説明

HypExecuteCalcScriptString ()は、計算スクリプトを代替変数とともに実行します。

説明

HypExecuteCalcScriptString ()は、代替変数を含む計算スクリプトを実行します。

HypGetCalcScriptとともに使用します。

この機能には、Oracle Hyperion Provider Services 11.1.2.4.017以上が必要です。

構文

HypExecuteCalcScriptString (vtSheetName, vtCalcScript, vtSubstitutionVarList)

ByVal vtSheetName As Variant

ByVal vtCalcScript As Variant

ByVal vtSubstitutionVarList As Variant

パラメータ

vtSheetName: 入力パラメータ。関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用され、接続には指定されたシート名のデータ・ソースが使用されます。

vtCalcScript: 入力パラメータ。実行する計算スクリプト文字列。

vtSubstitutionVarList: 入力パラメータ。実行時に使用される代替変数のリスト。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Sub calcScrVBATest2()
Script = "SET RUNTIMESUBVARS{salesNum =400;_mySales=300;myRTVar=@CHILDREN(~100~);myCOGS=30;};FIX (@INTERSECT(@CHILDREN(~100~), ~100-10~)) Sales = &_mySales;COGS=555;ENDFIX;"

Script = Replace(Script, Chr(126), Chr(34)) ‘replace ~ with “

Param = "_mySales=222;"

HypExecuteCalcScriptString("Sheet1", Script, Param)

End Sub

HypDeleteCalc

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypDeleteCalc()は、Essbaseサーバーから計算スクリプトを削除します。

構文

HypDeleteCalc (vtSheetName, vtApplicationName, vtDatabaseName, vtCalcScript)

ByVal vtSheetName As Variant

ByVal vtApplicationName As Variant

ByVal vtDatabaseName As Variant

ByVal vtCalcScript As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtApplicationName: 計算スクリプトを含むアプリケーションの名前

vtDatabaseName: 計算スクリプトを含むデータベースの名前

vtCalcScript: 削除する計算スクリプトの名前

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypDeleteCalc Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtApplicationName As Variant, ByVal vtDatabaseName As Variant, ByVal vtCalcScript As Variant) As Long

Sub Example_HypDeleteCalc
Dim X as Long
X = HypDeleteCalc (Empty,"Sample","Basic","CalcYear")
End Sub

11 計算、連結および換算関数

関連トピック

- 計算、連結および換算関数について

- HypCalculate

- HypCalculateContribution

- HypConsolidate

- HypConsolidateAll

- HypConsolidateAllWithData

- HypForceCalculate

- HypForceCalculateContribution

- HypForceTranslate

- HypTranslate

計算、連結および換算関数について

これらの関数は、Oracle Hyperion Financial Managementアプリケーションのデータに対して、計算、連結および換算操作を実行します。

HypCalculate

データ・プロバイダ・タイプ: Oracle Hyperion Financial Management

説明

HypCalculate()は、計算メソッドを呼び出します。

構文

HypCalculate (vtSheetName, vtRange)

ByVal vtSheetName As Variant

By Val vtRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: 使用されるデータを含む範囲。EmptyまたはNullの場合、ワークシートの選択された範囲が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Declare Function HypCalculate Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant) As Long
Sub Example_HypCalculate()
sts = HypCalculate (Empty, Empty)
End Sub

HypCalculateContribution

データ・プロバイダ・タイプ: Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypCalculateContribution()は、コントリビューションの計算を呼び出します。

構文

HypCalculateContribution (vtSheetName, vtRange)

ByVal vtSheetName As Variant

By Val vtRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: 使用されるデータを含む範囲。EmptyまたはNullの場合、ワークシートの選択された範囲が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Declare Function HypCalculateContribution Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant) As Long
Sub Example_HypCalculateContribution()
sts = HypCalculateContribution (Empty, Empty)
End Sub

HypConsolidate

データ・プロバイダ・タイプ: Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypConsolidateは、連結メソッドを呼び出します。

構文

HypConsolidate (vtSheetName, vtRange)

ByVal vtSheetName As Variant

By Val vtRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: 使用するデータを参照する範囲オブジェクト。EmptyまたはNullの場合、ワークシートの選択された範囲が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Declare Function HypConsolidate Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant) As Long
Sub Example_HypConsolidate()
sts = HypConsolidate (Empty, Empty)
End Sub

HypConsolidateAll

データ・プロバイダ・タイプ: Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypConsolidateAll()は、すべてを連結メソッドを呼び出します。

構文

HypConsolidateAll (vtSheetName, vtRange)

ByVal vtSheetName As Variant

By Val vtRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: 使用されるデータを含む範囲。EmptyまたはNullの場合、ワークシートの選択された範囲が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Declare Function HypConsolidateAll Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant) As Long
Sub Example_HypConsolidateAll
sts = HypConsolidateAll(Empty, Empty)
End Sub

HypConsolidateAllWithData

データ・プロバイダ・タイプ: Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypConsolidateAllWithDataは、データのあるものすべてを連結メソッドを呼び出します。

構文

HypConsolidateAllWithData (vtSheetName, vtRange)

ByVal vtSheetName As Variant

By Val vtRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: 使用されるデータを含む範囲。EmptyまたはNullの場合、ワークシートの選択された範囲が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Declare Function HypConsolidateAllWithData Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant) As Long
Sub Example_HypConsolidateAllWithData()
sts = HypConsolidateAllWithData (Empty, Empty)
End Sub

HypForceCalculate

データ・プロバイダ・タイプ: Oracle Hyperion Financial Management

説明

HypForceCalculate()は、強制計算メソッドを呼び出します。

構文

HypForceCalculate(vtSheetName, vtRange)

ByVal vtSheetName As Variant

By Val vtRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: 使用されるデータを含む範囲。EmptyまたはNullの場合、ワークシートの選択された範囲が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Declare Function HypForceCalculate Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant) As Long
Sub Example_HypForceCalculate()
sts = HypForceCalculate (Empty, Empty)
End Sub

HypForceCalculateContribution

データ・プロバイダ・タイプ: Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypForceCalculateContributionは、コントリビューションの強制計算メソッドを呼び出します。

構文

HypForceCalculateContribution (vtSheetName, vtRange)

ByVal vtSheetName As Variant

By Val vtRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: 使用されるデータを含む範囲。EmptyまたはNullの場合、ワークシートの選択された範囲が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Declare Function HypForceCalculateContribution Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant) As Long
Sub Example_HypForceCalculateContribution()
sts = HypForceCalculateContribution (Empty, Empty)
End Sub

HypForceTranslate

データ・プロバイダ・タイプ: Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypForceTranslateは、強制換算メソッドを呼び出します。

構文

HypForceTranslate (vtSheetName, vtRange)

ByVal vtSheetName As Variant

By Val vtRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: 使用されるデータを含む範囲。EmptyまたはNullの場合、ワークシートの選択された範囲が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Declare Function HypForceTranslate Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant) As Long
Sub Example_HypForceTranslate()
sts = HypForceTranslate (Empty, Empty)
End Sub

HypTranslate

データ・プロバイダ・タイプ: Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypTranslate()は、換算メソッドを呼び出します。

構文

HypTranslate (vtSheetName, vtRange)

ByVal vtSheetName As Variant

By Val vtRange As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtRange: 使用されるデータを含む範囲。EmptyまたはNullの場合、ワークシートの選択された範囲が使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は対応するエラー・コードを戻します。

例

Declare Function HypTranslate Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant) As Long
Sub Example_HypTranslate()
sts = HypTranslate (Empty, Empty)
End Sub

12 メンバー問合せ関数

関連トピック

- メンバー問合せ関数について

- HypFindMember

- HypFindMemberEx

- HypGetAncestor

- HypGetChildren

- HypGetParent

- HypIsAttribute

- HypIsDescendant

- HypIsAncestor

- HypIsExpense

- HypIsParent

- HypIsChild

- HypIsUDA

- HypOtlGetMemberInfo

- HypQueryMembers

- HypGetMemberInformation

- HypGetMemberInformationEx

メンバー問合せ関数について

メンバー問合せ関数は、メンバーに関する世代、レベル、属性およびその他の情報を取得します。

HypFindMember

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypFindMember()は、指定したメンバーのディメンション、別名、世代およびレベルの情報を取得します。

構文

HypFindMember (vtSheetName, vtMemberName, vtAliasTable, vtDimensionName, vtAliasName, vtGenerationName, vtLevelName)

ByVal vtSheetName As Variant

ByVal vtMemberName As Variant

ByVal vtAliasTable As Variant

ByRef vtDimensionName As Variant

ByRef vtAliasName As Variant

ByRef vtGenerationName As Variant

ByRef vtLevelName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 入力パラメータ。情報を取得するメンバー。必須。デフォルト値はありません。

vtAliasTable: 入力パラメータ。別名の検索に使用する別名表の名前。Nullの場合は、デフォルトの別名表が使用されます。

vtDimensionName: 出力パラメータ。メンバーのディメンション

vtAliasName: 出力パラメータ。メンバーの別名

vtGenerationName: 出力パラメータ。メンバーの世代

vtLevelName: 出力パラメータ。メンバーのレベル

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypFindMember Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal vtAliasTable As Variant, ByRef vtDimensionName As Variant, ByRef vtAliasName As Variant, ByRef vtGenerationName As Variant, ByRef vtLevelName As Variant) As Long

Sub Example_HypFindMember()
X = HypFindMember(Empty, "100", "Default", dimName, aliasName, genName, levelName)
MsgBox (dimName)
MsgBox (aliasName)
MsgBox (genName)
MsgBox (levelName)
End Sub

HypFindMemberEx

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypFindMemberEx()は、指定したメンバーのディメンション、別名、世代およびレベルの情報を取得します。

構文

HypFindMember (vtSheetName, vtMemberName, vtAliasTable, vtDimensionName, vtAliasName, vtGenerationName, vtLevelName)

ByVal vtSheetName As Variant

ByVal vtMemberName As Variant

ByVal vtAliasTable As Variant

ByRef vtDimensionName As Variant

ByRef vtAliasName As Variant

ByRef vtGenerationName As Variant

ByRef vtLevelName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

vtAliasTable: 別名の検索に使用する別名表の名前。Nullの場合は、デフォルトの別名表が検索されます。

vtDimensionName: 出力パラメータ。メンバーのディメンション

vtAliasName: 出力パラメータ。メンバーの別名

vtGenerationName: 出力パラメータ。メンバーの世代

vtLevelName: 出力パラメータ。メンバーのレベル

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypFindMemberEx Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal vtAliasTable As Variant, ByRef vtDimensionName As Variant, ByRef vtAliasName As Variant, ByRef vtGenerationName As Variant, ByRef vtLevelName As Variant) As Long

Sub Example_HypFindMemberEx()
X = HypFindMemberEx(Empty, "100", "Default", dimName, aliasName, genName, levelName)
MsgBox (dimName)
MsgBox (aliasName)
MsgBox (genName)
MsgBox (levelName)
End Sub

HypGetAncestor

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypGetAncestor()は、指定したメンバーの、任意の特定世代またはレベルの祖先を戻します。

構文

HypGetAncestor (vtSheetName, vtMemberName, vtLayerType, intLayerNum, vtAncestor)

ByVal vtSheetName As Variant

ByVal vtMemberName As Variant

ByVal vtLayerType As Variant

ByVal intLayerNum As Integer

ByRef vtAncestor As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

vtLayerType: 入力パラメータ。GenまたはLevel。NullまたはEmptyに設定されると、Genがデフォルトになります。

intLayerNum: 入力パラメータ。レベルまたは世代番号。必須。

vtAncestor: 出力パラメータ。祖先の名前

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetAncestor Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal vtLayerType As Variant, ByVal intLayerNumber As Integer, ByRef vtAncestor As Variant) As Long

Sub Example_HypGetAncestor
Dim X as Long
Dim vtAncestor As Variant
X = HypGetAncestor (Empty, "100-20", "Level", 1, vtAncestor)
End Sub

HypGetChildren

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypGetChildren()は、指定したメンバーの子を戻します。

構文

HypGetChildren (vtSheetName, vtMemberName, intChildCount, vtChildArray)

ByVal vtSheetName As Variant

ByVal vtMemberName As Variant

ByVal intChildCount As Integer

ByRef vtChildArray As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 入力パラメータ。メンバー名。必須。

intChildCount: 入力パラメータ。戻される子の数の制限。

- ChildCount <=0。すべての子が戻されます。

- ChildCount >0。結果セットは、引数として指定された数に制限されます。指定された引数よりも結果セットが少ない場合は、すべての結果が戻されます。

vtChildArray: 子のリストを格納する出力結果ベクトル。マクロが正常に終了しなかった場合、コンテンツは不明になります。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetChildren Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal intChildCount As Integer, ByRef vtChildArray As Variant) As Long

Sub Example_HypGetChildren
Dim vtChildren As Variant
Dim vtChild As Variant
Dim X as Long
X = HypGetChildren (Empty, "Market", 0, vtChildren)
If IsArray (vtChildren) Then
For i = LBound (vtChildren) To UBound (vtChildren)
VtChild = vtChildren (i)
Next
End If
End Sub

HypGetParent

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypGetParent()は、指定したメンバーの親の名前を戻します。

構文

HypGetParent(vtSheetName, vtMemberName, vtParentName)

ByVal vtSheetName As Variant

ByVal vtMemberName As Variant

ByRef vtParentName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 入力パラメータ。メンバー名。必須。

vtParentName: 出力パラメータ。親の名前

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetParent Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByRef vtParentName As Variant) As Long

Sub Example_HypGetParent
Dim vtParent As Variant
X = HypGetParent (Empty, "East", vtParent)
End sub

HypIsAttribute

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypIsAttribute()は、指定したメンバーが特定の属性を持つかどうかを確認します。

構文

HypIsAttribute(vtSheetName, vtDimensionName, vtMemberName, vtUDAString)

ByVal vtSheetName As Variant

ByVal vtDimensionName As Variant

ByVal vtMemberName As Variant

ByVal vtUDAString As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDimensionName: メンバーが属するディメンションの名前

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

vtUDAString: メンバーの属性と比較する入力文字列。

戻り値

Variant (-1はTRUE、0はFALSE)を戻します。それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypIsAttribute Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtDimensionName As Variant, ByVal vtMemberName As Variant, ByVal vtUDAString As Variant) As Variant

Sub Example_HypIsAttribute()
vtret = HypIsAttribute(Empty, "Market", "Connecticut", "MyAttribute")
If vtret = -1 Then
MsgBox ("Found MyAttribute")
ElseIf vtret = 0 Then
MsgBox ("MyAttribute not available for Connecticut")
Else
MsgBox ("Error value returned is" & vtret)
End If
End Sub

HypIsDescendant

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypIsDescendant()は、指定したメンバーが、指定したもう1つのメンバーの子孫かどうかを確認します。

構文

HypIsDescendant(vtSheetName, vtMemberName, vtAncestorName)

ByVal vtSheetName As Variant

ByVal vtMemberName As Variant

ByVal vtAncestorName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

vtAncestorName: 祖先の名前。必須。

戻り値

Variant (-1はTRUE、0はFALSE)を戻します。それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypIsDescendant Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal vtDescendantName As Variant) As Boolean

Sub Example_HypIsDescendant
Dim b as Boolean
b = HypIsDescendant (Empty, "Year", "Jan")
End sub

HypIsAncestor

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypIsAncestor()は、指定したメンバーが、指定したもう1つのメンバーの祖先かどうかを確認します。

構文

HypIsAncestor(vtSheetName, vtMemberName, vtAncestorName)

ByVal vtSheetName As Variant

ByVal vtMemberName As Variant

ByVal vtAncestorName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

vtAncestorName: 祖先の名前。必須。

戻り値

Variant (-1はTRUE、0はFALSE)を戻します。それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypIsAncestor Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal vtAncestorName As Variant) As Variant

Sub Example_HypIsAncestor
Dim b As Variant
b = HypIsAncestor (Empty, "Year", "Jan")
End sub

HypIsExpense

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypIsExpense()は、指定したメンバーが「費用」タグを持っているかどうかを確認します。

構文

HypIsExpense(vtSheetName, vtDimensionName, vtMemberName)

ByVal vtSheetName As Variant

ByVal vtDimensionName As Variant

ByVal vtMemberName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDimensionName: メンバーのディメンション。NullまたはEmptyに設定されると、アクティブなディメンションが使用されます。

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

戻り値

Variant (-1はTRUE、0はFALSE)を戻します。それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypIsExpense Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtDimensionName As Variant, ByVal vtMemberName As Variant) As Variant

Sub CheckExpense()
vtret = HypIsExpense(Empty, "Measures", "Opening Inventory")
If vtret = -1 Then
MsgBox ("Opening Inventory has expense flag set")
ElseIf vtret = 0 Then
MsgBox ("Expense flag has not been set")
Else
MsgBox ("Error value returned is" & vtret)
End If
End Sub

HypIsParent

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypIsParent()は、指定したメンバーが、指定したもう1つのメンバーの親かどうかを確認します。

構文

HypIsParent(vtSheetName, vtMemberName, vtParentName)

ByVal vtSheetName As Variant

ByVal vtMemberName As Variant

ByVal vtParentName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

vtParentName: 親の名前。必須。

戻り値

Variant (-1はTRUE、0はFALSE)を戻します。それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypIsParent Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal ParentName As Variant) As Boolean

Sub Example_HypIsParent
Dim b as Boolean
b = HypIsParent (Empty, "East", "Market")
End Sub

HypIsChild

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypIsChild()は、メンバーが、指定した親メンバーの子かどうかを決定します。HypIsChildによる確認の対象は子のみであり、すべての子孫が確認されるわけではありません。

構文

HypIsChild(vtSheetName, vtParentName, vtChildName)

ByVal vtSheetName As Variant

ByVal vtParentName As Variant

ByVal vtChildName As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtParentName: 親の名前。必須

vtChildName: 子の名前。必須

戻り値

Variant (-1はTRUE、0はFALSE)を戻します。それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypIsChild Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtParentName As Variant, ByVal vtChildName As Variant) As Variant

Sub Example_HypIsChild
Dim b as Boolean
b = HypIsChild ("Sheet1", "Year", "Qtr1")
End Sub

HypIsUDA

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypIsUDA()は、メンバーに特定のUDAがあるかどうかを判別します。

構文

HypIsUDA (vtSheetName, vtDimensionName, vtMemberName, vtUDAString)

ByVal vtSheetName As Variant

ByVal vtDimensionName As Variant

ByVal vtMemberName As Variant

ByVal vtUDAString As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDimensionName: メンバーのディメンション

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

vtUDAString: メンバーの属性と比較する入力文字列。

戻り値

Variant (-1はTRUE、0はFALSE)を戻します。それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypIsUDA Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtDimensionName As Variant, ByVal vtMemberName As Variant, ByVal vtUDAString As Variant) As Variant

Sub Example_HypIsUDA()
vtret = HypIsUDA(Empty, "Market", "Connecticut", "MyUDA")
If vtret = -1 Then
MsgBox ("Found MyUDA")
ElseIf vtret = 0 Then
MsgBox ("Did not find MyUDA")
Else
MsgBox ("Error value returned is" & vtret)
End If
End Sub

HypOtlGetMemberInfo

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypOtlGetMemberInfo()は、選択したメンバー選択に関連付けられているコメント、式、UDAおよび属性を戻します。

構文

HypOtlGetMemberInfo (vtSheetName, vtDimensionName, vtMemberName, vtPredicate, vtMemberArray)

ByVal vtSheetName As Variant

ByVal vtDimensionName As Variant

ByVal vtMemberName As Variant

ByVal vtPredicate As Variant

ByRef vtMemberArray As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtDimensionName: メンバーのディメンション。Nullに設定されると、アウトライン全体で述部が検索されます。

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

vtPredicate: メンバー選択条件:

- 1 = HYP_COMMENT

- 2 = HYP_FORMULA

- 3 = HYP_UDA

- 4 = HYP_ATTRIBUTE

vtMemberArray: 出力パラメータ。問合せの結果。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypOtlGetMemberInfo Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtDimensionName As Variant, ByVal vtMemberName As Variant,  ByVal vtPredicate As Variant, ByRef vtMemberArray As Variant) As Long
Sub Example_HypOtlGetMemberInfo()
vtRet = HypOtlGetMemberInfo(Empty, "Year", "Jan", HYP_COMMENT, vt)
If IsArray(vt) Then cbItems = UBound(vt) + 1
MsgBox ("Number of elements = " + Str(cbItems))
For i = 0 To UBound(vt)
MsgBox ("Member = " + vt(i))
Next
MsgBox ("Return Value = " + vtRet)
End Sub

HypQueryMembers

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypQueryMembers()は、メンバー選択問合せを実行します。

構文

HypQueryMembers (vtSheetName, vtMemberName, vtPredicate, vtOption, vtDimensionName, vtInput1, vtInput2, vtMemberArray)

ByVal vtSheetName As Variant

ByVal vtMemberName As Variant

ByVal vtPredicate As Variant

ByVal vtOption As Variant

ByVal vtDimensionName As Variant

ByVal vtInput1 As Variant

ByVal vtInput2 As Variant

ByRef vtMemberArray As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

vtPredicate: メンバー選択条件(整数):

- 1 = HYP_CHILDREN

- 2 = HYP_DESCENDANTS

- 3 = HYP_BOTTOMLEVEL

- 4 = HYP_SIBLINGS

- 5 = HYP_SAMELEVEL

- 6 = HYP_SAMEGENERATION

- 7 = HYP_PARENT

- 8 = HYP_DIMENSION

- 9 = HYP_NAMEDGENERATION

- 10 HYP_NAMEDLEVEL

- 11 HYP_SEARCH

- 12 HYP_WILDSEARCH

- 13 HYP_USERATTRIBUTE

- 14 HYP_ANCESTORS

- 15 HYP_DTSMEMBER

- 16 HYP_DIMUSERATTRIBUTES

vtOption: (整数)オプションは述部に依存します。述部の値がHYP_SEARCHおよびHYP_WILDSEARCHの場合は、次の問合せオプションを指定します。

- HYP_MEMBERSONLY

- HYP_ALIASESONLY

- HYP_MEMBERSANDALIASES

vtDimensionName: (文字列)問合せの範囲を制限するディメンション。これは、問合せオプションHYP_NAMEDGENERATION、HYP_NAMEDLEVEL、HYP_USERATTRIBUTE、HYP_SEARCH (Nullに設定するとすべてのディメンションが検索されます)、HYP_WILDSEARCH (Nullに設定するとすべてのディメンションが検索されます)で使用され、それ以外では無視されます。

vtInput1: (文字列)オプションによって決まる入力文字列。これは、次の問合せオプションで使用され、それ以外では無視されます。

- HYP_NAMEDGENERATION (世代の名前)

- HYP_NAMEDLEVEL (レベルの名前)

- HYP_SEARCH (検索する文字列。この文字列は完全一致として定義されています)

- HYP_WILDSEARCH (検索する文字列。この文字列は、末尾にオプションの'*'が付いた完全一致検索文字列として定義されており、'*'部分は任意の文字の組合せが可能です)

- HYP_USERATTRIBUTE (ユーザー定義属性)

vtInput2: (文字列)オプションによって決まる入力文字列。これは、次の問合せオプションで使用され、それ以外では無視されます。

- HYP_USERATTRIBUTE (ユーザー定義属性)

- HYP_SEARCH、HYP_WILDSEARCH (オプションの設定で別名表を検索するようになっている場合、この文字列では検索する別名表を指定します。文字列がNullの場合、すべての別名表が検索されます)。

vtMemberArray: 問合せの結果を格納する出力。正常に終了しなかった場合、コンテンツは不明になります。

戻り値

正常に終了した場合はゼロ(0)を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypQueryMembers Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal vtPredicate As Variant, ByVal vtOption As Variant, ByVal vtDimensionName As Variant, ByVal vtInput1 As Variant, ByVal vtInput2 As Variant, ByRef vtMemberArray As Variant) As Long

Sub Example_HypQueryMembers()
' sts = HypQueryMembers(Empty, "Profit", HYP_CHILDREN, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Profit", HYP_DESCENDANTS, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Profit", HYP_BOTTOMLEVEL, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_SIBLINGS, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_SAMELEVEL, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_SAMEGENERATION, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_PARENT, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_DIMENSION, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Year", HYP_NAMEDGENERATION, Empty, "Year", "Quarter", Empty, vArray)
' sts = HypQueryMembers(Empty, "Product", HYP_NAMEDLEVEL, Empty, "Product", "SKU", Empty, vArray)
' sts = HypQueryMembers(Empty, "Product", HYP_SEARCH, HYP_ALIASESONLY, "Product", "Cola", Empty, vArray)
' sts = HypQueryMembers(Empty, "Year", HYP_WILDSEARCH, HYP_MEMBERSONLY, "Year", "J*", Empty, vArray)
' sts = HypQueryMembers(Empty, "Market", HYP_USERATTRIBUTE, Empty, "Market", "Major Market", Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_ANCESTORS, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Jan", HYP_DTSMEMBER, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Product", HYP_DIMUSERATTRIBUTES, Empty, Empty, Empty, Empty, vArray)

If IsArray(vt) Then
cbItems = UBound(vt) + 1
MsgBox ("Number of elements = " + Str(cbItems))
For i = 0 To UBound(vt)
MsgBox ("Member = " + vt(i))
Next
Else
MsgBox ("Return Value = " + Str(vt))
End If
End Sub

HypGetMemberInformation

データ・プロバイダ・タイプ: Oracle Essbase

説明

HypGetMemberInformationは、選択したメンバーのプロパティを戻します。

構文

HypGetMemberInformation (vtSheetName, vtMemberName, vtPropertyName, vtPropertyValue, vtPropertyValueStrings)

ByVal vtMemberName As Variant

ByVal vtPropertyName As Variant

ByVal vtPropertyValue As Variant

ByRef vtPropertyValueStrings As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

vtPropertyName: 入力パラメータ。情報が必要なプロパティの名前。「メンバー情報の定数」を参照してください。

vtPropertyValue: 出力パラメータ。サーバーから数値として戻されるメンバーのプロパティ配列。

vtPropertyValueStrings: 出力パラメータ。数値が意味をなさないプロパティについて、数値に対応する文字列として戻されるメンバーのプロパティ配列。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetMemberInformation Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal vtPropertyName As Variant, ByRef vtPropertyValue As Variant, ByRef vtPropertyValueStrings As Variant) As Long
Sub Example_HypGetMemberInformation
sts = HypGetMemberInformation("Sheet1", "Jan", HYP_MI_NAME, vtValues, vtPropertyValueString)
End Sub

メンバー情報の定数

次にメンバー情報のプロパティの定数および文字列のリストを示します。

Global Const HYP_MI_NAME = "Name"

Global Const HYP_MI_DIM = "Dim"

Global Const HYP_MI_LEVEL = "Level"

Global Const HYP_MI_GENERATION = "Generation"

Global Const HYP_MI_PARENT_MEMBER_NAME = "ParentMbrName"

Global Const HYP_MI_CHILD_MEMBER_NAME = "ChildMbrName"

Global Const HYP_MI_PREVIOUS_MEMBER_NAME = "PrevMbrName"

Global Const HYP_MI_NEXT_MEMBER_NAME = "NextMbrName"

Global Const HYP_MI_CONSOLIDATION = "Consolidation"

Global Const HYP_MI_IS_TWO_PASS_CAL_MEMBER = "IsTwoPassCalcMbr"

Global Const HYP_MI_IS_EXPENSE_MEMBER = "IsExpenseMbr"

Global Const HYP_MI_CURRENCY_CONVERSION_TYPE = "CurrencyConversionType"

Global Const HYP_MI_CURRENCY_CATEGORY = "CurrencyCategory"

Global Const HYP_MI_TIME_BALANCE_OPTION = "TimeBalanceOption"

Global Const HYP_MI_TIME_BALANCE_SKIP_OPTION = "TimeBalanceSkipOption"

Global Const HYP_MI_SHARE_OPTION = "ShareOption"

Global Const HYP_MI_STORAGE_CATEGORY = "StorageCategory"

Global Const HYP_MI_CHILD_COUNT = "ChildCount"

Global Const HYP_MI_ATTRIBUTED = "Attributed"

Global Const HYP_MI_RELATIONAL_DESCENDANT_PRESENT = "RelDescendantPresent"

Global Const HYP_MI_RELATIONAL_PARTITION_ENABLED = "RelPartitionEnabled"

Global Const HYP_MI_DEFAULT_ALIAS = "DefaultAlias"

Global Const HYP_MI_HIERARCHY_TYPE = "HierarchyType"

Global Const HYP_MI_DIM_SOLVE_ORDER = "DimSolveOrder"

Global Const HYP_MI_IS_DUPLICATE_NAME = "IsDuplicateName"

Global Const HYP_MI_UNIQUE_NAME = "UniqueName"

Global Const HYP_MI_ORIGINAL_MEMBER = "OrigMember"

Global Const HYP_MI_IS_FLOW_TYPE = "IsFlowType"

Global Const HYP_MI_AGGREGATE_LEVEL = "AggLevel"

Global Const HYP_MI_FORMAT_STRING = "FormatString"

Global Const HYP_MI_ATTRIBUTE_DIMENSIONS = "AttributeDims"

Global Const HYP_MI_ATTRIBUTE_MEMBERS = "AttributeMbrs"

Global Const HYP_MI_ATTRIBUTE_TYPES = "AttributeTypes"

Global Const HYP_MI_ALIAS_NAMES = "AliasNames"

Global Const HYP_MI_ALIAS_TABLES = "AliasTables"

Global Const HYP_MI_FORMULA = "Formula"

Global Const HYP_MI_COMMENT = "Comment"

Global Const HYP_MI_LAST_FORMULA = "LastFormula"

Global Const HYP_MI_UDAS = "Udas"

HypGetMemberInformationEx

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypGetMemberInformationExは、配列内のメンバーに関するすべての情報を戻します。

構文

HypGetMemberInformationEx (vtSheetName, vtMemberName, vtPropertyNames, vtPropertyValues, vtPropertyValueStrings)

ByVal vtSheetName As Variant

ByVal vtMemberName As Variant

ByRef vtPropertyNames As Variant

ByRef vtPropertyValues As Variant

vtPropertyValueStrings As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 情報を取得するメンバー。このパラメータにはデフォルト値がないため、指定は必須です。

vtPropertyNames: プロパティ名の配列

vtPropertyValues: プロパティ値の配列

vtPropertyValueStrings: プロパティ文字列値の配列

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypGetMemberInformationEx Lib "HsAddin" (ByVal vtSheetName As Variant,ByVal vtMemberName As Variant, ByRef vtPropertyNames As Variant, ByRef vtPropertyValues As Variant, ByRef vtPropertyValueStrings As Variant) As Long

sub Example_HypGetMemberInformationEx()
sts = HypGetMemberInformationEx(Empty, "100-10", propertynames, propertyvalues, propertyvaluestrings)
End Sub

13 オプション関数

関連トピック

- オプション関数について

- HypGetGlobalOption

- HypSetGlobalOption

- HypGetSheetOption

- HypSetSheetOption

- HypGetOption

- HypSetOption

- HypDeleteAllMRUItems

オプション関数について

オプション関数は、グローバル・オプションとシート・オプション、あるいはその両方に関する情報を設定および取得し、MRUアイテムの削除を可能にします。

HypGetGlobalOption

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetGlobalOption()は、Oracle Smart View for Officeグローバル(デフォルト)・オプションに関する情報を戻します。グローバル・オプションは、現在のワークブック全体および今後作成されるすべてのワークブックおよびワークシートに適用されるオプションです。

ヒント:

HypGetOptionを使用してグローバル(デフォルト)およびシート固有の両方のSmart Viewオプションを設定すると、2つのオプション・タイプでVBAコマンドを区別する必要はありません。

構文

HypGetGlobalOption(vtItem)

ByVal vtItem As Long

パラメータ

vtItem: 取得するオプションを示す番号

表13-1に、オプション番号とそれぞれの戻りデータ型を示します。

表13-1 HypGetGlobalOptionのパラメータ番号およびオプション

vtItem

オプション

戻りデータ型

1

Excelフォーマットの使用

ブール

2

アド・ホック操作にはダブルクリックを使用

ブール

3

「元に戻す」の使用可能化

ブール

4

未使用

--

5

メッセージ・レベル設定の指定:

- 0 = 情報

- 1 = 警告

- 2 = エラー

- 3 = なし

- 4 = 拡張情報

このオプションと下位互換性の詳細は、「HypSetGlobalOption」の「注意」を参照してください。

整数

6

3桁ごとのセパレータの使用

ブール

7

メッセージをログ・ファイルに送る

ブール

8

次回起動時にログ・ファイルをクリア

ブール

9

データなし操作

ブール

10

未使用

--

11

未使用

--

12

無意味ラベルの指定

テキスト

13

Excelファイル・サイズの縮小

ブール

14

フォーマット済文字列の使用可能化

ブール

15

数値のフォーマットを保持

ブール

16

拡張コメント処理を有効にする

ブール

17

リボン・コンテキストの保持の使用可能化

ブール

18

起動時にSmart Viewパネルを表示

ブール

19

リフレッシュ時に常に表示(「コメントの編集」ダイアログ・ボックス内。「拡張コメント処理」が有効で、グリッドにコメントが含まれる場合のみ使用可能)

ブール

20

プロファイリングの有効化。拡張情報ログ・エントリおよび関数呼出しの大部分が含まれます。アクティブなSmart Viewで各OfficeアプリケーションのXMLファイルを作成します。デバッグを目的としています。パフォーマンスに大きく影響します。
下位互換性の詳細は、「HypSetGlobalOption」の「注意」を参照してください。

ブール

戻り値

該当する戻りデータ型(表13-1を参照)を戻します。それ以外の場合は、該当するエラー・コードを戻します。

例

次の例では、メッセージ・レベル・オプションを指定して、値の設定が有効かどうかを確認します。

Declare Function HypGetGlobalOption Lib "HsAddin" (ByVal vtItem As Long) As Variant

Sub Example_HypGetGlobalOption()
sts = HypGetGlobalOption(5)
If sts = -15 then
Msgbox ("Invalid Parameter")
Else
Msgbox ("Message level is set to" & sts)
End If
End Sub

HypSetGlobalOption

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetGlobalOption()は、Oracle Smart View for Officeのグローバル・オプションを設定します。グローバル・オプションは、現在のワークブック全体および今後作成されるすべてのワークブックおよびワークシートに適用されるオプションです。

注意:

一度に設定できるオプションは1つのみです。

ヒント:

HypSetOptionを使用してグローバル(デフォルト)およびシート固有の両方のSmart Viewオプションを設定すると、2つのオプション・タイプでVBAコマンドを区別する必要はありません。

構文

HypSetGlobalOption(vtItem, vtGlobalOption)

ByVal vtItem As Long

ByVal vtGlobalOption As Variant

パラメータ

vtItem: 設定するオプションを示す番号。値については、表13-1を参照してください。

vtGlobalOption: vtItemに設定されるオプションを示すブール値、数値またはテキストを指定できる変数。NullまたはEmptyの場合は、何も実行されません。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

注意

下位互換用に、Smart View 11.1.2.5.000より前のリリースで作成されたシートでプロファイリング・オプションを設定する場合にのみ、HypSetGlobalOption(5, 5)がサポートされます。このVBA文は、Smart View 11.1.2.5.000以降で作成されたシートでプロファイリング・オプションを設定する場合はサポートされません。

Smart View 11.1.2.5.000以降では、HypSetGlobalOption(5,5)を使用してプロファイル・オプションを設定すると、-69, SS_VBA_DEPRECATEDという値が戻されます。かわりに、次の関数を使用してプロファイリング・オプションを取得または設定します。

- HypGetGlobalOption(20)およびHypSetGlobalOption(20, True or False)

- HypGetOption(119, Var, "")およびHypSetOption(119, True or False, "")

例

次の例では、メッセージを表示しないオプションを設定します。

Declare Function HypSetGlobalOption Lib "HsAddin" (ByVal vtItem As Long, ByVal vtGlobalOption As Variant) As Long

Sub Example_HypSetGlobalOption()
X=HypSetGlobalOption(5, 3)
If X=0 Then
MsgBox("Message level is set to 3 - No messages")
Else
MsgBox("Error. Message level not set.")
End If
End Sub

HypGetSheetOption

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetSheetOption()は、シート・レベル・オプションに関する情報を戻します。

ヒント:

HypGetOptionを使用してグローバル(デフォルト)およびシート固有の両方のOracle Smart View for Officeオプションを設定すると、2つのオプション・タイプでVBAコマンドを区別する必要はありません。

構文

HypGetSheetOption(vtSheetName, vtItem)

ByVal vtSheetName As Variant

ByVal vtItem As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtItem: 取得するオプションを示す番号。値のリストは、表13-2を参照してください。

表13-2 vtItemのオプション

vtItem

オプション

データ型と値

1

「ズーム・イン・レベル」の設定:

- 0 = 次のレベル

- 1 = すべてのレベル

- 2 = 最下位レベル

- 3 = 兄弟レベル

- 4 = 同一レベル

- 5 = 同世代

- 6 = 式

数値

2

「選択項目を含める」設定の使用可能化

ブール

3

「選択したグループ内」設定の使用可能化

ブール

4

「選択されていないグループの削除」設定の使用可能化

ブール

5

「インデント」設定の指定:

- 0 = インデントなし

- 1 = サブ・アイテムのインデント

- 2 = 合計のインデント

数値

6

「欠落の抑制」設定の使用可能化

ブール

7

「ゼロの抑制」設定の使用可能化

ブール

8

アンダースコアの抑制設定の使用可能化

ブール

9

「アクセス権なし」設定の使用可能化

ブール

10

「繰返しメンバー」設定の使用可能化

ブール

11

「無効」設定の使用可能化

ブール

12

祖先の位置:

- 0 = 最上位

- 1 = 最下位

数値

13

「不足しているテキスト」ラベルの指定

テキスト

14

「アクセス権なし」ラベルの指定

テキスト

15

セル・ステータス:

- 0 = データ

- 1 = 計算ステータス

- 2 = プロセス管理

数値

16

「メンバー名の表示」オプション:

- 0 = 名前のみ

- 1 = 名前と説明

- 2 = 説明のみ

数値

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetSheetOption Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtItem As Variant) As Variant

Sub Example_HypGetSheetOption()
sts = HypGetSheetOption("Sheet", 5)
If sts = -15 then
Msgbox ("Invalid Parameter")
Else
Msgbox ("Indentation is set to" & sts)
End If
End Sub

HypSetSheetOption

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetSheetOption()は、シート・レベル・オプションを設定します。

注意:

一度に設定できるオプションは1つのみです。

ヒント:

HypSetOptionを使用してグローバル(デフォルト)およびシート固有の両方のOracle Smart View for Officeオプションを設定すると、2つのオプション・タイプでVBAコマンドを区別する必要はありません。

構文

HypSetSheetOption(vtSheetName, vtItem, vtOption)

ByVal vtSheetName As Variant

ByVal vtItem As Variant

ByVal vtOption As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtItem: 設定するオプションを示す番号。値のリストは、表13-2を参照してください。

vtOption: アイテムの新しい値。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypSetSheetOption Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtItem As Variant, ByVal vtOption As Variant) As Long

Sub Example_HypSetSheetOption()
X=HypSetSheetOption(Empty, 6, FALSE)
If X=0 Then
MsgBox("#Missing values will appear. ")
Else
MsgBox("Error. #Missing option not set.")
End If
End Sub

HypGetOption

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetOption()は、グローバル(デフォルト)およびシート固有の両方のOracle Smart View for Officeオプションを取得するので、2つのオプション・タイプでVBAコマンドを区別する必要はありません。

「HypGetGlobalOption」および「HypGetSheetOption」も参照してください。

構文

HypGetOption (vtItem,vtRet,vtSheetName)

ByVal vtItem As Variant

ByRef vtRet As Variant

ByVal vtSheetName As Variant

パラメータ

vtItem: 特定のオプションを参照するインデックスまたは定数。オプションの詳細は、表13-3を参照してください。また、使用可能なオプションのリストがsmartview.basの「Enumeration of options index to be used for HypGetOption/HypSetOption.」の下に示されます。

vtRet: 出力変数

vtSheetName: シート・レベル・オプションのシート名。有効なシート名が指定されてない場合、デフォルトのオプションが使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypGetOption Lib "HsAddin" (ByVal vtItem As Variant, ByRef vtRet As Variant, ByVal vtSheetName As Variant) As Long

Sub Example_HypGetOption()

sts = HypGetOption(HSV_ZOOMIN, Var, "Sheet2") 'get zoom in option for sheet2
sts = HypGetOption(1, Var, "") 'get default zoom in option

End Sub

表13-3 HypGetOptionおよびHypSetOptionのオプション定数

オプション

定数

データ型

コメント

HSV_ZOOMIN

1

数値

ズーム・イン・レベルを設定します。

- 0 = 次のレベル

- 1 = すべてのレベル

- 2 = 最下位レベル

- 3 = 兄弟レベル

- 4 = 同一レベル

- 5 = 同世代

- 6 = 式

HSV_INCLUDE_SELECTION

2

ブール

「選択項目を含める」チェック・ボックスを選択します

HSV_WITHIN_SELECTEDGROUP

3

ブール

「選択したグループ内」チェック・ボックスを選択します

HSV_REMOVE_UNSELECTEDGROUP

4

ブール

「選択されていないグループの削除」チェック・ボックスを選択します

HSV_INDENTATION

5

数値

「インデント」オプションを選択します

- 0 = インデントなし

- 1 = サブ・アイテムのインデント

- 2 = 合計のインデント

HSV_SUPPRESSROWS_MISSING

6

ブール

データなしまたは欠落データが含まれる行が抑制されます

HSV_SUPPRESSROWS_ZEROS

7

ブール

ゼロのみを含む行が抑制されます

HSV_SUPPRESSROWS_UNDERSCORE

8

ブール

メンバー名にアンダースコア文字を含む行が抑制されます

HSV_SUPPRESSROWS_NOACCESS

9

ブール

ユーザーに表示するセキュリティ・アクセス権がないデータが含まれている行が抑制されます

HSV_SUPPRESSROWS_REPEATEDMEMBERS

10

ブール

グリッドの方向にかかわらず繰り返されるメンバー名を含む行が抑制されます。

HSV_SUPPRESSROWS_INVALID

11

ブール

無効な値のみを含む行が抑制されます

HSV_ANCESTOR_POSITION

12

数値

階層での祖先の位置を指定します。

- 0 = 最上位

- 1 = 最下位

HSV_MISSING_LABEL

13

テキスト

欠落データが含まれるデータ・セルに、#Missing、#Numeric Zero、または選択したテキストを表示します。

HSV_NOACCESS_LABEL

14

テキスト

ユーザーに表示する権限がないデータ・セルに、#NoAccess、#Numeric Zero、または選択したテキストを表示します。

HSV_CELL_STATUS

15

数値

実際のデータを表示するかわりに、セルの計算ステータスまたはプロセス・ステータスを表示します。

- 0 = データ

- 1 = 計算ステータス

- 2 = プロセス管理

HSV_MEMBER_DISPLAY

16

数値

セルにメンバー名を表示する方法を指定します。

- 0 = 名前のみ

- 1 = 名前と説明

- 2 = 説明のみ

HSV_INVALID_LABEL

17

テキスト

無効なデータを含むデータ・セルに、#Invalid、#Numeric Zero、または選択したテキストを表示します。

HSV_SUBMITZERO

18

ブール

HSV_MISSING_LABEL、HSV_NOACCESS_LABELまたはSV_INVALID_LABELオプションで#NumericZeroを指定した場合、データベースにゼロ(0)を送信できます。

HSV_MOVEESSBASEMEMBERFORMULAONZOOM

19

ブール

Trueに設定されている場合、ズーム・インおよびズーム・アウト時にメンバー式を移動します。
有効にすると、この動作によってズーム・インおよびズーム・アウト時にパフォーマンスが影響を受ける可能性があります。したがって、デフォルト設定はFalseです。

グリッドにデータ式またはデータ以外の式が含まれているか、ズーム・インがフリー・フォーム・グリッドで実行される場合、メンバー式はデフォルトで移動するので、このオプションは無関係になります。

HSV_PRESERVE_ESSBASECOMMENT_UNKNOWNMEMBERS

20

ブール

Essbaseコメントを保存します。Falseに設定されると、Essbaseから「不明メンバー」エラー・メッセージが表示されます。

HSV_PRESERVE_FORMULA_COMMENT

21

ブール

問合せ時にグリッドの式とコメントを保存します。

HSV_22

22

将来の使用のために予約されています

HSV_FORMULA_FILL

23

ブール

メンバー・セルに関連付けられている式を、ズーム・インの結果として取得されたメンバーに伝播します。
HSV_PRESERVE_FORMULA_COMMENTとHSV_EXCEL_FORMATTINGの両方が有効である場合、ズーム・インの結果として取得されたメンバーにセルのフォーマットを伝播します。

メンバーとデータ・セルの両方の式に適用されます。

HSV_PRESERVE_FORMULA_ONPOVCHANGE

24

ブール

フォーム・シートに固有です。ユーザーがPOVをリフレッシュまたは変更すると、式がセルに保存されます。Falseに設定されている場合、シート内のすべての式が失われます。

HSV_EXCEL_FORMATTING

30

ブール

Excelフォーマットチェック・ボックスを選択します

HSV_RETAIN_NUMERIC_FORMATTING

31

ブール

ユーザーがディメンションにドリルダウンするとき、HSV_SCALEに指定したスケールまたはHSV_DECIMALPLACESの小数点以下の桁数(あるいは両方)をデータに使用します。

HSV_THOUSAND_SEPARATOR

32

ブール

数値データでカンマまたは他の3桁ごとのセパレータを使用します。Excelの「オプション」の「インターナショナル」タブで、桁区切り記号として#または$を使用しないでください。

HSV_NAVIGATE_WITHOUTDATA

33

ブール

移動中にソース・データを計算しないようにすることで、「ピボット」、「ズーム」、「選択項目のみ保持」、「選択項目のみ削除」などの操作を高速化できます。データを取得する準備ができたら、「データなし操作」を無効にします。

HSV_ENABLE_FORMATSTRING

34

ブール

Essbase固有。
Essbaseには、様々なデータ型に関連付けられるフォーマット文字列が用意されています。

有効にすると、数値のかわりにユーザー固有のテキストが表示されます。

HSV_ENHANCED_COMMENT_HANDLING

35

ブール

コメントが含まれているアド・ホック・グリッドでコメントとメンバー名を確認して修正できます。

HSV_ADJUSTCOLUMNWIDTH

36

ブール

セルの内容にあわせて列の幅を自動的に調整します。

HSV_DECIMALPLACES

37

数値

表示する小数点以下の桁数を指定します。

HSV_SCALE

38

数値

選択されたスケールに基づいて表示される数値データのスケールを指定します。

HSV_MOVEFORMATS_ON_ADHOC

39

ブール

ズーム・インされたセルに親セルのフォーマットをコピーし、操作後にセルの場所が変更された場合でもこのフォーマットを保持します。

HSV_DISPLAY_INVALIDDATA

40

ブール

無効なデータを表示します。

HSV_SUPPRESSCOLUMNS_MISSING

41

ブール

データベース内にデータが存在しないセルを含む列が抑制されます(データなしはゼロとは異なります。ゼロはデータ値です。)

HSV_SUPPRESSCOLUMNS_ZEROS

42

ブール

ゼロのみを含む列が抑制されます。

HSV_SUPPRESSCOLUMNS_NOACCESS

43

ブール

ユーザーに表示するセキュリティ・アクセス権がないデータが含まれている列が抑制されます。

HSV_SUPPRESS_MISSINGBLOCKS

44

ブール

データベースにデータが存在しないセルのブロックが抑制されます。

HSV_REPEATMEMBERS_IN_FORMS

45

ブール

メンバー名をデータ行ごとに表示できるようにして、PlanningおよびFinancial Managementフォームの読みやすさを向上させます。

HSV_DOUBLECLICK_FOR_ADHOC

101

ブール

ダブルクリックによって空のワークシートにデフォルトのグリッドを取得してから、セル・コンテンツにズーム・インまたはズーム・アウトするように指定します。

HSV_UNDO_ENABLE

102

ブール

「元に戻す」を有効または無効にします。
元に戻すことができる操作の数をHSV_NUMBER_OF_UNDO_ACTIONパラメータに指定します。

HSV_103

103

将来の使用のために予約されています。

HSV_LOGMESSAGE_DISPLAY

104

数値

メッセージ表示レベル設定を指定します。

- 0 = 情報

- 1 = 警告

- 2 = エラー

- 3 = なし

- 4 = 拡張情報

HSV_ROUTE_LOGMESSAGE_TO_FILE

105

ブール

「メッセージをファイルに送る」チェック・ボックスを有効または無効にします。

HSV_CLEAR_LOG_ON_NEXTLAUNCH

106

ブール

Excelが閉じた後に表示される次のログ・メッセージの生成が開始されると、ログ・ファイルがクリアされます。

HSV_REDUCE_EXCEL_FILESIZE

107

ブール

使用すべきではない次の場合を除き、常に有効にする必要があります。

- 9.3.1.6より前のSmart Viewリリースのユーザー、またはSmart Viewリリースに関係なくMicrosoft OfficeのユーザーにExcelワークブックを送信する場合。これらのワークブックでは、次のようになります。

- 関数を含むグリッドは、データを表示する前にリフレッシュする必要があります。

- アド・ホック・モードで、POV設定が失われます。この動作は、新規のアド・ホック・グリッドの動作と同じです。

- 9.3.1.6より前のSmart Viewリリースのユーザー、またはSmart Viewリリースに関係なくMicrosoft Officeのユーザーから送信されたワークブックを開く場合

HSV_ENABLE_RIBBON_CONTEXT

108

ブール

ユーザーがSmart Viewのリボンのボタンを使用した後に、アクティブなデータ・プロバイダのリボンを自動的に表示します。

HSV_DISPLAY_HOMEPANEL_ONSTARTUP

109

ブール

「Smart Viewホーム」パネルの「起動時に表示」チェック・ボックスを有効または無効にします。
有効にすると、Smart Viewのリボンで「パネル」アイコンを選択したときに、「Smart Viewホーム」パネルが表示されます。

無効にすると、最後に開いていたパネルが表示されます。

HSV_SHOW_COMMENTDIALOG_ON_REFRESH

110

ブール

有効にすると、グリッドにコメントがある場合、リフレッシュ時にコメント・エディタがユーザーに表示されます。
無効にすると、Smart Viewのリボンからユーザーがコメント・エディタを起動できます。

HSV_NUMBER_OF_UNDO_ACTION

111

数値

1回の操作で許可される元に戻す処理とやり直し処理の数(0から100)。
HSV_UNDO_ENABLEパラメータと一緒に機能します。

HSV_NUMBER_OF_MRU_ITEMS

112

数値

「Smart Viewホーム」、およびSmart Viewのリボンの「開く」メニューに表示される、最後に使用した接続の数(15以下)。

HSV_ROUTE_LOGMESSAGE_FILE_LOCATION

113

テキスト

ログ・メッセージをファイルに保存します。

HSV_DISABLE_SMARTVIEW_IN_OUTLOOK

114

ブール

OutlookでSmart Viewタスク・リストを使用しない場合に、OutlookでSmart Viewを使用不可にします。

HSV_DISPLAY_SMARTVIEW_SHORTCUT_MENU_ONLY

115

ブール

ショートカット・メニューにSmart Viewのメニュー・アイテムのみを表示します。それ以外の場合、ショートカット・メニューにはExcelとSmart Viewの両方のアイテムが表示されます。

HSV_DISPLAY_DRILL_THROUGH_REPORT_TOOLTIP

116

ブール

セル上にマウスを移動したときに、そのセルの使用可能なドリルスルー・レポートのリストをデフォルトで表示します。

HSV_SHOW_PROGRESSINFORMATION

117

ブール

HSV_PROGRESSINFO_TIMEDELAYに定義された秒数の経過後に操作が開始したら、「Smart View進捗」ステータス・バーが表示されるように指定します。

HSV_PROGRESSINFO_TIMEDELAY

118

数値

操作が始まってから「Smart View進捗」ステータス・バーが表示されるまでの時間(秒)。

HSV_ENABLE_PROFILING

119

ブール

拡張情報ログ・エントリおよび関数呼出しの大部分を作成します。アクティブなSmart Viewで各OfficeアプリケーションのXMLファイルを作成します。デバッグを目的としています。パフォーマンスに大きく影響します。

HSV_REFRESH_SELECTED_DEPENDENT_FUNCTIONS

121

ブール

選した関数を実行する前に、同じシートの依存関数を実行します。

HSV_IMPROVE_METADATASTORAGE

122

ブール

内部データ構造の、より効率的なストレージを可能にします。
このオプションは、Smart Viewの異なるバージョン間の相互運用性に関連します。

このオプションがTrueに設定されている場合、Smart Viewは互換性を目的としてメタデータの2つのコピーを保持するので、全体のパフォーマンスが低下する可能性があります。

組織内のすべてのユーザーがSmart View 9.3.1.6以上を使用している場合、このオプションは常にTrueにする必要があります。

次のような場合は、このオプションをFalseに設定してください。

- 9.3.1.6より前のSmart Viewリリースのユーザー、またはSmart Viewリリースに関係なくMicrosoft Office 2002以前のユーザーにExcelワークブックを送信する場合

- 9.3.1.6より前のSmart Viewリリースのユーザー、またはSmart Viewリリースに関係なくMicrosoft Office 2002以前のユーザーから送信されたワークブックを開く場合

HypSetOption

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetOption()では、Oracle Smart View for Officeオプションをグローバル(デフォルト)およびシート固有の両方として設定できるため、2つのオプション・タイプでVBAコマンドを区別する必要はありません。

「HypSetGlobalOption」および「HypSetSheetOption」も参照してください。

構文

HypSetOption (vtItem,vtOption,vtSheetName)

ByVal vtItem As Variant

ByVal vtOption As Variant

ByVal vtSheetName As Variant

パラメータ

vtItem: 特定のオプションを参照するインデックスまたは定数。オプションの詳細は、表13-3を参照してください。また、使用可能なオプションのリストがsmartview.basの「Enumeration of options index to be used for HypGetOption/HypSetOption.」の下に示されます。

vtOption: オプションに設定する入力値。

vtSheetName: シート・レベル・オプションを設定するシート名。有効なシート名が指定されてない場合、デフォルトのオプションが使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypSetOption Lib "HsAddin" ( ByVal vtItem As Variant,ByVal vtOption As Variant, ByVal vtSheetName As Variant) As Long

Sub Example_HypSetOption()

sts = HypSetOption(HSV_ZOOMIN, 2, "Sheet2") 'set zoom in option for sheet2
sts = HypSetOption(HSV_ZOOMIN, 1, "") 'set default zoom in

sts = HypSetOption(HSV_INVALID_LABEL, "#InvalidTest", "Sheet2")  'set invalid label for sheet2
sts = HypSetOption(17, "#globalinvalid", "") 'set default invalid label, numbers can be used instead of declared constants

End Sub

Sub SetOptn()
HypSetOption (HSV_REFRESH_SELECTED_DEPENDENT_FUNCTIONS, False, "")
HypSetOption (HSV_IMPROVE_METADATASTORAGE, False, "")
End Sub

HypDeleteAllMRUItems

データ・プロバイダ・タイプ: すべて

説明

HypDeleteAllMRUItems ()は、最後に使用したリストの全アイテム(リストに固定されたアイテムを含む)を削除します。

構文

HypDeleteAllMRUItems Lib "HsAddin" () As Long

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypDeleteAllMRUItems Lib "HsAddin" () As Long

Sub Example_HypDeleteAllMRUItems ()
sts = HypDeleteAllMRUItems()
End Sub

14 動的リンク関数

関連トピック

- 動的リンク・ビューについて

- 動的リンク・ビューの設定

- マクロの自動実行

- HypUseLinkMacro

- HypSetLinkMacro

- HypGetLinkMacro

- HypGetSourceGrid

- HypDisplayToLinkView

- HypGetConnectionInfo

- HypSetConnectionInfo

- HypGetRowCount

- HypGetColCount

- HypGetPOVCount

- HypGetRowItems

- HypSetRowItems

- HypGetColItems

- HypSetColItems

- HypGetPOVItems

- HypSetPOVItems

動的リンク・ビューについて

静的または動的リンク・ビューを使用して、メイン・ウィンドウのコンテンツに影響を与えずに、隣接するウィンドウにデータ・ポイントに関する詳細を表示できます。静的リンク・ビューは事前定義済で、Oracle Smart View for Officeに組み込まれています。動的リンク・ビューでは、この項のVBA関数を使用して、行、列、POVおよび接続情報を変更できます。

動的リンク問合せが初期化されると、後続のすべてのsetinfo、getinfo、displaytolinkview呼出しは、保存された動的リンク問合せに対して実行されます。ワークシート上のグリッドを変更し、新しいグリッドで動的リンクのアクションを実行する場合は、利用可能なsetinfo呼出しを使用して問合せを再び初期化する必要があります。

動的リンク・ビューの設定

マクロの自動実行

動的リンク・ビューの設定

動的リンク・ビューを使用してリンクの動作をカスタマイズします。動的リンク・ビューを使用すると、接続、行、列、POVおよび列の情報を変更できます。

動的リンク・ビューを設定する手順:

1. HypUseLinkMacroフラグをTrueに設定します。

HypUseLinkMacroをFalseに設定している場合は、事前定義されたリンク問合せが実行されます。

2. 実行するマクロ名を設定します。

設定するマクロ名には、グリッドを初期化して、接続、行、POVおよび列のアイテムを必要に応じて設定するための、すべての関数呼出しを含める必要があります。

3. シートを接続し、適切なグリッドをシート上に取得します。

4. シート上でデータ・ポイントを選択します。

5. Essbaseのリボンから、「視覚化」、「Excelで視覚化」の順に選択します。

手順2で設定したマクロが実行され、リンク・アクションが実行されます。

マクロの自動実行

Oracle Smart View for Officeメニューからのマクロの実行を自動化できます。

Smart Viewメニューから手動で実行するマクロを設定する手順:

1. HypUseLinkMacroフラグをFalseに設定します。

2. シートに接続してグリッドを取得します。

3. シート上でデータ・ポイントを選択します。

4. グリッドを初期化して、接続、行、列およびPOVのアイテムを設定するための、すべての関数呼出しを含むマクロを実行します。

HypUseLinkMacro

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypUseLinkMacro()は、リンク・ビューのタイプ(静的または動的)を指定します。

注意:

静的リンク・ビューおよび動的リンク・ビューは、同じメニュー項目を共有します。したがって、動的リンク問合せを実行する前にこのフラグをオンにする必要があります。動的リンク・ビューの作業が済んだら、フラグをオフにします。

構文

HypUseLinkMacro (bUse)

ByVal bUse as Boolean

パラメータ

bUse: 動的リンクを実行する場合はTrueに設定します。静的リンクを実行する場合はFalseに設定します。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypUseLinkMacro Lib "HsAddin" (ByVal bUse As Boolean) As Long

Sub Example_HypUseLinkMacro()
Sts = HypUseLinkMacro(True)
End sub

HypSetLinkMacro

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypSetLinkMacro()は、動的リンク問合せのアクションを実行するために使用されるマクロ名を設定します。

注意:

「Excelで視覚化」メニュー・アイテムからリンク・アクションが開始されると、この関数によって設定されたマクロが実行されます。

構文

HypSetLinkMacro (vtMacroName)

ByVal vtMacroName As Variant

パラメータ

vtMacroName: 実行するマクロの名前

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypSetLinkMacro Lib "HsAddin" (ByVal vtMacroName As Variant) As Long

Sub Example_HypSetLinkMacro()
Sts = HypUseLinkMacro(True)
Sts = HypSetLinkMacro("Sheet1.Macro8")
End Sub

HypGetLinkMacro

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetLinkMacro()は、動的リンク問合せの実行に使用する、現在設定されているマクロ名を戻します。

構文

HypGetLinkMacro (vtMacroName)

ByRef vtMacroName As Variant

パラメータ

vtMacroName: 現在設定されているマクロ名を戻す出力パラメータ

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetLinkMacro Lib "HsAddin" (ByRef vtMacroName As Variant) As Long

Sub Example_HypGetLinkMacro()
Dim Macroname As Variant
Sts = HypUseLinkMacro(True)
Sts = HypSetLinkMacro("Sheet1.Macro8")
Sts = HypGetLinkMacro(Macroname)
If (StrComp(MacroName, "Sheet1.Macro8")) Then
MsgBox ("Error Occurred")
End If
End Sub

HypGetSourceGrid

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypGetSourceGrid()は、動的リンク問合せのソース・グリッドから問合せを作成します。

この関数は、静的リンク・ビューと動的リンク・ビューの両方に適用されます。

HypGetSourceGridを実行する前に、接続されたグリッドがアクティブなワークシート上に存在し、有効なデータ・セルが選択される必要があります。

構文

HypGetSourceGrid(vtSheetName, vtGrid)

ByVal vtSheetName As Variant

ByRef vtGrid As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtGrid: 戻されるグリッドXML

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetSourceGrid Lib "HsAddin" (ByVal vtSheetName As Variant, ByRef vtGrid As Variant) As Long

Sub Example_HypGetSourceGrid()
Dim vtGrid As Variant
Range ("B2").Select
Sts = HypGetSourceGrid (Empty, vtGrid)
End sub

HypDisplayToLinkView

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

データ・プロバイダ・タイプ:

説明

HypDisplayToLinkView()は、WordまたはPowerPointにOfficeドキュメントを、Excelにグリッドを表示します。

注意:

動的リンク問合せの最新のコンテンツでリンク・アクションが実行されます。

構文

HypDisplayToLinkView (vtDocumentType, vtDocumentPath)

ByVal vtDocumentType As Variant

ByVal vtDocumentPath As Variant

パラメータ

vtDocumentType: リンク・ビューの宛先。有効な値を次に示します。

- EXCEL_APP

- WORD_APP

- PPOINT_APP

vtDocumentPath: ドキュメントへのパス。WORD_APPまたはPPOINT_APPの場合にのみ必要です。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypDisplayToLinkView Lib "HsAddin" (ByVal vtDocumentType As Variant, ByVal vtDocumentPath As Variant) As Long

Sub Example_HypDisplayToLinkView()
Dim vtGrid As Variant
Sts = HypConnect(Empty, "UserName", "Password", "MyDemoBasic")
Sts = HypRetrieve(Empty)
Range("B2").Select
Sts = HypGetSourceGrid(Empty, vtGrid)
Sts = HypSetColItems(1, "Market", "East", "West", "South", "Central", "Market")
Sts = HypDisplayToLinkView("EXCEL_APP", "")
End Sub

HypGetConnectionInfo

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypGetConnectionInfo()は、動的リンク問合せの接続情報を戻します。

注意:

これは、動的リンク問合せを初期化するためにHypGetSourceGridの呼出しがすでに実行されており、アクティブなデータ・プロバイダおよびワークシート上のグリッドに関する情報が格納されていることを前提とします。

構文

HypGetConnectionInfo(vtServerName, vtUserName,vtPassword, vtApplicationName, vtDatabaseName,vtFriendlyName,vtURL,vtProviderType)

ByRef vtServerName As Variant

ByRef vtUserName As Variant

ByRef vtPassword As Variant

ByRef vtApplicationName As Variant

ByRef vtDatabaseName As Variant

ByRef vtFriendlyName As Variant

ByRef vtURL As Variant

ByRef vtProviderType As Variant

パラメータ

vtServerName: 出力パラメータ。動的リンク問合せのサーバーの名前

vtUserName: 出力パラメータ。動的リンク問合せのユーザー名

vtPassword: 出力パラメータ。動的リンク問合せのパスワード。注意: 実際のパスワードはセキュリティ上の理由から戻されません。空として戻されます。

vtApplicationName: 出力パラメータ。動的リンク問合せのアプリケーション名

vtDatabaseName: 出力パラメータ。動的リンク問合せのデータベース名

vtFriendlyName: 出力パラメータ。動的リンク問合せのわかりやすい接続名

vtURL: 出力パラメータ。動的リンク問合せのURL

vtProviderType: 出力パラメータ。動的リンク問合せのプロバイダ・タイプ

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetConnectionInfo Lib "HsAddin" (ByRef vtServerName As Variant, ByRef vtUserName As Variant, ByRef vtPassword As Variant, ByRef vtApplicationName As Variant, ByRef vtDatabaseName As Variant, ByRef vtFriendlyName As Variant, ByRef vtURL As Variant, ByRef vtProviderType As Variant) As Long

Sub Example_HypGetConnectionInfo()
Dim vtGrid As Variant
Dim server As Variant
Dim user As Variant
Dim app As Variant
Dim db As Variant
Dim provider As Variant
Dim conn As Variant
Dim url As Variant
Sts = HypConnect(Empty, "UserName", "MyDemoBasic")
Sts = HypRetrieve(Empty)
Range ("B2").Select
Sts = HypGetSourceGrid (Empty, vtGrid)
Sts = HypGetConnectionInfo(server,user, pwd, app, db, conn, url, provider)
End sub

HypSetConnectionInfo

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetConnectionInfo()は、問合せ内の接続情報を変更します。

HypSetConnectionInfo()に渡されるパラメータは、その接続名で保管されている接続情報と一致している必要があります。

注意:

これは、動的リンク問合せを初期化するためにHypGetSourceGridの呼出しがすでに実行されており、アクティブなデータ・プロバイダおよびワークシート上のグリッドに関する情報が格納されていることを前提とします。

構文

HypSetConnectionInfo (vtServerName, vtUserName, vtPassword, vtApplicationName, vtDatabaseName, vtFriendlyName, vtURL, vtProviderType)

ByVal vtServerName As Variant

ByVal vtUserName As Variant

ByVal vtPassword As Variant

ByVal vtApplicationName As Variant

ByVal vtDatabaseName As Variant

ByVal vtFriendlyName As Variant

ByVal vtURL As Variant

ByVal vtProviderType As Variant

パラメータ

vtServerName: 問合せ内のサーバー名

vtUserName: 問合せ内のユーザー名

vtPassword: 問合せ内のユーザー・パスワード

vtApplicationName: 問合せ内のアプリケーション名

vtDatabaseName: 問合せ内のデータベース名

vtFriendlyName: 問合せ内のわかりやすい接続名

vtURL: 問合せ内のプロバイダURL

vtProviderType: 問合せ内のプロバイダ・タイプ

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypSetConnectionInfo Lib "HsAddin" (ByVal vtServerName As Variant, ByVal vtUserName As Variant, ByVal vtPassword As Variant, ByVal vtApplicationName As Variant, ByVal vtDatabaseName As Variant, ByVal vtFriendlyName As Variant, ByVal vtURL As Variant, ByVal vtProviderType As Variant) As Long

Sub Example_HypSetConnectionInfo()
Dim vtGrid As Variant
Sts = HypConnect(Empty, "UserName", "Password", "DemoBasic")
Sts = HypRetrieve(Empty)
Range("B2").Select
Sts = HypGetSourceGrid(Empty, vtGrid)
Sts = HypSetConnectionInfo("localhost", "UserName", "Password", "Sample", "Basic", "SampleBasic", "http://localhost:13080/aps/SmartView", provider)
End Sub

HypGetRowCount

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypGetRowCount()は、行のディメンションの数を戻します。

注意:

これは、動的リンク問合せを初期化するためにHypGetSourceGridの呼出しがすでに実行されており、アクティブなデータ・プロバイダおよびワークシート上のグリッドに関する情報が格納されていることを前提とします。

構文

HypGetRowCount()

戻り値

正常に終了した場合は行のディメンションの数を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetRowCount Lib "HsAddin" () As Long

Sub Example_HypGetRowCount()
Dim vtGrid As Variant
Sts = HypConnect(Empty, "UserName", "Password", "MyDemoBasic")
Sts = HypRetrieve(Empty)
Range ("B2").Select
Sts = HypGetSourceGrid (Empty, vtGrid)
Sts = HypGetRowCount ()
End sub

HypGetColCount

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypGetColCount()は、列のディメンションの数を戻します。

注意:

これは、動的リンク問合せを初期化するためにHypGetSourceGridの呼出しがすでに実行されており、アクティブなデータ・プロバイダおよびワークシート上のグリッドに関する情報が格納されていることを前提とします。

構文

HypGetColCount()

戻り値

正常に終了した場合は列のディメンションの数を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetColCount Lib "HsAddin" () As Long

Sub Example_HypGetColCount()
Dim vtGrid As Variant
Sts = HypConnect(Empty, "UserName", "Password", "MyDemoBasic")
Sts = HypRetrieve(Empty)
Range ("B2").Select
Sts = HypGetColCount ()
End sub

HypGetPOVCount

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypGetPOVCount()は、動的リンク問合せからPOV内のディメンション数を戻します。

注意:

これは、動的リンク問合せを初期化するためにHypGetSourceGridの呼出しがすでに実行されており、アクティブなデータ・プロバイダおよびワークシート上のグリッドに関する情報が格納されていることを前提とします。

構文

HypGetPOVCount()

戻り値

正常に終了した場合はPOVのディメンションの数を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetPOVCount Lib "HsAddin" () As Long

Sub Example_HypGetPOVCount()
Dim vtGrid As Variant
Sts = HypConnect(Empty, "UserName", "Password", "MyDemoBasic")
Sts = HypRetrieve(Empty)
Range ("B2").Select
Sts = HypGetSourceGrid (Empty, vtGrid)
Sts = HypGetPOVCount ()
End sub

HypGetRowItems

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypGetRowItems()は、動的リンク問合せ内のn番目の行のディメンションに存在するメンバーを戻します。

注意:

これは、動的リンク問合せを初期化するためにHypGetSourceGridの呼出しがすでに実行されており、アクティブなデータ・プロバイダおよびワークシート上のグリッドに関する情報が格納されていることを前提とします。

構文

HypGetRowItems(vtRowID, vtDimensionName, vtMemberNames)

ByVal vtRowID As Variant

ByRef vtDimensionName As Variant

ByRef vtMemberNames As Variant

パラメータ

vtRowID: 行番号n。

vtDimensionName: 出力パラメータ。n番目の行のディメンション名

vtMemberNames: 出力パラメータ。n番目の行のディメンションのメンバー

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetRowItems Lib "HsAddin" (ByVal vtRowID As Variant, ByRef vtDimensionName As Variant, ByRef vtMemberNames As Variant) As Long

Sub Example_HypGetRowItems()
Dim vtGrid As Variant
Dim vtDimName As Variant
Dim vtMembers As Variant
Sts = HypConnect(Empty, "UserName", "Password", "DemoBasic_Connection")
Sts = HypRetrieve(Empty)
Range ("B2").Select
Sts = HypGetSourceGrid (Empty, vtGrid)
Sts = HypGetRowItems(1, vtDimName, vtMembers)
End sub

HypSetRowItems

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

この動的リンク問合せのn番目の行のディメンションのメンバーを設定します。n番目の行が存在しない場合は、新しい行が追加されます。

注意:

これは、動的リンク問合せを初期化するためにHypGetSourceGridの呼出しがすでに実行されており、アクティブなデータ・プロバイダおよびワークシート上のグリッドに関する情報が格納されていることを前提とします。

構文

HypSetRowItems (vtRowID, vtDimensionName, ParamArray MemberList())

ByVal vtRowID As Variant

ByVal vtDimensionName As Variant

ParamArray MemberList() As Variant

パラメータ

vtRowID: 行番号n

vtDimensionName: ディメンション名

ParamArray MemberList: メンバー名のリスト

戻り値

長整数。正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypSetRowItems Lib "HsAddin" (ByVal vtRowID As Variant, ByVal vtDimensionName As Variant, ParamArray MemberList() As Variant) As Long

Sub Example_HypSetRowItems()
Dim vtGrid As Variant
Sts = HypConnect(Empty, "UserName", "Password", "DemoBasic")
Sts = HypRetrieve(Empty)
Range ("B2").Select
Sts = HypGetSourceGrid (Empty, vtGrid)
Sts = HypSetRowItems(1, "Product", "100", "200", "300", "400", "Diet", "Product")
End sub

HypGetColItems

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypGetColItems()は、n番目の列のディメンションへの動的リンク問合せに表示されるメンバーを戻します。

注意:

これは、動的リンク問合せを初期化するためにHypGetSourceGridの呼出しがすでに実行されており、アクティブなデータ・プロバイダおよびワークシート上のグリッドに関する情報が格納されていることを前提とします。

構文

HypGetColItems(vtColID, vtDimensionName, vtMemberNames)

ByVal vtColID As Variant

ByRef vtDimensionName As Variant

ByRef vtMemberNames As Variant

パラメータ

vtColID: 列番号n

vtDimensionName: n番目の列のディメンション名を戻します

vtMemberNames: n番目の列のディメンションのメンバーを戻します

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetColItems Lib "HsAddin" (ByVal vtColID As Variant, ByRef vtDimensionName As Variant, ByRef vtMemberNames As Variant) As Long

Sub Example_HypGetColItems()
Dim vtGrid As Variant
Dim vtDimensionName As Variant
Dim vtMembers As Variant
Sts = HypConnect(Empty, "UserName", "Password", "AnamikaDemoBasic")
Sts = HypRetrieve(Empty)
Range ("B2").Select
Sts = HypGetSourceGrid (Empty, vtGrid)
Sts = HypGetColItems(1, vtDimensionName, vtMemberNames)
End sub

HypSetColItems

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypSetColItems()は、動的リンク問合せのn番目の列のディメンションのメンバーを設定します。n番目の列が存在しない場合は、新しい列が追加されます。

注意:

これは、動的リンク問合せを初期化するためにHypGetSourceGridの呼出しがすでに実行されており、アクティブなデータ・プロバイダおよびワークシート上のグリッドに関する情報が格納されていることを前提とします。

構文

HypSetColItems (vtColID, vtDimensionName, ParamArray MemberList())

ByVal vtColID As Variant

ByVal vtDimensionName As Variant

ParamArray MemberList() As Variant

パラメータ

vtColID: 列番号n

vtDimensionName: ディメンション名

ParamArray MemberList: メンバー名のリスト

戻り値

長整数。正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypSetColItems Lib "HsAddin" (ByVal vtColID As Variant, ByVal vtDimensionName As Variant, ParamArray MemberList() As Variant) As Long

Sub Example_HypSetColItems()
Dim vtGrid As Variant
Sts = HypConnect(Empty, "Username", "Password", "SalesDemoBasic")
Sts = HypRetrieve(Empty)
Range("B2").Select
Sts = HypGetSourceGrid(Empty, vtGrid)
Sts = HypSetColItems(1, "Market", "East", "West", "South", "Central", "Market")
End Sub

HypGetPOVItems

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypGetPOVItems()は、POV内のディメンションと、各ディメンションで現在選択されているメンバーを戻します。

注意:

これは、動的リンク問合せを初期化するためにHypGetSourceGridの呼出しがすでに実行されており、アクティブなデータ・プロバイダおよびワークシート上のグリッドに関する情報が格納されていることを前提とします。

構文

HypGetPOVItems(vtDimensionNames, vtPOVNames)

ByRef vtDimensionNames As Variant

ByRef vtPOVNames As Variant

パラメータ

vtDimensionNames: POV内のディメンション名

vtPOVNames: POV内の各ディメンションで現在選択されているメンバー。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypGetPOVItems Lib "HsAddin" (ByRef vtDimensionNames As Variant, ByRef vtPOVNames As Variant) As Long

Sub Example_HypGetPOVItems()
Dim vtGrid As Variant
Dim vtDimNames As Variant
Dim vtPOVNames As Variant
Sts = HypConnect(Empty, "UserName", "Password", "MyDemoBasic")
Sts = HypRetrieve(Empty)
Range ("B2").Select
Sts = HypGetSourceGrid (Empty, vtGrid)
Sts = HypGetPOVItems (vtDimNames, vtPOVNames)
End sub

HypSetPOVItems

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Oracle Planning and Budgeting Cloud (アド・ホックのみ)

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypSetPOVItems()は、動的リンク問合せのPOVディメンションを設定します。

注意:

これは、動的リンク問合せを初期化するためにHypGetSourceGridの呼出しがすでに実行されており、アクティブなデータ・プロバイダおよびワークシート上のグリッドに関する情報が格納されていることを前提とします。

構文

HypSetPOVItems (ParamArray MemberList())

ParamArray MemberList() As Variant

パラメータ

ParamArray MemberList(): 必要なPOVアイテムのリストをDimension#Current Memberの形式で表したもの

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Declare Function HypSetPOVItems Lib "HsAddin" (ParamArray MemberList() As Variant) As Long
Sub Example_HypSetPOVItems()
Dim vtGrid As Variant
Sts = HypConnect(Empty, "UserName", "Password", "MyDemoBasic")
Sts = HypRetrieve(Empty)
Range ("B2").Select
Sts = HypGetSourceGrid (Empty, vtGrid)
Sts = HypSetPOVItems ("Scenario#Scenario", "Measures#Measures")
End sub

15 MDX問合せ関数

関連トピック

- MDXについて

- HypExecuteMDXEx

MDXについて

多次元式(MDX)言語を使用して、Oracle Essbaseデータベースのデータやメタデータに対して問合せおよびレポート作成を行うスクリプトまたはアプリケーションを開発します。MDXの詳細は、Essbaseのドキュメント・セットを参照してください。

HypExecuteMDXEx

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypExecuteMDXEx()は、結果をデータ構造に出力するがワークシート上には表示しないMDX問合せを実行します。(問合せ結果をワークシート上に表示する必要がある場合は、かわりにHypExecuteQueryを使用します。)

構文

HypExecuteMDXEx
(
ByVal vtSheetName As Variant,
ByVal vtQuery As Variant,
ByVal vtBoolHideData As Variant,
ByVal vtBoolDataLess As Variant,
ByVal vtBoolNeedStatus As Variant,
ByVal vtMbrIDType As Variant,
ByVal vtAliasTable As Variant,
ByRef outResult As MDX_AXES_NATIVE
) As Long

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtQuery: 実行するMDX問合せ

vtBoolHideData: 結果でデータを非表示にするか表示するかを示すブール・フラグ

vtBoolDataLess: 結果でデータを取得するか回避するかを示すブール・フラグ

vtBoolNeedStatus: 結果でステータス情報を取得するか回避するかを示すブール・フラグ

vtMbrIDType: 結果のメンバー・タイプ識別子(名前または別名)

vtAliasTable: 使用する別名表

outResult: タイプがMDX_AXESの構造へのポインタ。問合せの出力を含みます。(このAPIでのデータ型およびサポートされる関数については、「HypExecuteMDXExに固有のデータ型」を参照してください。)

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

HypExecuteMDXExに固有のデータ型

次のデータ型は、HypExecuteMDXExにのみ適用されます。

MDX_CELL: セルに対応するデータ型

MDX_PROPERTY: メンバーおよびディメンションに関するプロパティを含むデータ型

MDX_MEMBER: メンバー情報のデータ型

MDX_DIMENSION: ディメンション情報のデータ型

MDX_CLUSTER: クラスタ情報のデータ型

MDX_AXIS: 軸を表すデータ型

MDX_AXES: 軸およびセルの集合を含む、ルート・レベル構造

MDX_AXES_NATIVE: HypExecuteMDXExの出力パラメータとして使用されるデータ型。この構造は、プロシージャGetVBCompatibleMDXStructureを使用してMDX_AXESに変換する必要があります。

例

Sub GetVBCompatibleMDXStructure(ByRef inStruct As MDX_AXES_NATIVE, ByRef outStruct As MDX_AXES)

Public Declare Function HypExecuteMDXEx Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtQuery As Variant, ByVal vtBoolHideData As Variant, ByVal vtBoolDataLess As Variant, ByVal vtBoolNeedStatus As Variant, ByVal vtMbrIDType As Variant, ByVal vtAliasTable As Variant, ByRef outResult As MDX_AXES_NATIVE) As Long

Sub Example_HypExecuteMDXEx()

Dim Query As Variant
Dim vtBoolHideData As Variant
Dim vtBoolDataLess As Variant
Dim vtBoolNeedStatus As Variant
Dim vtMbrIDType As Variant
Dim vtAliasTable As Variant
Dim result_Native As MDX_AXES_NATIVE
Dim result_VBCompatible As MDX_AXES

Query = "select {Jan} on COLUMNS, {Profit} on ROWS from Sample.Basic"
vtBoolHideData = True
vtBoolDataLess = True
vtBoolNeedStatus = True
vtMbrIDType = "alias"
vtAliasTable = "none"

sts = HypConnect(Empty, "UserName", "Password", "SB")

If sts = 0 Then

sts = HypExecuteMDXEx(Empty, Query, vtBoolHideData, vtBoolDataLess, vtBoolNeedStatus, vtMbrIDType, vtAliasTable, result_Native)
sts = GetVBCompatibleMDXStructure(result_Native, result_VBCompatible)
sts = HypDisconnect(Empty, True)
Else
End If
End Sub

16 Oracle Journals for Financial Managementの関数

関連トピック

- Oracle Journals for Financial Managementの関数について

- RegAsmを使用したOracle JournalsのVBA関数の登録

- Oracle Journals for Financial Managementの関数を使用する準備

- Oracle Journals for Financial Management拡張機能オブジェクトのインスタンス化

- Oracle Journals for Financial Management拡張機能の関数

Oracle Journals for Financial Managementの関数について

この章のVBA関数が操作をサポートするのは、Oracle Hyperion Financial Managementデータ・ソースに接続している場合です。

この章のVBA関数を使用するには、Financial Management 11.1.2.4.204と11.1.2.4.204 PSE 25575478が必要です。また、Oracle Smart View for Office 11.1.2.5.700と、11.1.2.5.700リリースに含まれるOracle Journals for Financial Management拡張機能をインストールする必要があります。

Oracle Journals for Financial ManagementのVBA関数の使用を開始する前に、次の手順を正しい順序で完了する必要があります。

1. RegAsmを使用したOracle JournalsのVBA関数の登録

2. Oracle Journals for Financial Managementの関数を使用する準備

3. Oracle Journals for Financial Management拡張機能オブジェクトのインスタンス化

RegAsmを使用したOracle JournalsのVBA関数の登録

Oracle Journals for Financial Managementで使用するVBA関数の作成および編集を開始する前に、RegAsmを使用してOracle Journals for Financial ManagementのDLLを登録する必要があります。

RegAsmを使用してOracle JournalsのDLLを登録する手順:

1. Oracle JournalsのDLL (Journals.dll)のファイルの場所をメモします。通常は次の場所にあります。

%APPDATA%\Oracle\SmartView\extensions\Bin\Oracle.SmartView.SVFMJournal\bin

2. Windowsエクスプローラで、Oracle Smart View for Officeのインストール・ディレクトリに移動します。通常は次の場所にあります。

C:\Oracle\SmartView\bin

3. Oracle.SmartView.Interop.SVRC.dllファイルを、この場所から手順1でメモしたOracle Journalsのファイルの場所にコピーします。

4. 管理者としてコマンド・プロンプトを開き、次のいずれかの場所に移動します。

- Microsoft Office (64ビット)の場合:

C:\Windows\Microsoft.NET\Framework64\v4.0.30319

- Microsoft Office (32ビット)の場合:

C:\Windows\Microsoft.NET\Framework\v4.0.30319

5. 次のコマンドを実行します:
regasm /codebase /tlb <file path from Step 1>\Journals.dll
次のメッセージが表示されます。

"Assembly exported to %APPDATA%\Oracle\SmartView\extensions\Bin\Oracle.SmartView.SVFMJournal\bin\Journals.tlb and the type library was registered successfully."

警告はすべて無視してかまいません。

「Oracle Journals for Financial Managementの関数を使用する準備」に進みます。

Oracle Journals for Financial Managementの関数を使用する準備

Journalsタイプ・ライブラリへの参照を追加して、Oracle Journals for Financial Managementで使用するVBA関数を作成および編集するための設定操作を続行します。

注意:

この手順を開始する前に、「RegAsmを使用したOracle JournalsのVBA関数の登録」の手順を完了する必要があります。

Oracle Hyperion Financial ManagementのOracle Journalsの参照を追加する手順:

1. Microsoft Officeアプリケーション(Excelなど)からVisual Basic Editorを起動します。

2. 「ツール」、「参照」の順に選択します。

3. 「使用できる参照」で、「Journals」参照を選択します。

「Oracle Journals for Financial Management拡張機能オブジェクトのインスタンス化」に進みます。

Oracle Journals for Financial Management拡張機能オブジェクトのインスタンス化

Oracle Hyperion Financial ManagementのOracle Journals拡張機能は、COMを介して自動化インタフェースを公開します。自動化呼出しを行うには、Oracle Journals for Financial ManagementのCOMオブジェクトをまずインスタンス化する必要があります。

Oracle Journals for Financial Managementのすべての自動化関数はIJournalVBAインタフェースに定義され、JournalVBAクラスがこれらの関数を実装します。したがって、Oracle Journalsのすべての自動化呼出しには、次の手順で説明する変数宣言を含める必要があります。

注意:

この手順を開始する前に、まず「RegAsmを使用したOracle JournalsのVBA関数の登録」の手順を完了し、次に「Oracle Journals for Financial Managementの関数を使用する準備」の手順を完了する必要があります。

すべての関数に組み込む変数宣言を作成する手順:

1. IJournalVBAタイプの変数を宣言します。

2. この変数をJournalVBAタイプのオブジェクトに設定します。

行は次のようになります。

Dim jObj As IJournalVBA

Set jObj = New JournalVBA

3. 前の手順の行を各関数に含めます。

これで、Oracle Journals for Financial Managementの関数の作成と使用を開始する準備が整いました。使用可能なすべての関数と使用方法のリストは、「Oracle Journals for Financial Management拡張機能の関数」を参照してください。

Oracle Journals for Financial Management拡張機能の関数

関連トピック

- ListJournals

- OpenJournal

- SetJournalProperty

- ListTemplates

- CreateJournal

- SaveJournal

- PerformAction

- ValidateJournal

ListJournals

説明

ListJournals()は、Oracle Hyperion Financial Managementの使用可能なすべての仕訳をリストします。

構文

Function ListJournals(

dims() As String,

dimVals() As String,

jrnlIDs() As String,

jrnlLabels() As String

) As Long

パラメータ

dims: 入力引数。ディメンションのリストを文字列の配列として指定します。

dimVals: 入力引数。ディメンション値のリストを文字列の配列として指定します。

jrnlIDs: 出力引数。仕訳IDを文字列の配列として戻します。

jrnlLabels: 出力引数。仕訳ラベルを文字列の配列として戻します。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

次の例では、メッセージを表示しないオプションを設定します。

Public Declare Function HypConnect Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtUserName As Variant, ByVal vtPassword As Variant, ByVal vtFriendlyName As Variant) As Long

Sub TestListJournals
‘Connect to an HFM data source
HypConnect “Sheet1”, “admin”, “password”, “connName”

Set jObj = New JournalVBA
jObj.UseActiveConnectionContext

dims(0) = HFM_JOURNAL_DIM_SCENARIO
dims(1) = HFM_JOURNAL_DIM_YEAR
dims(2) = HFM_JOURNAL_DIM_PERIOD
dims(3) = HFM_JOURNAL_DIM_VALUE

dimVals(0) = "Actual"
dimVals(1) = "2007"
dimVals(2) = "January"
dimVals(3) = "<Entity Curr Adjs>"

Dim jrnlIds() As String
Dim jrnlLabels() As String

Dim retVal as Long
retVal = jObj.ListJournals(dims, dimVals, jrnlIds, jrnlLabels)

If retVal = 0 Then
Debug.Print "Following are the Journal IDs and their Labels..."
Debug.Print "Journal Id        Name"
Dim i As Integer
For i = 0 To UBound(jrnlIds)
Debug.Print Spc(5); jrnlIds(i); Spc(10); jrnlLabels(i)
Next
Else
Debug.Print "ListJournals Failed!!!"
End If

End Sub

OpenJournal

説明

OpenJournal()は、指定された仕訳を開きます。

構文

Function OpenJournal(

jrnID As String,

dims() As String,

dimVals () As String

) As Long

パラメータ

jrnlID: 入力引数。開く仕訳の仕訳IDを指定します。仕訳IDは、ListJournals()を呼び出すことで取得できます。

dims: 入力引数。ディメンションのリストを文字列の配列として指定します。

dimVals: 入力引数。ディメンション値のリストを文字列の配列として指定します。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Sub OpenJournal
‘Firstly, get the list of Journals
ListJournals

Dim jrnlID As String
jrnlID = 1

retVal = jObj.OpenJournal(jrnlID, dims, dimVals)

If retVal = 0 Then
Debug.Print "OpenJournal Succeeded"
Else
Debug.Print "OpenJournal Failed!!!"
End If

End Sub

SetJournalProperty

説明

SetJournalProperty()は、現在開いている仕訳の指定されたプロパティを設定します。

構文

Function SetJournalProperty(

sheetName As String,

props() As String,

propVals() As String

) As Long

パラメータ

sheetName: 入力引数。仕訳が開いているシートの名前を指定します。

props: 入力引数。プロパティのリストを文字列の配列として指定します。

propVals: 入力引数。プロパティ値のリストを文字列の配列として指定します。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypRetrieve Lib "HsAddin" (ByVal vtSheetName As Variant) As Long
Sub SetJournalProperty()

Dim props(6) As String
props(0) = HFM_JOURNALPROP_LABEL
props(1) = HFM_JOURNALPROP_DESCRIPTION
props(2) = HFM_JOURNALPROP_TYPE
props(3) = HFM_JOURNALPROP_BALANCE_TYPE
props(4) = HFM_JOURNALPROP_GROUP
props(5) = HFM_JOURNALPROP_SECURITY
props(6) = HFM_JOURNALPROP_READONLY

Dim propVals(6) As String
propVals(0) = "J001"
propVals(1) = "Test1"
propVals(2) = HFM_JOURNALPROP_TYPE_REGULAR
propVals(3) = HFM_JOURNALPROP_BALANCETYPE_BALANCED
propVals(4) = HFM_JOURNALPROP_GROUP_ALLOCATION
propVals(5) = HFM_JOURNALPROP_SECURITY_ACCOUNTS
propVals(6) = "0"

Dim retVal As Long
Set jObj = New JournalVBA
retVal = jObj.SetJournalProperty("Sheet1", props, propVals)

If retVal = 0 Then
Debug.Print "SetJournalProperty Succeeded"

Dim status As Long
status = HypRetrieve(Empty)
Debug.Print "HypRetrieve returned Status as "; status
Else
Debug.Print "SetJournalProperty Failed"
End If

End Sub

ListTemplates

説明

ListTemplates()は、使用可能なすべての仕訳テンプレートをリストします。

構文

Function ListTemplates(

templateType() As String,

templateName() As String

) As Long

パラメータ

templateType: 出力引数。使用可能なテンプレート・タイプ(標準または繰返し)を文字列の配列として戻します。

templateName: 出力引数。テンプレート名を文字列の配列として戻します。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Public Declare Function HypConnect Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtUserName As Variant, ByVal vtPassword As Variant, ByVal vtFriendlyName As Variant) As Long
Sub TestListTemplates
‘Connect to an HFM data source
HypConnect “Sheet1”, “admin”, “password”, “connName”

Set jObj = New JournalVBA
jObj.UseActiveConnectionContext

Dim templateType() As String
Dim templateName() As String

retVal = jObj.ListTemplates(templateType, templateName)

If retVal = 0 Then
Debug.Print "Following are the Template types and their names..."
Debug.Print "Type        Name"
Dim i As Integer
For i = 0 To UBound(templateType)
Debug.Print Spc(5); templateType(i); Spc(10); templateName(i)
Next
Else
Debug.Print "ListTemplates Failed!!!"
End If
End Sub

CreateJournal

説明

CreateJournal()は、空の仕訳あるいは標準テンプレートまたは繰返しテンプレートに基づいた仕訳を作成します。

構文

Function CreateJournal(

dims() As String,

dimVals () As String,

templateType As String,

templateNames() As String

) As Long

パラメータ

dims: 入力引数。ディメンションのリストを文字列の配列として指定します。

dimVals: 入力引数。ディメンション値のリストを文字列の配列として指定します。

templateType: 入力引数。値は次のいずれかです。

- HFM_JOURNAL_TEMPLATE_TYPE_BLANK

- HFM_JOURNAL_TEMPLATE_TYPE_STANDARD

- HFM_JOURNAL_TEMPLATE_TYPE_RECURRING

これらは、HFMJournalVBA.basで定義されています。

templateNames: 入力引数。テンプレート名を文字列の配列として指定します。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Sub CreateJournal
‘Connect to an HFM data source
HypConnect “Sheet1”, “admin”, “password”, “connName”

Set jObj = New JournalVBA
jObj.UseActiveConnectionContext

dims(0) = HFM_JOURNAL_DIM_SCENARIO
dims(1) = HFM_JOURNAL_DIM_YEAR
dims(2) = HFM_JOURNAL_DIM_PERIOD
dims(3) = HFM_JOURNAL_DIM_VALUE

dimVals(0) = "Actual"
dimVals(1) = "2007"
dimVals(2) = "January"
dimVals(3) = "<Entity Curr Adjs>"

Dim templateNames(0) As String
templateNames(0) = "Template1"
retVal = jObj.CreateJournal(dims, dimVals, HFM_JOURNAL_TEMPLATE_TYPE_STANDARD, templateNames)

If retVal = 0 Then
Debug.Print "Create Journal from Template Succeeded"
Else
Debug.Print "Create Journal from Template Failed!!!"
End If
End Sub

SaveJournal

説明

SaveJournal()は、Oracle Hyperion Financial Managementサーバーに仕訳を保存します。

構文

Function SaveJournal(

props() As String,

propVals() As String,

dims() As String,

dimVals () As String

) As Long

パラメータ

props: 入力引数。プロパティのリストを文字列の配列として指定します。

propVals: 入力引数。プロパティ値のリストを文字列の配列として指定します。

dims: 入力引数。ディメンションのリストを文字列の配列として指定します。

dimVals: 入力引数。ディメンション値のリストを文字列の配列として指定します。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Sub SaveJournal()

Connect to an HFM data source
HypConnect “Sheet1”, “admin”, “password”, “connName”

Set jObj = New JournalVBA
jObj.UseActiveConnectionContext

Dim props(6) As String
props(0) = HFM_JOURNALPROP_LABEL
props(1) = HFM_JOURNALPROP_DESCRIPTION
props(2) = HFM_JOURNALPROP_TYPE
props(3) = HFM_JOURNALPROP_BALANCE_TYPE
props(4) = HFM_JOURNALPROP_GROUP
props(5) = HFM_JOURNALPROP_SECURITY
props(6) = HFM_JOURNALPROP_READONLY

Dim propVals(6) As String
propVals(0) = "J001"
propVals(1) = "Test1"
propVals(2) = HFM_JOURNALPROP_TYPE_REGULAR
propVals(3) = HFM_JOURNALPROP_BALANCETYPE_BALANCED
propVals(4) = HFM_JOURNALPROP_GROUP_ALLOCATION
propVals(5) = HFM_JOURNALPROP_SECURITY_ACCOUNTS
propVals(6) = "0"

dims(0) = HFM_JOURNAL_DIM_SCENARIO
dims(1) = HFM_JOURNAL_DIM_YEAR
dims(2) = HFM_JOURNAL_DIM_PERIOD
dims(3) = HFM_JOURNAL_DIM_VALUE

dimVals(0) = "Actual"
dimVals(1) = "2007"
dimVals(2) = "March"
dimVals(3) = "<Entity Curr Adjs>"

retVal = jObj.SaveJournal(props, propVals, dims, dimVals)
If retVal = 0 Then
Debug.Print "SaveJournal Succeeded"
Else
Debug.Print "SaveJournal Failed!!!"
End If
End Sub

PerformAction

説明

PerformAction()は、POST、UNPOST、SUBMIT、UNSUBMIT、APPROVE、REJECTまたはDELETEのいずれかの操作を実行します。

構文

Function PerformAction(

action As String

) As Long

パラメータ

action: 入力引数。値は次のいずれかです。

HFM_JOURNAL_ACTION_POSTまたは

HFM_JOURNAL_ACTION_UNPOSTまたは

HFM_JOURNAL_ACTION_SUBMITまたは

HFM_JOURNAL_ACTION_UNSUBMITまたは

HFM_JOURNAL_ACTION_APPROVEまたは

HFM_JOURNAL_ACTION_REJECTまたは

HFM_JOURNAL_ACTION_DELETE。

これらは、HFMJournalVBA.basで定義されています。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Sub TestPerformAction()
Set jObj = New JournalVBA

retVal = jObj.PerformAction(HFM_JOURNAL_ACTION_UNSUBMIT)
If retVal = 0 Then
Debug.Print "PerformAction Succeeded."
Else
Debug.Print "PerformAction Succeeded!!!"
End If
End Sub

ValidateJournal

説明

ValidateJournal()は、Oracle Hyperion Financial Managementサーバーと通信して、ディメンション、メンバーおよび仕訳プロパティを検証します。

構文

Function ValidateJournal(

errNames() As String,

errValues() As String

) As Long

パラメータ

errNames: 出力引数。失敗した検証のカテゴリを文字列の配列として戻します。

errValues: 出力引数。失敗した検証を文字列の配列として戻します。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

Sub TestValidateJournal()
‘Call TestCreateJournal
TestCreateJournal

Dim errNames() As String
Dim errValues() As String

retVal = jObj.ValidateJournal(errNames, errValues)
If retVal = 0 Then
Debug.Print "Validation Succeeded"
If (Not Not errNames) <> 0 Then
Debug.Print "Following are the Validation Errors"
Debug.Print "Error Type       Description"
Dim i As Integer
For i = 0 To UBound(errNames)
Debug.Print errNames(i); Spc(10); errValues(i)
Next
Else
Debug.Print "No Validation Errors."
End If
Else
Debug.Print "ValidateJournal Failed : " + GetErrorMessage(retVal)
End If
End Sub

17 Oracle Analytics Cloudの関数

関連トピック

- Oracle Analytics Cloudの関数について

- Oracle Analytics Cloudの関数を使用する準備

- Oracle Smart View BI拡張機能オブジェクトのインスタンス化

- Oracle Smart View BI拡張機能の関数

Oracle Analytics Cloudの関数について

この章のVBA関数がOracle Smart View for Officeの操作をサポートするのは、Oracle Analytics Cloudデータ・ソースに接続している場合です。

Oracle Analytics Cloudの関数を使用する準備

Oracle Analytics Cloudで使用するVBA関数の作成および編集を開始する前に、Oracle Smart View BI拡張機能タイプ・ライブラリおよびOracle Smart View for Officeタイプ・ライブラリの参照を追加する必要があります。

Oracle Smart View BI拡張機能およびSmart Viewの参照を追加する手順:

1. Microsoft Officeアプリケーション(Excelなど)からVisual Basic Editorを起動します。

2. 「ツール」、「参照」の順に選択します。

3. 「使用できる参照」で、次のアイテムを選択します。

- Oracle Smart View BI拡張機能

- Oracle SmartView RC 1.0タイプ・ライブラリ

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

「Oracle Smart View BI拡張機能オブジェクトのインスタンス化」に進みます。

Oracle Smart View BI拡張機能オブジェクトのインスタンス化

Oracle Smart View BI拡張機能は、COMインタフェースを介して自動化インタフェースを公開します。Oracle Smart View BI拡張機能に自動化呼出しを行うには、Oracle Smart View BI拡張機能のCOMオブジェクトをまずインスタンス化する必要があります。

Oracle Analytics Cloudのすべての自動化関数はIBIReportインタフェースに定義され、SmartViewOBIEEAutomationクラスがこれらの関数を実装します。したがって、Oracle Analytics Cloudのすべての自動化呼出しには、次の手順で説明する変数宣言を含める必要があります。

すべての関数に組み込む変数宣言を作成する手順:

1. IBIReportタイプの変数を宣言します。

2. この変数をSmartViewOBIEEAutomationタイプのオブジェクトに設定します。

行は次のようになります。

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

3. 手順2の行を各関数に含めます。

これで、Oracle Smart View BI拡張機能の関数の作成と使用を開始する準備が整いました。使用可能なすべての関数と使用方法のリストは、「Oracle Analytics Cloudの関数」を参照してください。

Oracle Smart View BI拡張機能の関数

関連トピック

- InsertView

- EditPrompts

- EditPagePrompts

- GetPagePrompts

- DeleteView

- AnalysisProperties

- DirProperties

- InvokeMenu

- CopyView

- PasteView

InsertView

説明

Oracle Analytics CloudビューをOfficeアプリケーションに挿入します。

構文

Function InsertView(

connectionContext As String,

sourcePath As String,

viewName As String,

prompt() As BIReportPrompt,

format As SVREPORT_RENDER_FORMAT,

insertOption As SVREPORT_COMPOUND_VIEW_INSERT_OPTION) As Boolean

パラメータ

connectionContext: Oracle Analytics CloudプロバイダのURL。

sourcePath: Oracle Analytics Cloudカタログ内のビューの場所。

ビューのパスを示すには、WebブラウザでOracle Analytics Cloudカタログにアクセスし、ビュー・フォルダに移動して、フォルダのURLをメモします。フォルダのパスは、フォルダURL (URLエンコーディングでエンコードされている)のデコード後に導出できます。ビューの場所を指定するには、パスに分析名を含めます。たとえば、ブラウザにおいて、Oracle Analytics CloudのフォルダのURLは次のようになります。

http://xxxx.com:xxxx/analytics/saw.dll?catalog#%7B%22location%22%3A%22%2Fusers%2Fadministrator%2Fsvc_auto_bugs%22%7D

URLをデコードすると、次のように変わります。

http://xxxx.com:xxxx/analytics/saw.dll?catalog#{"location":"/users/administrator/svc_auto_bugs"}

フォルダ・パスを取得した後、パスに分析名を付加します。最終的に、パスは次のようになります。

/users/administrator/svc_auto_bugs/AnalysisName

viewName: ビューの名前。

prompt: ビューを挿入するためのプロンプト。

プロンプトはBIReportPromptの配列です。BIReportPromptは、1つのメンバー(文字列の配列)のみを含むクラスです。すべてのプロンプトの入力は文字列に変換する必要があります。BIReportPrompt配列の順序は、「プロンプト・セレクタ」ダイアログ・ボックスのプロンプトの順序と同じにする必要があります。

たとえば、図17-1のプロンプトに対してプロンプト値を指定するには、次の4つのBIReportPromptを含む配列を作成する必要があります。

- 最初の要素は"D1 Office"の選択肢を含みます

- 2番目の要素は"1 - Revenue"に対応します

- 3番目の要素は"P3 LOB"に対応します

- 4番目の要素は"T00 Calendar Date"に対応します

図17-1の後にサンプル・コードを示します。

図17-1 事務所、事業部門およびカレンダ日付の選択肢を含む「プロンプト・セレクタ」ダイアログ・ボックス

Dim prompts(0 To 3) As BIReportPrompt

Dim firstPrompt(0 To 3) As String
firstPrompt(0) = "Madison Office"
firstPrompt(1) = "Merrimon Office"
firstPrompt(2) = "Spring Office"
firstPrompt(3) = "Tellaro Office"
prompts(0).Values = firstPrompt

Dim secondPrompt(0 To 0) As String
secondPrompt(0) = "500"
prompts(1).Values = secondPrompt

Dim ThirdPrompt(0 To 5) As String
ThirdPrompt(0) = "Communication"
ThirdPrompt(1) = "Digital"
ThirdPrompt(2) = "Electronics"
ThirdPrompt(3) = "Games"
ThirdPrompt(4) = "Services"
ThirdPrompt(5) = "TV"
prompts(2).Values = ThirdPrompt

Dim FourthPrompt(0 To 0) As String
ForthPrompt(0) = "5/15/2009"
prompts(3).Values = ForthPrompt

format: 表示形式。有効な表示形式の値は、表17-1で説明します。

表17-1 表示形式とビュー・タイプ

表示形式の値

使用されるビュー・タイプ

Default_Format

すべてのビュー

ExcelPivot

ピボット・テーブル・ビューのみ

ExcelTable

表ビューのみ

Image

チャート・ビューのみ

insertOption: 複合ビューのみ。このオプションは、複合ビューにすべてのビューを挿入する方法を指定し、個々のビューについては無視されます。

有効な値を次に示します。

- NewSheet - 新規シートの複合ビューに各ビューを挿入します。

- SameSheet - 同じシートの複合ビューに各ビューを挿入します。

戻り値

操作が成功したかどうかを示します。

例

Sub InsertTableTest()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

Dim prompts() As BIReportPrompt

obiee.InsertView “http://xxx.com:xxxx/analytics/jbips”, "/shared/SmartView/OBIEE/sv_vba_dev", "tableView!1", prompts, Default_Format, NewSheet

End Sub

Sub InsertPromptTableTest()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

Dim prompts(0 To 3) As BIReportPrompt

Dim firstPrompt(0 To 3) As String
firstPrompt(0) = "Madison Office"
firstPrompt(1) = "Merrimon Office"
firstPrompt(2) = "Spring Office"
firstPrompt(3) = "Tellaro Office"
prompts(0).Values = firstPrompt

Dim secondPrompt(0 To 0) As String
secondPrompt(0) = "500"
prompts(1).Values = secondPrompt

Dim ThirdPrompt(0 To 5) As String
ThirdPrompt(0) = "Communication"
ThirdPrompt(1) = "Digital"
ThirdPrompt(2) = "Electronics"
ThirdPrompt(3) = "Games"
ThirdPrompt(4) = "Services"
ThirdPrompt(5) = "TV"
prompts(2).Values = ThirdPrompt

Dim FourthPrompt(0 To 0) As String
ForthPrompt(0) = "5/15/2009"
prompts(3).Values = ForthPrompt

obiee.InsertView “http://xxx.com:xxxx/analytics/jbips”,"/shared/SmartView/sv_vba_dev/promptAllTypes", "tableView!1", prompts, Default_Format, SameSheet

End Sub

EditPrompts

説明

ビューのプロンプトを編集します。

構文

Function EditPrompts(

objID As String,

prompt() As BIReportPrompt

) As Boolean

パラメータ

objID: 編集するビューのID。空のIDが渡されると、選択したビューが使用されます。

prompt: oac_insertview_112x1861b63f.htm#PromptSelectorDialogBoxWithSelectio-18680EC2の"prompt"パラメータと同じです。

戻り値

操作が成功したかどうかを示します。

例

Sub EditPromptTableTest()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

Dim prompts(0 To 3) As BIReportPrompt

Dim firstPrompt(0 To 3) As String
firstPrompt(0) = "Madison Office"
firstPrompt(1) = "Merrimon Office"
firstPrompt(2) = "Spring Office"
firstPrompt(3) = "Tellaro Office"
prompts(0).Values = firstPrompt

Dim secondPrompt(0 To 0) As String
secondPrompt(0) = "500"
prompts(1).Values = secondPrompt

Dim ThirdPrompt(0 To 5) As String
ThirdPrompt(0) = "Communication"
ThirdPrompt(1) = "Digital"
ThirdPrompt(2) = "Electronics"
ThirdPrompt(3) = "Games"
ThirdPrompt(4) = "Services"
ThirdPrompt(5) = "TV"

prompts(2).Values = ThirdPrompt

Dim ForthPrompt(0 To 0) As String
ForthPrompt(0) = "8/15/2009"
prompts(3).Values = ForthPrompt

obiee.EditPrompts Empty, prompts

EditPagePrompts

説明

ビューのページ選択を編集します。

構文

Function EditPagePrompts(

objID As String,

pageSelections() As String

) As Boolean

パラメータ

objID: 編集するビューのID。空のIDが渡されると、選択したビューが使用されます。

pageSelections: 文字列配列に格納されるページ選択の順序は、「ページ・セレクタ」ダイアログ・ボックスに表示されるページ選択の順序と同じにする必要があります。たとえば、図17-2に示されるページ選択肢を指定するには、図の後のサンプル・コードを使用します。

図17-2 地域と年の選択肢を含む「ページ・セレクタ」ダイアログ・ボックス

Dim pageSelections(0 To 1) As String
pageSelections (0) = "CENTRAL REGION"
pageSelections (1) = "2000"

戻り値

操作が成功したかどうかを示します。

例

Sub EditPagePromptTest()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation
Dim pages(0 To 1) As String
pages(0) = "CENTRAL REGION"
pages(1) = "2000"

obiee.EditPagePrompts Empty, pages

End Sub

GetPagePrompts

説明

ビューのページ選択を取得します。

構文

Function GetPagePrompts(

objID As String,

PageEdges() As String,

PageSelections() As String

) As Boolean

パラメータ

objID: ページ選択を取得するビューのID。空のIDが渡されると、選択したビューが使用されます。

PageEdges: 出力引数。ビューのページ・エッジの名前を戻します。

PageSelections: 出力引数。選択したページの値を戻します。

戻り値

操作が成功したかどうかを示します。

例

Sub TestGetPage()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

Dim dims() As String
Dim pageSelections() As String

obiee.GetPagePrompts Empty, dims, pageSelections

End Sub

DeleteView

説明

Officeアプリケーションのビューを削除します。

構文

Function DeleteView( objID As String ) As Boolean

パラメータ

objID: 削除するビューのID。空のIDが渡されると、選択したビューが使用されます。

戻り値

操作が成功したかどうかを示します。

例

Sub DeleteViewTest()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation
obiee.DeleteView Empty

End Sub

AnalysisProperties

説明

分析のプロパティをフェッチします。

構文

Function AnalysisProperties(

connectionContext As String,

sourcePath As String,

analysisName As String

) As SVReportProperty()

パラメータ

connectionContext: Oracle Analytics CloudプロバイダのURL。

sourcePath: 分析のパス。

analysisName: 分析の名前。

戻り値

SVReportPropertyの配列。配列の各要素は、分析の1つのプロパティを表します。SVReportPropertyの名前メンバーにはプロパティの名前が含まれ、値メンバーにはプロパティの値が含まれます。

例

Sub TestAnalysisProp()

Dim BIReport As IBIReport
Set BIReport = New SmartViewOBIEEAutomation

Dim result As Variant

result = BIReport.AnalysisProperties(“http://xxx.com:xxxx/analytics/jbips”,"/shared/SmartView/OBIEE", "svdevusr")

End Sub

DirProperties

説明

ディレクトリのプロパティをフェッチします

構文

Function DirProperties (

connectionContext As String,

sourcePath As String,

) As SVReportProperty()

パラメータ

connectionContext: Oracle Analytics CloudプロバイダのURL。

sourcePath: ディレクトリのパス。

戻り値

AnalysisPropertiesの戻り値と同じです。SVReportPropertyの配列。配列の各要素は、分析の1つのプロパティを表します。SVReportPropertyの名前メンバーにはプロパティの名前が含まれ、値メンバーにはプロパティの値が含まれます。

例

Sub TestDirProp()

Dim BIReport As IBIReport
Set BIReport = New SmartViewOBIEEAutomation

Dim result As Variant

result = BIReport.DirProperties(“http://xxx.com:xxxx/analytics/jbips”,"/shared/SmartView/OBIEE/sv_vba_dev")

End Sub

InvokeMenu

説明

Smart View Oracle BI EE拡張機能メニュー・リボンを起動します。

構文

Sub InvokeMenu(

menuID As String

)

パラメータ

menuID: メニュー・アイテムのID。表17-2に有効な値を示します。

表17-2 Oracle BI EEのメニュー・アイテムとID

メニュー

ID

ビュー・デザイナ

ViewDesigner

ビューの発行

PublishView

リフレッシュ

リフレッシュ

プロンプトの編集

EditPrompts

ページ・プロンプトの編集

EditPage

コピー

CopyView

貼付け

PasteView

削除

DeleteView

データのマスク

MaskView

ドキュメント・データのマスク

MaskDocumentView

例

Sub TestMenuInvoke()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

obiee.InvokeMenu "ViewDesigner"

End Sub

CopyView

CopyView関数は、現在のリリースではサポートされていません。

PasteView

PasteView関数は、現在のリリースではサポートされていません。

18 Oracle BI EEの関数

関連トピック

- Oracle BI EEの関数について

- Oracle BI EEの関数を使用する準備

- Oracle Smart View BI拡張機能オブジェクトのインスタンス化

- Oracle Smart View BI拡張機能の関数

Oracle BI EEの関数について

この章のVBA関数がOracle Smart View for Officeの操作をサポートするのは、Oracle Business Intelligence Enterprise Editionデータ・ソースに接続している場合です。

Oracle BI EEの関数を使用する準備

Oracle Business Intelligence Enterprise Editionで使用するVBA関数の作成および編集を開始する前に、Oracle Smart View BI拡張機能タイプ・ライブラリおよびOracle Smart View for Officeタイプ・ライブラリの参照を追加する必要があります。

Oracle Smart View BI拡張機能およびSmart Viewの参照を追加する手順:

1. Microsoft Officeアプリケーション(Excelなど)からVisual Basic Editorを起動します。

2. 「ツール」、「参照」の順に選択します。

3. 「使用できる参照」で、次のアイテムを選択します。

- Oracle Smart View BI拡張機能

- Oracle SmartView RC 1.0タイプ・ライブラリ

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

「Oracle Smart View BI拡張機能オブジェクトのインスタンス化」に進みます。

Oracle Smart View BI拡張機能オブジェクトのインスタンス化

Oracle Smart View BI拡張機能は、COMインタフェースを介して自動化インタフェースを公開します。Oracle Smart View BI拡張機能に自動化呼出しを行うには、Oracle Smart View BI拡張機能のCOMオブジェクトをまずインスタンス化する必要があります。

Oracle Business Intelligence Enterprise Editionのすべての自動化関数はIBIReportインタフェースに定義され、SmartViewOBIEEAutomationクラスがこれらの関数を実装します。したがって、Oracle BI EEのすべての自動化呼出しには、次の手順で説明する変数宣言を含める必要があります。

すべての関数に組み込む変数宣言を作成する手順:

1. IBIReportタイプの変数を宣言します。

2. この変数をSmartViewOBIEEAutomationタイプのオブジェクトに設定します。

行は次のようになります。

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

3. 手順2の行を各関数に含めます。

これで、Oracle Smart View BI拡張機能の関数の作成と使用を開始する準備が整いました。使用可能なすべての関数と使用方法のリストは、「Oracle Smart View BI拡張機能の関数」を参照してください。

Oracle Smart View BI拡張機能の関数

関連トピック

- InsertView

- EditPrompts

- EditPagePrompts

- GetPagePrompts

- DeleteView

- AnalysisProperties

- DirProperties

- InvokeMenu

- CopyView

- PasteView

InsertView

説明

Oracle Business Intelligence Enterprise EditionビューをOfficeアプリケーションに挿入します。

構文

Function InsertView(

connectionContext As String,

sourcePath As String,

viewName As String,

prompt() As BIReportPrompt,

format As SVREPORT_RENDER_FORMAT,

insertOption As SVREPORT_COMPOUND_VIEW_INSERT_OPTION) As Boolean

パラメータ

connectionContext: Oracle BI EEプロバイダのURL。

sourcePath: Oracle BI EEカタログ内のビューの場所。

ビューのパスを示すには、WebブラウザでOracle BI EEカタログにアクセスし、ビュー・フォルダに移動して、フォルダのURLをメモします。フォルダのパスは、フォルダURL (URLエンコーディングでエンコードされている)のデコード後に導出できます。ビューの場所を指定するには、パスに分析名を含めます。たとえば、ブラウザにおいて、Oracle BI EEのフォルダのURLは次のようになります

http://xxxx.com:xxxx/analytics/saw.dll?catalog#%7B%22location%22%3A%22%2Fusers%2Fadministrator%2Fsvc_auto_bugs%22%7D

URLをデコードすると、次のように変わります。

http://xxxx.com:xxxx/analytics/saw.dll?catalog#{"location":"/users/administrator/svc_auto_bugs"}

フォルダ・パスを取得した後、パスに分析名を付加します。最終的に、パスは次のようになります。

/users/administrator/svc_auto_bugs/AnalysisName

viewName: ビューの名前。

prompt: ビューを挿入するためのプロンプト。

プロンプトはBIReportPromptの配列です。BIReportPromptは、1つのメンバー(文字列の配列)のみを含むクラスです。すべてのプロンプトの入力は文字列に変換する必要があります。BIReportPrompt配列の順序は、「プロンプト・セレクタ」ダイアログ・ボックスのプロンプトの順序と同じにする必要があります。

たとえば、図18-1のプロンプトに対してプロンプト値を指定するには、次の4つのBIReportPromptを含む配列を作成する必要があります。

- 最初の要素は"D1 Office"の選択肢を含みます

- 2番目の要素は"1 - Revenue"に対応します

- 3番目の要素は"P3 LOB"に対応します

- 4番目の要素は"T00 Calendar Date"に対応します

図18-1の後にサンプル・コードを示します。

図18-1 事務所、事業部門およびカレンダ日付の選択肢を含む「プロンプト・セレクタ」ダイアログ・ボックス

Dim prompts(0 To 3) As BIReportPrompt

Dim firstPrompt(0 To 3) As String
firstPrompt(0) = "Madison Office"
firstPrompt(1) = "Merrimon Office"
firstPrompt(2) = "Spring Office"
firstPrompt(3) = "Tellaro Office"
prompts(0).Values = firstPrompt

Dim secondPrompt(0 To 0) As String
secondPrompt(0) = "500"
prompts(1).Values = secondPrompt

Dim ThirdPrompt(0 To 5) As String
ThirdPrompt(0) = "Communication"
ThirdPrompt(1) = "Digital"
ThirdPrompt(2) = "Electronics"
ThirdPrompt(3) = "Games"
ThirdPrompt(4) = "Services"
ThirdPrompt(5) = "TV"
prompts(2).Values = ThirdPrompt

Dim FourthPrompt(0 To 0) As String
ForthPrompt(0) = "5/15/2009"
prompts(3).Values = ForthPrompt

format: 表示形式。有効な表示形式の値は、表18-1で説明します。

表18-1 表示形式とビュー・タイプ

表示形式の値

使用されるビュー・タイプ

Default_Format

すべてのビュー

ExcelPivot

ピボット・テーブル・ビューのみ

ExcelTable

表ビューのみ

Image

チャート・ビューのみ

insertOption: 複合ビューのみ。このオプションは、複合ビューにすべてのビューを挿入する方法を指定し、個々のビューについては無視されます。

有効な値を次に示します。

- NewSheet - 新規シートの複合ビューに各ビューを挿入します。

- SameSheet - 同じシートの複合ビューに各ビューを挿入します。

戻り値

操作が成功したかどうかを示します。

例

Sub InsertTableTest()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

Dim prompts() As BIReportPrompt

obiee.InsertView “http://xxx.com:xxxx/analytics/jbips”, "/shared/SmartView/OBIEE/sv_vba_dev", "tableView!1", prompts, Default_Format, NewSheet

End Sub

Sub InsertPromptTableTest()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

Dim prompts(0 To 3) As BIReportPrompt

Dim firstPrompt(0 To 3) As String
firstPrompt(0) = "Madison Office"
firstPrompt(1) = "Merrimon Office"
firstPrompt(2) = "Spring Office"
firstPrompt(3) = "Tellaro Office"
prompts(0).Values = firstPrompt

Dim secondPrompt(0 To 0) As String
secondPrompt(0) = "500"
prompts(1).Values = secondPrompt

Dim ThirdPrompt(0 To 5) As String
ThirdPrompt(0) = "Communication"
ThirdPrompt(1) = "Digital"
ThirdPrompt(2) = "Electronics"
ThirdPrompt(3) = "Games"
ThirdPrompt(4) = "Services"
ThirdPrompt(5) = "TV"
prompts(2).Values = ThirdPrompt

Dim FourthPrompt(0 To 0) As String
ForthPrompt(0) = "5/15/2009"
prompts(3).Values = ForthPrompt

obiee.InsertView “http://xxx.com:xxxx/analytics/jbips”,"/shared/SmartView/sv_vba_dev/promptAllTypes", "tableView!1", prompts, Default_Format, SameSheet

End Sub

EditPrompts

説明

ビューのプロンプトを編集します。

構文

Function EditPrompts(

objID As String,

prompt() As BIReportPrompt

) As Boolean

パラメータ

objID: 編集するビューのID。空のIDが渡されると、選択したビューが使用されます。

prompt: InsertViewの"prompt"パラメータと同じです。

戻り値

操作が成功したかどうかを示します。

例

Sub EditPromptTableTest()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

Dim prompts(0 To 3) As BIReportPrompt

Dim firstPrompt(0 To 3) As String
firstPrompt(0) = "Madison Office"
firstPrompt(1) = "Merrimon Office"
firstPrompt(2) = "Spring Office"
firstPrompt(3) = "Tellaro Office"
prompts(0).Values = firstPrompt

Dim secondPrompt(0 To 0) As String
secondPrompt(0) = "500"
prompts(1).Values = secondPrompt

Dim ThirdPrompt(0 To 5) As String
ThirdPrompt(0) = "Communication"
ThirdPrompt(1) = "Digital"
ThirdPrompt(2) = "Electronics"
ThirdPrompt(3) = "Games"
ThirdPrompt(4) = "Services"
ThirdPrompt(5) = "TV"

prompts(2).Values = ThirdPrompt

Dim ForthPrompt(0 To 0) As String
ForthPrompt(0) = "8/15/2009"
prompts(3).Values = ForthPrompt

obiee.EditPrompts Empty, prompts

EditPagePrompts

説明

ビューのページ選択を編集します。

構文

Function EditPagePrompts(

objID As String,

pageSelections() As String

) As Boolean

パラメータ

objID: 編集するビューのID。空のIDが渡されると、選択したビューが使用されます。

pageSelections: 文字列配列に格納されるページ選択の順序は、「ページ・セレクタ」ダイアログ・ボックスに表示されるページ選択の順序と同じにする必要があります。たとえば、図18-2に示されるページ選択肢を指定するには、図の後のサンプル・コードを使用します。

図18-2 地域と年の選択肢を含む「ページ・セレクタ」ダイアログ・ボックス

Dim pageSelections(0 To 1) As String
pageSelections (0) = "CENTRAL REGION"
pageSelections (1) = "2000"

戻り値

操作が成功したかどうかを示します。

例

Sub EditPagePromptTest()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation
Dim pages(0 To 1) As String
pages(0) = "CENTRAL REGION"
pages(1) = "2000"

obiee.EditPagePrompts Empty, pages

End Sub

GetPagePrompts

説明

ビューのページ選択を取得します。

構文

Function GetPagePrompts(

objID As String,

PageEdges() As String,

PageSelections() As String

) As Boolean

パラメータ

objID: ページ選択を取得するビューのID。空のIDが渡されると、選択したビューが使用されます。

PageEdges: 出力引数。ビューのページ・エッジの名前を戻します。

PageSelections: 出力引数。選択したページの値を戻します。

戻り値

操作が成功したかどうかを示します。

例

Sub TestGetPage()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

Dim dims() As String
Dim pageSelections() As String

obiee.GetPagePrompts Empty, dims, pageSelections

End Sub

DeleteView

説明

Officeアプリケーションのビューを削除します。

構文

Function DeleteView( objID As String ) As Boolean

パラメータ

objID: 削除するビューのID。空のIDが渡されると、選択したビューが使用されます。

戻り値

操作が成功したかどうかを示します。

例

Sub DeleteViewTest()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation
obiee.DeleteView Empty

End Sub

AnalysisProperties

説明

分析のプロパティをフェッチします。

構文

Function AnalysisProperties(

connectionContext As String,

sourcePath As String,

analysisName As String

) As SVReportProperty()

パラメータ

connectionContext: Oracle Business Intelligence Enterprise EditionプロバイダのURL。

sourcePath: 分析のパス。

analysisName: 分析の名前。

戻り値

SVReportPropertyの配列。配列の各要素は、分析の1つのプロパティを表します。SVReportPropertyの名前メンバーにはプロパティの名前が含まれ、値メンバーにはプロパティの値が含まれます。

例

Sub TestAnalysisProp()

Dim BIReport As IBIReport
Set BIReport = New SmartViewOBIEEAutomation

Dim result As Variant

result = BIReport.AnalysisProperties(“http://xxx.com:xxxx/analytics/jbips”,"/shared/SmartView/OBIEE", "svdevusr")

End Sub

DirProperties

説明

ディレクトリのプロパティをフェッチします

構文

Function DirProperties (

connectionContext As String,

sourcePath As String,

) As SVReportProperty()

パラメータ

connectionContext: Oracle Business Intelligence Enterprise EditionプロバイダのURL。

sourcePath: ディレクトリのパス。

戻り値

AnalysisPropertiesの戻り値と同じです。SVReportPropertyの配列。配列の各要素は、分析の1つのプロパティを表します。SVReportPropertyの名前メンバーにはプロパティの名前が含まれ、値メンバーにはプロパティの値が含まれます。

例

Sub TestDirProp()

Dim BIReport As IBIReport
Set BIReport = New SmartViewOBIEEAutomation

Dim result As Variant

result = BIReport.DirProperties(“http://xxx.com:xxxx/analytics/jbips”,"/shared/SmartView/OBIEE/sv_vba_dev")

End Sub

InvokeMenu

説明

Smart View Oracle BI EE拡張機能メニューを起動します。

構文

Sub InvokeMenu(

menuID As String

)

パラメータ

menuID: メニュー・アイテムのID。表18-2に有効な値を示します。

表18-2 Oracle BI EEのメニュー・アイテムとID

メニュー

ID

ビュー・デザイナ

ViewDesigner

ビューの発行

PublishView

リフレッシュ

リフレッシュ

プロンプトの編集

EditPrompts

ページ・プロンプトの編集

EditPage

コピー

CopyView

貼付け

PasteView

削除

DeleteView

データのマスク

MaskView

ドキュメント・データのマスク

MaskDocumentView

例

Sub TestMenuInvoke()

Dim obiee As IBIReport
Set obiee = New SmartViewOBIEEAutomation

obiee.InvokeMenu "ViewDesigner"

End Sub

CopyView

CopyView関数は、現在のリリースではサポートされていません。

PasteView

PasteView関数は、現在のリリースではサポートされていません。

Oracleの法律上の注意点

コピーライト

Copyright © 1994-2018, Oracle and/or its affiliates. All rights reserved.

ライセンス制約の保証と結果的に生じる損害の免責

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

保証免責

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

制限付権利について

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

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

危険な用途への使用について

このソフトウェアまたはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアまたはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアまたはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(redundancy)、その他の対策を講じることは使用者の責任となります。このソフトウェアまたはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、Oracle Corporationおよびその関連会社は一切の責任を負いかねます。

商標と登録商標について

OracleおよびJavaはオラクルおよびその関連会社の登録商標です。その他の社名、商品名等は各社の商標または登録商標である場合があります。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

第三者のコンテンツ、製品、サービスに対する免責事項

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

Pre-General Availability (一般提供前)版のドキュメントについて

このドキュメントがPre-General Availability (一般提供前)版の場合:

このドキュメントはPre-General Availability (一般提供前)版であり、デモおよび暫定使用のみを目的としたものです。このソフトウェアを使用するハードウェアに限定するものではありません。Oracle Corporationおよびその関連会社は、このドキュメントに関して一切の責任を負わず、いかなる保証もいたしません。また、このドキュメントを使用したことによって損失、費用、あるいは損害が発生しても、一切の責任を負いかねます。

非公開のPre-General Availability (一般提供前)版のドキュメントについて

このドキュメントが非公開のPre-General Availability (一般提供前)版の場合:

このドキュメントに含まれる情報は、情報の共有のみを目的としたものであって、顧客諮問委員会(Customer Advisory Board)のメンバーとしてのお客様の立場でのみ、またはお客様のPre-General Availability Trial Agreement (Pre-GAトライアル契約)のみに従って検討されるべきものとします。マテリアル、コード、または機能の提供をお約束するものではなく、購入決定を行う際の判断材料とすべきではありません。このドキュメントに記載されている特徴または機能の開発、リリースおよび時期については、オラクルの裁量により決定されます。

このドキュメントには、ソフトウェアまたは印刷物などの形式を問わず、オラクルが独占的な権利を有する財産的情報が含まれています。この機密資料へのアクセスと使用は、お客様とオラクルとの間で締結され、お客様が遵守に同意した、Oracle Master Agreement、Oracle License and Oracle Services Agreement (オラクル・ライセンスおよびサービスに関する契約書)、Oracle Partner Network Agreement、Oracle Distribution Agreementまたはその他のライセンス契約の条件に従うものとします。このドキュメントとその内容の開示、コピー、複製および配布には、オラクルによる事前の承諾を必要とします。このドキュメントはライセンス契約の一部となるものではなく、オラクルおよびその子会社や関連会社との契約を構成するものではありません。

ドキュメントのアクセシビリティ

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

Oracle Supportへのアクセス

サポートをご契約のお客様には、My Oracle Supportを通して電子支援サービスを提供しています。詳細情報は(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info)か、聴覚に障害のあるお客様は(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs)を参照してください。