Skip to content

Commit

Permalink
Merge pull request #11 from os2display/feature/2328-feed-source-test-…
Browse files Browse the repository at this point in the history
…guide

Added testing guide for feed sources
  • Loading branch information
tuj authored Dec 2, 2024
2 parents 41bb0e6 + afa4d04 commit 892ebe1
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions content_structure/test_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ The following test scenarios are explained:
* [T6 External users](#t6-external-users)
* [T7 Campaigns](#t7-campaigns)
* [T8 Shared playlists](#t8-shared-playlists)
* [T9 Feed sources](#t9-feed-sources)

---

Expand Down Expand Up @@ -488,3 +489,39 @@ When it is shared it can be displayed in another tenant, but not edited.
* Test that the playlist is displayed on the screen. See T1 for how to activate the screen.

---

## T9 Feed sources

### Description

Feed sources are the link between external data source and slides. An example is the RSS feed.
When creating a slide with the RSS template a feed source ("datakilde") needs to be selected.
After the feed source has been selected it is possible to input the url to the RSS feed to show data from.
The feed source contains the code that calls the external source and converts data to a format the RSS template
understands.

Feed sources are connected to a tenant. New feed sources can be connected to a tenant in through the
"Datakilde" link in the navigation.

The following guide describes how to add a "calendar api" feed source to a tenant.

NB! The calendar api feed source has some installation requirements that are assumed to have been set up.
See the [documentation](https://github.com/os2display/display-api-service/blob/develop/docs/calender-api-feed.md) for
further information.

With the calendar api feed source the administrator should select which locations are connected with the given tenant.
When creating a slide with the given feed source, the resources that belong to the given locations are available
to deliver data to the slide.

### Steps

* Go to `/admin/feed-sources/list`.
* Click "Opret ny datakilde" (`/admin/feed-sources/create`).
* Select a name (e.g. "My calendar feed") and add a description of the feed source.
* Select "Kalender feed" for "Type".
* It will display "Bemærk! Datakilden skal gemmes før der kan tilkobles lokationer. Gem og åbn datakilden igen.".
* Save with "Gem datakilde".
* Reopen the feed source from the list.
* Select locations that should be connected with the given tenant.
* Save with "Gem datakilde".
* Now the feed source should be available in the feed selector, when setting up a "calendar" slide.

0 comments on commit 892ebe1

Please sign in to comment.