Dashboard Business Rules

1If args.FunctionType = DashboardExtenderFunctionType.LoadDashboard Then
2  Dim reason As LoadDashboardReasonType = args.LoadDashboardTaskInfo.Reason
3  Dim action As LoadDashboardActionType = args.LoadDashboardTaskInfo.Action
4
5  ' Set defaults only on first load, before parameters are prompted
6  If reason = LoadDashboardReasonType.Initialize AndAlso _
7     action = LoadDashboardActionType.BeforeFirstGetParameters Then
8      ' Only set a default if the parameter has not been set yet.
9      ' (Derive the value however you like — e.g. from the workflow POV or another parameter.)
10      Dim currentEntity As String = BRApi.Dashboards.Parameters.GetLiteralParameterValue(si, False, "EntityParam")
11      If String.IsNullOrEmpty(currentEntity) Then
12          BRApi.Dashboards.Parameters.SetLiteralParameterValue(si, False, "EntityParam", "Houston")
13      End If
14  End If
15End If

1If args.FunctionType = DashboardExtenderFunctionType.ComponentSelectionChanged Then
2  Select Case args.FunctionName
3
4      Case "RunReport"
5          ' XFGetValue takes only the key and returns "" when the key is missing
6          Dim reportType As String = args.NameValuePairs.XFGetValue("ReportType")
7          If String.IsNullOrEmpty(reportType) Then reportType = "Summary"
8          ' Set a parameter to control which report layout to show
9          BRApi.Dashboards.Parameters.SetLiteralParameterValue(si, False, "ActiveReport", reportType)
10
11          Dim result As New XFSelectionChangedTaskResult()
12          result.IsOK = True
13          Return result
14
15      Case "ExportData"
16          Dim format As String = args.NameValuePairs.XFGetValue("Format")
17          If String.IsNullOrEmpty(format) Then format = "CSV"
18          ' Export logic here...
19
20          Dim result As New XFSelectionChangedTaskResult()
21          result.IsOK = True
22          result.ShowMessageBox = True
23          result.Message = "Export completed in " & format & " format."
24          Return result
25
26  End Select
27End If

1Select Case args.FunctionType
2
3  Case DashboardDataSetFunctionType.GetDataSetNames
4      Dim names As New List(Of String)()
5      names.Add("RevenueByEntity")
6      names.Add("ExpenseSummary")
7      Return names
8
9  Case DashboardDataSetFunctionType.GetDataSet
10      If args.DataSetName.XFEqualsIgnoreCase("RevenueByEntity") Then
11          ' Build a DataTable with revenue data
12          Dim dt As New DataTable()
13          dt.Columns.Add("Entity", GetType(String))
14          dt.Columns.Add("Revenue", GetType(Decimal))
15          dt.Columns.Add("Variance", GetType(Decimal))
16
17          ' Query cube data and populate the table
18          Using dbConnApp As DbConnInfo = BRApi.Database.CreateApplicationDbConnInfo(si)
19              Dim sql As String = "SELECT Entity, SUM(Amount) AS Revenue, 0 AS Variance FROM dbo.FinancialData WHERE Account = 'Revenue' GROUP BY Entity"
20              Dim sourceTable As DataTable = BRApi.Database.ExecuteSql(dbConnApp, sql, False)
21              For Each sourceRow As DataRow In sourceTable.Rows
22                  Dim newRow As DataRow = dt.NewRow()
23                  newRow("Entity") = sourceRow("Entity")
24                  newRow("Revenue") = sourceRow("Revenue")
25                  newRow("Variance") = 0D
26                  dt.Rows.Add(newRow)
27              Next
28          End Using
29
30          Return dt
31
32      ElseIf args.DataSetName.XFEqualsIgnoreCase("ExpenseSummary") Then
33          ' Build expense summary DataTable...
34          Dim dt As New DataTable()
35          dt.Columns.Add("Category", GetType(String))
36          dt.Columns.Add("Amount", GetType(Decimal))
37          Return dt
38      End If
39
40End Select

1Select Case args.FunctionName
2
3  Case "GetEntityDescription"
4      ' Return the description of an entity member
5      Dim entityName As String = args.NameValuePairs.XFGetValue("Entity")
6      If Not String.IsNullOrEmpty(entityName) Then
7          Dim memberInfo As MemberInfo = BRApi.Finance.Members.GetMemberInfo(si, DimType.Entity.Id, entityName, True)
8          If memberInfo IsNot Nothing Then
9              Return memberInfo.Member.Description
10          End If
11      End If
12      Return entityName
13
14  Case "IsUserAdmin"
15      ' Return True/False based on security role
16      Dim isAdmin As Boolean = BRApi.Security.Authorization.IsUserInGroup(si, si.UserName, "Administrators", False)
17      Return isAdmin.ToString()
18
19  Case "GetVisibility"
20      ' Control component visibility based on scenario
21      Dim scenario As String = args.NameValuePairs.XFGetValue("Scenario")
22      If scenario.XFEqualsIgnoreCase("Actual") Then
23          Return "False"  ' Hide for Actual scenario
24      End If
25      Return "True"
26
27End Select
28
29Return String.Empty

1' Store a value in page state
2BRApi.State.SetPageOrDlgState(si, False, args.PageInstanceInfo.PageOrDlgInstanceID, _
3  si.ClientModuleType, "MyDashboard", "", "LastAction", "", "Export", Nothing)
4
5' Retrieve a value from page state
6Dim state As XFUserState = BRApi.State.GetPageOrDlgState(si, False, args.PageInstanceInfo.PageOrDlgInstanceID, _
7  si.ClientModuleType, "MyDashboard", "", "LastAction", "")
8Dim lastAction As String = If(state IsNot Nothing, state.TextValue, String.Empty)