Temporary folders

In BI Point application, it is possible to change folders into temporary files by editing entries on META database in dbo.settings table.     Subsequent fields are indicated by the specified paths:
  • FileDataSourcesDirectory – specifies the path to a folder, where the copies of files used to file connections will be stored.
  • SegmentationUploadDirectory – specifies the path to a folder to which CSV files, that were used to define a micro segment, will be uploaded.
  • SegmentationTempDirectory – specifies the path to a folder, in which the temporary files, used by the segmentation engine to calculate the process result, will be stored.
  • SegmentationResultDirectory – specifies the path to a folder in which the output files of the segmentation process will be stored.
  • ExportToFileTempDirectory – specifies the path to a folder in which a temporary file, that is created during export, is stored.
  • CommentaryScreenShootsDirectory ­– specifies the path to a folder in which the screenshots used in comments will be stored.
   

Managing permissions to objects in Comarch BI Point

From the level of the repository, it is possible to share dashboards, reports and Excel reports. To provide a user with access to data in a report or dashboard, it is necessary to share also (with at least the right to preview) the data models used by a given report or dashboard. Objects are shared in BI Point by selecting a data model and then the option Manage Permissions on the screen with the report repository screen. You can select multiple elements at the same time:   To share an element with a user, select Manage Permissions and then Add Permissions. Select the user the list, assign a priviledge and then select Add Permissions. Hovering the mouse cursor over Grant Permissions shows the information about possible permissions that can be assigned to the user. Depending on the selected permission level, people who gain access will be able to perform different actions:
  • Unlimited
can perform all available actions and manage permissions
  • Limited
can open and copy a folder with its content, but cannot modify or share elements in the folder with others
  • Preview
can view a folder and open all its elements
  • Denied
have no permissions to a folder and its elements   The last step is to select Save Changes so that the permissions are saved correctly. To remove a permission assignment from a user or user group, click on the red bin icon in the list and then save the changes. When attempting to delete the shared object, a window pops up to inform that the object has been shared with another user. In order to permanently delete a report or dashboard, you need to confirm the deletion of the object.

Home screen

Once you have logged in to the application properly, you will be redirected to the home page.   Selecting [Show My Reports] will redirect you to the new repository.  
Wskazówka
You can restore the standard layout of the application at any time during work with the new repository by selecting [Switch to standard repository version] in the upper panel. 
 

Left repository panel

The left panel of the repository can be divided into 3 sections:  
  1. My Dashboard
  2. Reports
  3. Other
  1. My Dashboard section is a quick access tab, where you can add a specific report/dashboard such as the most frequently used one.
   
  1. Reports section is divided into 4 tabs:
  • Favorites
This tab includes dashboards, reports, external links, XLS files or RS reports that were marked as “favorite” in the Reports tab. In this tab, you can add the most frequently used reports/dashboards, for instance, in order to easily and quickly access them.
  • Recently Opened
Recently opened reports, dashboards etc.
  • My Reports
Selecting this tab redirects you to a user-dedicated directory.   The layout of the left panel is then adapted to the currently opened view. As shown in the figure above, folders available under a specific path are displayed in the left panel. The main part of the screen, on the other hand, displays everything that can be found under this path. In the above example, it is a “test” folder and a report named “example”. To return to the main section of the left tab, just select [Back] in the upper left part of the screen.
  • ALL
This tab redirects to the mail repository folder, where all child folders can be found, such as Private Reports and Standard Reports. The Private Reports folder stores reports/dashboards created and saved by an individual user, whereas the Standard Reports folder stores reports/dashboards created during installation of a specific product.
Wskazówka
However, this does not make it impossible to save reports created by users in folders other than Private Reports.
.3. Other section is divided into 3 tabs:
  • Connections
This tab contains information about existing connections. To create a new connection, select [Create] in the upper right corner of the screen followed by a selected connection. For description of available connections, refer to chapter  Connections.
  • Data Models
This tab contains information about existing data models. To create a new data model, select [Create] in the upper right corner of the screen.
  • Subscriptions
In this tab, you can find information about defined subscriptions.

Operations on repository objects

In each selected tab (such as My Reports), there are various management options (options for managing reports, folders, main screen) in the main directory.
  1. Main panel options
There are 2 main edit options of the screen displayed.
  • Column filters
