Keywords are used to limit the events that appear in your app. Only events that are associated with specific keywords will appear in the app.
Tessitura Configuration
- Choose the keyword(s) that you want to use for events in your app. You can use existing keywords or create new keywords specifically for your app.
- Attach the keyword to any Production Element in Tessitura that you want to appear in your app. Note that keywords are inherited. If you attach to a keyword to a Production Season, all the related Performances will have that keyword, too.
For more information on Keywords setup please see the Tessitura user guides.
InstantEncore Configuration
There are two settings in the Control Panel that can be used to identify which keywords should be used to filter events.
Option 1: Performance Keyword Category ID
Use this option if you have multiple keywords that are grouped in a Keyword Category. You can attach any of these keywords to a Production Element to have it appear in your app. This is the technique typically used by TNEW.
- Go to the API Settings page (Control Panel > InstantApps > Tessitura > Required Settings).
- Open the Required Settings section.
- In the Performance Keyword Category ID field input the ID of keyword category used to filter keywords for just performances. This ID can be found in the TR_TKW_CATEGORY system table. Leave blank to return all events.
Options 2: Event Keywords
This is a simple option to just list the keywords that you want to use regardless of Keyword Category.
- Go to the API Settings page (Control Panel > InstantApps > Tessitura > Required Settings).
- Open the Required Settings section.
- In the Event Keywords field input a comma separated list of keywords that should be used to filter your events. Use the actual words, not the ID's. Leave blank to return all events.
Notes
- When you add new Performances to Tessitura you will need to add the keywords to them.
- If you specify both Performance Keyword Category ID and Event Keywords settings then the Performance Keyword Category ID will take precedence.