Skip to main content
K
Kai
February 8, 2024
Solved

UserState Parameter in the Api.Data.Calculate

  • February 8, 2024
  • 2 replies
  • 0 views

May I have an example of using UserState Parameter in the Api.Data.Calculate? Thank you

 

Best answer by RobbSalzmann

Hi  Kai,

you may have noted this is an optional parameter, so you can leave it out.

Instantiating a XFUserState object involves this API:
Dim objXFUserState As XFUserState = BRApi.State.GetUserState(si, isSystemLevel, clientModuleType, relatedObjectType, relatedObjectName, key1, key2)

XFUserState appears to be related to the user's session state and activitiy.  It seems pretty useless in the context of writing business rules in a business setting.

MMomentoff #Abstraction.  The exposed method signature for Api.Data.Calculate could be wrapped within a method whose signature only requires arguments a business user can reasonably supply.

 

2 replies

R
RobbSalzmannAnswer
February 8, 2024

Hi  Kai,

you may have noted this is an optional parameter, so you can leave it out.

Instantiating a XFUserState object involves this API:
Dim objXFUserState As XFUserState = BRApi.State.GetUserState(si, isSystemLevel, clientModuleType, relatedObjectType, relatedObjectName, key1, key2)

XFUserState appears to be related to the user's session state and activitiy.  It seems pretty useless in the context of writing business rules in a business setting.

MMomentoff #Abstraction.  The exposed method signature for Api.Data.Calculate could be wrapped within a method whose signature only requires arguments a business user can reasonably supply.

 

B
BobNelson
January 2, 2025

I'm seeing an api.Data.Calculate statement with a script, followed by blank commas for the dimension filters, then an "onEval" statement, a final comma, then the word False.  Can I assume that the final comma refers to the IsDurableCalculatedData Boolean, even though no blank has been assigned to userState?

Terms & ConditionsAccessibility statement