Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.

Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |

Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
Create custom integrations
BVD expects to receive your data as HTTP post requests in JavaScript Object Notation (JSON) format.
We recommend that your JSON input contains flat data, consisting of name-value pairs. If you must send nested data, BVD automatically flattens the data (see also Nested JSON data). You can also send JSON data in arrays. This enables you to send multiple data objects in a single web service call (see also JSON data arrays).
Example: Sending JSON Data to BVD
Learn More

The BVD receiver URL should look something like this:
-
URL with dimensions only:
https://<external_access_host>/bvd-receiver/api/submit/<API key>/dims/<dims>[,<dims=value>]
-
URL with tags only:
https://<external_access_host>/bvd-receiver/api/submit/<API key>/tags/<tags>
-
URL with both dimensions and tags:
https://<external_access_host>/bvd-receiver/api/submit/<API key>/dims/<dims>[,<dims=value>]/tags/<tags>
The tags can also precede the dims:
https://<external_access_host>/bvd-receiver/api/submit/<API key>/tags/<tags>/dims/<dims>[,<dims=value>]
If the application sending the data is also installed as a suite container, define the receiver URL as follows:
http://bvd-receiver.<namespace>.svc.cluster.local:4000/bvd-receiver/api/submit/<API_key>
-
<external_access_host>
-
The fully qualified domain name of the host which you specified as
EXTERNAL_ACCESS_HOST
in theinstall.properties
file during the Container Deployment Foundation installation. Usually, this is the master node's FQDN. -
<namespace>
-
The namespace assigned to your suite deployment. You can check the namespace by accessing SUITE > Management in the Management Portal.
-
<API_key>
-
Identifies your BVD instance. You can find the API key in
Administration > Settings.
-
<tags>
-
Static labels that you can attach to your data to create more specific data channels.
-
<dims>
-
The names in your JSON name-value pairs. Select and combine dimensions (dims) that uniquely identify your data.
-
<dims=value>
-
The names and values in your JSON name-value pairs. Directly assign values with names to improve data identification. Use this option, for example, if you have separate servers of the same data source for different locations and you want separate dashboards for each location. These name-value pairs do not have to be part of the JSON input. If they are, the values in the JSON input will be overwritten by the values in the URL.

You can also submit the dims and tags as HTTP parameters of the URL.
Example
https://bvd.example.com/bvd-receiver/api/submit/47a648e9065d465012e541288b5a345e?dims=viewName,ciName,kpiName,location=nyc&tags=omi,kpi

You can combine the receiver URL and HTTP parameters to send dims and tags. Define the dims and tags as part of the URL path first, then add additional dims and tags as HTTP parameters.
Example
https://bvd.example.com/bvd-receiver/api/submit/47a648e9065d465012e541288b5a345e/dims/viewName,ciName=abc/tags/omi,kpi?dims=kpiName,location=nyc&tags=bvd
However, if the same dimension or tag is specified more than once, the value of the last query parameter overwrites the values of the previous parameters. The value of the last query parameter appears multiple times as data channel.
Example
https://bvd.example.com/bvd-receiver/api/submit/47a648e9065d465012e541288b5a345e/dims/location=boston?dims=location=nyc&tags=east&dims=location=atlanta
In this example, the dim location
will have the value atlanta
. Because dimensions are accumulated, the value atlanta
appears three times as data channel.

You can submit multiple JSON objects in a single web service call by adding them to an array.
Array: |
[ { |

If the input contains nested data, BVD automatically flattens the data by renaming nested name-value pairs to include the names of the parent elements, separated by slashes (/), for example:
Nested JSON data: |
Flattened JSON data: |
{ |
{ |

BVD stores only a specific number of data records per channel. The records are only kept if they are related to a widget.