tutorials:musicmaster:nexus-api-setup
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
tutorials:musicmaster:nexus-api-setup [2017/08/21 15:29] – tw | tutorials:musicmaster:nexus-api-setup [2019/07/09 16:18] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 14: | Line 14: | ||
The Nexus API is an HTTP-based protocol provided by MusicMaster that allows third-party software like mAirList to access and manipulate the MusicMaster database (library and schedule). | The Nexus API is an HTTP-based protocol provided by MusicMaster that allows third-party software like mAirList to access and manipulate the MusicMaster database (library and schedule). | ||
- | The Nexus Server | + | The Nexus server |
+ | |||
+ | ===== Prerequisites ===== | ||
+ | |||
+ | ==== Nexus Server ==== | ||
+ | |||
+ | We assume that you have MusicMaster and the Nexus server installed and running. The actual setup and configuration of MMServer or MusicMaster Plus Server is not part of this tutorial. | ||
+ | |||
+ | The Nexus server should be accessible from your mAirList PC via an URL like '' | ||
+ | |||
+ | MusicMaster provides a test application ('' | ||
+ | |||
+ | ==== Memo Field for XML Metadata ==== | ||
+ | |||
+ | In the Nexus API configuration, | ||
+ | ===== mAirList Setup ===== | ||
+ | |||
+ | Open the mAirList configuration app, and go to //Databases -> Nexus API//. Click //Add// to add a new connection to a Nexus Server. | ||
+ | |||
+ | First, go to the //General// tab: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Set up the **URL** of your Nexus server (remember that it's an HTTP-based protocol), usually in the form | ||
+ | |||
+ | http://< | ||
+ | |||
+ | User name and password are usually not required, but we support HTTP basic authentication if you plan to work with a reverse proxy and password protection. SSL is also supported (just enter an '' | ||
+ | |||
+ | On the // | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | First, type the name of the MusicMaster databases, as defined in the Nexus server configuration, | ||
+ | |||
+ | On the //System Field Mapping// tab, we link some MusicMaster fields to mAirList' | ||
+ | |||
+ | * Artist | ||
+ | * Title | ||
+ | * Duration | ||
+ | * Filename | ||
+ | * XML Metadata | ||
+ | * ID | ||
+ | * Category | ||
+ | * NonMusic | ||
+ | * Ramp 1 (seconds) | ||
+ | * Ramp 2 (seconds) | ||
+ | * Ramp 3 (seconds) | ||
+ | * Ramp 1 (mm:ss) | ||
+ | * Ramp 2 (mm:ss) | ||
+ | * Ramp 3 (mm:ss) | ||
+ | * Color Key | ||
+ | |||
+ | When you enter the dialog for the first time, only numeric IDs will be displayed. As soon as you use the dropdown for any field, mAirList will fetch the field names from the Nexus server: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Notes: | ||
+ | |||
+ | * XML Metadata is the Memo field that you created in order to save non-standard metadata fields as XML (see // | ||
+ | * The ID field is where mAirList will save its Internal Database ID values during [[tutorials: | ||
+ | * Ramps can either be stored (and retrieved) in "full seconds" | ||
+ | * Color key is used by the [[tutorials: | ||
+ | |||
+ | On the //Attribute Field Mapping// tab, you can link additional attribute fields in mAirList to fields in MusicMaster: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Just type a mAirList attribute name in the left-hand column, and select the corresponding MusicMaster field in the right-hand column. **Use the cursor-down key to add more rows.** | ||
+ | |||
+ | ===== MusicMaster Enterprise ===== | ||
+ | |||
+ | [[https:// | ||
+ | |||
+ | The Nexus functions mAirList will handle Enterprise databases in the following way: | ||
+ | |||
+ | * All library **write** operations will be performed on the parent database. | ||
+ | * Library **read** operations during [[tutorials: | ||
+ | * All schedule **read** operations and their corresponding library lookups will be performed on the child database. | ||
+ | |||
+ | One important thing to understand is that the MusicMaster field IDs can (and often will) be different between the parent and the child databases. So you must actually configure the field mapping twice in mAirList: once for the parent database, and once for the child database. | ||
+ | |||
+ | To set up a Nexus connection to an Enterprise database, switch to the // | ||
+ | |||
+ | For non-Enterprise databases, it is important to leave the // |
tutorials/musicmaster/nexus-api-setup.1503329342.txt.gz · Last modified: 2019/07/09 16:19 (external edit)