Tabla 7-3 Lista de API de JAVA
API | Descripción |
---|---|
BigDecimal getPOVLocation(BigDecimal pLoadId) | Devuelve la clave de partición según el ID de carga. |
BigDecimal getPOVCategory(BigDecimal pLoadId) | Devuelve la clave de categoría según el ID de carga. |
Date getPOVStartPeriod(BigDecimal pLoadId) | Devuelve la clave de periodo del periodo inicial según el ID de carga. |
Date getPOVEndPeriod(BigDecimal pLoadId) | Devuelve la clave de periodo del periodo final según el ID de carga cuando al cargar un único periodo, el periodo inicial y final son el mismo. |
executePLSQL |
Ejecuta un bloque de código de lenguaje procedural/lenguaje de consulta estructurado (PL/SQL). La API toma los tres parámetros siguientes:
Este es un ejemplo de cómo se ejecuta el 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 devuelve las siguientes columnas para cada trabajo enviado por el lote:
|
int executeDML(String query,Object[] parameters) | Permite ejecutar cualquier sentencia DML. Proporcione la consulta y el parámetro. El parámetro se proporciona como una lista. |
logDB(String pEntityType, String pEntityName, int pLogSequence, String pLogMessage) | Registra mensajes en una tabla de base de datos AIF_PROCESS_LOGS. |
logFatal(String pLogMessage) | Registra un mensaje cuando se produce un error fatal. Este mensaje se muestra en todos los niveles de registro. |
logError(String pLogMessage) | Registra un mensaje cuando se produce un error. Este mensaje se muestra en el nivel de registro 2 o superior. |
logWarn(String pLogMessage) | Registra un mensaje cuando se produce un error de condición de advertencia. Este mensaje se muestra en el nivel de registro 3 o superior. |
logInfo(String pLogMessage) | Registra un mensaje informativo. Este mensaje se muestra en el nivel de registro 4 o superior. |
logDebug(String pLogMessage) | Registra un mensaje de depuración. Este mensaje se muestra en el nivel de registro 5. |
Map getProcessStates(BigDecimal pLoadId) |
Devuelve el estado del proceso de flujo de trabajo. Estados disponibles:
|
Map getPeriodDetail(Date pPeriodKey,String pApplicationName) //devuelve PERIODTARGET y YEARTARGET | Devuelve la asignación de periodo objetivo para una clave de periodo determinada. |
Object getCustomScriptParameterValue(BigDecimal pLoadId,String pParameterName) | Devuelve el valor para el nombre de parámetro de script personalizado e ID de carga. |
Object getCustomScriptParameterValue(String pParameterName) | Devuelve el valor para el nombre de parámetro de script personalizado proporcionado y el contexto inicializado cargado. |
ResultSet getBatchDetails() |
Devuelve la información de definición de lote de la tabla AIF_BATCHES. Campos que devuelve getBatchDetails():
|
ResultSet getBatchJobDetails(BigDecimal pLoadId) | Recupera mensajes de error registrados en la tabla de base de datos AIF_PROCESS_LOGS para el ID de carga determinado. |
ResultSet getCategoryList() |
Devuelve una lista de categorías en un conjunto de resultados. Campos que devuelve getCategoryList():
|
ResultSet getCheckEntityGroupList(BigDecimal pApplicationId) | Devuelve una lista de grupos de comprobación en un conjunto de resultados. |
ResultSet getCheckEntityForGroup(String pValGroupKey) | Devuelve una lista de entidades de un grupo de comprobación en un conjunto de resultados. |
ResultSe tgetCheckEntityGroupList(BigDecimal pApplicationId) | Devuelve una lista de grupos de reglas de comprobación en un conjunto de resultados. |
ResultSet getCheckEntityForGroup | Devuelve una lista de reglas de grupo de reglas de comprobación en un conjunto de resultados. |
ResultSet getCustomDBLog() |
Recupera mensajes de error registrados en la tabla de base de datos AIF_PROCESS_LOGS para el proceso actual. Campos que devuelve getCustomDBLog():
|
ResultSet getCustomDBLog(BigDecimal pLoadId) | Devuelve las sentencias de registro de la base de datos para un ID de carga determinado. |
ResultSet getCustomScriptParameters() | Devuelve la lista de parámetros del script personalizado en un conjunto de resultados para el ID de carga inicializado por el contexto. |
ResultSet getCustomScriptParameters(BigDecimal pLoadId) | Devuelve la lista de los parámetros del script personalizado en un conjunto de resultados para el ID de carga determinado. |
ResultSet getPeriodList() |
Devuelve una lista de periodos en un conjunto de resultados. Campos que devuelve getPeriodList():
|
ResultSet executeQuery(String query, Object[] parameters) | Ejecuta cualquier sentencia de consulta SQL. Los resultados de la consulta se devuelven en un conjunto de resultados. Proporcione la consulta y el parámetro. El parámetro se proporciona como una lista. |
ResultSet getImportFormatDetails(String pImpGroupKey) |
Devuelve los detalles del formato de importación en un conjunto de resultados según la clave de formato de importación. Campos que devuelve getImportFormatDetails(String pImpGroupKey):
|
ResultSet getImportFormatMapDetails(String pImpGroupKey) |
Devuelve los detalles de asignación del formato de importación en un conjunto de resultados para una clave de formato de importación determinada. Actualmente solo soporta formatos de importación basados en archivo. Campos que devuelve getImportFormatMapDetails(String pImpGroupKey):
|
ResultSet getLocationDetails(BigDecimal pPartitionKey) |
Devuelve los detalles de ubicación en un conjunto de registros para una clave de ubicación determinada. Campos que devuelve getLocationDetails:
Por ejemplo, si desea conocer los campos que devuelve la API getLocationDetails, ejecute el siguiente 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) |
Devuelve los detalles de la regla de datos en un conjunto de registros para un ID de regla de datos determinado. Campos que devuelve getRuleDetails(BigDecimal pRuleId):
|
showCustomDBLog() | Muestra una lista de mensajes personalizados en la interfaz de usuario después de terminar un proceso. El mensaje se puede mostrar al final de un paso de flujo de trabajo de carga de datos, como importar, validar, exportar, comprobar o al final de una ejecución de script personalizado. Tenga en cuenta que los mensajes se muestran solo cuando el proceso se ejecuta en el modo en línea. |
showCustomFile(String filePath) | Muestra un archivo personalizado (archivo de registro, archivo de informe) en la interfaz de usuario después de terminar un proceso. El mensaje se puede mostrar al final de un paso de flujo de trabajo de carga de datos, como importar, validar, exportar, comprobar o al final de una ejecución de script personalizado. Tenga en cuenta que los mensajes se muestran solo cuando el proceso se ejecuta en el modo en línea. |
showCustomMessage(String message) | Muestra un mensaje personalizado en la interfaz de usuario después de terminar un proceso. El mensaje se puede mostrar al final de un paso de flujo de trabajo de carga de datos, como importar, validar, exportar, comprobar o al final de una ejecución de script personalizado. Tenga en cuenta que los mensajes se muestran solo cuando el proceso se ejecuta en el modo en línea. |
String getCategoryMap(BigDecimal pCatKey,String pApplicationName) | Devuelve el escenario para una categoría y nombre de aplicación determinados. |
String getCustomMessage() | Recupera el último mensaje personalizado emitido para el proceso actual. |
String getCustomMessage(BigDecimal pLoadId) | Recupera el último mensaje personalizado emitido para el ID de carga determinado. |
String getCustomFile() | Recuperar el archivo personalizado creado para el proceso actual. |
String getCustomFile(BigDecimal pLoadId) | Recuperar el archivo personalizado creado para el ID de carga actual. |
String getPOVDataValue(BigDecimal pPartitionKey) | Devuelve el valor de datos de la ubicación. |
String getDirTopLevel(BigDecimal pApplicationId) | Devuelve el directorio de nivel superior según la aplicación. |
String getDirInbox(BigDecimal pApplicationId) | Devuelve el directorio Inbox según la aplicación. |
String getDirOutbox(BigDecimal pApplicationId) | Devuelve el directorio Outbox según la aplicación. |
String getDirScripts(BigDecimal pApplicationId) | Devuelve el directorio Scripts según la aplicación. |
String getProfileOptionValue(String pProfileOptionName, BigDecimal pApplicationId, String pUserName) | Devuelve el valor establecido para una opción. Las opciones se pueden establecer en Configuración del sistema, Configuración de aplicación y Configuración de usuario. El orden de prioridad es: Usuario, Aplicación y Sistema. La API determina el valor aplicable adecuado y devuelve el valor. |
void writeToProcessLogsDB(BigDecimal pLoadId, String pEntityType, String pEntityName, int pLogSequence,String pLogMessage) | Escribe la información de registro en la tabla AIF_PROCESS_LOGS. Utiliza Tipo de entidad y Nombre de entidad para agrupar mensajes registrados. Los registros solo se pueden crear a partir de un proceso de flujo de trabajo de carga de datos. |
void writeToProcessLogsFile(BigDecimal pLoadId, String pLogMessage) |
Escribe la información de registro en el archivo de registro del proceso de carga de datos. Los registros se escriben según el nivel de registro del proceso. Los registros solo se pueden crear a partir de un proceso de flujo de trabajo de carga de datos. Nota: Se recomienda utilizar la API de registro, por ejemplo, logDebug o la API logInfo, en lugar de utilizar la API writeToProcessLogsFile. |
void closeConnection() | Se utiliza para cerrar la conexión a base de datos. |
void closeResultSet(ResultSet resultSet) | Se utiliza para cerrar el objeto de resultado. |
void updateImportFormat(String pImpgroupKey,BigDecimal pLoadId) | Actualiza el formato de importación para la ejecución actual. Solo se aplica para formatos de importación basados en archivo. |