Table of Contents
1. Overview
The Sources in the Setup section allows you to seamlessly link and utilize data from existing Infoveave Datasources, SQL queries, or raw data into configuring the widgets.
2. Sources
The Sources feature in the Setup section of the Customization Panel allows you to create Infoboard sources and incorporate data into your widgets. Here is a step-by-step guide on how to effectively use the Sources feature:
Select the Sources option and click on + Add New Source.
- This will allow you to select the Infoboard source for your widgets.
- Choose any from the below Infoboard sources options:
- Datasource
- Query
- Raw Data
- API Source
- Use Code
2.1 Start with Existing Datasource
Start with Existing Datasource option allows you to select from existing Datasources that can be used to create Infoboard
- To Start with Existing Datasource:
- Click on Select Datasource.
- Select the appropriate Datasource from the available list to incorporate the data into your widgets.
- Click Save to, save the selected Datasource.
- To learn about configuring Datasources in Infoveave, visit the section Datasources.
2.2 Use Query
To utilize the Start with Query option and set up an SQL query, follow these steps:
- Click the Use Query button to choose the Start with Query option.
- This will direct you to the SQL query setup.
- Provide a name for the query.
- Assign a meaningful name to the query to facilitate easy identification and management.
- Select the Datasource.
- Choose the appropriate Datasource on which the SQL query should be executed.
- Write the SQL query.
- Write the SQL query that captures the required data.
- Specify the SELECT statements, conditions, joins, and any necessary clauses.
- Write the SQL query that captures the required data.
- Run the SQL query.
- Click the Run icon to execute the SQL query.
- This will run the query and generate the resulting tables.
- Click on Save to save the SQL query.
- Right-clicking on the query writing section provides the following options:
- Change all occurrences: Modify all instances of a specific term or expression within the query.
- Cut: Remove the selected portion of the query and store it in the clipboard.
- Copy: Duplicate the selected portion of the query and store it in the clipboard.
- Paste: Insert the contents from the clipboard into the query.
- Command palette: Access a range of additional functions and commands related to query editing and management.
- The date filter options appear only when the SQL query have a date filter.
2.3 Use Raw Data
To create the Infoboard source with Raw Data, follow the below steps:
- Click on the option Use Data.
- This action will direct you to the setup for the raw data source.
- Provide a name for the source:
- Name the source to facilitate easy management.
- Paste the raw excel data.
- Copy the raw Excel data from your source file.
- Paste the data into the designated area within the setup.
- Click on the View Table icon.
- This action will display the table generated from the pasted raw data.
- The system will automatically identify the column names as measures and dimensions.
- Save the raw data source.
- Click on the Save button to store the raw data source.
- When creating new sources from raw data in Infoveave, columns with special characters or alphabets in their values are automatically classified as dimensions.
- For numerical operations, clean and format the data before importing it into Infoveave.
2.4 Use API
To build a Datasource directly in Infoveave from an API, follow the below steps:
- Click the Use API button to Start with API source option.
- This will direct you to the API setup.
- Provide a name for the API source.
- Assign a meaningful name to facilitate easy identification and management.
- Select the desired HTTP request method from the dropdown list. Infoveave supports the following request types:
- GET: Retrieve data from a specified resource. It is commonly used to fetch information from APIs.
- POST: Send data to a server to create a new resource. It is used to submit data to APIs for creating records.
- Enter the required Request URL, which specifies the endpoint of the API you want to interact with (required).
- Define the content type as json or form-url-encoded, depending on the requirements of the API (required).
- To configure the headers, click on the header column.
- For each header, define a name/key and a corresponding value.
- The name/key typically represents the type of information, like “Authorization” or “Content-Type.”
- Authorization Header: Often used for authentication, it might include a token or other credentials
- Content-Type Header: Specifies the format of the data being sent, such as “application/json” for JSON data.
- The value is the specific data associated with that name/key.
- The name/key typically represents the type of information, like “Authorization” or “Content-Type.”
- If you need more than one header, simply repeat the process by clicking the + button again.
- In case you need to remove a header, click on the delete button associated with each name/key-value entry.
- Configure the body of the request, if needed, by specifying the necessary data in json format.
- If authentication is required, enter the Auth URL, Auth Request Type, Auth Headers, Client ID, and Client Secret in the corresponding fields.
- Click Run icon to run the API with your configuration and view the table in the preview side.
- Click Save to save the source.
- You can add date filters to your URL in th below format (If your dataset contains a date column).
- To add date filter to the Header add the below syntax to the header column.
- @StartDate
- @EndDate
- Use the POST request type.
- Modify the request URL accordingly.
- Add the row data to the request body in JSON format.
- Click the Preview Table icon to verify that the data has been successfully added.
- To confirm the addition of data, change the request type to GET and update the request URL accordingly.
- Click the Preview Table icon again to ensure that the data has been successfully incorporated into the API source.
2.5 Use Code
To create the Infoboard source with Code, follow the below steps:
- Click on the option Use Code.
- This action will direct you to the setup for writing your custom JavaScript code.
- Provide a name for the source:
- Name the source to facilitate easy management.
- Write custom JavaScript.
- Write the custom code into the designated area within the setup.
- Click on the Preview Table icon.
- This action will display the table generated from the pasted raw data.
- Save the code source.
- Click on the Save button to store the code source.
- The Code-Based Datasource supports variables, allowing to use predefined variables and other system defined variables such as @StartDate and @EndDate of the board, available in "YYYY-MM-DD" format.
2.3 Add Calculated Column
A calculated column is a new set of columns added to the original dataset based on the Infoveave functions. The calculated columns make use of the existing data columns across your data table to add new information to your dataset transforming them to generate detailed insights. For example, you can create a calculated column in your data table that gives you the percentage difference between the any two column values in that table.
2.3.1 Calculated Column Syntax
Function(<Reference>,<Condition>)
Where
<Reference>
is replaced by[Column Name]
and<Condition>
is replaced by[Column Name] ="Column Value".
Function
: Functions are like commands that you use in data analysis to perform specific tasks.Column Name
is enclosed in square brackets ([]
) to represent a measure name."Column Value"
is enclosed within double quotes (" "
) to represent a specific dimension value.
- To add a calculated column to any of your Query, Raw Data or API source in Infoveave, navigate to the desired Infoboard under Insights.
- In the Infoboards section, locate the and access the Infoboard for which you want to configure expressions.
- Click on the Setup tab associated with the selected Infoboard under the Customization panel.
- Within the Setup panel, click on the Sources option.
- Click on add calculated column icon across the required Query, Raw Data or API source.
- Click on the option Add Calculated Column.
- Give the calculated column a name.
- Select the calculated column type from the list of drop-down options.
- Write your calculated column function following the appropriate syntax.
- Click on Preview, to view the added column to your data table.
- Click on OK to save the added column.