| BigDecimal getPOVLocation(BigDecimal pLoadId) | Returns the Partition Key based on the LOADID. |
| BigDecimal getPOVCategory(BigDecimal pLoadId) | Returns the Category Key based on the LOADID. |
| Date getPOVStartPeriod(BigDecimal pLoadId) | Returns the Period Key of the start period based on the LOADID. |
| Date getPOVEndPeriod(BigDecimal pLoadId) | Returns the Period Key of the end period based on the LOADID.when loading single period the start period and end period are the same. |
| int executeDML(String query,Object[] parameters) | Execute any DML Statement. Provide the query and parameter. The parameter is provided as a list. |
| logDB(String pEntityType, String pEntityName, int pLogSequence, String pLogMessage) | Log messages to a database table AIF_PROCESS_LOGS. |
| logFatal(String pLogMessage) | Log a message when a fatal error occurs. This message is displayed at all log levels. |
| logError(String pLogMessage) | Log a message when a error occurs. This message is displayed at log level 2 or higher. |
| logWarn(String pLogMessage) | Log a message when a warning condition error occurs. This message is displayed at log level 3 or higher. |
| logInfo(String pLogMessage) | Log a informational message. This message is displayed at log level 4 or higher. |
| logDebug(String pLogMessage) | Log a debug message. This message is displayed at log level 5. |
| Map getProcessStates(BigDecimal pLoadId) | Returns status of Workflow process. Available statuses: IMPSTATUS—Returns the status of the import process. A 0 status indicates that the process has not yet started, or the process failed. A 1 status indicates the process is successful. VALSTATUS—Returns the status of validation process. A 0 status indicates that the process has not yet started, or the process failed. A 1 status indicates the process is successful. EXPSTATUS—Returns the status of export process. A 0 status indicates that the process has not yet started, or the process failed. A 1 status indicates the process is successful. CHKSTATUS—Returns the status of check process. A 0 status indicates that the process has not yet started, or the process failed. A 1 status indicates the process is successful. PROCESSSTATUS—Returns the exact error code. The detail for the error code can be found in the tlogprocessstates table.
|
| Map getPeriodDetail(Date pPeriodKey,String pApplicationName) //returns PERIODTARGET and YEARTARGET | Returns the Target period mapping for a given Period key. |
| Object getCustomScriptParameterValue(BigDecimal pLoadId,String pParameterName) | Returns the value for given custom script parameter name and loadID. |
| Object getCustomScriptParameterValue(String pParameterName) | Returns the value for given custom script parameter name and context initialized loaded, |
| ResultSet getBatchDetails() | Returns batch definition information from AIF_BATCHES table. |
| ResultSet getBatchJobDetails(BigDecimal pLoadId) | Retrieve error messages logged to the database table AIF_PROCESS_LOGS for the given loadid. |
| ResultSet getCategoryList() | Returns list of Categories in a result set. |
| ResultSet getCheckEntityGroupList(BigDecimal pApplicationId) | Returns list of Check Group in a result set. |
| ResultSet getCheckEntityForGroup(String pValGroupKey) | Returns list of Entity in a Check Group in a result set. |
| ResultSe tgetCheckEntityGroupList(BigDecimal pApplicationId) | Returns list of Check Rule Group in a result set. |
| ResultSet getCheckEntityForGroup | Returns list of Check Rule Group rules in a result set. |
| ResultSet getCustomDBLog() | Retrieve error messages logged to the database table AIF_PROCESS_LOGS for the current process. |
| ResultSet getCustomDBLog(BigDecimal pLoadId) | Returns the log statements from DB for a given loadID |
| ResultSet getCustomScriptParameters() | Returns the list of custom script parameters in a resultset for the context initialized loadID. |
| ResultSet getCustomScriptParameters(BigDecimal pLoadId) | Returns the list of custom script parameters in a resultset for the given loadID |
| ResultSet getPeriodList() | Returns list of Periods in a result set. |
| ResultSet executeQuery(String query, Object[] parameters) | Execute any SQL Query Statement. The query results are returned in a result set. Provide the query and parameter. The parameter is provided as a list. |
| ResultSet getImportFormatDetails(String pImpGroupKey) | Returns the Import Format details in a result set based on the Import Format key. |
| ResultSet getImportFormatMapDetails(String pImpGroupKey) | Returns the Import Format Mapping details in a result set for a given Import Format key. This currently supports only file based import formats. |
| ResultSet getLocationDetails(BigDecimal pPartitionKey) | Returns the Location details in a record set for a given Location key. |
| ResultSet getRuleDetails(BigDecimal pRuleId) | Returns the Data Rule details in a record set for a given Data Rule ID. |
| showCustomDBLog() | Show a list of custom messages in the user interface after completion of a process. Message can be displayed at the end of a data load workflow step like import, validate, export, check or at the end of a custom script execution. Note messages are displayed only when the process are run in online mode. |
| showCustomFile(String filePath) | Show a custom file (log file, report file) in the user interface after completion of a process. Message can be displayed at the end of a data load workflow step like import, validate, export, check or at the end of a custom script execution. Note messages are displayed only when the process are run in online mode. |
| showCustomMessage(String message) | Show a custom message in the user interface after completion of a process. Message can be displayed at the end of a data load workflow step like import, validate, export, check or at the end of a custom script execution. Note messages are displayed only when the process are run in online mode. |
| String getCategoryMap(BigDecimal pCatKey,String pApplicationName) | Returns the Scenario for a given Category and Application Name. |
| String getCustomMessage() | Retrieve the last custom message raised for the current process. |
| String getCustomMessage(BigDecimal pLoadId) | Retrieve the last custom message raised for the given loadid. |
| String getCustomFile() | Retrieve the custom file created for the current process. |
| String getCustomFile(BigDecimal pLoadId) | Retrieve the custom file created for the given loadid. |
| String getPOVDataValue(BigDecimal pPartitionKey) | Returns the data value of the Location. |
| String getDirTopLevel(BigDecimal pApplicationId) | Returns the Top Level directory based on the Application. |
| String getDirInbox(BigDecimal pApplicationId) | Returns the Inbox directory based on the Application. |
| String getDirOutbox(BigDecimal pApplicationId) | Returns the Outbox directory based on the Application. |
| String getDirScripts(BigDecimal pApplicationId) | Returns the Scripts directory based on the Application. |
| String getProcessLogFile(BigDecimal pLoadId) | Returns the log file name for the given loadID. |
| String getProfileOptionValue(String pProfileOptionName, BigDecimal pApplicationId, String pUserName) | Returns the value set for an option. Options can be set at the System Setting, Application Setting, and User Setting. The order of precedence is: User, Application, and System. The API determines the appropriate applicable value and returns the value. |
| void writeToProcessLogsDB(BigDecimal pLoadId, String pEntityType, String pEntityName, int pLogSequence,String pLogMessage) | Writes the log information to the AIF_PROCESS_LOGS table. Use Entity Type and Entity Name to group the logged messages. Logs can be created only from a data load workflow process. |
| void writeToProcessLogsFile(BigDecimal pLoadId, String pLogMessage) | Writes the log information to the Data Load Process log file. The logs is written based on the process log level. Logs can be created only from a data load workflow process.Note: It is recommended that you use the logging API, for example logDebug or, logInfo API, instead of using the writeToProcessLogsFile API. |
| void closeConnection() | Use to close the database connection. |
| void closeResultSet(ResultSet resultSet) | Use to close result object. |
| void updateImportFormat(String pImpgroupKey,BigDecimal pLoadId) | Update the import format for the current run. This is applicable only for File-based import formats. |