Skip to content

Commit 8c60bf1

Browse files
authored
Merge pull request #329 from quixio/feature/sc-58235/external-source-destination-no-longer-in
External source is not available in code samples library
2 parents a78224c + dd1d3bb commit 8c60bf1

File tree

5 files changed

+24
-101
lines changed

5 files changed

+24
-101
lines changed

docs/develop/integrate-data/external-source.md

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,13 @@
22

33
One simple way to write data into a Quix topic, is to use the prebuilt connector called `External source`.
44

5-
To use the `External source` connector, step through the following procedure:
6-
7-
1. In the UI click on `Code Samples` in the left-hand sidebar.
8-
9-
2. Search for `External source`.
10-
11-
3. Click `Add external source`.
12-
13-
4. Select the output topic that you want to publish data to.
14-
15-
5. Give your source a name.
5+
To add an external source:
166

7+
1. Go to the pipeline view.
8+
2. Click `+ New` in the top right corner of the view.
9+
3. Select `External source`.
10+
4. In `Output` select the topic you are going to publish to, or add a new topic with `+ Add new`.
11+
5. In `Name` type any suitable name, such as "Laptop CPU Load".
1712
6. Click `Add external source`.
1813

19-
7. In the Pipeline view click the newly created source and the following is displayed:
20-
21-
![External source options](../../images/external-source-options.png){width=80%}
22-
23-
8. For this example, select `HTTP API - JavaScript`. Code is generated for you that uses the Streaming Writer API (HTTP interface).
24-
25-
9. Click the `Copy code` button to copy the code to your clipboard.
26-
27-
You can now paste the code into your JavaScript code, for example, your web browser client code. The code writes data into the Quix topic that you configured.
28-
29-
As you can see there are other options such as generating Curl code that can be run in your shell to also write data into Quix.
30-
31-
The code samples generated are meant to provide you with a starting point from which you can build your own solutions. They provide a convenient way to see how the API works.
32-
33-
## Next steps
34-
35-
Further information can be found in the [Streaming Writer API](../../apis/streaming-writer-api/overview.md) documentation.
14+
The external source now appears in the pipeline view as a reminder (visual cue) as to the nature of the source generating the data for this topic.
-94.7 KB
Binary file not shown.

docs/quix-cloud/quixtour/external-source.md

Lines changed: 6 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,18 @@ At this point, you have completed the [Quickstart](../quickstart.md), and you ha
44

55
However, you can't currently see this in the Pipeline view. To help you visualize what you've created, you add an external source component, to provide a visual entity in the pipeline view.
66

7-
## Watch a video on adding an external source
8-
9-
<div style="position: relative; padding-bottom: 62.24066390041494%; height: 0;"><iframe src="https://www.loom.com/embed/0c9be6ea1f9540618d8bf0c2dabc8533?sid=728b4cad-a224-4ffa-82fe-7f0bbe737779" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
10-
11-
??? "Transcript"
12-
13-
0:01 Welcome back to another video. In this video I'll show you how to improve your pipeline view by creating an external source.
14-
15-
0:11 So let's go straight into it. The easiest way to do this, there's various ways that you can do this, but as you see there is a nice big box here, add external source, you can just click on that.
16-
17-
0:28 The reason that I'm adding an external source is because my command line program that's capturing CPU load and publishing that into Quix is external to the Quix and environment.
18-
19-
0:42 You'll see other examples where we use Quix's built-in code samples and connectors to build your pipeline, but they're internal to Quix, so you just use an ordinary source.
20-
21-
0:57 So for our purposes here, we're going to create an example. External source. I'm going to call it server load, CPU load.
22-
23-
1:10 You can call it anything you like really, as long as it makes sense to you. We also need to select the output topic.
24-
25-
1:21 Well, we know the topic is CPU load because it's the only one we've got So let's go ahead and add that source now we can see The external source appears in the pipeline view And then later in the quick stall we're going to extend this pipeline So in the second part of the tour you'll add a transformation
26-
27-
1:44 here and then when that's done on the other side of the transformation you'll create a destination to complete the pipeline.
28-
29-
1:56 Okay that's it for this video thanks for watching and see you in the next video.
30-
317
## How to add an external source
328

339
To add an external source:
3410

35-
1. Click on `Code Samples`.
36-
2. Select the `Source`, and `Basic templates` filters.
37-
3. On the `External Source` sample, click `Add external source`.
38-
4. Give the component a name, such as "Laptop CPU Load".
39-
5. For output topic select `cpu-load`.
11+
1. Go to the pipeline view.
12+
2. Click `+ New` in the top right corner of the view.
13+
3. Select `External source`.
14+
4. In `Output` select the topic you are going to publish to, or add a new topic with `+ Add new`. In this case select the `cpu-load` topic.
15+
5. In `Name` type any suitable name, such as "Laptop CPU Load".
4016
6. Click `Add external source`.
4117

