Embedding Dashboards as iframe

Integration Auth

For page access security, IBI supports the following authentication methods:

• Authentication via the share ID generated by dashboard sharing, parameter: shareid. The shareid contains dashboard ID (boardId) information.
• Authentication via username and password, parameters: userName/password. The password supports plaintext or MD5 encrypted authentication.
• Authentication via JWT token, parameter: token.

Single Dashboard (PC)

The URL format for single dashboard integration is as follows:

https://bi.epivotlabs.com/appname/render.html?[key=value]

For external system integration, the dashboard sharing feature can be used to generate an accessible link from outside. The operation is as follows:

Free Layout Dashboard → Share → Select a sharing link validity period → Click Add:

After that, the dashboard can be accessed elsewhere. The dashboard accessed via this link does not include the surrounding menu bar and dashboard parameters.

Filter Parameter by URL

Keys are case-sensitive; this will not be repeated in subsequents.

Parameter Details

showParam

Global control to show/hide the parameter bar on the dashboard. Acceptable values: 0/1, true/false. If not provided, defaults to showing the parameter bar.

http://localhost:8088/render.html?shareid=N9SYIQ9r&showParam=false
http://localhost:8088/render.html?shareid=N9SYIQ9r&showParam=0

hiddenPNames

Controls hiding specific parameters in the parameter bar. Pass an array of parameter names. For example, the following request can hide the parameter named User on the dashboard to prevent users from modifying it.

http://localhost:8088/render.html?shareid=N9SYIQ9r&hiddenPNames=['User']

Parameter names can be compatible with both single and double quotes.

showTitle

Controls whether to show the original dashboard title.

http://localhost:8088//render.html?shareid=N0zt6xJw&showTitle=false#/

showExport

http://localhost:8088//render.html?shareid=N0zt6xJw&showExport=true#/

filters

The state of dashboard parameters can be set by passing a JSON object (generally generated by external integration system code). The specific format is as follows:

{
    "boardParams": [
        {
            "id": "mpgxi01ev6k",
            "name": "User",
            "type": "=",
            "values": ["aaa", "bbb"]
        },
        {
            "id": "2khmtv1s63p",
            "name": "User Name",
            "type": "=",
            "values": []
        }
    ]
}

• This JSON object can be extracted via the URL Parameter Tool. Users decide whether to URL-encode it before passing based on the complexity of parameter values.
• Association with parameters on the dashboard is via the id. Items that cannot be associated are discarded. The name property in filter items is optional; removing it can reduce parameter length.
• type: Different parameter types have different type values. It is recommended to check and debug via the URL Parameter Tool before setting.

  const EQ = '=',
      NEQ = '≠',
      GT = '>',
      LT = '<',
      GET = '≥',
      LET = '≤',
      LIKE = 'like',
      NOT_LIKE = 'not like',
      GEL = '(a,b]',
      EGL = '[a,b)',
      GL = '(a,b)',
      EGEL = '[a,b]';

http://host/render.html?shareid=N9SYIQ9r&filters={"boardParams":[{"id":"mpgxi01ev6k","name":"用户","type":"=","values":["aaa","bbb"]},{"id":"2khmtv1s63p","name":"用户名","type":"=","values":[]}]}

// After applying encodeURIComponent to filters
http://host/render.html?shareid=N9SYIQ9r&filters=filters=%7B%22boardParams%22%3A%5B%7B%22id%22%3A%22mpgxi01ev6k%22%2C%22name%22%3A%22%E7%94%A8%E6%88%B7%22%2C%22type%22%3A%22%3D%22%2C%22values%22%3A%5B%22aaa%22%2C%22bbb%22%5D%7D%2C%7B%22id%22%3A%222khmtv1s63p%22%2C%22name%22%3A%22%E7%94%A8%E6%88%B7%E5%90%8D%22%2C%22type%22%3A%22%3D%22%2C%22values%22%3A%5B%5D%7D%5D%7D

locale

Multilingual support for system menu items.

http://localhost:8088//render.html?shareid=N0zt6xJw&showExport=true&locale=en#/

Single Chart (PC)

The URL format for single chart integration is as follows:

https://bi.epivotlabs.com/appname/render.html?widgetId=xxx

Mini App (PC)

The format for thematic analysis integration is as follows, where the id parameter is the thematic analysis ID.

https://bi.epivotlabs.com/appname/mini-app.html?id=appId

Multiple Dashboards (PC)

The URL format for integration is as follows:

https://bi.epivotlabs.com/appname/render-lite.html?boards=[json array]&other variable definitions

URL Variable

boards

boards is a JSON array string, where each member corresponds to an integrated tab page (one dashboard). The accepted parameters are basically the same as for single dashboard integration.

[
    {
        showParam: true,
        showExport: true,
        title: 'First Board',
        boardId: 63,
        hiddenParamNames: [],
        filters: {
            boardParams:[{
                id: '5chiv3mmalw',
                name: 'country',
                type: '=',
                values: ['Canada']
            }]
        },
        variables: {
          country: 'USA'
        }
    },
    //...
]

boardStyle

The style of the dashboard display area, as a URL-encoded CSS string.

http://localhost:8088/render-lite.html?userName=peter&password=xxxboardStyle=background-color%3Ared

Cockpit (URL)

https://bi.epivotlabs.com/appname/cockpit.html?boardId=id&other variable definitions

URL Parameter

Cockpit Group

Generate integration addresses via the sharing feature.

URL Parameter

Filters Parameter Format

Can be generated via the URL Parameter Tool in the sharing window. Filters added to the URL need to be encoded. The name property in parameter items can be omitted. Parameter matching is associated via id.

{
    boardParams: [{
        boardId: xxx,
        filters: [{"id":"5chiv3mmalw","name":"Country","type":"=","values":["USA"]}]
    }]
}

Single Dashboard (Mobile)

https://bi.epivotlabs.com/mobile deployment address/render.html?boards=xxx

Multiple Dashboard (Mobile)

https://bi.epivotlabs.com/mobile deployment address/render.html?boards=xxx

URL Parameter

Mini App (Mobile)

https://bi.epivotlabs.com/mini-app.html?id=appId

URL Parameter