Lista de APIs JAVA

Tabela 7-3 Lista de APIs JAVA

API	Descrição
BigDecimal getPOVLocation(BigDecimal pLoadId)	Retorna a Chave de Partição baseada no LOADID.
BigDecimal getPOVCategory(BigDecimal pLoadId)	Retorna a Chave de Categoria baseada no LOADID.
Date getPOVStartPeriod(BigDecimal pLoadId)	Retorna a Chave de Período do período de início com base no LOADID.
Date getPOVEndPeriod(BigDecimal pLoadId)	Retorna a Chave de Período do período de término com base no LOADID. Durante o carregamento de períodos únicos, o período de início e o período de término são iguais.
executePLSQL	Executa um bloco do código PL/SQL (Procedural Language/Structured Query Language). Essa API usa os três seguintes parâmetros: String — Um bloco válido de código PL/SQL. O bloco PL/SQL deve ser colocado entre aspas duplas. Matriz de objetos — Uma matriz de entrada de objetos Java (por exemplo, String, BigDecimal) representando parâmetros de entrada ao bloco de código. A matriz de objetos é usada para inserção no PL/SQL onde há espaços reservados (pontos de interrogação). Booliano — se uma confirmação deve ou não ser executada O valor Booliano é True ou False. Um exemplo de como executar o 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	A getBatchJobDetails retorna a seguinte coluna para cada job enviado pelo lote: 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)	Executa qualquer Instrução DML. Fornece a consulta e o parâmetro. O parâmetro é fornecido como uma lista.
logDB(String pEntityType, String pEntityName, int pLogSequence, String pLogMessage)	Registra mensagens em uma tabela do banco de dados AIF_PROCESS_LOGS.
logFatal(String pLogMessage)	Registra uma mensagem quando ocorre um erro fatal. Essa mensagem é exibida em todos os níveis de log.
logError(String pLogMessage)	Registra uma mensagem quando ocorre um erro. Essa mensagem é exibida no nível de log 2 ou superior.
logWarn(String pLogMessage)	Registra uma mensagem quando ocorre um erro de condição de aviso. Essa mensagem é exibida no nível de log 3 ou superior.
logInfo(String pLogMessage)	Registra uma mensagem informativa. Essa mensagem é exibida no nível de log 4 ou superior.
logDebug(String pLogMessage)	Registra uma mensagem de depuração. Essa mensagem é exibida no nível de log 5.
Mapear getProcessStates(BigDecimal pLoadId)	Retorna o status de processo de workflow. Status disponíveis: IMPSTATUS — Retorna o status do processo de importação. Um status de 0 indica que o processo ainda não foi iniciado ou o processo falhou. Um status de 1 indica que o processo é bem-sucedido. VALSTATUS — Retorna o status do processo de validação. Um status de 0 indica que o processo ainda não foi iniciado ou o processo falhou. Um status de 1 indica que o processo é bem-sucedido. EXPSTATUS — Retorna o status do processo de exportação. Um status de 0 indica que o processo ainda não foi iniciado ou o processo falhou. Um status de 1 indica que o processo é bem-sucedido. CHKSTATUS — Retorna o status do processo de verificação. Um status de 0 indica que o processo ainda não foi iniciado ou o processo falhou. Um status de 1 indica que o processo é bem-sucedido. PROCESSSTATUS — Retorna o código de erro exato. Os detalhes do código de erro podem ser encontrados na tabela tlogprocessstates.
Mapear getPeriodDetail(Date pPeriodKey,String pApplicationName) //retorna PERIODTARGET e YEARTARGET	Retorna o mapeamento do período de Destino para uma determinada chave de Período.
Object getCustomScriptParameterValue(BigDecimal pLoadId,String pParameterName)	Retorna o valor de determinado nome de parâmetro de script personalizado e loadID.
Object getCustomScriptParameterValue(String pParameterName)	Retorna o valor de um determinado nome de parâmetro de script personalizado e contexto carregado inicializado.
ResultSet getBatchDetails()	Retorna informações de definição de lote da tabela AIF_BATCHES. Os campos retornados por getBatchDetails(): BATCH_ID BATCH_NAME APPLICATION_ID BATCH_TYPE BATCH_EXECUTION_MOD
ResultSet getBatchJobDetails(BigDecimal pLoadId)	Recupera mensagens de erro registradas na tabela de banco de dados AIF_PROCESS_LOGS para um determinado loadid.
ResultSet getCategoryList()	Retorna uma lista de Categorias em um conjunto de resultados. Os campos retornados por getCategoryList(): CATKEY CATNAME
ResultSet getCheckEntityGroupList(BigDecimal pApplicationId)	Retorna uma lista de Grupos de Verificação em um conjunto de resultados.
ResultSet getCheckEntityForGroup(String pValGroupKey)	Retorna uma lista de Entidades em um Grupo de Verificação em um conjunto de resultados.
ResultSet getCheckEntityGroupList(BigDecimal pApplicationId)	Retorna uma lista de Grupos de Regras de Verificação em um conjunto de resultados.
ResultSet getCheckEntityForGroup	Retorna uma lista de regras de Grupos de Regras de Verificação em um conjunto de resultados.
ResultSet getCustomDBLog()	Recupera mensagens de erro registradas na tabela de banco de dados AIF_PROCESS_LOGS para o processo atual. Os campos retornados por getCustomDBLog(): ENTITY_TYPE ENTITY_NAME LOG_SEQUENCE
ResultSet getCustomDBLog(BigDecimal pLoadId)	Retorna as instruções de log do BD para um determinado loadID.
ResultSet getCustomScriptParameters()	Retorna a lista de parâmetros de scripts personalizados em um conjunto de resultados para o loadID inicializado por contexto.
ResultSet getCustomScriptParameters(BigDecimal pLoadId)	Retorna a lista de parâmetros de script personalizado em um conjunto de resultados para o loadID especificado.
ResultSet getPeriodList()	Retorna uma lista de Períodos em um conjunto de resultados. Os campos retornados por getPeriodList(): PERIODKEY PERIODDESC
ResultSet executeQuery(String query, Object[] parameters)	Executa qualquer Instrução de Consulta SQL. Os resultados da consulta são retornados em um conjunto de resultados. Fornece a consulta e o parâmetro. O parâmetro é fornecido como uma lista.
ResultSet getImportFormatDetails(String pImpGroupKey)	Retorna os detalhes do Formato de Importação em um conjunto de resultados com base na chave do Formato de Importação. Os campos retornados por getImportFormatDetails(String pImpGroupKey): IMPGROUPKEY IMPGROUPDESC IMPGROUPFILETYPE IMPGROUPDELIMITER IMPGROUPTYPE IMPSOURCESYSTEMID IMPSOURCELEDGERID IMPSOURCECOAID IMPTARGETAPPLICATIONID IMPADAPTERID IMPDRILLURLID IMPODISCENARIO IMPREGENSCEN IMPDRILLREQUESTMETHOD IMPDRILLURL IMPTARGETSOURCESYSTEMID
ResultSet getImportFormatMapDetails(String pImpGroupKey)	Retorna os detalhes do Mapeamento do Formato de Importação em um conjunto de resultados para uma chave de Formato de Importação. Atualmente, isso suporta apenas os formatos de importação baseados em arquivo. Os campos retornados por getImportFormatMapDetails(String pImpGroupKey): IMPSEQ IMPGROUPKEY IMPFLDFIELDNAME IMPFLDFIXEDTEXT IMPFLDSTARTPOS IMPFLDLENGTH IMPFLDSOURCECOLNAME
ResultSet getLocationDetails(BigDecimal pPartitionKey)	Retorna os detalhes de Local em um conjunto de registros para uma chave de Local especificada. Os campos retornados por 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 Por exemplo, se você desejar conhecer os campos retornados pela API getLocationDetails, execute o seguinte script: 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)	Retorna os detalhes da Regra de Dados em um conjunto de registros para um ID de Regra de Dados especificado. Os campos retornados por 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()	Mostra uma lista de mensagens personalizadas na interface do usuário após a conclusão de um processo. A mensagem pode ser exibida no fim da etapa do workflow de carregamento de dados, como importação, validação, exportação, verificação ou no fim de uma execução de script personalizada. Mensagens de nota serão exibidas somente quando os processos forem executados no modo on-line.
showCustomFile(String filePath)	Mostra um arquivo personalizado (arquivo de log, arquivo de relatório) na interface do usuário após a conclusão de um processo. A mensagem pode ser exibida no fim da etapa do workflow de carregamento de dados, como importação, validação, exportação, verificação ou no fim de uma execução de script personalizada. Mensagens de nota serão exibidas somente quando os processos forem executados no modo on-line.
showCustomMessage(String message)	Mostra uma mensagem personalizada na interface do usuário após a conclusão de um processo. A mensagem pode ser exibida no fim da etapa do workflow de carregamento de dados, como importação, validação, exportação, verificação ou no fim de uma execução de script personalizada. Mensagens de nota serão exibidas somente quando os processos forem executados no modo on-line.
String getCategoryMap(BigDecimal pCatKey,String pApplicationName)	Retorna o Cenário para uma Categoria e Nome de Aplicativo especificados.
String getCustomMessage()	Recupera a última mensagem personalizada gerada para o processo atual.
String getCustomMessage(BigDecimal pLoadId)	Recupera a última mensagem personalizada gerada para o loadid especificado.
String getCustomFile()	Recupera o arquivo personalizado criado para o processo atual.
String getCustomFile(BigDecimal pLoadId)	Recupera o arquivo personalizado criado para o loadid especificado.
String getPOVDataValue(BigDecimal pPartitionKey)	Retorna o valor de dados do Local.
String getDirTopLevel(BigDecimal pApplicationId)	Retorna o diretório de nível superior baseado no Aplicativo.
String getDirInbox(BigDecimal pApplicationId)	Retorna o diretório `Inbox` baseado no Aplicativo.
String getDirOutbox(BigDecimal pApplicationId)	Retorna o diretório `Outbox` baseado no Aplicativo.
String getDirScripts(BigDecimal pApplicationId)	Retorna o diretório `Scripts` baseado no Aplicativo.
String getProfileOptionValue(String pProfileOptionName, BigDecimal pApplicationId, String pUserName)	Retorna o conjunto de valores para uma opção. As opções podem ser definidas nas Configurações do Sistema, Configurações do Aplicativo e Configurações do Usuário. A ordem de precedência é: Usuário, Aplicativo e Sistema. A API determina o valor aplicável apropriado e retorna o valor.
void writeToProcessLogsDB(BigDecimal pLoadId, String pEntityType, String pEntityName, int pLogSequence,String pLogMessage)	Grava as informações de log na tabela AIF_PROCESS_LOGS. Usa Tipo de Entidade e Nome da Entidade para agrupar as mensagens de log. Os logs podem ser criados apenas com base em um processo de workflow de carregamento de dados.
void writeToProcessLogsFile(BigDecimal pLoadId, String pLogMessage)	Grava as informações de log no arquivo de log do Processo de Carregamento de Dados. Os logs são gravados com base no nível de log do processo. Os logs podem ser criados apenas com base em um processo de workflow de carregamento de dados. Nota: É recomendável que você use a API de log, por exemplo, logDebug ou logInfo, em vez de usar a API writeToProcessLogsFile.
void closeConnection()	Usada para fechar a conexão de banco de dados.
void closeResultSet(ResultSet resultSet)	Usada para fechar o objeto de resultado.
void updateImportFormat(String pImpgroupKey,BigDecimal pLoadId)	Atualiza o formato de importação para a execução atual. É aplicável somente para formatos de importação baseados em arquivo.