### Example: New Bold BI Installation

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-linux/installation-and-deployment/bold-bi-on-open.md

Provides an example of how to run the Bold BI installation script for a new installation, specifying the user, host URL, and enabling Nginx configuration.

```shell
sudo bash install-boldbi.sh -i new -u www-data -h http://linux.example.com -n true
```

--------------------------------

### Example Bold BI Installation Command

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-linux/deploy-bold-bi-using-apache-server/configure-apache-server-in-centos.md

An example of the Bold BI installation command for a new installation, specifying the user, host URL, and Apache server configuration.

```shell
sudo bash install-boldbi.sh -i new -u www-data -h http://linux.example.com -s apache
```

--------------------------------

### Install React Dependencies and Start Application

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/samples/react-with-python.md

Install the necessary packages for the React frontend and then start the development server. This will launch the embedded dashboard in your browser.

```bash
npm install
npm start
```

--------------------------------

### Silent Installation without Application Startup Details

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-windows/silent-installation.md

Example command for silent installation where application startup details are not provided during setup. Set 'IsSilentStartUp' to 'false'.

```bash
boldbienterpriseedition_10.1.1200_202307101000.exe /Install Silent /InstallPath:C:\BoldBI\ /IISPortNo:80 /IISSiteName:BoldBI /IsSetFirewall:true /IsDesktopShortcut:true /IsStartMenuShortcut:true /IsSilentStartUp:false
```

--------------------------------

### Run React with Node.js Sample

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/samples/react-with-node-js.md

Start the React and Node.js sample application after installation.

```javascript
npm start
```

--------------------------------

### Example: New Installation with HTTPS

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-linux/installation-and-deployment/bold-bi-on-ubuntu.md

Demonstrates a new Bold BI installation using an HTTPS host URL, including SSL certificate and key paths.

```shell
sudo bash install-boldbi.sh -i new -u www-data -h https://linux.example.com -n true --ssl-cert /etc/ssl/domain.crt --ssl-key /etc/ssl/domain.key
```

--------------------------------

### Silent Installation with Application Startup Details

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-windows/silent-installation.md

Example command for silent installation including application startup configuration via a JSON file. Ensure 'IsUpgrade' is 'False' for a fresh installation.

```bash
boldbienterpriseedition_10.1.1200_202307101000.exe /Install Silent /InstallPath:C:\BoldBI\ /IISPortNo:80 /IISSiteName:BoldBI /IsSetFirewall:true /IsDesktopShortcut:true /IsStartMenuShortcut:true /IsSilentStartUp:true /JsonFilePath:C:\BoldBI\application_startup.json
```

--------------------------------

### Example Deployment with Apache (HTTPS)

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-linux/deploy-bold-bi-using-apache-server/configure-apache-server-in-ubuntu.md

An example command for a new Bold BI installation using an HTTPS host URL, specifying SSL certificate and key paths for Apache.

```shell
sudo bash install-boldbi.sh -i new -u www-data -h https://linux.example.com -s apache --ssl-cert /etc/ssl/domain.crt --ssl-key /etc/ssl/domain.key
```

--------------------------------

### Install Vue.js Dependencies and Run

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/samples/vuejs-with-node-js.md

Install dependencies for your Vue.js application and start the development server to render the dashboard.

```bash
npm install
npm run serve
```

--------------------------------

### Sample Query for Project Users in a Workspace

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/working-with-data-sources/data-connectors/toggl.md

Example URL to get a list of users associated with projects within a specific workspace.

```URL
https://www.toggl.com/api/v8/workspaces/12345/project_users
```

--------------------------------

### Run Bold BI Installation Script

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-linux/installation-and-deployment/bold-bi-using-rpm.md

Execute the Bold BI installation script from the installation directory. Use the provided flags for new installations, specifying user, host URL, and Nginx configuration.

```bash
sudo bash install-boldbi.sh -i {new} -u {user} -h {host URL} -n {true or false}
eg : sudo bash install-boldbi.sh -i new -u root -h http://linux.example.com -n true
```

--------------------------------

### Start Bold BI Container and View Logs

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-docker/bold-bi-on-docker/bold-bi-eval-on-single-container.md

Run this command to start the Bold BI application container in detached mode and then stream its logs to monitor the installation status.

```bash
docker-compose up -d; docker-compose logs -f boldbi
```

--------------------------------

