2. Manage a CFI Loader¶
2.1. Add a CFI Loader¶
Use API_CFIADM.ADD_LOADER to add a new loader:
- p_ldr_name
Unique name of the loader (converted to upper case).
- p_tsa_retention
Number of days the data remains in the TSA table before it is removed (default 10).
- p_priority
Order in which pending loads of the same loader and BDomain are executed; lower values are loaded first (default 999).
- p_use_ultimo_shift
If true, the BDate of a business ultimo is shifted to the calendar ultimo (default false).
Example: Add the Loader ‘PERSON’
1EXECUTE SCRIPT API_CFIADM.ADD_LOADER(
2 'PERSON' -- p_ldr_name
3 ,null -- p_tsa_retention (default 10)
4 ,100 -- p_priority
5 ,true -- p_use_ultimo_shift
6);
This command creates a new entry in the table CFIADM.CFI_LOADER.
LDR_NAME |
TSA_RETENTION |
PRIORITY |
USE_ULTIMO_SHIFT |
|---|---|---|---|
PERSON |
10 |
100 |
true |
2.2. Modify a CFI Loader¶
Modify a loader with API_CFIADM.MODIFY_LOADER. The loader name cannot be changed, but all other parameters can. NULL leaves a parameter unchanged, while a blank (’ ‘) restores its default value. In the following example the retention period is changed and the ultimo shift is deactivated, while the priority stays the same.
Example: Change Retention and Ultimo Shift
1EXECUTE SCRIPT API_CFIADM.MODIFY_LOADER(
2 'PERSON' -- p_ldr_name
3 ,3 -- p_tsa_retention
4 ,null -- p_priority
5 ,false -- p_use_ultimo_shift
6);
The entry for loader ‘PERSON’ in CFIADM.CFI_LOADER has changed:
LDR_NAME |
TSA_RETENTION |
PRIORITY |
USE_ULTIMO_SHIFT |
|---|---|---|---|
PERSON |
3 |
100 |
false |
2.3. Remove a CFI Loader¶
To remove a CFI loader, pass its name to API_CFIADM.REMOVE_LOADER:
Example: Remove the Loader ‘PERSON’
1EXECUTE SCRIPT API_CFIADM.REMOVE_LOADER(
2 'PERSON' -- p_ldr_name
3);
The entry of loader ‘PERSON’ is removed from CFIADM.CFI_LOADER.