Forum Discussion

fc's avatar
fc
New Contributor III
2 years ago

Literal parameters and multiple users

Hi all,  I'm currently developing a dashboard that will likely be used by multiple users at the same time.  Users will be able to set some initial parameters within the dashboard, and click on a ...
Dashboards
  • RobbSalzmann's avatar
    RobbSalzmann
    2 years ago

    Literal Parameters values are application-wide, session inspecfic.  Things like formats and colors work well in Literal parameters 

     

    For user/session specific parameters, use Input Parameters:

    In your code, these Input Parameters are oddly named "ModifiedSubVars".  You change the value of the ModifiedSubVars on the returned Task Result object, e.g.  XFLoadDashboardTaskResult, XFSelectionChangedTaskResult depending on what event you're handling.  Be sure to also set one or all of the ChangeCustomSubstVarsIn properties to True.

    E.g. 

    selectionChangedTaskResult.ChangeCustomSubstVarsInDashboard = True
    selectionChangedTaskResult.ModifiedCustomSubstVars.Add("pm_myParameter_Name", "User Specific Value")

  • fc's avatar
    fc
    2 years ago

    It finally works! The problem was that the popup came out every time the dashboard refreshed, thus every time this section of the script was triggered:

        Case Is = DashboardExtenderFunctionType.LoadDashboard
              If args.FunctionName.XFEqualsIgnoreCase("LoadFunction") Then
                   .....
              End If

    I managed to avoid the pop up to come out by adding a couple of lines of code:


     Case Is = DashboardExtenderFunctionType.LoadDashboard
              If args.FunctionName.XFEqualsIgnoreCase("LoadFunction") Then

                loadDashboardTaskResult.ChangeCustomSubstVarsInDashboard = True

                If Not(args.LoadDashboardTaskInfo.CustomSubstVarsFromPriorRun.XFGetValue("p_RowEntityList").Equals("None")) Then
                
                loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowEntityList", args.LoadDashboardTaskInfo.CustomSubstVarsFromPriorRun.XFGetValue("p_RowEntityList"))
                loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowAccList", args.LoadDashboardTaskInfo.CustomSubstVarsFromPriorRun.XFGetValue("p_RowAccList"))
                loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowDocList", args.LoadDashboardTaskInfo.CustomSubstVarsFromPriorRun.XFGetValue("p_RowDocList"))

                Return loadDashboardTaskResult

              Else

                loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowEntityList", "None")
                loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowAccList", "None")
                loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowDocList", "None")

                Return loadDashboardTaskResult

              End If
     End If

     The rest of the script is structured as Rob suggested.

    Thank you all for the help!

fc's avatar
fc
New Contributor III
2 years ago

It finally works! The problem was that the popup came out every time the dashboard refreshed, thus every time this section of the script was triggered:

    Case Is = DashboardExtenderFunctionType.LoadDashboard
          If args.FunctionName.XFEqualsIgnoreCase("LoadFunction") Then
               .....
          End If

I managed to avoid the pop up to come out by adding a couple of lines of code:


 Case Is = DashboardExtenderFunctionType.LoadDashboard
          If args.FunctionName.XFEqualsIgnoreCase("LoadFunction") Then

            loadDashboardTaskResult.ChangeCustomSubstVarsInDashboard = True

            If Not(args.LoadDashboardTaskInfo.CustomSubstVarsFromPriorRun.XFGetValue("p_RowEntityList").Equals("None")) Then
            
            loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowEntityList", args.LoadDashboardTaskInfo.CustomSubstVarsFromPriorRun.XFGetValue("p_RowEntityList"))
            loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowAccList", args.LoadDashboardTaskInfo.CustomSubstVarsFromPriorRun.XFGetValue("p_RowAccList"))
            loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowDocList", args.LoadDashboardTaskInfo.CustomSubstVarsFromPriorRun.XFGetValue("p_RowDocList"))

            Return loadDashboardTaskResult

          Else

            loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowEntityList", "None")
            loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowAccList", "None")
            loadDashboardTaskResult.ModifiedCustomSubstVars.Add("p_RowDocList", "None")

            Return loadDashboardTaskResult

          End If
 End If

 The rest of the script is structured as Rob suggested.