### Example URL with Multiple Parameters

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/working-with-data-sources/dashboard-parameter/change-the-dashboard-parameter-value-in-url.md

This is an example of how to construct a dashboard URL with multiple parameter values.

```text
https://<servername>/dashboards/<dashboardid>/<category>/<dashboardname>?&&<parameter1>=<value1>&&<parameter2>=<value2>
```

--------------------------------

### Install pv tool on Ubuntu

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-linux/upgrade-to-latest.md

Installs the 'pv' tool on Ubuntu systems, which is often used for monitoring data transfer during installations or upgrades.

```bash
sudo apt-get install pv
```

--------------------------------

### Run Go Backend Sample

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/samples/vuejs-with-go.md

Use this command to run the backend Go sample application. Ensure you have Go installed and the token generation file is present.

```bash
go run tokengeneration.go
```

--------------------------------

### Start Function Example

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/working-with-data-sources/data-connectors/live-web.md

Sets the date and time values to the start of the given string parameter (e.g., 'week').

```template
{{:today.addweeks(2).start(week)}}
```

--------------------------------

### Example Dashboard URL

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/iframe-embedding/embedding-with-token-authentication.md

This is an example of a dashboard URL that can be embedded. Refer to the 'Get links to Dashboards' documentation for more details.

```javascript
https://test.boldbi.com/bi/en-us/site/site1/dashboards/8428c9d9-85db-418c-b877-ea4495dcddd7/Predictive%20Analytics/Personal%20Expense%20Analysis
```

--------------------------------

### Serve the Application Locally

Source: https://github.com/boldbi/bold-bi-docs/blob/main/README.md

Starts a local development server to view the documentation. Navigate to http://localhost:8000 in your browser after running this command.

```cmd
gulp serve
```

--------------------------------

### Install Python 3.9 on Ubuntu 20.04

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-linux/upgrade-to-latest.md

Installs Python 3.9 on Ubuntu 20.04 systems, including necessary dependencies and PPA setup.

```bash
sudo apt update && sudo apt install wget software-properties-common && sudo add-apt-repository ppa:deadsnakes/ppa && sudo apt update && sudo apt install python3.9
```

--------------------------------

### Sample Query for Projects

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/working-with-data-sources/data-connectors/toggl.md

Example URL to retrieve project information from Toggl.

```URL
https://www.toggl.com/api/v8/projects
```

--------------------------------

### Create React App and Navigate

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/samples/react-with-node-js.md

Commands to create a new React application within a 'client' directory and navigate into it.

```bash
mkdir client
cd client
npx create-react-app .
cd..
```

--------------------------------

### Run Node.js Sample

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/samples/node-js.md

Execute this command to run the Node.js sample application after installing the packages.

```javascript
node tokengeneration.js
```

--------------------------------

### Build the Application

Source: https://github.com/boldbi/bold-bi-docs/blob/main/README.md

Compiles and builds the documentation application. This command should be run after installing dependencies.

```cmd
gulp build
```

--------------------------------

### Count Function Examples

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/visualizing-data/working-with-widgets/configuring-label-parameters.md

Use the Count function to get the number of records for numeric, text, or date-time columns. Examples include {{:count(Quantity)}}, {{:count(ShipCountry)}}, or {{:count(InvoiceDate)}}.

```text
Number of records : {{:count(Quantity)}}
```

```text
Number of records : {{:count(ShipCountry)}}
```

```text
Total Transactions : {{:count(InvoiceDate)}}
```

--------------------------------

### MariaDB Full Table Configuration Example

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/working-with-data-sources/working-with-bold-data-hub/data-connectors/mariadb.md

Example configuration for a MariaDB data connector using the FULL_TABLE replication method. This setup fetches data in full table loads with specified intervals.

```yaml
version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: tap_postgres
      connectorname: MariaDB
      config:
        host: Hostname or IP address of the server
        port: Server running port
        username: Username
        password: Password
        database: Database
        drivername: mysql+pymysql
      select:
        - TABLE1
        - TABLE2
      metadata:
        TABLE1:
          replication_method: FULL_TABLE
          replication_key: last_modified_on
          replication_value: 2023-07-19 00:00:00
          interval_type: days
          interval_value: 6
        TABLE2:
          replication_method: FULL_TABLE
          replication_key: last_modified_on
          replication_value: 2023-07-19 00:00:00
          interval_type: days
          interval_value: 6
```

--------------------------------

### Index JS Setup

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/samples/react-with-go.md

