Java APIリスト

表7-3 Java APIリスト

API	説明
BigDecimal getPOVLocation(BigDecimal pLoadId)	LOADIDに基づいてパーティション・キーを返します。
BigDecimal getPOVCategory(BigDecimal pLoadId)	LOADIDに基づいてカテゴリ・キーを返します。
Date getPOVStartPeriod(BigDecimal pLoadId)	LOADIDに基づいて開始期間の期間キーを返します。
Date getPOVEndPeriod(BigDecimal pLoadId)	1つの期間をロードするとき、LOADIDに基づいて終了期間の期間キーを返します(開始期間と終了期間は同じです)。
executePLSQL	Procedural Language/Structured Query Language (PL/SQL)コードのブロックを実行します。このAPIは次の3つのパラメータを取ります: 文字列 - PL/SQLコードの有効なブロック。 PL/SQLブロックは二重引用符で囲む必要があります。オブジェクト配列 — コードのブロックに対する入力パラメータを表すJavaオブジェクト(String、BigDecimalなど)の入力配列。オブジェクト配列は、プレース・ホルダー(疑問符)があるPL/SQLに挿入するために使用されます。ブール — コミットを実行するかどうか。ブール値はTrueまたはFalseです。 PL/SQLの実行例: fdmAPI.executePLSQL("BEGIN dbms_stats.gather_table_stats(user,?,estimate_percent=>dbms_stats.auto_sample_size,force=>TRUE); END;", ["tDataSeg_T"], True);
getBatchJobDetails	getBatchJobDetailsは、バッチによって送信されたジョブごとに次の列を戻します。 BATCH_ID BATCH_NAME APPLICATION_ID BATCH_TYPE BATCH_EXECUTION_MODE BATCH_WAIT_TIMEOUT USER_POV_PERIOD OPEN_BATCH_FOLDER PLAN_TYPE FILENAME_SEPARATOR BATCH_GROUP_ID BEF_PROCESS_BATCH_SCRIPT AFT_PROCESS_BATCH_SCRIPT EXECUTION_DATE EXECUTED_BY LOADID BATCH_LOADID PARENT_BATCH_LOADID PARTITIONKEY CATKEY START_PERIODKEY END_PERIODKEY IMPORT_FROM_SOURCE_FLAG EXPORT_TO_TARGET_FLAG RECALCULATE_FLAG CHECK_FLAG JOURNAL_FLAG IMPORT_MODE EXPORT_MODE IMPGROUPKEY PROCESS_NAME RULE_TYPE LOG_FILE OUTPUT_FILE EPM_ORACLE_INSTANCE ODI_SESSION_NUMBER STATUS
int executeDML(String query,Object[] parameters)	任意のDML文を実行します。問合せおよびパラメータを指定します。パラメータはリストとして指定します。
logDB(String pEntityType, String pEntityName, int pLogSequence, String pLogMessage)	データベース表AIF_PROCESS_LOGSにメッセージを記録します。
logFatal(String pLogMessage)	致命的なエラーが発生した場合にメッセージをログに記録します。このメッセージはすべてのログ・レベルで表示されます。
logError(String pLogMessage)	エラーが発生した場合にメッセージをログに記録します。このメッセージは2以上のログ・レベルで表示されます。
logWarn(String pLogMessage)	警告条件エラーが発生した場合にメッセージをログに記録します。このメッセージは3以上のログ・レベルで表示されます。
logInfo(String pLogMessage)	情報メッセージをログに記録します。このメッセージは4以上のログ・レベルで表示されます。
logDebug(String pLogMessage)	デバッグ・メッセージをログに記録します。このメッセージはログ・レベル5で表示されます。
Map getProcessStates(BigDecimal pLoadId)	ワークフロー・プロセスのステータスを返します。使用可能なステータス: IMPSTATUS - インポート・プロセスのステータスを返します。 0ステータスは、プロセスがまだ開始されていないか、プロセスが失敗したことを示します。1ステータスは、プロセスが成功していることを示します。 VALSTATUS - 検証プロセスのステータスを返します。 0ステータスは、プロセスがまだ開始されていないか、プロセスが失敗したことを示します。1ステータスは、プロセスが成功していることを示します。 EXPSTATUS - エクスポート・プロセスのステータスを返します。 0ステータスは、プロセスがまだ開始されていないか、プロセスが失敗したことを示します。1ステータスは、プロセスが成功していることを示します。 CHKSTATUS - チェック・プロセスのステータスを返します。 0ステータスは、プロセスがまだ開始されていないか、プロセスが失敗したことを示します。1ステータスは、プロセスが成功していることを示します。 PROCESSSTATUS - 正確なエラー・コードを返します。エラー・コードの詳細は、tlogprocessstates表で確認できます。
Map getPeriodDetail(Date pPeriodKey,String pApplicationName) //returns PERIODTARGET and YEARTARGET	特定の期間キーに対するターゲット期間マッピングを返します。
Object getCustomScriptParameterValue(BigDecimal pLoadId,String pParameterName)	指定のカスタム・スクリプト・パラメータ名とloadIDに対する値を返します。
Object getCustomScriptParameterValue(String pParameterName)	指定のカスタム・スクリプト・パラメータ名と初期化ロードされたコンテキストの値を返します。
ResultSet getBatchDetails()	AIF_BATCHES表からバッチ定義情報を返します。 getBatchDetails()から返されるフィールド: BATCH_ID BATCH_NAME APPLICATION_ID BATCH_TYPE BATCH_EXECUTION_MOD
ResultSet getBatchJobDetails(BigDecimal pLoadId)	指定のloadidについてデータベース表AIF_PROCESS_LOGSに記録されたエラー・メッセージを取得します。
ResultSet getCategoryList()	結果セット内のカテゴリのリストを返します。 getCategoryList()から返されるフィールド: CATKEY CATNAME
ResultSet getCheckEntityGroupList(BigDecimal pApplicationId)	結果セット内の確認グループのリストを返します。
ResultSet getCheckEntityForGroup(String pValGroupKey)	結果セット内の確認グループのエンティティ・リストを返します。
ResultSe tgetCheckEntityGroupList(BigDecimal pApplicationId)	結果セット内の確認ルール・グループのリストを返します。
ResultSet getCheckEntityForGroup	結果セット内の確認ルール・グループのルールのリストを返します。
ResultSet getCustomDBLog()	現在のプロセスについてデータベース表AIF_PROCESS_LOGSに記録されたエラー・メッセージを取得します。 getCustomDBLog()から返されるフィールド: ENTITY_TYPE ENTITY_NAME LOG_SEQUENCE
ResultSet getCustomDBLog(BigDecimal pLoadId)	指定のloadIDについてDBからログ文を返します。
ResultSet getCustomScriptParameters()	コンテキストの初期化済loadIDに対する結果セットのカスタム・スクリプト・パラメータ・リストを返します。
ResultSet getCustomScriptParameters(BigDecimal pLoadId)	指定のloadIDに対する結果セットのカスタム・スクリプト・パラメータ・リストを返します。
ResultSet getPeriodList()	結果セット内の期間のリストを返します。 getPeriodList()から返されるフィールド: PERIODKEY PERIODDESC
ResultSet executeQuery(String query, Object[] parameters)	任意のSQL問合せ文を実行します。問合せの結果が結果セットとして返されます。問合せおよびパラメータを指定します。パラメータはリストとして指定します。
ResultSet getImportFormatDetails(String pImpGroupKey)	インポート・フォーマット・キーに基づく結果セットとしてインポート・フォーマットの詳細を返します。 getImportFormatDetails(String pImpGroupKey)から返されるフィールド: IMPGROUPKEY IMPGROUPDESC IMPGROUPFILETYPE IMPGROUPDELIMITER IMPGROUPTYPE IMPSOURCESYSTEMID IMPSOURCELEDGERID IMPSOURCECOAID IMPTARGETAPPLICATIONID IMPADAPTERID IMPDRILLURLID IMPODISCENARIO IMPREGENSCEN IMPDRILLREQUESTMETHOD IMPDRILLURL IMPTARGETSOURCESYSTEMID
ResultSet getImportFormatMapDetails(String pImpGroupKey)	指定のインポート・フォーマット・キーに対する結果セットとしてインポート・フォーマット・マッピングの詳細を返します。現在、ファイルベースのインポート・フォーマットのみサポートされています。 getImportFormatMapDetails(String pImpGroupKey)から返されるフィールド: IMPSEQ IMPGROUPKEY IMPFLDFIELDNAME IMPFLDFIXEDTEXT IMPFLDSTARTPOS IMPFLDLENGTH IMPFLDSOURCECOLNAME
ResultSet getLocationDetails(BigDecimal pPartitionKey)	指定のロケーション・キーに対するレコード・セットとしてロケーションの詳細を返します。 getLocationDetailsから返されるフィールド: PARTITIONKEY PARTNAME PARTDESC PARTNOTES PARTLASTIMPFILE PARTLASTEXPFILE PARTIMPGROUP PARTLOGICGROUP PARTVALGROUP PARTVALENTGROUP PARTCURRENCYKEY PARTPARENT PARTTYPE PARTSEQMAP PARTDATAVALUE PARTSEGMENTKEY PARTCONTROLSTYPE PARTCONTROLSGROUP1 PARTCONTROLSGROUP2 PARTCONTROLSAPPROVER PARTCONTROLSAPPROVERPROXY PARTCONTROLSREDFLAGLEVEL PARTCLOGICGROUP PARTINTGCONFIG1 PARTINTGCONFIG2 PARTINTGCONFIG3 PARTINTGCONFIG4 PARTADAPTOR PARTSOURCESYSTEMID PARTSOURCELEDGERID PARTTARGETAPPLICATIONID PARTPARENTKEY PARTSOURCEAPPLICATIONID PARTTARGETSOURCESYSTEMID たとえば、getLocationDetails APIから返されるフィールドを確認する場合は、次のスクリプトを実行します: rs = fdmAPI.getLocationDetails(fdmContext["LOCKEY"]) i = 1 metaData = rs.getMetaData() while i <= metaData.getColumnCount(): fdmAPI.logDebug(metaData.getColumnLabel(i)) i +=1
ResultSet getRuleDetails(BigDecimal pRuleId)	指定のデータ・ルールIDに対するレコード・セットとしてデータ・ルールの詳細を返します。 getRuleDetails(BigDecimal pRuleId)から返されるフィールド: RULE_ID SOURCE_SYSTEM_ID SOURCE_LEDGER_ID APPLICATION_ID RULE_NAME RULE_DESCRIPTION PLAN_TYPE LEDGER_GROUP INCL_ZERO_BALANCE_FLAG BALANCE_SELECTION AMOUNT_TYPE BALANCE_METHOD_CODE BALANCE_TYPE BAL_SEG_VALUE_OPTION_CODE EXCHANGE_RATE_OPTION_CODE EXCHANGE_BEGIN_RATE_TYPE EXCHANGE_END_RATE_TYPE EXCHANGE_AVERAGE_RATE_TYPE DATA_SYNC_OBJECT DATA_SYNC_OBJECT_ID PARTCONTROLSAPPROVERPROXY PARTCONTROLSREDFLAGLEVEL STATUS PARTITIONKEY CATKEY INCLUDE_ADJ_PERIODS_FLAG BALANCE_AMOUNT_BS BALANCE_AMOUNT_IS AS_OF_DATE BLANK_PERIODKEY BR_MEMBER_NAME BR_MEMBER_DISP_NAME CALENDAR_ID CURRENCY_CODE DP_MEMBER_NAME FILE_NAME_DATE_FORMAT FILE_NAME_STATIC FILE_NAME_SUFFIX_TYPE FILE_PATH LEDGER_GROUP_ID PERIOD_MAPPING_TYPE VERSION SIGNAGE_METHOD DIRECT_FILE_LOAD_FLAG LOAD_OPTIONS RULE_ATTR1 RULE_ATTR2 RULE_ATTR3 RULE_ATTR4 ICP_LOAD MULTI_PERIOD_FILE_FLAG IMPGROUPKEY SOURCE_APP_PLAN_TYPE
showCustomDBLog()	プロセス完了後にユーザー・インタフェースにカスタム・メッセージ・リストを示します。メッセージは、データ・ロード・ワークフロー・ステップ(インポート、検証、エクスポート、確認など)の終了時、またはカスタム・スクリプト実行の終了時に表示できます。プロセスがオンライン・モードで実行される場合のみメッセージが表示されることに注意してください。
showCustomFile(String filePath)	プロセス完了後にユーザー・インタフェースにカスタム・ファイル(ログ・ファイル、レポート・ファイル)を表示します。メッセージは、データ・ロード・ワークフロー・ステップ(インポート、検証、エクスポート、確認など)の終了時、またはカスタム・スクリプト実行の終了時に表示できます。プロセスがオンライン・モードで実行される場合のみメッセージが表示されることに注意してください。
showCustomMessage(String message)	プロセス完了後にユーザー・インタフェースにカスタム・メッセージを示します。メッセージは、データ・ロード・ワークフロー・ステップ(インポート、検証、エクスポート、確認など)の終了時、またはカスタム・スクリプト実行の終了時に表示できます。プロセスがオンライン・モードで実行される場合のみメッセージが表示されることに注意してください。
String getCategoryMap(BigDecimal pCatKey,String pApplicationName)	指定のカテゴリおよびアプリケーション名のシナリオを返します。
String getCustomMessage()	現在のプロセスについて発行された最後のカスタム・メッセージを取得します。
String getCustomMessage(BigDecimal pLoadId)	指定のloadidについて発行された最後のカスタム・メッセージを取得します。
String getCustomFile()	現在のプロセスについて作成されたカスタム・ファイルを取得します。
String getCustomFile(BigDecimal pLoadId)	指定のloadidについて作成されたカスタム・ファイルを取得します。
String getPOVDataValue(BigDecimal pPartitionKey)	ロケーションのデータ値を返します。
String getDirTopLevel(BigDecimal pApplicationId)	アプリケーションに基づいて最上位レベル・ディレクトリを返します。
String getDirInbox(BigDecimal pApplicationId)	アプリケーションに基づいて`Inbox`ディレクトリを返します。
String getDirOutbox(BigDecimal pApplicationId)	アプリケーションに基づいて`Outbox`ディレクトリを返します。
String getDirScripts(BigDecimal pApplicationId)	アプリケーションに基づいて`Scripts`ディレクトリを返します。
String getProfileOptionValue(String pProfileOptionName, BigDecimal pApplicationId, String pUserName)	オプションの値セットを返します。オプションは、「システム設定」、「アプリケーション設定」および「ユーザー設定」で設定できます。優先順位は、ユーザー、アプリケーション、システムです。APIによって、適切な適用可能値が判別され、値が返されます。
void writeToProcessLogsDB(BigDecimal pLoadId, String pEntityType, String pEntityName, int pLogSequence,String pLogMessage)	ログ情報をAIF_PROCESS_LOGS表に書き込みます。エンティティ・タイプとエンティティ名を使用して、記録されたメッセージをグループ分けします。データ・ロード・ワークフロー・プロセスからのみログを作成できます。
void writeToProcessLogsFile(BigDecimal pLoadId, String pLogMessage)	ログ情報をデータ・ロード・プロセスのログ・ファイルに書き込みます。ログはプロセス・ログ・レベルに基づいて書き込まれます。データ・ロード・ワークフロー・プロセスからのみログを作成できます。注: writeToProcessLogsFile APIではなくロギングAPI (たとえば、logDebugまたはlogInfo API)を使用することをお薦めします。
void closeConnection()	データベース接続を閉じるために使用します。
void closeResultSet(ResultSet resultSet)	結果オブジェクトを閉じるために使用します。
void updateImportFormat(String pImpgroupKey,BigDecimal pLoadId)	現在の実行のインポート・フォーマットを更新します。これはファイルベースのインポート・フォーマットのみに適用できます。