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) 단일 기간을 로드하는 경우 LOADID를 기준으로 종료 기간의 기간 키를 반환합니다. 시작 기간과 종료 기간이 같습니다.
executePLSQL

PL/SQL(Procedural Language/Structured Query Language) 코드 블록을 실행합니다. 이 API는 다음 세 개의 매개변수를 사용합니다.

  • 문자열 - 적합한 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 쿼리,Object[] 매개변수) 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) //PERIODTARGET 및 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 쿼리, Object[] 매개변수) 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) 현재 실행에 대한 임포트 형식을 업데이트합니다. 파일 기반 임포트 형식에만 적용할 수 있습니다.