Configures the entry point of the React application. Renders the main App component into the DOM using createRoot.

```javascript
import React from 'react';

```

--------------------------------

### COUNT Function Example

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/working-with-data-sources/data-modeling/configuring-expression-columns/aggregation-expressions.md

Counts the number of items in a specified numeric expression. Use this to get the total count of records.

```boldbi
COUNT([OrderID])
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/boldbi/bold-bi-docs/blob/main/README.md

Installs all necessary project dependencies defined in the package.json file. Run this command from the root folder of the cloned repository.

```cmd
npm install
```

--------------------------------

### DayOfWeek Function Example

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/visualizing-data/working-with-widgets/configuring-label-parameters.md

Use the DayOfWeek function to get the day of the week (Sunday to Saturday) for a selected record, e.g., {{:dayofweek(ShippedDate)}}.

```text
Weather in NYC on {{:dayofweek(ShippedDate)}}
```

--------------------------------

### Install Node.js Dependencies

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/samples/flutter-with-javascript.md

Install the necessary Node.js dependencies for the backend server. This command should be run in the 'nodejs' directory of the sample application.

```bash
cd nodejs
npm install
```

--------------------------------

### Incremental Refresh with UTC Timezone

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/working-with-data-sources/working-with-bold-data-hub/data-connectors/mongodb.md

Example of configuring incremental data refresh for multiple tables using UTC timezone. The replication_value indicates the starting point for data fetching.

```yaml
version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: tap_postgres
      connectorname: PostgreSQL
      config:
        connection_url: "<connectionurl>"
        database: <databasename>
      select:
        - TABLE1
        - TABLE2
      metadata:
        TABLE1:
          replication_method: INCREMENTAL
          replication_key: last_modified_on
          replication_value: 2023-07-19 00:00:00
          timezone: UTC
        TABLE2:
          replication_method: INCREMENTAL
          replication_key: last_modified_on
          replication_value: 2023-07-19 00:00:00
          timezone: UTC
```

--------------------------------

### Sample Query for Tasks

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/working-with-data-sources/data-connectors/toggl.md

Example URL to retrieve task information from Toggl.

```URL
https://www.toggl.com/api/v8/tasks/12345
```

--------------------------------

### MongoDB Connection URL Examples

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/working-with-data-sources/working-with-bold-data-hub/data-connectors/mongodb.md

Illustrates various connection URL formats for different MongoDB deployment methods, such as local installations, Docker, MongoDB Atlas, and managed cloud services.

```text
mongodb://dbuser:passwd@host.or.ip:27017
```

```text
mongodb://dbuser:passwd@docker.host:27017
```

```text
mongodb+srv://dbuser:passwd@cluster.mongodb.net
```

```text
mongodb://dbuser:passwd@managed.cloud:27017
```

```text
mongodb://dbuser:passwd@config.tool:27017
```

```text
mongodb://dbuser:passwd@replica.set:27017
```

```text
mongodb://dbuser:passwd@shard.cluster:27017
```

```text
mongodb://dbuser:passwd@k8s.cluster:27017
```

```text
mongodb://dbuser:passwd@tarball.host:27017
```

--------------------------------

### Handle Pinboard Action Start Event

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/component-api-v2.0/pinboard/pinboard-events.md

Use the `onActionStart` event to trigger custom actions at the beginning of various viewer operations. This example shows how to perform specific actions when the `clearAllFilter` event type occurs.

```javascript
var dashboard = BoldBI.create({
     events: {
        onActionStart: function (args) {
          if (args.eventType === "clearAllFilter") {
               // Write a code block to perform any further actions.
          }
        }
     } 
});
dashboard.loadPinboard()
```

--------------------------------

### Run Vue Frontend Sample

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/samples/vuejs-with-go.md

Use this command to start the Vue.js development server and run the frontend sample application. This will typically launch the app in your default browser.

```bash
npm run serve
```

--------------------------------

### Generate Embed Signature and Fetch Details (Python)

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/authorization-options/authorization-server-url-work-flow.md

This Python snippet demonstrates how to generate an embed signature using HMAC-SHA256 and then fetch embed details by making a GET request to the Bold BI server. Ensure you have the 'requests' library installed.

```python
embedDetailsUrl = "/embed/authorize?" + embedQuerString + "&embed_signature=" + get_signature_url(embedQuerString)
result_content=requests.get(dashboardServerApiUrl + embedDetailsUrl)
return HttpResponse(result_content)