These options are used to filer a specific column according to their purpose.  For instance, if you have a single column Owners, you can use filters to select a specific owner or group. The number of available filters depends on the adapted columns (see subsequent chapter for more information).
  • Option to view directory/report details
Selecting the pencil icon in the main panel of the directory, you can set columns which are to be presented in folders.     Selectable options:
  • Owner
  • Created (date created)
  • Modified (date modified)
  • Detailed Type (folder, report, ...)
  • Data Model Type (SQL, Postgres, file model, ….)
  • Data Model Name
Uwaga
The number of available columns depends of the location (path) of the user.
In the right side of “column adjustment”, you can set the order of columns as needed. Columns closest to the left will be arranged on top and columns closest to the right will be arranged at the bottom. If you select a greater number of columns, additional filter options will become available, as shown in the figure below: 2. Right panel options The right panel is available upon selecting << available on the right toolbar on the tabs. Available options:
  • Details
To view the details of a specific object, you need to select it and then click the details icon in the right panel. . Following information is presented on the details screen: object name and type (folder, report, ...), object description (and if missing you can add one), object location, its modification and creation dates. There may be additional information, such as data model for report, depending on the object type.
  • Access rights and authorizations
To view access rights and authorization to a specific object, you need to select it and then click the access and authorization icon in the right panel.
On the screen, you can see your authorizations as well as access rights granted to other users. In the right panel, you can also assign authorizations to users by selecting [Manage Permissions]. More information on how it works and how to grant permissions can be found in the article "Managing Comarch BI Point object permissions".
  • History
You can access an object history on the screen of report/model repository tree. The history option is available in the right context menu upon selecting a relevant icon. .
You can use this option to view the history of actions performed on a given object.
  • Translations
BI Point application provides the mechanism for adding translations to objects. You can add translations in a selected language. Object names and descriptions are translatable.
  • Subscriptions
A subscription option is also available in the right panel, depending on the selected object. This option is available to reports and dashboards. The panel provides information on existing subscriptions for the object. You can also define a new subscription by selecting [Add Subscription]. More information about subscriptions can be found in the subscription article here.
Wskazówka
Some of the options are available by selecting an object and then dropdown kebab menu in the upper right part of the repository, as shown in the figure below. The other options that are not available in the right panel are: Open in a new tab (opens a report in a new browser tab) and Add to favorites (adds a report to user’s favorites and displays it in the left panel under the Favorites tab).

Copy-Paste function

To properly copy a table, just use the mouse to select an area, and then using the keyboard shortcut Ctrl+C, copy the data to the clipboard. The selected area is highlighted in a different color to make sure what exactly is being copied. Example: After copying, just do the keyboard shortcut Ctrl+V or right mouse button + paste. Instead of using the mouse, you can also select the entire table with the keyboard shortcut Ctrl+A. In a situation where a specific dimension contains multiple sub-dimensions in the table, for example, the Year dimension contains multiple documents from the Document Number dimension, The Copy function will split the Year dimension into each document number from the table (the column with year is not merged):         In a situation where dimensions are presented differently in the table, as in the case below:
  • Year dimension is expanded
  • Document Number dimension is expanded for one document only
  • Product Code dimension is only expanded for one document that is expanded in the Document Number dimension
            the table will look as follows after pasting the data: As shown in the above screenshot, when there is no product expanded for other dimensions, the corresponding column is copied from the previous dimension (in this case, these are the red document numbers framed in red). As far as the format of copied data is concerned, the data is always pasted in numerical format after copying. Example: Comarch BI Point
  • Measure “Sales Value” in thousands format
  • Measure “Sales Quantity” in Scientific notation format
                          Microsoft Excel                        

Import/export

Import/export in a new repository

 

Export

To export a data model, select an object and then the button "Download File": or the option "Download File" from the context menu: You can also export multiple elements at once: Selecting "Download File" in the bottom right corner of the screen opens a transfer window, where you can view the object export status.  

Import

To import a file, go to the target directory and select the option "Upload File" from the context menu: or manually open the taget location and select "Create" > "Upload File" respectively:   Selecting "Upload File" in the bottom right corner of the screen opens a transfer window, where you can view the file's current import status. When the program detects that the imported object has a reference object (data model/report) in the repository to which the object is being imported, an additional dialog box opens: Available import options are:
  • Skip
