Skip to content

Commit 4490997

Browse files
committed
docs: add Show/Episode editor Fiori app documentation
1 parent 99476d7 commit 4490997

1 file changed

Lines changed: 67 additions & 0 deletions

File tree

cap/docs/fiori-show.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Show App
2+
3+
The Show app is a **draft-enabled** Fiori Elements editor for Star Wars TV shows and their episodes. It exposes the `StarWarsShow` service. Reading requires the `Viewer` role; creating or editing requires `Editor`.
4+
5+
Annotation files: `cap/srv/show-fiori.cds`, `cap/srv/episode-fiori.cds`
6+
7+
## Show List Report
8+
9+
| Column | Field |
10+
| --- | --- |
11+
| Title | `title` |
12+
| Type | `show_type` (LIVE_ACTION_SERIES, ANIMATED_SERIES, ANIMATED_FILM) |
13+
| Director | `director` |
14+
| Release Date | `release_date` |
15+
| Seasons | `seasons` |
16+
| Episode Count | `episode_count` |
17+
| Network | `network` |
18+
19+
**Selection fields:** show_type, network, director, release_date
20+
21+
## Show Object Page
22+
23+
**Header:** Show title, show_type (description).
24+
25+
**Show Details tab (`FieldGroup#Main`):**
26+
27+
| Field | Notes |
28+
| --- | --- |
29+
| Title | |
30+
| Show Type | `show_type` enum |
31+
| Seasons | |
32+
| Episode Count | |
33+
| Network | |
34+
| Director | |
35+
| Producer | |
36+
| Release Date | |
37+
38+
**Episodes tab:** Displays the `episodes` composition using `Episode`'s `UI.LineItem`:
39+
40+
| Column | Field |
41+
| --- | --- |
42+
| Season | `season_number` |
43+
| Episode | `episode_number` |
44+
| Title | `title` |
45+
| Air Date | `air_date` |
46+
| Director | `director` |
47+
| Writer | `writer` |
48+
| Runtime | `runtime` (minutes) |
49+
| Timeline | `timeline` (e.g. `22 BBY`) |
50+
51+
Clicking an episode row opens the **Episode Object Page**.
52+
53+
**Characters tab:** Displays `Show2People` — characters who appear in any episode of this show (derived via the `Episode2People` aggregation view, not a physical junction to the show).
54+
55+
## Episode Object Page
56+
57+
The Episode Object Page shows the episode's detail fields (season, episode number, title, air date, director, writer, runtime, timeline) and a single **Episode Details** tab containing the same fields in a form layout.
58+
59+
Annotation: `annotate sws.Episode` in `cap/srv/show-fiori.cds`.
60+
61+
## Episode2* Sub-navigation
62+
63+
The `StarWarsEpisode` service exposes `Episode2People`, `Episode2Planets`, `Episode2Starships`, `Episode2Vehicles`, and `Episode2Species` as read-only projections. These are accessible directly via the OData service but are not surfaced as tabs in the Show app's Episode Object Page — they require direct API access or a future extension of the annotations.
64+
65+
## Draft Workflow
66+
67+
Identical to the Film app. Shows use `@odata.draft.enabled`. Editing a show (including adding/removing episodes) creates a draft. Activating the draft commits the entire show + episodes composition atomically.

0 commit comments

Comments
 (0)