Skip to main content
Jul 29, 2025 2:01 PM UTC
Solved

Is it possible to retrieve values of additional options from the data management export step?

Hi OneStream Experts, 

Is it possible to extract the value of "options" from the data management export data step using a extensibility rule?



I used a syntax above to retrieve it. but, unfortunately no luck. 

Any help or suggestions are much appreciated.
Thank you. 

RobbSalzmann
Employee - Advisor
Jul 29, 2025 6:23 PM UTC

(being picky :) ) if your going to use interpolated string, then put the values in brackets:
BRApi.ErrorLog.LogMessage(si, $"IncludeZeros Value: {paramIZ}")

Alternatively you can log everything in the ExportDataDefinition object like this:

dim serializedExportDataDefinition as string = Newtonsoft.Json.JsonConvert.SerializeObject(args.DataMgmtArgs.CurrentStep.ExportDataDefinition, Formatting.Indented)
BRApi.ErrorLog.LogMessage(si, serializedExportDataDefinition)

' or access the DataFilters property directly:
Dim exportDataDefinitionDataFilters as List(Of string) = args.DataMgmtArgs.CurrentStep.ExportDataDefinition.DataFilters
Dim serializedExportDataDefinitionDataFilters as string = Newtonsoft.Json.JsonConvert.SerializeObject(exportDataDefinitionDataFilters, Formatting.Indented)
BRApi.ErrorLog.LogMessage(si, serializedExportDataDefinitionDataFilters)

These are all the properties available on args.DataMgmtArgs.CurrentStep.ExportDataDefinition:

UseDetailedLogging
FileShareFileName
IncludeCubeInFileName
IncludeEntityInFileName
IncludeParentInFileName
IncludeConsInFileName
IncludeScenarioInFileName
IncludeTimeInFileName
OverwriteExistingFiles
IncludeZeros
IncludeMemberDescriptions
IncludeCellAnnotations
IncludeInputData
IncludeCalculatedData
Cube
EntityFilter
ParentFilter
ConsFilter
ScenarioFilter
TimeFilter
ViewFilter
AccountFilter
FlowFilter
OriginFilter
ICFilter
UD1Filter
UD2Filter
UD3Filter
UD4Filter
UD5Filter
UD6Filter
UD7Filter
UD8FilterDataFilters

5 replies

Member
Jul 29, 2025 2:30 PM UTC

What are you trying to achieve with this?

 

Aug 1, 2025 6:00 AM UTC

Creating a dashboard for end users to extract data by themselves without giving access to Application tab. Thought of giving these additional options in the dashboard for their reference.

RobbSalzmann
Employee - Advisor
Employee - Advisor
Jul 29, 2025 6:23 PM UTC

(being picky :) ) if your going to use interpolated string, then put the values in brackets:
BRApi.ErrorLog.LogMessage(si, $"IncludeZeros Value: {paramIZ}")

Alternatively you can log everything in the ExportDataDefinition object like this:

dim serializedExportDataDefinition as string = Newtonsoft.Json.JsonConvert.SerializeObject(args.DataMgmtArgs.CurrentStep.ExportDataDefinition, Formatting.Indented)
BRApi.ErrorLog.LogMessage(si, serializedExportDataDefinition)

' or access the DataFilters property directly:
Dim exportDataDefinitionDataFilters as List(Of string) = args.DataMgmtArgs.CurrentStep.ExportDataDefinition.DataFilters
Dim serializedExportDataDefinitionDataFilters as string = Newtonsoft.Json.JsonConvert.SerializeObject(exportDataDefinitionDataFilters, Formatting.Indented)
BRApi.ErrorLog.LogMessage(si, serializedExportDataDefinitionDataFilters)

These are all the properties available on args.DataMgmtArgs.CurrentStep.ExportDataDefinition:

UseDetailedLogging
FileShareFileName
IncludeCubeInFileName
IncludeEntityInFileName
IncludeParentInFileName
IncludeConsInFileName
IncludeScenarioInFileName
IncludeTimeInFileName
OverwriteExistingFiles
IncludeZeros
IncludeMemberDescriptions
IncludeCellAnnotations
IncludeInputData
IncludeCalculatedData
Cube
EntityFilter
ParentFilter
ConsFilter
ScenarioFilter
TimeFilter
ViewFilter
AccountFilter
FlowFilter
OriginFilter
ICFilter
UD1Filter
UD2Filter
UD3Filter
UD4Filter
UD5Filter
UD6Filter
UD7Filter
UD8FilterDataFilters

Aug 1, 2025 6:01 AM UTC

Thanks a lot Robb

Aug 2, 2025 9:25 AM UTC

Hi,

Good Day !

 

This utility sounds very interesting. I had a similar idea in mind as well. Could you please share your final dashboard with me? I'm currently working on incorporating user details and timestamps along with the data.

Can you please help me with the information is this something already there with OneStream in anyone of the OneStream marketplace solution ? 

Thanks in advance!