7. Manage an Action File Export via Mail

A mail action export makes it possible to send data of a view or table via mail as soon as some application status has been reached.

Configure a proper e-mail body in ADM_MAIL_PARAMS first using API_REDADM.SET_MAIL_PARAM.

make sure that an application and proper export definitions already exist:

• Create an Application

• Add objects to an Application

• Add an export formatting rule

• Create an Action Export

7.1. Add a Mail Action Export to an Application

Use the script API_REDADM.ADD_APP_ACT_EXP_MAIL.

The example below creates an action (of type ‘export_mail’) which is triggered when the FINAL application status switches to FINISHED (which means that all depending tables have reached the status ‘FINISHED’)i with a delay of 60 sec. The action will create a file based on the export definition ‘test_exp’

• for the BDate 2024-08-01

• a mail template called ‘app_notify_final’ will be used

• the mail will be sent to ‘testuser@test.at’

• the mail will not be sent once more for the same BDate if on of the components woulkd have been reloaded for some reason The action will not be fired if a BDate swiches to ‘FINISHED’ which is older than 3 days from today.

Example

EXECUTE SCRIPT API_REDADM.ADD_APP_ACT_EXP_MAIL(
     'test_app'            -- p_app_name
     ,'tst_act'            -- p_action_name
     ,'test action'        -- p_description
     ,'FINAL'              -- p_finished_type
     ,'test_exp'           -- p_exp_name
     ,'app_notify_final'   -- p_mail_template
     ,'testuser@test.at'   -- p_recipients
     ,'2024-08-01'         -- p_valid_from_bdate
     ,false                -- p_active
     ,true                 -- p_run_once
     ,60                   -- p_run_delay
     ,3                    -- p_bdate_retention
);

After issuing this command a new entry is added to RED_APP_ACTIONS.

APP_NAME	ACTION_NAME	DESCRIPTION	FINISHED_TYPE	ACTION_TYPE	ACTION_PAR1	ACTION_PAR2	ACTION_PAR3	VALID_FROM_BDATE	ACTIVE	RUN_ONCE	RUN_DELAY	BDATE_RETENTION
test_app	tst_act	test action	FINAL	exp_mail	test_exp	app_notify_final	testuser@test.at	2024-08-01	false	true	60	3

7.2. Modify a Mail Action Export

For modification use the script API_REDADM.MODIFY_APP_ACT_EXP_MAIL. Providing NULL leaves the parameters as is, while a blank (’ ‘) restores the default value.

In the example below only the value for the mail template should be changed, while the rest remains the same. Change that parameter with caution as only mail templates which already exist in REDADM.ADM_MAIL_PARAMS can be used and the exact ID has to be provided.

Example

EXECUTE SCRIPT API_REDADM.MODIFY_APP_ACT_EXP_MAIL(
     'test_app'   -- p_app_name
     ,'tst_act'   -- p_action_name
     ,null        -- p_description
     ,null        -- p_finished_type
     ,null        -- p_exp_name
     ,'test'      -- p_mail_template
     ,null        -- p_recipients
     ,null        -- p_valid_from_bdate
     ,null        -- p_active
     ,null        -- p_run_once
     ,null        -- p_run_delay
     ,null        -- p_bdate_retention
);

After issuing this command the entry in RED_APP_ACTIONS will have changed as follows.

APP_NAME	ACTION_NAME	DESCRIPTION	FINISHED_TYPE	ACTION_TYPE	ACTION_PAR1	ACTION_PAR2	ACTION_PAR3	VALID_FROM_BDATE	ACTIVE	RUN_ONCE	RUN_DELAY	BDATE_RETENTION
test_app	tst_act	test action	FINAL	exp_mail	test_exp	test	testuser@test.at	2024-08-01	false	true	60	3

7.3. Remove a Mail Action Export

Remove any application action using the script API_REDADM.REMOVE_APP_ACTION.

Example

EXECUTE SCRIPT API_REDADM.REMOVE_APP_ACTION(
   'test_app'   -- p_app_name
   ,'tst_act'   -- p_action_name
);

After having issued the command above the entry in RED_APP_ACTIONS will have been removed.