Skip to main content
Newcomer
Mar 1, 2024 11:29 AM UTC

Automate workflow using BRAPi.Utilities.ExecuteFileHarvestBatch

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

7 replies

RobbSalzmann
Employee - Advisor
Employee - Advisor
Mar 1, 2024 12:01 PM UTC
MK3Author
Newcomer
Mar 1, 2024 12:56 PM UTC

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

RobbSalzmann
Employee - Advisor
Employee - Advisor
Mar 1, 2024 1:17 PM UTC

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)

Employee - Sage
Mar 1, 2024 12:02 PM UTC

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:

  1. In Business Rules, create a rule of type Extender
  2. place your code under the case ExecuteDataMgmtBusinessRuleStep and save
  3. In Data Management, create a Step of type Execute Business Rule
  4. Specify the Extender in the "Business Rule" property, and pass parameters if necessary.
  5. Assign the Step to a Sequence, or execute it directly.
MK3Author
Newcomer
Mar 1, 2024 7:25 PM UTC

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.

Employee - Sage
Mar 4, 2024 10:21 AM UTC

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