Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proofread overview #585

Merged
merged 16 commits into from
Feb 27, 2024
10 changes: 5 additions & 5 deletions 404.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ showBreadcrumbs: false
sitemap: false
---

**The Page you requested doesn't exist. Sorry about that. If we did something wrong, let us know at
**The page you requested doesn't exist. Sorry about that. If we did something wrong, let us know at
[support@keboola.com](mailto:support@keboola.com).**

{: .text-center}
![Confused Octopus](/keboola-kolecko.png)

If you are looking for some other stuff that does not exist, you might want to visit:

- [connection.keboola.com](https://connection.keboola.com) -- for logging in into KBC
- [status.keboola.com](https://status.keboola.com/) -- for getting KBC Status updates (service status and changelog); we recommend subscribing to the feed or monitoring it in a Slack channel to keep up to date.
- [help.keboola.com](https://help.keboola.com) -- for general help with using KBC
- [developers.keboola.com](https://developers.keboola.com) -- for developing a KBC extension
- [connection.keboola.com](https://connection.keboola.com) -- for logging in into Keboola
- [status.keboola.com](https://status.keboola.com/) -- for getting Keboola Status updates (service status and changelog); we recommend subscribing to the feed or monitoring it in a Slack channel to keep up to date.
- [help.keboola.com](https://help.keboola.com) -- for general help with using Keboola
- [developers.keboola.com](https://developers.keboola.com) -- for developing a Keboola extension
- [blog.keboola.com](https://blog.keboola.com/) -- something to read for data analysts
- [500.keboola.com](https://500.keboola.com/) -- something to read for tech geeks

Expand Down
2 changes: 1 addition & 1 deletion _layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="author" content="Keboola">
<title>{{ page.title }} | Keboola Connection User Documentation</title>
<title>{{ page.title }} | Keboola User Documentation</title>
<script src="https://ajax.googleapis.com/ajax/libs/webfont/1.6.26/webfont.js"></script>
<script>
WebFont.load({
Expand Down
8 changes: 4 additions & 4 deletions catalog/multi-project/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ permalink: /catalog/multi-project/
* TOC
{:toc}

Keboola Connection is a very versatile platform and can be used in many different ways. When you deal with a larger number of source
Keboola is a very versatile platform and can be used in many different ways. When you deal with a larger number of source
and destination systems, or when some of them are very complex or difficult to set up, you might consider splitting the
traditional extract-load process into isolated projects.

Expand All @@ -22,12 +22,12 @@ over again.
- etc.

The multi project architecture is a solution to these kinds of problems. It is not really any sort of architecture, it is
only a *usage pattern* of the Keboola Connection platform. The idea is to create separate projects for receiving,
only a *usage pattern* of the Keboola platform. The idea is to create separate projects for receiving,
analyzing and writing data. The projects structure can follow the organization structure, technological structure, or
anything else really.

## Example Scenario
Let's say that you have an existing Keboola Connection project that contains:
Let's say that you have an existing Keboola project that contains:

- Oracle database extractor with the following configurations:
- `ora-history` -- The source database is over 2TB; the largest table is `op_history`, which can be easily loaded [incrementally](/storage/tables/#incremental-loading) as records are only added; it is updated every 10 minutes.
Expand Down Expand Up @@ -80,7 +80,7 @@ working immediately. If the word "everyone" in the above statement is undesired,
anything in the database schema, they can do that in an unlimited number of arbitrarily sized steps, provided that the shared data
remains same. For that they can use the entire power of SQL, Python, R and Julia transformations combined. This is a much more flexible
solution then the traditional way of creating views. Then there is, of course, the advantage that you can work with the Oracle data
even when the server is down; but that's integral part of Keboola Connection.
even when the server is down; but that's integral part of Keboola.

On a very high level, the following schema represents a single project setup:

Expand Down
2 changes: 1 addition & 1 deletion components/applications/ai/generative-ai/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ redirect_from:
* TOC
{:toc}

The Generative AI application allows you to query both [OpenAI](https://platform.openai.com/docs) and [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/overview) models using data from your Keboola Connection project.
The Generative AI application allows you to query both [OpenAI](https://platform.openai.com/docs) and [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/overview) models using data from your Keboola project.

## Create New Configuration

Expand Down
18 changes: 9 additions & 9 deletions components/applications/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,26 @@ All applications are **implemented as [components](https://developers.keboola.co
and as such can be completely created by 3rd party developers.
You can even create your own application.
Applications can be created either for a particular end-user, or they may be offered
to all Keboola Connection customers; in that case they have to be registered in Keboola Connection [Developer Portal](https://components.keboola.com/).
to all Keboola customers; in that case they have to be registered in Keboola [Developer Portal](https://components.keboola.com/).

Applications may

- vary in terms and conditions.
- be billed extra; some are for free.
- send your data to 3rd party services outside of Keboola Connection.
- send your data to 3rd party services outside of Keboola.
- extract data from outside sources.
- be created by you, Keboola, or third parties.
- have support provided by their author.

The following screenshot shows some of many Keboola Connection applications (created by both, Keboola and 3rd parties):
The following screenshot shows some of many Keboola applications (created by both, Keboola and 3rd parties):

{: .image-popup}
![Keboola and 3rd parties Applications in KBC](/components/applications/applications.png)
![Keboola and 3rd parties Applications in Keboola](/components/applications/applications.png)

If you want to learn more about Applications or are interested in creating one, go to
our [Developer Documentation](https://developers.keboola.com/extend/).

If you want to see a short **demo on using a 3rd party app in Keboola Connection** (analyzing text data), [click here](https://www.youtube.com/watch?v=dx03hlA7dTo).
If you want to see a short **demo on using a 3rd party app in Keboola** (analyzing text data), [click here](https://www.youtube.com/watch?v=dx03hlA7dTo).
The video shows how to quickly extract text data from Twitter's API, process the data through Geneea's
natural language processing algorithm and visualise the results in Tableau.

Expand All @@ -52,16 +52,16 @@ Application and Transformations share many common properties. However, they diff
- Both Transformations and Applications can be used in your orchestrations in exactly the same way.
- The code of most R and Python Transformations can be used in Applications and vice versa, with none or
very few modifications.
- The Keboola Connection programming interfaces for Applications and Transformations are highly similar.
- The Keboola programming interfaces for Applications and Transformations are highly similar.

**Differences:**

- The code in Transformations is visible to everyone in the Keboola Connection project. The application code can be hidden.
- The code in Transformations is visible to everyone in the Keboola project. The application code can be hidden.
- The Transformation code is tied to a specific project. To share the code across different projects,
use Application.
- Transformations are versioned as changes in the configuration in the Keboola Connection project.
- Transformations are versioned as changes in the configuration in the Keboola project.
Applications are versioned externally.
- Applications can be created for you by 3rd parties, with some or even no access to your Keboola Connection project.
- Applications can be created for you by 3rd parties, with some or even no access to your Keboola project.
- There are also some [technical differences](https://developers.keboola.com/extend/custom-science/#technical-differences) between the two.

When deciding between the two, consider your capabilities, available resources and the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ permalink: /components/applications/triggers/orchestration-trigger-queue-v2/
* TOC
{:toc}

Trigger to start a Keboola Orchestration V2 across different Keboola Connection projects.
Trigger to start a Keboola Orchestration V2 across different Keboola projects.

## Authorization

Authorization is done with a [KBC Storage API token](https://help.keboola.com/management/project/tokens).
Authorization is done with a [Keboola Storage API token](https://help.keboola.com/management/project/tokens).
Generate a dedicated API token with either:

* Full access to all buckets and components.
Expand All @@ -24,8 +24,8 @@ If the second option is chosen, you must create a new token with further permiss
{: .image-popup}
![Screenshot - Incremental fetching](/components/applications/triggers/orchestration-trigger-queue-v2/config.png)

* Fill in the KBC Storage API token.
* Fill in the KBC stack based on your stack, you can find this out from the link to your keboola project
* Fill in the Keboola Storage API token.
* Fill in the Keboola stack based on your stack, you can find this out from the link to your keboola project
* Fill in the Orchestration ID
* Check or uncheck the checkbox for "Wait for job finish and check jobs status".
If checked, the job of the trigger will only finish when
Expand Down
10 changes: 5 additions & 5 deletions components/branches/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ from the Storage as if it were a normal configuration. However, when your branch
(tables or files) to Storage, it is stored separately and does not overwrite the original production data and interfere
with the running configurations. There is no need to duplicate your project's data when creating a new branch.

### Data pipelines
### Data Pipelines

When you create an extractor and then transform the data it produces using transformation it behaves the following way in branches:

Expand Down Expand Up @@ -84,18 +84,18 @@ You can end your branch's lifecycle in two ways:
**Important:** All this happens in a same project, allowing you to collaborate on the modifications with other members
of the project.

## Component considerations
## Component Considerations

Certain components are not allowed to run in development branches. There are following special cases where components' functionality is limited in the development branches.

### Working with external resources
### Working with External Resources

Some components, like writers, can write to a destination that is external to Keboola Connection. Those components'
Some components, like writers, can write to a destination that is external to Keboola. Those components'
configs are first marked as *unsafe* in development branch.

You will not be able to run an unsafe config. You need to first observe the config and verify that it's either OK to
write to the destination, or change the destination accordingly.

### OAuth authorized components
### OAuth Authorized Components

Components using OAuth does not allow authorizing nor changing the OAuth in development branch. The OAuth authorization tokens are shared with production so changing them might break the production pipeline.
14 changes: 7 additions & 7 deletions components/data-apps/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ customized internal reporting tools for business teams, financial apps to get in
Data apps may be written in any language. However, for now Keboola only supports apps written in [Streamlit](https://streamlit.io/),
which is a Python framework for rapid development of such applications.

As mentioned above, a data app is a simple web application, which can be deployed inside a Keboola Connection project
As mentioned above, a data app is a simple web application, which can be deployed inside a Keboola project
and also publicly accessed from outside the project.
It means that the users that will access your data app don't need access to a Keboola Connection project.
It means that the users that will access your data app don't need access to a Keboola project.

## Create a Data App
There are two ways to create a data app in Keboola Connection. Select a deployment type that will suit your needs:
There are two ways to create a data app in Keboola. Select a deployment type that will suit your needs:
- **Code** – Just paste a Streamlit code to create a simple data app.
- **Git repository** – Specify a git repository with Streamlit app sources. This is more suitable for complex applications.

Expand Down Expand Up @@ -62,14 +62,14 @@ These secrets will be injected into the secrets.toml file upon deployment of the
![Secrets](/components/data-apps/data_apps-secrets.png)

## Loading Data from Storage
To load data from the storage of a Keboola Connection project into the app, use the [input mapping](https://help.keboola.com/transformations/mappings/#input-mapping) section.
To load data from the storage of a Keboola project into the app, use the [input mapping](https://help.keboola.com/transformations/mappings/#input-mapping) section.
Just select your table in the input mapping section and navigate to that by /data/in/table/your_data.csv or /data/in/files/fileID_FileName.* in your code.
Note that, while in BETA, the app needs to be redeployed to fetch up-to-date data.
Or you can use [Keboola Connection Storage Python Client](https://github.com/keboola/sapi-python-client) in the app to load the data as needed.
Or you can use [Keboola Storage Python Client](https://github.com/keboola/sapi-python-client) in the app to load the data as needed.
See the [examples](#Examples) below for usage of the Keboola Storage Python Client.

## Writing Back to Storage
For writing data back to Keboola Connection Project Storage, use our [Keboola Connection Storage Python Client](https://github.com/keboola/sapi-python-client).
For writing data back to Keboola Project Storage, use our [Keboola Storage Python Client](https://github.com/keboola/sapi-python-client).
See the [examples](#Examples) below for usage of the Keboola Storage Python Client.

## Deployment and App Management
Expand Down Expand Up @@ -226,7 +226,7 @@ This data app, along with the complete workflow, can be implemented using the AI
### Interactive Keboola Sheets
Author: Petr Huňka

Simplify data editing and management within your company. The data app eliminates the need to export data to external tools, allowing business users to directly access and edit tables stored in Keboola Connection Storage.
Simplify data editing and management within your company. The data app eliminates the need to export data to external tools, allowing business users to directly access and edit tables stored in Keboola Storage.
- [Live app](https://sandbox.north-europe.azure.keboola.com/51814820/)
- [Configuration](https://demo.keboola.com/app/data-apps/51359967)
- [Documentation](https://help.keboola.com/templates/interactive-keboola-sheets/)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ redirect_from:
* TOC
{:toc}

This extractor allows you to import data from email attachments to Keboola Connection.
This extractor allows you to import data from email attachments to Keboola.
It extracts data from systems generating exports only as CSV files attached to an email.
It can also be used instead of repeated [manual imports of CSV](/tutorial/load/) files.

Expand Down
2 changes: 1 addition & 1 deletion components/extractors/communication/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ redirect_from:

---

Extractors import data from external sources and integrate it to the Keboola Connection environment.
Extractors import data from external sources and integrate it to the Keboola environment.
The following extractors support communication systems:

- [Email Attachments](/components/extractors/communication/email-attachments/)
Expand Down
2 changes: 1 addition & 1 deletion components/extractors/communication/slack/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ redirect_from:
{:toc}

The Slack extractor uses the [Slack API](https://api.slack.com/methods) to fetch data from [Slack](https://slack.com/)
and to bring it to Keboola Connection.
and to bring it to Keboola.

## Create New Configuration
[Create a new configuration](/components/#creating-component-configuration) of the **Slack** extractor.
Expand Down
2 changes: 1 addition & 1 deletion components/extractors/communication/zendesk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Fill in a description for the new token (for example, `Keboola Zendesk Extractor
{: .image-popup}
![Zendesk Token copy](/components/extractors/communication/zendesk/zendesk-2.png)

When the registration is finished, take a note of the API Key and save it. You will need it when creating your extractor configuration in Keboola Connection.
When the registration is finished, take a note of the API Key and save it. You will need it when creating your extractor configuration in Keboola.

## Configuration
[Create a new configuration](/components/#creating-component-configuration) of the **Zendesk** extractor.
Expand Down
6 changes: 3 additions & 3 deletions components/extractors/database/bigquery/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ redirect_from:
* TOC
{:toc}

The BigQuery extractor loads data from [BigQuery](https://cloud.google.com/bigquery/) and brings it into Keboola Connection.
The BigQuery extractor loads data from [BigQuery](https://cloud.google.com/bigquery/) and brings it into Keboola.
Running the extractor creates a background job that

- executes the queries in Google BigQuery.
- saves the results to Google Cloud Storage.
- exports the results from Google Cloud Storage and stores them in specified tables in Keboola Connection Storage.
- exports the results from Google Cloud Storage and stores them in specified tables in Keboola Storage.
- removes the results from Google Cloud Storage.

***Note:** Using the Google BigQuery extractor is also described in our [Getting Started Tutorial](/tutorial/ad-hoc/#using-bigquery-extractor).*
Expand All @@ -24,7 +24,7 @@ Running the extractor creates a background job that
To access and extract data from your BigQuery dataset, you need to set up a Google service account. Go
to [**Google Cloud Platform Console > IAM & admin > Service accounts**](https://console.cloud.google.com/iam-admin/serviceaccounts)
and select the project you want the extractor to have access to. Click **Create Service Account**
and enter a *Service account name* (e.g., `Keboola Connection BigQuery Extractor`).
and enter a *Service account name* (e.g., `Keboola BigQuery extractor`).

{: .image-popup}
![Screenshot - Create service account](/components/extractors/database/bigquery/googlecloud-1.png)
Expand Down
2 changes: 1 addition & 1 deletion components/extractors/database/filemaker/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Output
======

**NOTE** The columns prefixed `_` are prefixed with hsh prefix in the result table.
This is because the Keboola Connection Storage does not allow to store columns prefixed with underscore. So the column `_Timestamp` will be stored as `hsh_Timestamp` in the resulting table.
This is because the Keboola Storage does not allow to store columns prefixed with underscore. So the column `_Timestamp` will be stored as `hsh_Timestamp` in the resulting table.


### Metadata Tables
Expand Down
2 changes: 1 addition & 1 deletion components/extractors/database/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ redirect_from:
* TOC
{:toc}

Extractors import data from external sources and integrate it to the Keboola Connection environment.
Extractors import data from external sources and integrate it to the Keboola environment.

## SQL Databases

Expand Down
2 changes: 1 addition & 1 deletion components/extractors/database/sqldb/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Avoid doing complex joins and aggregations in SQL queries.
Remember that these queries are executed on the database server you are extracting from.
This database system might not be designed or optimized for complex SELECT queries.
Complex queries may result in timeouts, or they might produce unnecessary loads on your internal systems.
Instead, import raw data, and then use Keboola Connection tools to give it the shape you want.
Instead, import raw data, and then use Keboola tools to give it the shape you want.

## Server Specific Notes

Expand Down
4 changes: 2 additions & 2 deletions components/extractors/erp/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: ERP
permalink: /components/extractors/erp/
---

Extractors import data from external sources and integrate it to the Keboola Connection environment.
Keboola Connection provides the following ERP extractors:
Extractors import data from external sources and integrate it to the Keboola environment.
Keboola provides the following ERP extractors:

- [K2](/components/extractors/erp/k2/)
- [NetSuite](/components/extractors/erp/netsuite/)
Expand Down
Loading
Loading