InstantEncore uses the Tessitura REST API to communicate between your app and Tessitura. Follow these instructions to set up the REST API credentials.
Prerequisites
- You must be using Tessitura REST API version 15+.
- Access to the Tessitura Security Application.
- Access to the TX_MACHINE_LOCATION system table in the Tessitura application.
1. Get REST API Credentials from Tessitura.
You will need to find the following information so that it can be saved to InstantEncore:
- REST API URL
- REST User Group ID: Note that the User Group ID is needed, not name
- REST Username
- REST Password (unencrypted)
You can use the an existing REST API user or create a new one in the Tessitura security application.
The unencrypted password of an existing user cannot be retrieved from the Tessitura security application. If you do not know it you will need to create a new REST API user.
If you need to create a REST API User please see Tessitura's instructions for doing so.
2. Organization Name or Parent Table
If your organization is part of a Tessitura consortium or uses multiple parent tables, then please specify the description from system table TR_Organization. Leave blank if using the default "Tessitura Web" value.
3. Add a row to the TX_MACHINE_LOCATION system table
- In the Tessitura application go to System Tables.
- Search for the TX_MACHINE_LOCATION system table.
- If it does not already exists, add a row with the "Machine Name" of "TNMP_WEB_APP".
- Ensure that the "Location" field for that row is set to "Administration".
- Save changes.
4. Verify permissions
To ensure that InstantEncore can communicate with your REST API the proper permissions must be configured in Tessitura.
See How do I configure permissions for the REST API?
5. Save credentials in InstantEncore
- Log into instantencore.com and go to the REST API Credentials (Control Panel > InstantApps > Tessitura > REST API Credentials).
- Copy the REST API credentials you retrieved above.
- If necessary, fill out the Organization Name or Parent Table field.
- Click the "Update" button.
- If there is an issue connecting to the REST API an error message will be displayed.