Thank you all for the help!

  • ckattookaran's avatar
    ckattookaran
    VIP
    3 months ago

    Hmm, that is an interesting solution. However, have you tried adding a supplied parameter on the main dashboard? That should solve the issue of it asking for the parameter value when a dialog box is open. You don't need to use the load dashboard event to do this.

    • GregHertling's avatar
      GregHertling
      New Contributor III
      2 months ago

      Hi, I am having the same issue with the pop up box for the parameters.  I have 6 combo boxes on a dashboard. 5 selecting parameters and one selecting a column set for cube views.  The parameters are used in two different cube views on the dashboard.  Every time I open the dashboard or make a selection on one of the cb's, the pop up appears showing all of the parameters.  I don't quite understand the "adding a supplied parameter on the main dashboard"  All combo boxes are triggering the same DE BR.

      Below is the code.  Any help is appreciated.

      Else If (args.FunctionName = "SetCorpVolAdjParams") Then
      Dim UD1Report As String = "Top.Base"
      Dim UD2Report As String = "Top"
      Dim UD3Report As String = "Top"
      Dim UD4Report As String = "Top"
      Dim EntitySelect As String = args.TaskInfo.CustomSubstVars("prm_Entity_Select")
      Dim MonthlyYearlySelect As String = args.TaskInfo.CustomSubstVars("prm_Monthly_Yearly_Select")
      Dim CVname As String = Nothing
      If MonthlyYearlySelect = "Monthly" Then
      CVname = "IBP_PeriodicAdj_Col"
      ElseIf MonthlyYearlySelect = "Yearly" Then
      CVname = "IBP_AnnualAdj_Col"
      End If
      Dim UD1Select As String = args.TaskInfo.CustomSubstVars("prm_UD1_Select")
      If Not UD1Select.Contains("Disagg") Then
      UD1Report = UD1Select
      End If
      Dim UD2Select As String = args.TaskInfo.CustomSubstVars("prm_UD2_Select")
      If Not UD2Select.Contains("Disagg") Then
      UD2Report = UD2Select
      End If
      Dim UD3Select As String = args.TaskInfo.CustomSubstVars("prm_UD3_Select")
      If Not UD3Select.Contains("Disagg") Then
      UD3Report = UD3Select
      End If
      Dim UD4Select As String = args.TaskInfo.CustomSubstVars("prm_UD4_Select")
      If Not UD4Select.Contains("Disagg") Then
      UD4Report = UD4Select
      End If

      Dim selectionChangedTaskResult As New XFSelectionChangedTaskResult()
      selectionChangedTaskResult.IsOK = True
      selectionChangedTaskResult.Message = String.Empty
      selectionChangedTaskResult.ShowMessageBox= False
      selectionChangedTaskResult.ChangeCustomSubstVarsInDashboard = True
      selectionChangedTaskResult.ModifiedCustomSubstVars.Add("prm_EntitySelectionValue_Form", EntitySelect)
      selectionChangedTaskResult.ModifiedCustomSubstVars.Add("prm_EntitySelectionValue_Report", EntitySelect)
      selectionChangedTaskResult.ModifiedCustomSubstVars.Add("prm_Monthly_Yearly_SelectionValue_Form", CVname)
      selectionChangedTaskResult.ModifiedCustomSubstVars.Add("prm_UD1SelectionValue_Form", UD1Select)
      selectionChangedTaskResult.ModifiedCustomSubstVars.Add("prm_UD1SelectionValue_Report", UD1Report)
      selectionChangedTaskResult.ModifiedCustomSubstVars.Add("prm_UD2SelectionValue_Form", UD2Select)
      selectionChangedTaskResult.ModifiedCustomSubstVars.Add("prm_UD2SelectionValue_Report", UD2Report)
      selectionChangedTaskResult.ModifiedCustomSubstVars.Add("prm_UD3SelectionValue_Form", UD3Select)
      selectionChangedTaskResult.ModifiedCustomSubstVars.Add("prm_UD3SelectionValue_Report", UD3Report)
      selectionChangedTaskResult.ModifiedCustomSubstVars.Add("prm_UD4SelectionValue_Form", UD4Select)
      selectionChangedTaskResult.ModifiedCustomSubstVars.Add("prm_UD4SelectionValue_Report", UD4Report)
      Return selectionChangedTaskResult