def get_signature_url(message):
    EmbedSecret = models.EmbedProperties.EmbedSecret
    keyBytes = bytes(EmbedSecret.encode('utf-8'))
    messageBytes = bytes(message.encode('utf-8'))
    hashMessage = base64.b64encode(hmac.new(keyBytes,messageBytes,digestmod=hashlib.sha256).digest())
    
    return str(hashMessage, "utf-8")
```

--------------------------------

### Example FULL_TABLE Configuration

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/working-with-data-sources/working-with-bold-data-hub/data-connectors/zendesk-talk.md

Provides a complete YAML configuration example for the FULL_TABLE replication method, including connection details and metadata for multiple tables.

```yaml
version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: zendesk_data
      connectorname: zendesk
      config:
        subdomain: subdomain
        email: mail
        password: password
        token: <>
        Oauth token: <>
      Select:
        - TABLE1
        - TABLE2
      metadata:
        TABLE1:
          replication_method: FULL_TABLE
          replication_key: last_modified_on
          replication_value: '2023-07-19 00:00:00'
          interval_type: days
          interval_value: 6
        TABLE2:
          replication_method: FULL_TABLE
          replication_key: last_modified_on
          replication_value: '2023-07-19 00:00:00'
          interval_type: days
          interval_value: 6

```

--------------------------------

### PHP: Get Embed Token with User Import Enabled

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/embedding-sdk/authorization-options/enabling-user-import-with-group-based-authorization.md

This PHP code demonstrates how to obtain an embed token from Bold BI, specifically enabling user import for group-based authorization. Ensure you have cURL installed and replace placeholder values with your actual server details and user information.

```php
function getToken() {
    $embedDetails = [
      "serverurl" => "<Bold BI Server URL>",
      "siteidentifier" => "<Site Identifier>",
      "embedsecret" => "<Embed Secret Key>",
      "dashboard" => [
        "id" => "<Dashboard Id>"
      ],
      // Group-Based details
      "email" => "<Third Party User Email>",  
      "groupbasedauthorization" => [
          "isenabled" => true,  // This property enables group-based authorization embedding.
          "userid" => "<User Id>",  // User id of the user
          "authprovidername" => "<Auth Provider Name>"  // Provide auth provider name
          "isenableduserimport" => true  // This property enables user import in group-based authorization
      ]
    ]

    // Send POST request to Bold BI server
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $embedDetails["serverurl"] . "/api/" . $embedDetails["siteidentifier"] . "/embed/authorize");
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'Content-Type: application/json'
    ]);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($embedDetails));
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);

    $response = curl_exec($ch);
    
    if (curl_errno($ch)) {
      curl_close($ch);
      return "Error: " . curl_error($ch);
    }

    curl_close($ch);

    // Decode JSON and extract token
    $decoded = json_decode($response, true);
    return $decoded['Data']['access_token'] ?? "Error: Token not found";
}
```

--------------------------------

### Install pip on Ubuntu

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-linux/installation-and-deployment/auto-deployment.md

Installs pip, the package installer for Python, on Ubuntu systems.

```bash
sudo apt-get install python3-pip
```

--------------------------------

### Start Local HTTP Server

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/embedding-options/iframe-embedding/sample/data-source-embedding/javascript.md

Initiate the HTTP server on a specific port to serve the application files. Replace <port number> with your desired port.

```bash
http-server -p <port number>
```

--------------------------------

### Install Data Hub via Command Prompt

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/working-with-data-sources/working-with-bold-data-hub/installation.md

Use this command to install the Data Hub service and application pool from the command prompt with administrative privileges. Ensure you use the correct path for your Bold Reports or Bold BI installation.

```bash
"C:\Program Files (x86)\Bold Reports\Enterprise Reporting\BoldETL>BoldETL.msi"
```

```bash
"C:\Program Files (x86)\Bold BI Enterprise Edition\BoldETL>BoldETL.msi"
```

--------------------------------

### Install GDIPlus package on RHEL

Source: https://github.com/boldbi/bold-bi-docs/blob/main/docs/deploying-bold-bi/deploying-on-linux/installation-and-deployment/bold-bi-on-redhat.md

Installs the 'GDIPlus' package, which is a dependency for Bold BI. This involves enabling the EPEL repository and then installing libgdiplus.

```bash
sudo dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
sudo yum install epel-release
sudo yum install libgdiplus
```