call sub profile for source tree()
This function is used to call a profile (subprofile), whose target structure has been added to the source structure of this profile (substructure).
The function can be placed on any node or field of the target structure of this profile and can also be placed and called multiple times.
For details on the adding and the further procedure, see section "Profile in source structure (sub profile)". You will also find example profiles there.
Parameters
Parameter |
Description |
a |
Name of the added subprofile. Note: Is set automatically when the subprofile is added via the context menu. |
b |
If true, the time-driven Input Agent of the subprofile is started. This must be explicitly stated if the subprofile has a time-driven Input Agent, otherwise, it will not get any data. Alternatively see parameter c. Note: Is set automatically when the subprofile is added via the context menu. |
c |
If b has not been set, the input data for the subprofile must be specified here (as a string). |
d |
(optional) If true, phase 4 of the subprofile will not be executed. Default: false. |
e |
(optional) If true, phase 5 of the subprofile will not be executed. Default: false. |
f |
(optional) If true, phase 6 of the subprofile will not be executed. Default: false. |
g |
(optional) If true, the substructure h is emptied before the function is executed. Default: false. |
h |
The unique name of the substructure into which the result data of the called subrofile is written. Note: Is set automatically when the subprofile is added via the context menu. |
i |
(optional) If true, the backup file of the called subprofile will be deleted if it has been executed without error (corresponds to Keep backup for=0). Otherwise, the backup file is retained. If false, the backup file will always be retained. Default: false. |
j |
(optional) If true, the result of the subprofile call is stored in an internal cache . Default: false . Note : See parameter k . |
k |
(optional) If true, the subprofile is not called again if the internal cache already contains data (see parameter j ). Instead, the data of the cache is used. Default: false . |
Deactivating phases 4, 5, 6 of subprofile
Since only the generated target tree of the subprofile is placed into the calling profile, it is not necessary to go through phases 4, 5 and 6 of the subprofile. Of course, you can still use these phases in the subprofile if it helps you solve you particular problem, but you don't have to. To disable these phases, use parameters d, e and f.
Deleting backup file of subprofile call
If a subprofile is called, you are basically dealing with a normal profile call, i.e. the called subprofile is displayed in the Control Center as you know it. If your subprofile calls are rather high-frequency or consist of rather 'volatile' data, you have the possibility to delete the backup files of the subprofile calls via parameter i.
Collected data from subprofile calls
If you call a subprofile in a profile, the target tree created by the subprofile is inserted in the substructure of the calling profile. If you call the subprofile again, the target tree created there will be written into the substructure of the calling profile again. This means that you get multiples of the substructure, as you know it from normal profiles, e.g. when multiple items of a purchase order are read in. Of course, this can be useful if you want to use it that way on purpose. However, you also have the option of emptying the substructure before making the second subprofile call. To do this, use parameter g.
In addition, you can work with a cache. You can write the data of the first subprofile call into an internal cache with parameter j. In a further subprofile call you can then use parameter k to decide whether the subprofile is actually called again or whether the data from the internal cache (if available) should be used instead.
Passed variables, lists and maps
See section "Passed Variables, Lists and Maps (Profile Chains and Sub Profiles)".
Mapping test
In a mapping test, the substructure of the calling profile for the data from the subprofile is not displayed directly. However, there is a separate tab in the mapping test dialogue where you can see the data supplied by the subprofile.