Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This structure includes basic parameter information about an Advanced Analytical Module (AAM) integration. The information represented in this structure is not comprehensive and only includes certain key attributes .used to establish an AAM integration. For each AAM integration type, the parameter set is different.  

Format


PwsClientSummaryAamIntegrationId: Int32
Panel
titlePwsAamIntegrationSummary
  • PwsAamDashboardParams
    • BdDashboardAlias: String (50)
    • BdDashboardParameters: String (255)
    • PbFilter: String (255)
    • PbReportId: String (255)
    • PbWorkspaceId: String (255)
    • OtherUrl: String (255)

Elements


M

Element

Data Type

Required?

Default

Description

Sample Data

AamIntegrationId

Int32

No

The AAM integration Id is a unique identifier for a client. For internal use only.

AamIntegrationNameString (50)YesThe name of AAM integration type. For exmaple, Project BI, MS Power BI and Other Compatible BI Tool.
MS Power BI
AamIntegrationUidInt64NoA unique and immutable identifier for an AAM integration.
1152921504606847218
AamTypeString (1)Yes

The AAM Integration type code:

P for Projector BI

M for MS Power BI

O for Other Compatible BI Tool

BdDashboardAlias

String (50)

Yes if AAM integration type = Projector BI


For Project BI AAM integration only. The dashboard alias name that is from the Projector BI system.

RD-MyStats

BdDashboardParameters
String (255)No
For Project BI AAM integration only. Parameters are filters that can be used to display a specific subset of data in the dashboard.
ProjectorProjectCode={0}
PbFilter
String (255)
No
For MS Power BI AAM integration only.

PbReportId
String (255)Yes

For MS Power BI AAM integration only.


PbWorkspaceIdString (255)Yes
For MS Power BI AAM integration only.
OtherUrl
String (255)Yes
For Other BI tools AAM integration only.

Usage Example(s)

Code Block
languagexml
titleExample 01 - Projector BI
collapsetrue
                           <b:ProjectAamDashboardParams i:type="b:PwsAamBdDashboardParams">
                              <b:BdDashboardAlias>Workspace-Project Health</b:BdDashboardAlias>
                              <b:BdDashboardParameters>ProjectorProjectCode={0}</b:BdDashboardParameters>
                           </b:ProjectAamDashboardParams>       


Code Block
languagexml
titleExample 02 - MS Power BI
collapsetrue
                           <b:ProjectAamDashboardParams i:type="b:PwsAamPbDashboardParams">
                              <b:PbFilter>https://community.powerbi.com</b:PbFilter>
                              <b:PbReportId>R1029--001</b:PbReportId>
                              <b:PbWorkspaceId>WS-1029-001</b:PbWorkspaceId>
                           </b:ProjectAamDashboardParams>


Code Block
languagexml
titleExample 03 - Other Compatible BI Tool
collapsetrue
                           <b:ProjectAamDashboardParams i:type="b:PwsAamPbDashboardParams">
                              <b:OtherUrl>https://www.xyzanalysis.com</b:OtherUrl>
                           </b:ProjectAamDashboardParams>