Purpose of the module

The primary goal is to be able to place arbitrary Microsoft Power BI reports in the Back Office of our ONe online store. Additionally, we aim to assign accessibility to these reports for customer service representatives and/or their roles. Besides this, the module is also capable of managing any linked content, whether it's any kind of document (doc, xlsx, ppt, pdf, etc…) or a web link.

Structure of the module

The structure can be divided into two main parts. One is a configuration interface where the reports can be managed, and the other is a user interface where everyone can find a list of reports available to them, and they can launch them with a click.

Permission Management

To properly manage permissions, it's essential to enable the synchronization of Back Office users in the settings. This allows for the listing of users and the determination of permission groupings. Synchronization occurs in the background every half hour, so the data won't be immediately available after activation.

To turn this on, open the ONe Framework and navigate to the Settings → System Settings menu.

Switch on the "Synchronize BackOffice Users" toggle, and then click the Save button located in the top right corner.

⚠️ Attention! Our system performs operator synchronization on an hourly basis. If you've recently added a new operator, please be aware that they will not have access to the reports immediately. Their access will only be granted once the operator's details have been synchronized into our database during the next scheduled synchronization. We appreciate your understanding and patience in this matter. Ensure that you inform new operators of this slight delay to set the right expectations.

Report Manager

To manage the reports, visit the ONe Framework and then open the PowerBI → Report Manager menu option.

This menu option is only accessible for users with the "Administrator" role. It will appear for everyone only if the synchronization of BackOffice users hasn't been enabled or synchronization hasn't occurred yet.

Upon navigating into the module, you'll see a structured screen. On the upper part of the screen, a table displays the reports that have already been recorded:

Additionally, if we select a report, its details and some guidance on further usage of the report will appear in the lower section.

Embedding Reports

We have the option to embed certain reports, for instance, into the customer menu item. To do this, in the URL of the report (referring to the specific customer), it is necessary to pass either the selected customer's ONe ID or the External ID defined by us during synchronization. In the window for adding a new report, an informational popup assists and explains its operation.

In the details window, we can see the URL in the "Plugin registration URL" field. If we register this URL as a plugin page, then the report appears in the desired location. To achieve this, all we need to do is expand our ONe Framework registration JSON's "components" array with an additional component:

{ 
      "type": "bo_client_account_tab", 
      "id": "backoffice_powerbi_report", 
      "tab": { 
        "tabLabel": { 
          "en": "Forgalmi kimutatás", 
          "hu": "Forgalmi kimutatás", 
          "pl": "Forgalmi kimutatás" 
        }, 
        "tabIcon": "cid-chart", 
        "tabIndex": 5, 
        "slugSuffix": "ide egy egyedi belső SLUG, pl: client-statistics", 
        "iframeUrl": "ide az url" 
      } 
}

The name of the menu item can be set using the localized variables of tabLabel.

The id is an arbitrary identifier; it can be the same as the slugSuffix.

The tabIcon determines the icon set for the menu item; you can choose from the following: https://coreui.io/icons/all/

The tabIndex indicates the order in which this menu item should appear from the top.

The slugSuffix is the internal URL that, when accessed, immediately navigates the page to the target location. It needs to be unique.

The iframeUrl is provided by our plugin: Plugin registration URL.

New Report

We can add a new report by clicking on the add button located in the top right corner.

The image shows text, electronics, a screenshot, and software.

Automatically generated description: In the window, mandatory fields are marked with a red asterisk.

Saving the Report

Clicking on the save button will present an error message if something is not filled out correctly.

By clicking on the user filter field, users will be listed. Any number of users can be selected from the list.

Filtering by permission group is done in the aforementioned manner.

We also have the option to provide an icon URL for the report, which can be any arbitrary image; it's recommended to place it in the media library. If this isn't specified, a default PowerBI icon will appear. There are two tags available in the report's URL; details about these can be read in the blue info window.

Editing or Deleting Report

In the table above, select the report you wish to edit. Following this, the operations menu appears below, at the top part of the details window:

By clicking on the edit button, the report's data will appear in a window similar to the recording one, where changes can be made and then saved.

My Reports

To manage the reports, visit the ONe Framework and then open the PowerBI → My Reports menu option.

This menu option displays a list of reports available to users in the form of "cards" that they have permission to access.

The "Open" button located at the bottom of these cards can be used to launch the reports.