Configuration Files
In the following sections, all provided configuration files are described. These are necessary for a proper TableStar installation.
The files can be downloaded as a ZIP file from our Artifactory. Further instructions for downloading and importing the ZIP are given in the "Importing the Configuration Files" section.
Structure Nodes
The configuration files will create the following structure nodes:
/system/sportergebnisse/system/sportergebnisse/fussball/system/sportergebnisse/teletext
All other configuration files will be located under one of these structure nodes.
Select Values
The following select values will be created when importing the provided configuration files. These are used in several select value fields and will be located at /system/sportergebnisse. If not otherwise declared these select values may be extended with custom values.
All of the select value documents already contain select values. In some cases this is due to technical necessity. These select values must not be changed. In all other cases the select values provide examples for the type of values that the select value is intended for.
| Select value name | Description | Usage |
|---|---|---|
| Alle Spieltage | Provides a constant value that is used to describe that all matchdays are affected. | This select value is used for the knockout mode configuration of the matchdays of a match round. |
| Disziplinarkarten | Provides a set of disciplinary cards. | This select value is used in the disciplinary cards section of a shorthand. |
| Disziplinen | Provides a set of disciplines. | This select value is used in match rounds, competitions and events. |
| Ergebniseigenschaften | Provides labels and descriptions for result values. | This select value is used in the bonus points section of point awards. |
| Ergebnislabel | Provides labels and description for result units. | This select value is used on result round to specify the unit of the results. |
| Filter für Spielezusammenstellungen | Provides a set a match compilation filters. | The select value is used in teams to specify a compilation filter for a team. |
| Import-Quellen | Provides a set of import sources. | The select value is used in match rounds and result rounds to specify the import source of the appropriate document. |
| K.-o.-Modus | Provides a set of knockout modes. | This select value is used for the knockout mode configuration of the matchdays of a match round. You may only add new knockout modes which apply to the following format: " play-off-best-of-<int>". |
| Legende | Provides a set of entries for a legend. | This select value is used in matches of match rounds, results of result rounds and in the world records section of record tables. |
| Ligen | Provides a set of leagues. | This select value is used in competitions. |
| Mannschaft: Bezug zur Vorsaison | Provides a set of connections to the previous season. | This select value is used in the teams section of a match round. |
| Medaillenvergabe | Provides a set of medal award constellations. | This select value is used in events to specify which medals will be awarded. |
| Qualifikationsstatus | Provides a set of qualification states. | This select value is used in the results section of a result round. |
| Redaktionelle Verantwortung | Provides a set of editorial teams. | This select value is used in team page entries within team documents to declare the editorial responsibility of the team page. |
| Rekorde und Bestleistungen | Provides a set of record types. | This select value is used in the results section of a result round. |
| Rundenstatus | Provides a set of round states. | This select values is used in result rounds to specify the type of the results. |
| Saison | Provides a set of seasons. | This select value is used in match rounds and competitions. It is also used in the season names section of a team to specify different team names for different seasons. |
| Sieger eines Duells | Provides constant values for the winner of a match. | This select value is used in the match details section of a shorthand. |
| Sortierbedingungen | Provides a set of sort conditions. | This select value is used in the sort criteria table of sort modes. This select value must not be changed in any way since it is used in the computation of the tables of a match round. |
| Sortierkriterien-Vergleich | Provides a set of sort criteria comparators. | This select value is used in the sort criteria table of sort modes. This select value must not be changed in any way since it is used in the computation of the tables of a match round. |
| Sortierkriterien | Provides a set of sort criteria. | This select value is used in the sort criteria table of sort modes. This select value must not be changed in any way since it is used in the computation of the tables of a match round. |
| Spezielle Ansetzung | Provides a set of special schedulings. | This select value is used in the matches table of a match round. This select value must not be changed in any way since it is used in the computation of the tables of a match round. |
| Spielphasen | Provides a set of phases of a match. | This select value is used in the matches table of a match round. This select value must not be changed in any way since it is used in the computation of the tables of a match round. |
| Spielstatus | Provides a set of contest states. | This select value is used in the matches table of a match round. This select value must not be changed in any way since it is used in the computation of the tables of a match round. |
| Sportarten | Provides a set of sports. | This select value is used in match rounds, result round and competitions. |
| Sportartspezifische Bezeichnungen | Provides a set of sport specific labels. | This select value is used in sport documents. This select value must not be changed in any way since it is used internally in several TableStar components. |
| Sportlergeschlecht | Provides a set of genders for athletes. | This select value is used in athletes. |
| Sportveranstaltungstypen | Provides a set of event types. | This select value is used in events. |
| Staffeln | Provides a set of divisions. | This select value is used in the teams section of a match round as well as in the components of a teletext page. |
| Tabellenplatzierungen | Provides a set of special table positions. | This select value is used in the table positions section of match rounds and in the table positions section of teletext color settings. |
| Teilnehmer | Provides a set of participant groups. | This select value is used in competitions, match rounds, result rounds, teams and in the record sections of records. |
| Teilnehmerländer | Provides a set of countries. | This select value is used in athletes, matches and table section of match rounds, events, record sections of records, result section of result rounds and in the medal section of medal table. |
| Teletext: Begegnungsrundeninhalt | Provides a set of match round content. | This select value is used in the components of a teletext page. The values specify the content of a match round that shall be rendered on the teletext (sub) page. This select value must not be changed since it is used internally for the rendering of teletext pages. |
| Teletext: Unterseitengenerierung | Provides a set of teletext sub page generation settings. | This select value is used in teletext pages to specify when additional sub pages will be created. This select value must not be changed since it is used internally for the rendering of teletext pages. |
| Teletext: Zeitanzeige | Provides a set of teletext time display settings. | This select value is used in teletext generation settings to specify how the time of a match will be displayed on a teletext (sub) page. This select value must not be changed since it is used internally for the rendering of teletext pages. |
| Vergleichsoperatoren | Provides a set of comparators. | This select value is used in the bonus points tables of a points award to specify when bonus points are applied. This select value must not be changed since it is used internally for the computation of the tables. |
| Zeitpunkte | Provides a set of repeating times. | This select value is used in match rounds. This select value must not be changed in any way since it is used in the advancement of the matchday of a match round. Further information about the matchday advancement can be found in the TableStar Controller Documentation. |
| Zuordung zu Mannschaft des Spiels | Provides set of team affiliations. | This select value is used in several statistic tables of a shorthand. |
Tab Documents
The following tabs will be created when importing the provided configuration files.
| Tab name | Applicable nodetypes |
|---|---|
| Einstellungen | sophora-sport-nt:matchRound |
| Spiele | sophora-sport-nt:matchRound |
| Statistik | sophora-sport-nt:athletesophora-sport-nt:shorthand |
Nodetypes
The TableStar mechanisms (table calculation, matchday advancement etc.) will not need all of the provided nodetypes. Nodetypes that are needed are written in bold letters. All other nodetypes may be configured to be neither searchable nor creatable if you don't need them for your use cases.
The following nodetypes and configurations will be created when importing the provided configuration files.
| Nodetype | Label | Explanation |
|---|---|---|
sophora-sport-mix:teletextPageVariables | - | Provides settings properties for the generation of teletext pages. |
sophora-sport-nt:achievementRow | Erfolge | Represents the achievement rows in an athlete. |
sophora-sport-nt:athlete | Sportlerporträt | Documents of this type represent athletes. |
sophora-sport-nt:athleteRef | Athleten-Referenz | The reference nodetype for sophora-sport-nt:athlete. |
sophora-sport-nt:bonusPointsConditionRow | Bonuspunkte | Represents bonus point conditions in bonus point tables of a points award. |
sophora-sport-nt:competition | Wettbewerb | Documents of this type represent competitions. |
sophora-sport-nt:competitionGroup | Wettbewerbe | Represents a competition an athlete participated in. |
sophora-sport-nt:competitionRef | Wettbewerbsreferenz | The reference nodetype for sophora-sport-nt:competition. |
sophora-sport-nt:dataTable | Datentabelle | Documents of this type represent data tables. |
sophora-sport-nt:dataTableGroup | Datentabellen | Represents boxes containing data tables. |
sophora-sport-nt:dataTableRef | Datentabellen-Referenz | The reference nodetype for sophora-sport-nt:dataTable. |
sophora-sport-nt:event | Sportveranstaltung | Documents of this type represent sport events. |
sophora-sport-nt:eventRef | Sportveranstaltungsreferenz | The reference nodetype for sophora-sport-nt:event. |
sophora-sport-nt:goalRow | Tore | Represents the achieved goals in the statistics of shorthands. |
sophora-sport-nt:knockoutModeRow | K.-o.-Modus | Represents knockout modes in the settings of match rounds. |
sophora-sport-nt:labelRow | Bezeichnungen | Represents labels in the labels table of sports. |
sophora-sport-nt:matchDaysNameRow | Spieltagsnamen | Represents matchday names in the settings of match rounds. |
sophora-sport-nt:matchRound | Begegnungsrunde | Documents of this type represent match rounds. |
sophora-sport-nt:matchRoundRef | Begegnungsrunden-Referenz | The reference nodetype for sophora-sport-nt:matchRound. |
sophora-sport-nt:matchRoundTeamRef | Mannschaft einer Begegnungsrunde | A reference nodetype for sophora-sport-nt:matchRound together with a team (of that round). |
sophora-sport-nt:matchRow | Begegnung | Represents matches in match rounds and shorthands. |
sophora-sport-nt:medalTable | Medaillenspiegel | Documents of this type represent medal tables. |
sophora-sport-nt:medalTableEntry | Medailleneintrag | Represents medal entries in medal tables. |
sophora-sport-nt:medalTableRef | Medaillenspiegel-Referenz | The reference nodetype for sophora-sport-nt:medalTable. |
sophora-sport-nt:menu | Sportmenü | Documents of this type represent sport menus. |
sophora-sport-nt:menuItem | Menüpunkt | Represents a menu item in sport menus. |
sophora-sport-nt:menuRef | Sportmenü-Referenz | The reference nodetype for sophora-sport-nt:menu. |
sophora-sport-nt:participations | Teilnahmen | Represents the participations box in athletes. |
sophora-sport-nt:penaltyCardRow | Disziplinarkarte | Represents penalty card entries in shorthands. |
sophora-sport-nt:penaltyShootoutIncidentRow | Ereignis beim Strafstoßschießen | Represents shootout incidents in shorthands. |
sophora-sport-nt:pointsAward | Punktvergabe | Documents of this type define a points award regulation for the computation of match round tables. |
sophora-sport-nt:recordTable | Rekorde | Documents of this type represent record tables. |
sophora-sport-nt:recordTableEntry | Rekord | Represents record entries in record tables. |
sophora-sport-nt:recordTableRef | Rekordreferenz | The reference nodetype for sophora-sport-nt:recordTable. |
sophora-sport-nt:resultRound | Ergebnisrunde | Documents of this type represent result rounds. |
sophora-sport-nt:resultRoundRef | Ergebnisrunden-Referenz | The reference nodetype for sophora-sport-nt:resultRound. |
sophora-sport-nt:resultRow | Ergebnis | Represents result entries in result rounds. |
sophora-sport-nt:round | - | Super type for sophora-sport-nt:matchRound and sophora-sport-nt:resultRound. |
sophora-sport-nt:roundGroup | Runden | Represents boxes containing match rounds or result rounds in a competition. |
sophora-sport-nt:seasonNameRow | Saisonnamen | Represents season name entries of teams. |
sophora-sport-nt:shorthand | Stenogramm | Documents of this type represent shorthands. |
sophora-sport-nt:sortMode | Sortiermodus | Documents of this type represent sort modes for the computation of match round tables. |
sophora-sport-nt:sortModeRow | Sortierkriterien | Represents sort criteria in sort modes. |
sophora-sport-nt:specialIncidentRow | Besondere Vorkommnisse | Represents special incidents in shorthands. |
sophora-sport-nt:sport | Sportart | Documents of this type represent sports. |
sophora-sport-nt:tablePositionsRow | Tabellenplatzierungen | Represents special table positions in the settings of match rounds. |
sophora-sport-nt:tableRow | Tabelle | Represents entries in a predefined table of a match round. |
sophora-sport-nt:team | Mannschaft | Documents of this type represent teams. |
sophora-sport-nt:teamPageRow | Mannschaftsseiten | Represents entries in a team pages table within team documents. |
sophora-sport-nt:teamRef | - | The reference nodetype for sophora-sport-nt:team. |
sophora-sport-nt:teamRow | Teilnehmer | Represents participating teams in the settings of a match round. |
sophora-sport-nt:teletextColorSettings | Teletextfarbeinstellungen (Sport) | Documents of this type represent color settings for the rendering of match rounds and data tables in the teletext. |
sophora-sport-nt:teletextColorTablePositionsRow | Tabellenplatzierungen | Represents special table positions in the teletext color settings. |
sophora-sport-nt:teletextGenerationSettings | Teletextgenerierungseinstellungen (Sport) | Documents of this type represent generation settings for the rendering of match rounds and data tables in the teletext. |
sophora-sport-nt:teletextPage | Teletextseite (Sport) | Documents of this type represent a teletext page. |
sophora-sport-nt:teletextSubPage | Unterseite | Represents the sub page boxes in teletext pages. |
sophora-sport-nt:teletextComponentRef | - | A reference nodetype for sophora-sport-nt:dataTable that is used in teletext sub page boxes. |
sophora-sport-nt:teletextMatchRoundComponentRef | - | A reference nodetype for sophora-sport-nt:matchRound that is used in teletext sub page boxes. |
sophora-sport-nt:worldCupStandingRow | Weltcupstand | Represents a world cup standing entry in athletes. |
Scripts
The following scripts will be created when importing the provided configuration files.
| Script name | Script type | Affected document types | Functionality |
|---|---|---|---|
| Mannschaften zur Begegnungsrunde hinzufügen | sophora-nt:clientScriptDocument (default) | sophora-sport-nt:matchRound | This is a client script that users can trigger via the document editor's toolbar. The script is used to add teams to match rounds in an easy way since the user will only see applicable teams that match the settings of the match round. |
| Begegnungsrunde anpassen | sophora-nt:script (documentChangingScript) | sophora-sport-nt:matchRound | This is a document changing script that is triggered when match rounds are saved. The script will do the following actions:
|
| Paarungen müssen vorhanden sein und dürfen nicht doppelt vorkommen | sophora-nt:script (validationScript) | sophora-sport-nt:matchRound | This is a validation script that is triggered whenever match rounds are changed and notifies the user with a validation error if checks have not passed. The script checks whether the match round contains duplicated fixtures. This part of the script will only be applied if the following conditions are met:
|
| Bei Begegnungsrunden nur Spiele mit eindeutigen IDs und der Runde zugeordneten Mannschaften erlauben | sophora-nt:script (validationScript) | sophora-sport-nt:matchRound | This is a validation script that is triggered whenever match rounds are changed and notifies the user with a validation error if checks have not passed. The script checks whether all match IDs of the matches are unique. It also checks whether all teams that participate in any match exist in the teams table of the match round. |
| Bei Begegnungsrunden nur Mannschaften mit passenden Teilnehmern und passender Sportart erlauben | sophora-nt:script (validationScript) | sophora-sport-nt:matchRound | This is a validation script that is triggered whenever match rounds are changed and notifies the user with a validation error if checks have not passed. The script checks whether all teams that participate in any match have the same sport and gender as the match round. |
| Weiterführende Begegnungsrunde im Wettbewerb einrichten | sophora-nt:clientScriptDocument (default) | sophora-sport-nt:competition | This is a client script that users can trigger via the document editor's toolbar. The script lets the user create the subsequent match round of existing match rounds in a competition. E.g. to create the final round of a Champions League from the groups. |
| Nachfolge-Wettbewerb oder -Begegnungsrunde anlegen | sophora-nt:clientScriptDocument (default) |
| This is a client script that users can trigger via the document editor's toolbar. The script lets the user create the succeeding competition of an existing competition or the succeeding match round of an existing match round. |
| Saisons austauschen | sophora-nt:clientScriptDocument (default) | sophora-sport-nt:menu | This is a client script that users can trigger via the document editor's toolbar. The script lets the user exchange the match rounds and competitions in a sport menu by the corresponding match rounds and competitions of another season. |
| Runden-IDs nicht mehrfach vergeben | sophora-nt:script (validationScript) | sophora-sport-nt:matchRound | This is a validation script that is triggered whenever match rounds are changed and notifies the user with a validation error if checks have not passed. The script checks whether any match rounds have identical round IDs. |
| Mannschaftsnamen nicht mehrfach vergeben | sophora-nt:script (validationScript) | sophora-sport-nt:team | This is a validation script that is triggered whenever teams are changed and notifies the user with a validation error if checks have not passed. The script will only be applied if one of the following checks match:
|
Configuration Document
The files also contain a configuration document for TableStar that contains the following keys:
| Key | Description | Example |
|---|---|---|
| tablestar.import.matchrounds.blacklist | Used in the TableStar import process to ignore all match rounds that are configured here. You may also use regular expressions to exclude all match rounds that match the expression. |
|
Example Documents
The provided ZIP does also contain several example documents for point awards, sort modes, sports, data tables, sport menus, shorthands and teletext configuration.
These will all be located at /system/sportergebnisse. If you create new documents you should not locate them under /system since this structure node is usually not accessible by non-admin users. If you want to use any of the provided example documents, you should move them to an accessible structure node.
The content of the example documents is not guaranteed to be complete or correct. These are simple examples without liability.
Importing the Configuration Files
The installation instructions and explanations below assume that you already have an installation of the Teletext Generator up and running. Especially make sure that you already imported the Teletext configuration files.
You should add the provided configuration files to your version control system to easily track and revert any changes you do to the files. This will also simplify the merge of changes made by us in future releases into your adapted configuration files.
Partners and clients with a Sophora-account can obtain detailed technical information from software.subshell.com. The information may include code examples, demos or JavaDocs depending on the module and context.
The ZIP containing all above described configuration files can be downloaded from software.subshell.com.
After extracting the files, you got 2 possibilities to import the files into your Sophora instance:
- Import the files by inserting them into the watch folder of your running Sophora Importer instance.
- Import the files via a running Sophora DeskClient instance in the given order.
After importing the files you can start creating and manipulating all the TableStar configuration files as well as install and start the TableStar tools.
First Steps After Import
After importing the configuration files you should do the following steps:
- Check the document reference labels of all document node types if they fit your needs.
- Check the provided select value labels of the following properties that are configured as a query select value if they fit your needs:
| Affected property | Location |
|---|---|
sophora-extension:title | sophora-sport-nt:competitionGroup |
sophora-sport:event | default property configuration |
sophora-sport:headToHeadRecord | default property configuration |
sophora-sport:pointsAwardRegulation | default property configuration |
sophora-sport:sortMode | default property configuration |
sophora-sport:team | default property configuration |
sophora-sport:teletextColorSettings | default property configuration |
sophora-sport:teletextGenerationSettings | default property configuration |
- (optional) Enrich the provided document nodetypes with your custom mixins (i.e. for teaser information) and your custom reference nodetypes.
- Extend the default child node configuration for
sophora-sport:copytextby your custom paragraph types.
