Forum Discussion

MarkHoughton's avatar
MarkHoughton
Contributor
9 months ago

Getting the Workflow Profile Text2 ( or 3 or 4 ) attribute value using BRApi ( Not Text1 )

Hi all, I am baffled as to why I am unable to retrieve the Text2 ( or 3 or 4 ) attribute value in a workflow profile. I use the following code to get the Text1 value : Dim wfClusterPK As Workflow...
Finance
  • MarcusH's avatar
    MarcusH
    9 months ago

    You have this code:

    Dim sVarStep2 As String =BRApi.Workflow.Metadata.GetParent(si,args.SubstVarSourceInfo.WorkflowUnitInfo.ProfileName).GetAttributeValue(wfScenarioTypeID, 18000)

    Instead of 18000 you use SharedConstants.WorkflowProfileAttributeIndexes.Text2

    Dim sVarStep2 As String =BRApi.Workflow.Metadata.GetParent(si,args.SubstVarSourceInfo.WorkflowUnitInfo.ProfileName).GetAttributeValue(wfScenarioTypeID, SharedConstants.WorkflowProfileAttributeIndexes.Text2)

     

JackLacava's avatar
JackLacava
Honored Contributor

It's still not clear - what does "from a CubeView" mean - is it a Cube View Extender you are writing? A dynamic Member Formula? A Dashboard Extender? Can you give us a screenshot of the client while writing the rule?

I'm not trying to be awkward: the question is because you're relying on si.WorkflowClusterPk to identify the workflow profile, but depending on context, this might not actually be what you think it is.

MarkHoughton's avatar
MarkHoughton
Contributor
5 months ago

Hi Jack,

Back here again as the solution that did work is working but not direct from CubeView designer, it only works when activated as a form from a template. We have recently upgraded to ver 7.4.4 from 7.3.1. being the only difference. Because it did end up working on the earlier suggestion of using .Text2 as apposed to the .20000 value, then I did not return and reply to you.

However, now I am wondering if your point is more relevant. At the moment the Business Rule is being called with this syntax BRString(BMK_MH_Helper,GetColFormula) as a UD4 field. The rule is sat in the Dashboard XFBR String sub-folder of Business Rules.  So is it in the wrong place and if so where is best ? Does this impact the cause of the error when running from CubeView designer rather than from a Form template ?

I have included the full script below. What it is aiming to do ( and was working back in June ) is create a dynamic formula based on the currency value held in the Text2 property and then create a col1+col2+col3 etc formulae but exclude the column relating to the value found in the Text2.

 

Namespace OneStream.BusinessRule.DashboardStringFunction.BMK_MH_Helper
Public Class MainClass
Public Function Main(ByVal si As SessionInfo, ByVal globals As BRGlobals, ByVal api As Object, ByVal args As DashboardStringFunctionArgs) As Object
Try

If (args.FunctionName.Equals("GetColFormula", StringComparison.InvariantCultureIgnoreCase)) Then

Dim MHClusterPK As WorkflowUnitClusterPk = si.WorkflowClusterPk
Dim MHScenarioTypeID As Integer = BRApi.Workflow.General.GetScenarioTypeId(si, MHClusterPK)

Dim myCurName As String =BRApi.Workflow.Metadata.GetParent(si,args.SubstVarSourceInfo.WorkflowUnitInfo.ProfileName).GetAttributeValue(MHScenarioTypeID, SharedConstants.WorkflowProfileAttributeIndexes.Text2)

'BRApi.ErrorLog.LogMessage(si, "ScenTypeID = " & MHScenarioTypeID)
'BRApi.ErrorLog.LogMessage(si, "CurrVal Here 123= " & myCurName)

Dim myColNum As Integer

Select Case myCurName

Case = "GBP" 
myColNum=1
Case = "USD" 
myColNum=2
Case = "EUR" 
myColNum=3
Case = "NOK" 
myColNum=4
Case = "CHF" 
myColNum=5
Case = "ISK" 
myColNum=6
Case = "VND" 
myColNum=7
Case = "HKD" 
myColNum=8
Case = "DKK" 
myColNum=9
Case = "COP" 
myColNum=10
Case = "MXN" 
myColNum=11
Case = "BRL" 
myColNum=12
Case = "IDR" 
myColNum=13
Case = "THB" 
myColNum=14
Case = "CNY" 
myColNum=15
Case = "TRL" 
myColNum=16
Case = "INR" 
myColNum=17
End Select

Dim myres As String

myres = "C#Local:U4#None:Name(Check Total):GetDataCell(CVC(Total)-CVC(Col0)"

For a = 1 To 17
    If a <> myColNum Then myres = myres + "-CVC(Col" & a & ")"
Next a

Return myres & ")"

 

 
  • JackLacava's avatar
    JackLacava
    Honored Contributor
    5 months ago

    Seems to work fine for me (on v8.2).

    Bar any possible version-specific issue, the main thing I would be wary of with your code is: because you're referencing the parent Workflow of the current one, if for any reason there isn't a current WF defined in the session, the lookup obviously fails. When you launch a Cube View from the designer or a Dashboard outside of the Workflow, I don't think we make any guarantees about having a Workflow available; whereas, when you execute a form from OnePlace, obviously there will always be one selected.

    A couple of other notes.

    • That string comparison is verbose, you can use this utility method instead:
      If args.FunctionName.XFEqualsIgnoreCase("GetColFormula") Then
    • If this is meant to be a visual check of values that are already in the Cube, it could be done automatically in a Confirmation Rule instead.
    • I personally call this type of rules using XFBR() rather than BRString() - it should be the same either way, but it saves a few characters (lol) and it's more old-school...
    • MarkHoughton's avatar
      MarkHoughton
      Contributor
      5 months ago

      Hi Jack,

      Thanks for the update. An extended problem with this has now manifest itself, where Ideally I want to get the local currency value of the entity into the cubeview to manipulate the col-total formula. I can see where it will fail without finding that WF setting. What code syntax should I be using that would retrieve the local currency of the entity. For simplicity, all of our entity Workflows have the same name as the entity "name".

      The 'extended' problem is I now need to export all of the entities within a division to excel using Books. I have created the book steps ok to do this, but again in excel the col-total is showing an error as it cannot derive what the local currency is.

      Cheers

      Mark