Depending on the imported object: When importing a report, analysis, or dashboard, selecting the "Skip" option will only import the selected object (provided that the data model and connection on which the object is based are the same as the data model/connection from which it was exported). If a data model or connection is missing, the import will create a separate directory in the corresponding location (tab: Connections, Models) that will contain the data model or connection for the imported object:
  • Save Separately
This option imports the object and creates duplicates of the model and connections. The import process creates new directories with the import name in the corresponding locations for Connections and Model. An additional window will appear during the import, where you can provide your credentials to the source location from which the data for the model and report are imported. You can skip this process and provide the connection details later.
  • Update Existing
This option imports an object and overwrites all the object-related elements.
Przykład
If you select the option "Update Existing"when importing an analysis to the environment where an analysis with the same model name and connections already exist, then: The current model and connections will be overwritten with data from the export file. All previous information related to the model and connection will be replaced with the values included in the import file. This way, the model structure and connection configuration will exactly match the version saved in the export file.

Repository from the user's perspective

This mode is only available to BI Point administrators. In this mode, you can select a user whose privileges will be used to view the repository with only the items accessible to the selected user. To continue to the view, select the action "Display As" under the profile icon:

This action opens a window where you can select the user whose privileges you want to view:

After selecting a user, the repository will customize accoridingly.

Personalized links – repository

In Comarch BI Point, you can add a link directly to the main menu of the repository:   To add a personalized link, you must add the appropriate entry to the RB.Links table in the BI Point database. In order to add a link, you must provide the following:
  • LNK_IdProd (unique link numbering in the database)
  • LNK_Name (link name displayed from the repository)
  • LNK_Link (referene link)
  • LNK_OnlyDottedVisibility (visibility parameter)
  A link icon is optional and can only be added from the Material Design pool. It must be added in the column LNK_Ico. The following was used in the example above: "picture_as_pdf"      

ChatERP

Uwaga
The appropriate role is required in order to use ChatER.
To open ChatERP on any repository view, you must select:   ChatERP is based on the Comarch BI Point documentation so as to quickly and easily search for the necessary information. The system integrates directly with the data in the documentation, allowing for effective retrieval of answers to user queries.
Przykład
Przykład

Contexts

Activating contexts

In order to use contexts in BI Point, you must edit the entries in the config.json file. Default location: "C:\Program Files (x86)\Comarch\BI Point\instances\instance name\bipoint" Flags:
  • IsReportContextEnable 
activates context-based reports
  • IsReportContextCheckEnabled 
activates certificate validation To be able to create contexts, both flags must be set to true, as shown below: Save the config.json file after making the above changes and restart the Comarch BI Point service for the changes to take effect.

Adding contexts

Contexts can only be added from a database level. To add a new context, you need to execute the following scripts on a PostgreSQL BI Point database.
INSERT INTO rb."Contexts" ("CTX_Name") VALUES ('ContextName')
INSERT INTO rb."Parameters" ("PAR_Name") VALUES ('ParameterName') INSERT INTO rb."ContextsParameters" ("CTP_ContextId","CPT_ParameterId") VALUES (1,1)
INSERT INTO [RB].[ContextsMappings]([CTM_ContextId],[CTM_ContextMapping],[CTM_MappingName]) VALUES (1,'ExternalContextName','ContextName') After you execute the above code, the NewContext will be visible. The API will use the name ExternalContextName. You can optionally add translations for conexts: INSERT INTO rb."ContextTranslations" ("CTL_Id", "CTL_ContextId", "CTL_LocaleId", "CTL_Translation") VALUES (1, 1, 'en-EN', 'Sale')

Defining contexts in Comarch BI Point

After you successfully activate contexts from the config.json file (as described in article Activating contexts) and add a context to the database (as described in article Adding contexts), you need to define contexts directly on the repository object. To define a context, first select the appropriate object and then the "Add Context" button.
Uwaga
Contexts cannot be added if the report, dashboard, or analysis is based on a data model that contains parameters.

After you select an object, a window with sections Context and Filtered Attribute will open.

  • Context
If only one context has been added, the field remains insensitive and cannot be edited. If more contexts have been added, a drop-down list with the added contexts will appear in the field, from which you can select the appropriate one.
  • Filtered attribute
In this field, you can select an attribute from the data model of the referenced object to which the created context will be assigned. You can add multiple contexts to a single object if more than one context has been defined in the database.

Using contexts in Comarch BI Point

Using contexts

