We will soon be upgrading Companion on all service machines from version 2.4 to version 3.5.4. This is a major upgrade that WILL require changes for every campus upgrading from 2.4. The purpose of this document is to cover what changes are required so that you can prepare and set aside the time required to complete the changes. The time involved for these changes will vary at every campus, but a typical installation should take no more than 15-30 minutes.
Before you begin, verify that you are on Companion version 3.5.4. If you are not, do not make any changes until you upgrade. You can upgrade your version using Company Portal (Windows) or Self Service (macOS).
The New ProPresenter-API Module
There is now a more modern "ProPresenter-API" module that supersedes the legacy one. While the legacy module continues to work, you should plan on replacing it with the newer API module. As newer versions of ProPresenter are released, the legacy module may have issues and could break or stop working completely. Due to that, we will not be able to support the legacy module as it is considered end of life.
Before you begin, do not disable or delete the old module until after you make the required changes below. If you see an empty action while viewing an old button, it is because the old module was disabled or deleted.
Changes Required
- To begin, add a new connection using the "ProPresenter-API" module and set the IP of device you're replacing (ie, the lyrics/songs computer would be
10.[Campus Code].60.11). Use the ProPresenter Network Port57894. You should now have two connected modules.
- Go to the Buttons section and find every button that has the ProPresenter actions and change them to use the new ProPresenter-API module. For example, the legacy "Stage Display Message" should be changed to "Stage Display: Operation".
- Any buttons that use variables will need updating to the new variables. We recommend opening two tab - one using the variable list that you can search thru, and one that has the buttons. A few useful variable changes are:
-:presentation_name→:active_presentation_name
-:current_slide→:active_presentation_slide_index
Not all of the old variables may be present or supported in the new version, such as the number of slides in the active presentation.
- Once done, the old ProPresenter modules should be disabled for at least one full service day and then deleted after verifying there aren't any issues.
Be sure to DISABLE the old module instead of deleting it. After you have tested that the new module is working as you intend, then it is recommended to delete the old one. We recommend you delete the module and not keep it so that your companion instance stayed clean.
Arena Module
If you're using the Arena module, you may need to update your configuration to use the newer REST API. This will require changes to the computer running Companion and the one running Arena.
These changes are required for all users upgrades from versions prior to 3.2. Those upgrading from newer versions of Companion may not need to make these changes.
Arena Changes
You'll need to enable the REST API inside of Arena.
- Open Arena and go to Settings \ Preferences.
- Go to Webserver.
- Check the box, "Enable Webserver & REST API." The default settings should be used. Make sure that the "Listen Address" is set to
0.0.0.0.
Companion Changes
- Edit the Arena module configuration and turn on "Use Rest for web api calls". You may also have to add the WebAPI port (8080).
- Next, any buttons that are firing things in Arena will need to be double checked and changed.
For example, it should look like the following:
Note: older versions called this "Trigger Column"
Before you update these fields, you may see ??? for the action or there could be a blank action listed.
Completing the Upgrade
Once the changes above are complete, restart your computer and verify everything is working as it should. You may see the following warning when starting Companion for the second time after upgrading:
It is safe to "Continue"; you shouldn't see this message again until you upgrade again. The notice is letting you know that there is an old configuration still there and you can revert to it by reinstalling the older version.
Testing
It is important to test that everything is working as it should before you enter a service environment. Here are some items to check:
- Stream Decks
Test all Stream Decks and buttons that will be used in a typical service. This includes devices connected to additional computers as these oftentimes connect to the same Companion instance. - Triggers
In Companion, check that triggers show up and that trigger times appear correct. Also, if they are referencing buttons, verify that these buttons are doing what they're intended to. - External Controls
If your campus is using external controls, such as recalling buttons via a Ross Switcher (ie, projector shuttering, K2 playback, etc), verify that these controls are working properly.