Appearance
Setting Up and Configuring Rapid
In this article, you will find the essential information you need for understanding the setup and configuration of Rapid.
For details on PC requirements, initial installation and upgrading Rapid, please read the Installing Rapid and PC Requirements article.
Upgrading Rapid
Perform this sequence of actions for upgrading Rapid.
- Run the supplied Rapid Installer application, and check that it is installing Rapid in the same folder as the current version. The new version of Rapid will over-write the existing version of Rapid.
- To test that the upgrade has been successful, launch a compatible browser on the Rapid server and go to this link/address:
http:/[ip_address_of_rapid:[port]/
.
If you haven’t changed the default port, to access Rapid from a browser on the same machine as the Rapid server the link will be: http://localhost:9001/
.
HTTPS Support
To add HTTPS support using an SSL certificate, you will need to perform this sequence of actions:
- Create a subfolder in the Rapid “data” folder: by default on Windows, the path to the Rapid "data" folder is C:\ProgramData\rapid\data\ and the subfolder should be named “ssl”.
- Put the certificate and key into this new subfolder: by default, C:\ProgramData\rapid\data\ssl\ is the path to the new subfolder.
- The certificate must be named 'certificate.crt' and the private key named 'private.key'.
- The private key must be unencrypted.
- Once these files have been added to the "ssl" folder, restart the Rapid service and Rapid will start listening on port 443 automatically.
Rapid System Settings
Rapid System Settings can be changed within the page named "SYSTEM | General Setup".
Rapid will use the operating system’s time zone.
Rapid will auto-generate the necessary folders: however, you may need to manually modify these system settings.
General
In the page for "SYSTEM | General Setup", you will see the system settings group for General.
In the General settings, your could choose Basic as the Playout Source Mode.
In the General settings, your could choose Advanced as the Playout Source Mode.
Basic Playout Soure Mode provides a simpler interface for managing the Playout Source. If you do not need to add multiple automation systems to a Playout Source then choose Basic, otherwise select Advanced mode.
In the meantime, in the page for "SYSTEM | General Setup", you will see the General system settings.
Image Upload: Key in your Max Image Upload Size (MB).
Truncation: If truncation is disabled, any messages that are too long for a specific output will be skipped by that output. If truncation is enabled, then any fields that are longer than the permitted length will be shortened to the maximum length. Up to three replacement characters can be shown as the last characters in the field that is published.
Status API: Select the checkbox and key in the code for the API.
Playout Source Mode: Select Basic or Advanced.
Music Lookup Configuration: If you have purchased the optional TiVo Lookup Service, then the service will be automatically enabled without you having to set it in the General Settings.
Rapid Hub Settings & Logging
Scroll down the page for "SYSTEM | General Setup": you will see the system settings for Rapid HUB and Logging.
For your Rapid HUB Settings, key in the Fallback Duration.
For each of the different types of logs (System, Broadcast, User Activity, and Playout), you could set:
- File Retention Days: This is the number of days’ worth of log entries that AIM Rapid will keep. Any log files older than the specified days will be deleted. If the Days are set to ‘0’ then the log files will not be deleted.
With the exception of the Broadcast logs, you could set:
- File Size (MB): This is the maximum size, in megabytes, that each log file can be. Once the log file for a particular day reaches that size a new log file will be created. The formatting of the filename is: YYYYMMDD_hhmm_rapid.txt, where the date of the log file is represented as YYYY=year MM=month DD=day, and the time of the first entry in the log file is represented as hh=hours mm=minutes (e.g., 20090421_1202_rapid.txt).
For the System logs, you could set:
- Log Level: Change this to match the level of logging you require. It is recommended that the log level ‘Verbose’ is only used when requested by AIM, due to the size of the log files that are generated. It should not be used on a general basis.
Active Directory Integration
Active Directory integration allows users to use their centralized login details to access Rapid.
To enable Active Directory support within Rapid, select the checkbox for "Enable Active Directory Integration".
Once Active Directory Integration is enabled:
- For whole domain access, leave the Domain Name field
- To access a specific Active Directory server then enter the server name, username and password for that server. The user must have enough privileges to be able to enumerate Users and Groups on that Domain.
Rapid will periodically check the Domain server for updates. The refresh interval defines how often this background check occurs. The minimum value for this field is one hour.
To map your Active Directory Groups to Roles within Rapid
When you have configured Active Directory, you can navigate to "User Management" and then select the "Roles" tab.
As you add a role, you should see an option for an "Active Directory Group Name".
This option represents an equivalent Group Name in your Active Directory account.
After creating this role, be sure to select the button named "Refresh Active Directory Users": after the refresh, Rapid will pull in all users to the Active Directory Group.
These users should then appear on the Users tab: they will have the inherited permissions you set for them on the role with the Group Name.
NOTE | You will not be able to edit these users on the user page.
v412