API methods must be executed directly after the BI Point instance, e.g. http://localhost:55555/api/ReportContext/GetContextReports  

Available methods:

  • api/ReportContext/GetContextReports
this method displays all reports to which the context has been assigned. It returns a list of objects containing the report ID, name, and a list of contexts. The returned list is in JSON format. 1. Request this request accepts a list of contexts and a list of users. Both parameters are optional; if neither is specified, the response will contain a list of all context reports, unfiltered by access. Adding a context ID or its name will return reports assigned to those contexts. Adding a user ID or login will filter the list and return only those reports to which the user has access. 2. Response this method returns a list of report objects grouped by users. Reports to which the user does not have access are not returned. Each report object contains an Id,ReportName, and a list of contexts (Id,Name,Caption) assigned to it.  
  • api/ReportContext/GenerateLinks
this method generates a link to the report using the list of members, the report ID, and the context number. The report ID is the minimum parameter. 1. Request the request accepts the report ID to be opened and a list of contexts. The list contains the context ID and a list of elements to be filtered. These elements may have Type and Value fields, which are limited to three supported types: 2. Unique name 3. Displayed name 4. OrgId If BI Point cannot find an element, or if the provided context is not linked to the report, the report will open without the missing elements. 5. Response this method generates a link to a report/dashboard with a GUID under which all information necessary for filtering is stored.  

Examples of how to use the methods

 
  • api/ReportContext/GetContextReports

1.Requests

  • all context reports are requested.
{"data":"{}"}
  • context reports assigned to the context "Product" are requested.
{"data":"{\"Contexts\":[{\"Name\":\"Product\"}]}"}
  • context reports assigned to the context with id 20 are requested.
{"data":"{\"Contexts\":\[{\"Id\":20}\]}"}
  • context reports assigned to the context "Product" or to the context with id 20 are requested.
{"data":"{\"Contexts\":[{\"Id\":20},{\"Name\":\"Product\"}]}"}
  • all context reports available to the user with login "ab" are queried.
{"data":"{\"Users\":[{\"Login\":\"ab\"}]}"}
  • all context reports available to the user with id 14 are queried.
{"data":"{\"Users\":[{\"Id\":14}]}"}
  • all context reports available to the user with the login ab and to the user with id 14 are queried. Reports are grouped separately for each user.
{"data":"{\"Users\":[{\"Login\":\"ab\"},{\"Id\":14}]}"}
  • context reports assigned to the contect with id 20 and grouped by the user with the login "ab" and id 14 are queried.
{"data":"{\"Users\":[{\"Login\":\"ab\"},{\"Id\":14}],\"Contexts\":[{\"Id\":20}]}"}

2.Responses

 
  • api/ReportContext/GenerateLinks

1.Requests

  • a link to the report 37530 is requested
{"data":"{\"Id\":37530}"}
  • a link to the report 37530 filtered to the element with a unique name (Type 0) in the context with id 20 is requested
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":0,\"Value\":\"[Product].[Code].&[100010013]\"}]}]}"}
  • a link to the report 37530 filtered to the element with a displayed name (Type 1) in the context with id 20 is requested
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":1,\"Value\":\"KAR/0024/OP\"}]}]}"}
  • a link to the report 37530 filtered to the element with OrgId (Type 2) in the context with id 20 is requested
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":2,\"Value\":\"368:141\"}]}]}"}
  • a link to the report 37530 filtered to the element with a unique name, displayed name and OrgId in the context with id 20 is requested
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":20,\"Members\":[{\"Type\":0,\"Value\":\"[Product].[Code].&[100010013]\"},{\"Type\":1,\"Value\":\"KAR/0024/OP\"},{\"Type\":2,\"Value\":\"368:141\"}]}]}"}
  • a link to the report 37530 filtered to the element with a displayed name in the context with id 12 and with a unique name, displayed name and OrgId in the context with id 20 is requested
{"data":"{\"Id\":37530,\"Contexts\":[{\"Id\":12,\"Members\":[{\"Type\":1,\"Value\":\"00111 test test DE-123123 Bayern\"}]},{\"Id\":20,\"Members\":[{\"Type\":0,\"Value\":\"[Product].[Code].&[100010013]\"},{\"Type\":1,\"Value\":\"KAR/0024/OP\"},{\"Type\":2,\"Value\":\"368:141\"}]}]}"}

2.Responses