When you added and configured your PowerBi report in the report manager, the plugin helps you and gives the registration URL to add the report into a new component like components in Account tab, Main menu.

To register the account tab you should copy the URL of the selected report.

Then, you can ask your active plugins to get the right pluginId of the framework with the following API:

GET

/api/v1/plugins/integrations/auth-required/active-plugins

Returns active plugins with their configuration. Plugin must have at least one component to be in this list.

Example response:

[
{
    "id": "oneframework",
    "components": [
      {
        "type": "iframe_bo",
        "buttonLabel": "ONe Framework",
        "buttonIcon": "cil-puzzle-piece",
        "page": {
          "slug": "one-framework-plugin",
          "title": "ONe Framework",
          "iframeUrl": "https://ase-oneframework-test-westeu-01.azurewebsites.net/?culture=PL-pl",
          "requiresLogin": true
        }
      }
    ],
    "authorizeWithOne": true
  }
]

Then you must get the plugin details of the framework with the following API:

GET

/api/v1/plugins/integrations/auth-required/plugin/{id}

getPlugin

Example response:

{
  "author": "HAD IT Services Kft",
  "name": {
    "en": "ONe Framework",
    "hu": "ONe Framework",
    "pl": "ONe Framework"
  },
  "components": [
    {
      "type": "iframe_bo",
      "id": "one-framework-plugin",
      "buttonLabel": {
        "en": "ONe Framework",
        "hu": "ONe Framework",
        "pl": "ONe Framework"
      },
      "buttonIcon": "cil-puzzle-piece",
      "page": {
        "slug": "one-framework-plugin",
        "title": {
          "en": "ONe Framework",
          "hu": "ONe Framework",
          "pl": "ONe Framework"
        },
        "iframeUrl": "https://ase-oneframework-test-westeu-01.azurewebsites.net/?culture=PL-pl"
      }
    }
  ],
  "security": {
    "authorizeWithOne": true,
    "permissions": {
      "view": {
        "name": {
          "en": "ONe Framework plugin",
          "hu": "ONe Framework plugin",
          "pl": "ONe Framework plugin"
        },
        "components": [
          "one-framework-plugin"
        ]
      }
    }
  }
}

You should add new component with the right type.

Examples of new components

Client tab

{
      "type": "bo_client_account_tab",
      "id": "backoffice_powerbi_report",
      "tab": {
        "tabLabel": {
          "en": "Analityka",
          "hu": "Analityka",
          "pl": "Analityka"
        },
        "tabIcon": "cil-chart",
        "tabIndex": 5,
        "slugSuffix": "client-statistics",
        "iframeUrl": "https://ase-oneframework-test-westeu-01.azurewebsites.net/power_bi/bo_riport?culture=PL-pl&riport=reportId"
      }
    }

📢 For more icons, please read: Plugin icons in menu elements page.

💡 You can use a formatting tester like https://jsonformatter.curiousconcept.com/# to check if your new registration is ok or not.

Now you must add the new client tab component into the framweork’s plugin components list and re register it with the following API:

PUT

/api/v1/plugins/integrations/auth-required/plugin/{id}

registerPlugin

Example JSON:

{
  "author": "HAD IT Services Kft",
  "name": {
    "en": "ONe Framework",
    "hu": "ONe Framework",
    "pl": "ONe Framework"
  },
  "components": [
    {
      "type": "iframe_bo",
      "id": "one-framework-plugin",
      "buttonLabel": {
        "en": "ONe Framework",
        "hu": "ONe Framework",
        "pl": "ONe Framework"
      },
      "buttonIcon": "cil-puzzle-piece",
      "page": {
        "slug": "one-framework-plugin",
        "title": {
          "en": "ONe Framework",
          "hu": "ONe Framework",
          "pl": "ONe Framework"
        },
        "iframeUrl": "https://ase-oneframework-test-westeu-01.azurewebsites.net/?culture=PL-pl"
      }
    },
	{
      "type": "bo_client_account_tab",
      "id": "backoffice_powerbi_report",
      "tab": {
        "tabLabel": {
          "en": "Analityka",
          "hu": "Analityka",
          "pl": "Analityka"
        },
        "tabIcon": "cil-chart",
        "tabIndex": 5,
        "slugSuffix": "client-statistics",
        "iframeUrl": "https://ase-oneframework-test-westeu-01.azurewebsites.net/power_bi/bo_riport?culture=PL-pl&riport=reportId"
      }
    }
  ],
  "security": {
    "authorizeWithOne": true,
    "permissions": {
      "view": {
        "name": {
          "en": "ONe Framework plugin",
          "hu": "ONe Framework plugin",
          "pl": "ONe Framework plugin"
        },
        "components": [
          "one-framework-plugin"
        ]
      }
    }
  }
}

Another example:

{
  "author": "HAD IT Services Kft",
  "name": {
    "en": "Analytics",
    "pl": "Analityka handlowca"
  },
  "components": [
    {
      "type": "iframe_bo",
      "id": "analityka_bo",
      "buttonLabel": {
        "en": "Analytics",
        "pl": "Analityka handlowca"
      },
      "buttonIcon": "cil-chart",
      "page": {
        "slug": "analityka",
        "title": {
          "en": "Analytics",
          "pl": "Analityka handlowca"
        },
        "iframeUrl": "https://ase-oneframework-prod-westeu-01.azurewebsites.net/power_bi/bo_riport?culture=PL-pl&riport=reportID"
      }
    }
  ],
  "security": {
    "authorizeWithOne": true,
    "permissions": {
      "view": {
        "name": {
          "en": "Analytics",
          "pl": "Analityka handlowca"
        },
        "components": [
          "analityka_bo"
        ]
      }
    }
  }
}

📢 For more icons, please read: Plugin icons in menu elements page.

⚠️ Be sure that you entered the right iframeUrl! In the above mentioned example we marked the reportId which is necessary to edited! "iframeUrl": "https://ase-oneframework-test-westeu-01.azurewebsites.net/power_bi/bo_power_bi_myreports?culture=PL-pl&riport=reportId"