Automate workflow using BRAPi.Utilities.ExecuteFileHarvestBatch

Forum|Forum|2 years ago
March 1, 2024
2 replies
0 views

Hi

Can I please get the working example of workflow automation using BRAPi.Utilities.ExecuteFileHarvestBatch function.

My workflow works fine manually, and it is connector based. And I wanted to automate using ExecuteFileHarvestBatch.

Thanks,

Manju K

Workflow

Here is a working example:

https://community.onestreamsoftware.com/t5/Workflow-and-Data-Integration/Batch-Loads-Freeze/m-p/17973/highlight/true#M1226

MK4Author

Thank you for your response, in this example, how it knows which workflow to execute?

Hi MK The process happens in the context DataMamangement. JackLacava provides a good outline of this below.
The specific load process run by ExecuteFileHarvestBatch is controlled by the filename(s) in the batch directory.

Re: Problem with Harvest Directory - OneStream Community (onestreamsoftware.com)

It's in the Accepted Code Samples section, which can be found by searching the site (the search box at the top of the page). https://community.onestreamsoftware.com/t5/Accepted-Code-Samples/Extender-automate-Import-Validate-Load/ta-p/6915

Edit: if you are not familiar with general automation via rules, the process is:

In Business Rules, create a rule of type Extender
place your code under the case ExecuteDataMgmtBusinessRuleStep and save
In Data Management, create a Step of type Execute Business Rule
Specify the Extender in the "Business Rule" property, and pass parameters if necessary.
Assign the Step to a Sequence, or execute it directly.

MK4Author

Thank you for the reply. It is very helpful.

I am looking for detailed understanding of ExecuteFileHarvestBatch function. Please share the reference urls, or function definition.

If you search for ExecuteFileHarvestBatch in the online documentation, you'll find this: https://documentation.onestream.com/release_8.1/Content/Design%20and%20Reference/Workflow%20Guides/Setting%20Up%20and%20Using%20Batch.html

You can also explore and drill through the helper tree you find beside the rule editor. I described the approach (for another function) here: https://community.onestreamsoftware.com/t5/Rules/Move-file-from-File-Explorer-to-File-Share/m-p/30956#M3048