42-
This now appears in the pipeline view as a reminder (visual cue) as to the nature of the source generating the data for this topic.
43-
18+
The external source now appears in the pipeline view as a reminder (visual cue) as to the nature of the source generating the data for this topic.
4419

4520
## 🏃‍♀️ Next step
4621

docs/tutorials/event-detection/data-acquisition.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,12 @@ An external source is a representation of a data source that is external to Quix
2424

2525
To add an external source:
2626

27-
1. Navigate to the `Code Samples`.
28-
29-
2. Under `Pipeline Stage` click `Source`.
30-
31-
3. Locate the `External Source` sample and click `Add external source`.
32-
33-
4. Enter `phone-data` in the `Output` field and click `Add new topic` in the dropdown.
34-
35-
5. Enter `Quix companion web gateway` in the `Name` field.
36-
37-
6. Click `Add external Source`.
27+
1. Go to the pipeline view.
28+
2. Click `+ New` in the top right corner of the view.
29+
3. Select `External source`.
30+
4. In `Output` select the topic you are going to publish to, or add a new topic with `+ Add new`. In this case select the `phone-data` topic.
31+
5. In `Name` type any suitable name, such as "Quix companion web gateway".
32+
6. Click `Add external source`.
3833

3934
### Install and configure the apps
4035

docs/tutorials/influxdb-alerting/external-source.md

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,15 @@
22

33
At this point you have an external program sending data into Quix, and it is writing into a Quix topic. However, you can't see this external program in the Pipeline view. To help you visualize what you've created, you can add an external source component, to provide a visual entity in the pipeline view. To do this, log into Quix Cloud:
44

5-
1. Click on `Code Samples`.
6-
2. Select the `Python`, `Source`, and `Basic templates` filters.
7-
3. On the `External Source` sample, click `Add external source`.
8-
4. Give the component a name, such as "Laptop CPU Load".
9-
5. For output topic select `cpu-load`.
5+
1. Go to the pipeline view.
6+
2. Click `+ New` in the top right corner of the view.
7+
3. Select `External source`.
8+
4. In `Output` select the topic you are going to publish to, or add a new topic with `+ Add new`. In this case select the `cpu-load` topic.
9+
5. In `Name` type any suitable name, such as "Laptop CPU Load".
1010
6. Click `Add external source`.
1111

1212
This now appears in the pipeline view as a reminder (visual cue) as to the nature of the source generating the data for this topic, and you can easily add further pipeline services on the output of this source.
1313

14-
Watch a video on adding an external source:
15-
16-
<div style="position: relative; padding-bottom: 62.24066390041494%; height: 0;"><iframe src="https://www.loom.com/embed/0c9be6ea1f9540618d8bf0c2dabc8533?sid=728b4cad-a224-4ffa-82fe-7f0bbe737779" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
17-
18-
??? "Transcript"
19-
20-
0:01 Welcome back to another video. In this video I'll show you how to improve your pipeline view by creating an external source.
21-
22-
0:11 So let's go straight into it. The easiest way to do this, there's various ways that you can do this, but as you see there is a nice big box here, add external source, you can just click on that.
23-
24-
0:28 The reason that I'm adding an external source is because my command line program that's capturing CPU load and publishing that into Quix is external to the Quix and environment.
25-
26-
0:42 You'll see other examples where we use Quix's built-in code samples and connectors to build your pipeline, but they're internal to Quix, so you just use an ordinary source.
27-
28-
0:57 So for our purposes here, we're going to create an example. External source. I'm going to call it server load, CPU load.
29-
30-
1:10 You can call it anything you like really, as long as it makes sense to you. We also need to select the output topic.
31-
32-
1:21 Well, we know the topic is CPU load because it's the only one we've got So let's go ahead and add that source now we can see The external source appears in the pipeline view And then later in the quick stall we're going to extend this pipeline So in the second part of the tour you'll add a transformation
33-
34-
1:44 here and then when that's done on the other side of the transformation you'll create a destination to complete the pipeline.
35-
36-
1:56 Okay that's it for this video thanks for watching and see you in the next video.
37-
38-
Note, this video is for a different project, but the principle is the same.
39-
4014
## 🏃‍♀️ Next step
4115

4216
[Part 3 - Add InfluxDB destination :material-arrow-right-circle:{ align=right }](./influxdb-destination.md)

0 commit comments

Comments
 (0)