SoundScape Portal User Manual v1.1
Contents
1. Locations and clicking on Add new in the Brand Location List page Path Home gt Brand Location List gt Add Brand Location Add Brand Location Home gt Brand Location List gt Add Brand Location Add New Mandatory fields Brand E Name Client Reference The mandatory fields are selecting the Brand giving a Name to the LOCATION setting the Time Zone and a Client Reference which is the BRAND s identifier for that LOCATION e g the branch number This has to be unique for the BRAND Additionally the Provider Admin can define more details such as the complete Address Phone Notes and place a marker in the map for the LOCATION or entering the exact coordinates in the Latitude and Longitude fields Putting a marker in the map of the LOCATION or setting the coordinates is very important in order to be able to quickly identify the DEVICES and LOCATIONS when monitoring the system from the BRAND s Location Map Notes 1 Putting the markers or entering the coordinates for each LOCATION is a manual procedure the Portal will not do a lookup on the Address 2 LOCATIONS can also be created in the system by importing the CSV file with the DEVICES for a BRAND see STEP 8 The Brand Location Groups section allows the user to specify the GROUP or SUB GROUP that this LOCATION belongs SOUNDSCAPE PORTAL USER M2. Clicking on the Save button will store the Recurrence in the system and all the instances of the SCHEDULE ITEM will be shown in the SCHEDULE Day Month Year VIEWS 32 SOUNDSCAPE PORTAL USER MANUAL Resolve Schedule Conflicts sometimes when scheduling some content the user will be prompted with a Warning or an Alert saying that the Schedule has a Conflict Sync Issues O Me Alerts 1 44 SoundScape Content Provide Logout Home Customers Content Schedules Devices Users Config This can happen when multiple SCHEDULED ITEMS of the same type e g two ADVERTS or two PLAYLIST STREAM are overlapping or when a SCHEDULED ITEM doesn t have an end STREAM or repeating PLAYLIST without End Time Date Note that if there are two SCHEDULED ITEMS of different tyoes scheduled at the same time the higher priority Item ADVERT will prevail over the lower priority Items PLAYLIST or STREAM and will not be considered a Schedule Conflict When a Schedule Conflict is detected the user is given the chance to Edit those conflictive SCHEDULED ITEMS and change the Start End Times and Dates in order to resolve those conflicts This schedule item does not end or conflicts with another in the same schedule iew Confl ci Clicking on View Conflicts will show the following page to the user Edit Lots of Conflicts Help Home gt Edit Schedule Deployment for Mixed Streams Sep Dec 15 gt Alerts gt Edit Lots o
3. CAPITAL LETTERS Entities Domains Objects and Items within the Portal e g PROVIDER BRAND DEVICE LOCATION PLAYLIST etc Underlined User accounts of the Portal with email and password credentials e g Portal Administrator Provider Admin Brand Admin Brand User Quoted Menu texts and Buttons appearing in the User Interface of the Portal e g Add New Customer Location Map Save etc 2 Objective The goal of this document is to help Provider Admin users to setup their SoundScape installations and to be used as a reference in the daily usage of the solution SOUNDSCAPE PORTAL USER MANUAL 3 3 SoundScape diagram PROVIDER Brand Admin Brand User SSeS Web Ul User Admin mee DEVICE DEVICE DEVICE LOCATION LOCATION LOCATION LOCATION GROUP GROUP The diagram above provides an overview of the SoundScape components entities and users that can be separated in the following sections Left column Content Servers and Streaming Servers These are the content sources that are not hosted by SoundScape This includes the CONTENT SERVERs where the PROVIDER stores all the library of content Tracks Adverts Playlists and the STREAMING SERVERS that generate HTTP streams ICEcast SHOUTcast Note that the SoundScape Portal will synchronise the directory listing of the CONTENT SERVERs and update them if the file modification timestamp has changed e g the ID3
4. shown in the Conflictive Items bar indicating there is a Schedule Conflict From this screen the user can click on the Item s bar directly to Edit them and shift the Start End Times to resolve the conflict Note that if the user doesn t take any action on the Schedule Conflicts concerning overlaps the policy of the system is that the Item with the most recent Start Time prevails This can be seen in the Continuity line of the screenshot from the example above If no action is taken the Playlist Morning mix will be played from 11 10 to 11 50 prevailing over the Stream Barix Radio HiQuality 34 SOUNDSCAPE PORTAL USER MANUAL STEP 13 Deploy a SCHEDULE After the user has configured the SCHEDULE the next step is to deploy the SCHEDULE to the BRAND GROUP LOCATION or DEVICE Note that a DEVICE will use only one SCHEDULE so it has to contain all the SCHEDULED ITEMS appropriate for that BRAND GROUP LOCATION or DEVICE In order to deploy a SCHEDULE the user has to go to the Schedules and Schedule Deployment menu This will take the user to the Schedule Deployment List with an Add New button on the top right Add Schedule Deployment Help Home gt Schedule Deployment List gt Add Schedule Deployment Add New Mandatory fields Which brand is the deployment for Provider BARIX CP Brand Alfa Pizzeria v What is being deployed Schedule Pizza feeli
5. Mandatory fields Device Details MAC Address 00 08 e1 03 c1 d6 Brand Spr ngli Brand Location Hardware Type Device Status Active The Add Device page requires the Provider Admin to specify the following information Set MAC Address that will be copied from the previous page Select the Brand to which this DEVICE will be assigned Select the Brand Location with the right LOCATION of this DEVICE Select the Hardware Type to define the model of SoundScape Player Finally the Provider Admin can set this device to Active in order to make the Portal accept and expect regular call ins from this DEVICE If the Active flag for this DEVICE is not set the Portal will keep the information provided for this DEVICE in its database but will not be reporting any alarm or showing any monitoring information for this device until it s activated This Active flag can also be used to mark the DEVICE as temporarily offline in certain situations e g moving LOCATION Once all the information has been filled in clicking on Save button will store all the information in the database of the Portal and the DEVICE will be able to start communicating with the Portal normally 18 SOUNDSCAPE PORTAL USER MANUAL STEP 8 Register DEVICES via Export Import CSV file When a PROVIDER wants to register multiple devices in bulk quantities it is convenient to use
6. Tracks menu and it will be available for Scheduling Note that the Portal is not streaming to the DEVICES only referencing the URL of the STREAM source from elsewhere so the DEVICES can go and fetch the STREAM for playback 22 SOUNDSCAPE PORTAL USER MANUAL STEP 11 Upload ADVERTS The Portal is able to import ADVERTS directly from the CONTENT SERVER The system will identify the Tracks as ADVERTS when they are found in the Adverts sub folder in the CONTENT SERVER These ADVERTS can be private and only visible for a single BRAND if they are located in a subfolder of the Adverts folder in the CONTENT SERVER called Adverts BRANDNAME However Provider Admins and Brand Admins can also upload ADVERTS directly to the Portal bypassing the sync process of the CONTENT SERVER In order to manually add an ADVERT to the system the user needs to select the Tracks menu under Content and click on the Add new advert button on the top right of the Track List page Path Home gt Track List gt Add Track Add Track Help ar F L Ad ra Add New Customer Track Filename Choose File Sa o Back When a Provider Admin is manually uploading an ADVERT he will have the option to choose the BRAND for whom this ADVERT is addressed This will not be possible when a Brand Admin is doing the same The user will have to Choose File from his local drive and clicking on Save will upload the ADVE
7. actual FIRMWARE update will be performed by each DEVICE at a date starting from the Deployment Start Date at a random time between the Deployment Start Time and Deployment Stop Time The user will be able to check the status of the FIRMWARE update of a DEVICE in the Firmware Update Status tab in the DEVICE page SOUNDSCAPE PORTAL USER MANUAL 41 STEP 16 Monitoring and reporting The SoundScape Portal offers powerful options to monitor the system Itself and the content being played by each player device connected to the Portal In this section we will provide some examples with the Location Map Device Communication Logs Track Plays reports and the deployment overviews for Schedules and Firmware Monitor with Location Map Once the user has deployed the SCHEDULES to the DEVICES and the SoundScape system is operating it s possible to monitor the status of the whole system with an overview displaying all the DEVICES in their LOCATIONS in a map The Location Map is accessible under the Locations menu and it will show all the active DEVICES in their LOCATIONS with color coded marker icons depending on their Status red if there is any active Alert and black if there are no Alerts Alerts 2 es Sportsbar barix com Logout Es AR IX Home Locations Content Schedules Devices Users Config Customer Location Map Home gt Customer Location Map Oe gers 4 AF Regents Park e
8. and a Recurrence End Time and Date Recurrence Unit Daily C Weekly C Monthly Yearly How often y 1 Recurrence End Time Save Weekly Recurrence allows the user to set How often in week s units and the Day of the Week that this should recur until the Recurrence End Time and Date Recurrence Unit Daily Weekly C Monthly Yearly How often Monday M Tuesday Wednesday Thursday Friday Saturday Sunday Recurrence End Time Save SOUNDSCAPE PORTAL USER MANUAL 31 Monthly Recurrence allows the user to set How often in Day calendar number of every month s units or the First Second Third Fourth Day of the Week of every month s units that this SCHEDULED ITEM should recur until the Recurrence End Date and Time Recurrence Unit Daily Weekly Monthly gt Yearly How often A First Tuesday 7 of eve Recurrence End Time Save Yearly Recurrence allows the user to set How often in year s units on a specific Date Month and Calendar Day or on the First Second Third Fourth Day of the Week of Month that this SCHEDULED ITEM should recur until the Recurrence End Date and Time Recurrence Unit Daily C Weekly Monthly Yearly How often July gt First Tuesday of July y Recurrence End Time Save
9. another in the same schedule Note ll If no End Time is defined and the Repeat option is not enabled the playback of the PLAYLIST will end after the last Track has been played elapsed total duration of the PLAYLIST Clicking the Save button will show a confirmation message and will display the Item Recurrence options see Create Recurrence SOUNDSCAPE PORTAL USER MANUAL 27 Schedule an ADVERT Add Schedule Item Help Home gt Schedule List gt Edit Choco Dreams gt Add Schedule Item Add New Mandatory fields Schedule Choco Dreams What type of item would you like to schedule Playlist Advert Stream Schedule Item Details Advert Track Advert Transition Start Time 01 05 2015 00 00 Volume 100 If an ADVERT is scheduled the user will be prompted to select the file name of the ADVERT from the Track List filtered by type Advert The user also needs to select the Start Time and Date for the ADVERT playback It is also mandatory to choose an Advert Transition mode Cut in with fading ADVERT will play exactly at Start Time fading out the Background music and fading it in again when the ADVERT playback finishes Finish current track The player device will wait until the current Track of the active PLAYLIST being played at Start Time finishes before playing the ADVERT Clicking the Save
10. button will show a confirmation message and will display the Advert Repetition and Item Recurrence options see Create Recurrence 28 SOUNDSCAPE PORTAL USER MANUAL ADVERT Repetition ADVERTS can be set to Repeat multiple times within a day NOTE Advert Repetition settings have to be set before setting any Recurrence to the Advert Add Schedule Repetition Pattern Help Home gt Schedule List gt Edit 12 Song Schedule gt Add Schedule Item gt Edit Advert Budweiser mp3 gt Add Schedule Repetition Pattern Add New Mandatory fields Start Time 15 00 Stop Time 18 00 Frequency Minutes 15 Clicking on the Create Repetition button will allow the user to define Start Time Stop Time Frequency can be every 10min 15min 20min 30min 60min or 120min Note that after setting the Repetition within a day for an ADVERT it is possible to set a Recurrence across multiple days of the repeated series NOTE it is only allowed to recur repeated Adverts until the end of the month SOUNDSCAPE PORTAL USER MANUAL 29 Schedule a STREAM Add Schedule Item Help Home gt Schedule List gt Edit Choco Dreams gt Add Schedule Item Add New Mandatory fields Schedule Choco Dreams What type of item would you like to schedule Playlist Advert Stream Schedule ltem Details Stream Track Start Time 01 05 2015 00 00 End Time
11. nomenclature and general structure of the system in order to be able to manage Devices and content The graph below summarises the basic workflow of the system and highlights the central role of the LOCATION defined for a BRAND within a PROVIDER It also shows how the user creates a SCHEDULE composed by SCHEDULE ITEMS and then makes a SCHEDULE DEPLOYMENT to the LOCATION where the DEVICE is registered The graph also provides a chronological order to follow when configuring the system Create BRAND Create LOCATION Register DEVICE to the LOCATION Create SCHEDULE and add SCHEDULE ITEMS to it Create SCHEDULE DEPLOYMENT to the LOCATION A Is All these steps are defined in more detail in the following chapters SOUNDSCAPE PORTAL USER MANUAL 5 5 STEP definitions system set up STEP 1 Define CONTENT SERVERS STEP 2 Create a BRAND STEP 3 Customise the Portal appearance optional STEP 4 Create additional user accounts optional Brand set up STEP 5 Define BRAND structure GROUPS and LOCATIONS STEP 6 Define DEVICE CONFIGURATION SETTINGS STEP 7 Register DEVICES STEP 9 Register DEVICES via CSV file import Operation STEP 9 Create PLAYLISTS STEP 10 Define STREAMS STEP 11 Upload ADVERTS STEP 12 Create SCHEDULES STEP 13 Deploy SCHEDULES STEP 14 Location specific tools STEP 15 Firmware management STEP 16 Monitoring and reporting 6 SOUNDSCAPE PORTAL USER MA
12. the Devices main menu Path Home gt Device Communication Logs Device Communication Logs Help Home L y y mmut ti Filters 14 07 2014 21 07 2014 BARIX SP SportsBar All City gt London All In this page the user has the possibility to use the Filters of the Communication Logs of the DEVICES with the following parameters Date Range PROVIDER BRAND selectable depending on the user s hierarchy LOCATION and or GROUP Status Code of the Communication Logs which can be All Codes All Success Codes All Warning Codes All Error Codes Specific Error Codes O O 0 0 0 SOUNDSCAPE PORTAL USER MANUAL 43 Generate Track Plays Reports The SoundScape Portal offers the user the possibility to generate Track Plays reports that can be very useful as a proof of play in order to verify Service Level Agreements SLA s with Content Providers or with Advertisers In order to access this feature the user has to select Download Track Plays under the Content main menu Path Home gt Download Track Plays Download Track Plays Help F Filters 21 07 2013 CH to 21 07 2014 U BARIX SP SportsBar All All Adverts and Non advert Tracks There are multiple Filters available Date Range PROVIDER and BRAND depending on user hierarchy LOCATION and or GROUP Adverts field which can be o Adverts and Non advert T
13. the GROUP The PROVIDER can then use this file to edit already registered DEVICES fields or to add new DEVICES to be registered Once all the mandatory fields are filled with the appropriate information the Provider Admin can use the Import button to select the edited CSV file and register the new DEVICES into the Portal The Import process will create new devices update existing ones and give the user the option to deactivate existing devices not existing in the import file When importing each row if a problem is found with the data the system will continue and process the valid data where possible TIP New LOCATIONS and GROUPS can be created using this method provided the GROUP TYPE is already existing in the system SOUNDSCAPE PORTAL USER MANUAL 19 STEP 9 Create PLAYLISTS The Portal can import existing PLAYLISTS MSU PLS and XSPF that the PROVIDER has previously created and stored in the CONTENT SERVERS and they will be ready to be used as soon as they are synced in the Portal However the system also provides means to create new PLAYLISTS from within the Portal with the Tracks available from the CONTENT SERVERS To create a PLAYLIST the user has to select the Playlist menu under Content and click on the Add New button on the top right of the Playlist List page Note that imported PLAYLISTS from the CONTENT SERVER will be shown in the Playlist List page but will not be e
14. the program of content to be played Each Schedule must have a Failover Playlist defined A Schedule has to be filled with Schedule Items before it can be used By itself a Schedule is only a frame and it doesn t refer to any timing information or type of content SCHEDULE DEPLOYMENT After a Schedule has been fully programmed with Schedule Items the Schedule Deployment assigns a Schedule to a Location to a Group of Locations or to all the Locations of a Brand All Devices in Locations with a schedule Deployment will get all the necessary information and content from the Portal to playback the items according to the Schedule being deployed Locations will get Schedules that have been deployed at a lower level e g Schedule Deployment restricted to a Location will get preference over a Schedule Deployment to a Group that includes that Location and if there is the case that multiple Schedule Deployments apply to a Location at the same level e g there are Schedule Deployments to different Groups that include the same Location the Location will get the Schedule of the Group with the higher Importance set SCHEDULE ITEMS These are the components of a Schedule which can be of 3 different types Playlist Streams or Adverts Each of these Schedule Items include related playback details such as timing information like Start and Stop times as well as Volume Repeat or Shuffle flags and Recurrences and Repetitions STREAM A Stream is a type of Sch
15. A f 77 a 7 gt a gt eG gt be Y DD as A vr os 7 A pis ate male gt AN Lr hen 4 Md r atacan a n Mansion H ay UR i Ba til me y i i t Knightsbridge i NA e ANT Belgravia S ure Y E ya A MN y IES a E iT TREF 3 3 hi Ele phantar Te ictoria Greycoat Gardens i AS ene e A ea El wo e A3213 Y A ieee E y WS ll e av AQ Pol VAS Us EN E amp astle AFA A 4 gt y 7 r Y 43 o Y re sp NY 3 Whitgit Estate S r AN W Pa ae DAN Ari y g MO DEA Sy da y K a y TH Le oN AN A AA e e DE W ill I y i Y a E H AA AKON 7 J iit m L i epi br i J an eS x i 1 Ly ii Clicking in any LOCATION marker icon will show a list of all the MAC addresses of DEVICES that are in that LOCATION with a direct link to the Edit tab of the DEVICE 42 SOUNDSCAPE PORTAL USER MANUAL This allows the user to make quick troubleshooting of the affected DEVICES and LOCATIONS HA pa E Y y PETA Southn Bankdd ae e U CH Y 00 08 e1 12 35 15 i _ Southwar gt qu Monitor with Device Communication Logs Another option to monitor the current and past Status of the DEVICES is using the Communication Logs of the DEVICES These Logs store information about the messages exchanged between the DEVICES and the Portal In order to access this feature the user has to select Device Communication Logs under
16. ANUAL 15 STEP 6 Device configuration settings A Provider Admin has the possibility to change global configuration settings of the devices under his domain These configuration settings can be applied to different context levels to all PROVIDER devices to a specific BRAND to a specific GROUP or only to a particular LOCATION or DEVICE Path Home gt Device Configuration Settings After selecting the context to edit the configuration the Provider Admin will be able to override the settings set by default or by a higher context System Settings Setting Override Value Help 10 1 the pdat the 7 ada COI bli bufi Bui vill Volume Setting Override Value Help The most important Settings that need to be set for each BRAND GROUP LOCATION or DEVICE are Call In Frequency Call In Lost Contact Time Device Update Window Start End Master Volume Please review the settings above to make sure they match the requirements of the installation 16 SOUNDSCAPE PORTAL USER MANUAL STEP 7 Register DEVICES After creating the BRAND GROUPs and LOCATIONSs the Provider Admin can start registering the DEVICES that belong to that BRAND and in a particular LOCATION In order to register a DEVICE the user has to click on the Register a Device option from the Devices menu Path Home gt Register a Device Register a Device MAC Address Register Device The user will be prompte
17. Add Schedule Item Help e List gt Edit Summe Add New Schedule What type of item would you like t OP 1 l im Here the user has to choose the type of content he would like to schedule This can be either a PLAYLIST and ADVERT or a STREAM The following pages of this document describe all the options and settings for adding each of these SCHEDULE ITEM types of content into a SCHEDULE 26 SOUNDSCAPE PORTAL USER MANUAL Schedule a PLAYLIST Add New Schedule Wi Pla Schedule Item Details Playlist Start Time 01 07 2014 00 00 End Time Repeat Shuffle Volume 100 eS When a PLAYLIST is scheduled the user has to select which is the PLAYLIST name and what is the desired Start Time and Date It is also mandatory to define the desired playback Volume for this PLAYLIST which is 100 by default The user can also define an End Time and Date to Stop the playback of the PLAYLIST at any given time and date Additionally the user can enable the Repeat flag to start over again once It reaches the end last Track of the PLAYLIST and the Shuffle mode to randomize the playback order of all the Tracks in the PLAYLIST Note l If no End Time is defined and the Repeat option is enabled the playback of the PLAYLIST will never end and the Portal will warn the user with a Schedule Conflict message This schedule item does not end or conflicts with
18. Brand Colour BB 063332 BB 000000 Click on Config top menu and select Settings This will show a page where Provider Admins can upload a company logo and select the colours to be used in multiple categories Brand colour Text Primary Button Secondary Button Navigation Misc 10 SOUNDSCAPE PORTAL USER MANUAL STEP 4 Create additional user accounts A Provider Admin has the possibility to create new users that can log in to the Portal and manage relevant issues The new user accounts have to belong to any of these 3 User Groups or categories Provider Admin Brand Admin Brand User requires a ROLE Each type of user will have different permissions and will be able to see and manage different sets of information in the Portal e Provider Admin is the top level PROVIDER user and can manage everything related to the PROVIDER and all of its BRANDs in the system e Brand Admin can only manage information related to a specific BRAND in the system Devices Locations Schedules e Brand User is the lowest level of user and can only view and execute actions according to the ROLE that it has been assigned See next page in the GROUP or LOCATION that has been restricted Path Home gt User List gt Add User Click on the Users main menu and from the User List page click the Add new button on the top right side of the list to create
19. Configuration Settings Manage Playlists and Tracks This ROLE allows the Brand User to see and edit some content PLAYLISTS View the List of Playlists add new Playlists and edit existing Playlists created in the Portal TRACKS View the List of available Tracks and Add new ADVERTS for the BRAND Manage Schedules This ROLE allows the Brand User to do the same as the View Devices and Locations and the Manage Playlists and Tracks and additionally it has the ability to work with the SCHEDULES SCHEDULES See the List of SCHEDULES Add New SCHEDULES Add Edit SCHEDULE ITEMS View Create SCHEDULE DEPLOYMENTS and Resolve SCHEDULE Conflicts 12 SOUNDSCAPE PORTAL USER MANUAL STEP 5 Define BRAND structure The SoundScape Portal allows users to organise the structure of the BRANDs to help administrators restrict the deployment of different SCHEDULES FIRMWARES or DEVICE CONFIGURATION settings to different GROUPS of DEVICES Create GROUP TYPES optional GROUP TYPES enable BRANDs to group the DEVICES and LOCATIONS according to their preferences These GROUP TYPES can be hierarchical with multiple layers or not Typical GROUP TYPES that can be used are Country Region or Size In order to create a GROUP TYPE the Provider Admin has to click on the Edit icon of the BRAND from the Brand List page Then the user has to select the Group Types tab Clicking on Add ne
20. NUAL STEP 1 Define CONTENT SERVERS The first step that a Provider Admin has to do is to define the CONTENT SERVERS where all the content media library Music Tracks Adverts and Playlists is stored CONTENT SERVERS can be synced to the Portal via standard FTP SFTP FT P SSL HTTP Apache IIS HTTPS Apache IIS and Network Share protocols Path Home gt Content Server List gt Add Content Server Click on Content and select Content Servers From the Content Server List page click the Add new button on the top right side of the list Add Content Server Help Add New Name Server Type v Host Nam Username Passwor d Remote Fold It is mandatory to define a Name select the Server Type Host Name or IP address Username and Password to access the CONTENT SERVER The Provider Admin has to specify the Remote Folder to define the complete path where the media content is located in the server in order to allow the Portal to sync If the content is located in the root folder of the server this field should be empty Note that when using FTP or FTP SSL Server Types the Portal will allow the user to select the options to Use Passive mode and Force passive connections to use host address which can be helpful to allow the SoundScape Portal to connect to these type of CONTENT SERVER and complete the sync process successfully Use Passive mode Force pass
21. PE PORTAL USER MANUAL Configure email Alerts The SoundScape Portal is able to send email Alerts to selected users whenever a DEVICE or any DEVICE from a BRAND has reported a problem so the user is always informed in a timely manner when there are issues In order to configure an email Alert the user has to go to the option Email and SMS Alerts from the main Config menu and click on Add New Path Home gt Alert List gt Add Alert Add Alert ert L Add Alert Add New Mandatory fie Which devices should trigger an alert Provider BARIX Provider Brand BARIX Shop Device What should cause the alert to be sent Device Reports an Error Code Call In Overdue by Set up the alert Send By Email Send By SMS Recipient Users Add Remove Items Remove Selected Alert should not be sent more often than every 60 Minute Email From Address Email Subject Email Body Cli yn the elds to ert then to the email a hey w e rep ed wit ue Device MAC Address Device Location Link to View Alert Reason for Alert a a Mm F QM Source Format B IS amp u Wil dt 99 Device DeviceMacld at location DeviceLocation has an error Reason ReasonForAlert View more information here DeviceAlertLink body p Save amp create new The user can define the BRAND or the particular DEVICE for which the email Alerts will be sent a specific Error Code or any that should trigger
22. RT to the Portal making it available for Scheduling SOUNDSCAPE PORTAL USER MANUAL 23 STEP 12 Create SCHEDULES Provider Admins Brand Admins and Brand Users with the right ROLES assigned can generate SCHEDULES SCHEDULES are the programs specifying what content should be played and when should it be played The system supports SCHEDULES for up to 2 years There are 3 types of content that can be scheduled PLAYLISTS ADVERTS and STREAMS In order to create a SCHEDULE the user has to select Schedules under the Schedules menu and click on Add new in the Schedule List page Path Home gt Schedule List gt Add Schedule Add Schedule Help Home gt Schedule List gt Add Schedule Add New Mandatory fields Brand Name Colour FCO5A3 v Failover Playlist Shuffle Failover Playlist It is mandatory to select a Brand provide the SCHEDULE s Name define a Colour to be used for displaying in the Schedule Deployment Overview Diagram and selecting a Failover Playlist which will be played in case the SCHEDULED ITEMS are not available e g when a STREAM is not reachable The Failover Playlist can be shuffled so that it doesn t always start with the same song and follows the same order whenever it has to play 24 SOUNDSCAPE PORTAL USER MANUAL Clicking on Save will create the SCHEDULE and the user will enter the Ed
23. VICES Calls in to the Portal the SCHEDULE will be deployed After the Schedule Deployment has been saved the user will see the Edit tab of the SCHEDULE with the Deployment Details Deployment Details System Provider Schedule Customer Location Groups Deployment Locations Customer Location Group Even if a user can create SCHEDULES with up to 2 years worth of content the DEVICES will be given SCHEDULE ITEMS only for a set of number of days in advance The Download days in advance setting is controlled by the Device configuration settings and by default the devices will set this to download the next 60 days worth of content 36 SOUNDSCAPE PORTAL USER MANUAL STEP 14 Location specific tools The Portal offers some functionality that is specific for a Location These are some examples of information that can be extracted from the Portal regarding a specific DEVICE and LOCATION In this section there are 3 examples Disabling Adverts Monitoring Tracks Played and inspecting the Device logs Disabling Adverts Selecting a LOCATION from the Brand Location List will show the user multiple tabs with information of that LOCATION One of the tabs is called Advert Disabling and allows the user to temporarily disable the playback of a particular Advert in that LOCATION until a given date Edit Tiefenbrunnen Help Home gt Brand Location List gt Edit Tiefenbrunnen Edit Devices Firm
24. Volume 100 o If a STREAM is scheduled the user will have to select the Stream Track from the drop down menu which will filter all stream type entries from the Track List and define a Start Time with a Date If no End Time and Date is defined the Portal will show that there is a Schedule Conflict because the STREAM playback will never end This schedule item does not end or conflicts with another in the same schedule View Conf cts setting the Volume of the STREAM is also mandatory The Portal will take 100 as default value Clicking the Save button will show a confirmation message and will display the Item Recurrence options see Create Recurrence 30 SOUNDSCAPE PORTAL USER MANUAL Create Recurrence For any SCHEDULED ITEM that is added to a SCHEDULE the user has the possibility to create a Recurrence to occur again periodically in multiple days After clicking on the Save button when adding a SCHEDULE ITEM a confirmation message that the SCHEDULE ITEM has been saved will appear on top of the page and a Create Recurrence button will appear at the bottom of the page Item Recurrence iS It t De S Clicking on the Create Recurrence button will show the user the Recurrence Unit which can be Daily Weekly Monthly or Yearly Daily Recurrence allows the user to set How often in day s units
25. a new user Add User Help Home gt User List gt Add User Add New Mandatory fields Email Password Enabled System Access User Group Fill all the mandatory fields Email Password User Group and click Save in the bottom to enable the new account Note A Brand Admin User account can only be created after the BRAND already exists in the system STEP 2 SOUNDSCAPE PORTAL USER MANUAL 11 Brand User Roles There are 5 ROLES that can be assigned to Brand Users This is the description of each of them with its available functionality View Devices and Locations This is a basic ROLE that can do operations on 3 areas DEVICES see the list of Registered Devices Register new Devices see all Device related information Tracks Played Call In Reports Firmware Update Status Device Logs Alerts and Activity LOCATIONS See the list of Locations and the Location Map and edit existing Locations change pointer in map and add remove GROUPS CONTENT Download Track Plays Disable Adverts This ROLE allows the user to do the same as the View Devices and Locations with the additional functionality of allowing the Brand User to Disable Adverts in a particular LOCATION Configure Devices This ROLE allows the user to do the same as the View Devices and Locations with the additional functionality of allowing the Brand User to configure the DEVICES with the Device
26. agement The SoundScape Portal is able to manage multiple versions of FIRMWARE and its deployment to sets of BRANDS GROUPS or particular LOCATIONS and DEVICES Upload new Firmware versions to the Portal Only the Provider Admin and the Portal Administrator can manage the FIRMWARE A Firmware version is a single package file PKG that contains all the necessary files to update a DEVICE to a specific FIRMWARE Standard FIRWMARE versions will be published by a BARIX Portal Administrator and will be available to all PROVIDERS However Provider Admins might want to deploy customised versions of FIRMWARE available only to their DEVICES In order to add a new special FIRMWARE version the user has to go to Firmware under the Devices menu and click on Add new The user has to give a Name to the FIRMWARE and specify to which Hardware Types should this FIRMWARE be available After clicking on Save the Portal will ask the user to associate a Firmware Version to this FIRMWARE The user can do so by clicking on the Firmware Versions tab and clicking on Add new In this page is where the user will be able to upload a Firmware Version to the Portal and associate it with a FIMRWARE Add Firmware Version Add New Firmware Firmware Version Name Firmware ZIP File Choose File The user will have to give the Firmware Version a name and click Choose Fi
27. an email Alert the Recipient Users and the composition of the email with specific From Address Email Subject and Email Body SOUNDSCAPE PORTAL USER MANUAL 47 6 Soundscape dictionary The SoundScape dictionary is an explanation of the terminology used with definitions of the entities items and concepts according to the SoundScape nomenclature ADVERT An Advert is a type of content that can be used as a Schedule Item Adverts are a special kind of Track flagged as an Advert Adverts can actually also be Announcements or Jingles that can be inserted into a Playlist or a Stream within a Schedule Adverts are synced from the Content Server when they are located inside the Adverts subfolder but they can also be uploaded directly to the Portal Adverts can be available for all Brands of a Provider when they are in the generic Adverts subfolder or they can be restricted to a particular Brand when they are located in the Adverts BRANDNAME subfolder in the Content Server ALERT An Alert is a message related to an issue reported by a Device or detected by the Portal that provides information about the status of the system There are 4 categories of Alerts Device Log Errors Messages reported by the Device to the Portal regarding playback or general functionality of the application Firmware Updates Issues during Firmware update process of a Device Call In Informing about Devices that lost contact with the Portal scheduling Issues Pr
28. at this mode is only available when inserting an Advert on top of a Playlist In case an Advert in this mode is inserted on top of a Stream it will be inserted as in Cut in with Fading mode FIRMWARE DEPLOYMENT It s assigning the Firmware Version that the Devices in a Location or Group need to install A Firmware Deployment includes the Firmware version and the Start Date and Time when the Firmware version needs to be installed in the assigned Devices Devices in a Location that have an active Firmware Deployment will download the corresponding Firmware Version at the next call in and will install the Firmware Version at a random time between the Start and the Stop Times from the Start Date onwards FIRMWARE VERSION It s a file that is used for updating the Devices to a specific version of the Firmware Firmware Versions are published and made available for all Providers in the Portal by BARIX administrators GROUP A Group is a collection of Locations following the criteria defined by the user Groups belong to a Group Type which is the category of the Group e g Language Size etc Group Types can be hierarchical and have sub groups Groups are used to make Schedule or Firmware Deployments to all the Locations in the Group with a single deployment Group Types have an Importance setting that is used to prioritise the Schedule to be used at a Location whenever there are multiple Group deployments that apply to a Locatio
29. d to enter the MAC Address of the DEVICE Please note that the system only accepts entries with lower case characters and hyphens separating the characters e g OO 08 e1 03 c1 d6 Clicking on the Register Device button will make the system check if that is a valid MAC Address and if this DEVICE has already been registered to the Portal previously In case the entered MAC Address of the DEVICE was already registered and present in the database of the system the Portal will show a message saying Device Found and the Provider Admin will be able to Edit the settings for this DEVICE Note that in order to make any changes in the DEVICE s BRAND or LOCATION of an already registered DEVICE it will be necessary to remove it from the system before registering It again with the new settings In case the entered MAC Address belongs to a DEVICE that had already started communicating with the Portal before being registered the Portal will recognize it and show the Edit page of the DEVICE allowing the Provider Admin to select the BRAND and the LOCATION of that DEVICE SOUNDSCAPE PORTAL USER MANUAL 17 After registering a valid and unknown DEVICE the Add Device page will appear Add Device Help Home gt Register a Device gt Add Device New Device The device is not already known to the system Please complete the configuration of the device to register it Add New
30. ditable they need to be edited in the CONTENT SERVER and wait to be re synceo Path Home gt Playlist List gt Add Playlist Add Playlist Add New Provider Title Genre Playlist Colour BB socosr7 Limit Brands Brands Add Remove Items Remove Selected Save amp create new The user will have to give a Title to the PLAYLIST to identify it and optionally describe a Genre It is also mandatory to choose a Playlist Colour to be displayed in the Schedule Deployment Overview and be able to quickly identify the PLAYLIST If the user is a Provider Admin the Portal will give the option to Limit Brands who can use this PLAYLIST or to make it available to all BRANDS under that PROVIDER see screenshot above 20 SOUNDSCAPE PORTAL USER MANUAL If the user is a Brand Admin the PLAYLIST will only be available for that particular BRAND and the Add Playlist page will not show the option to Limit Customers After clicking on the Save button the Edit Playlist page will be shown Edit CustomerAdmin Playlist Help Edit Item saved Playlist CustomerAdmin Playlist has been saved Edit Playlist Add to Playlist Audit Title CustomerAdmin Playlist Genre Rock Playlist Colour Mi secosaz Num Tracks Total Length Modified Time 7 11 15 sme The Edit Playlist page has 4 tabs that allow the user to Edit Change Ti
31. e to be scheduled for all the BRANDS of this PROVIDER If the PROVIDER wants to restrict these ADVERTS to be available for scheduling only for a particular BRAND they should be placed in the subfolder Adverts BRANDNAME see STEP 2 All PLAYLISTS M3U PLS in the CONTENT SERVER should have their referenced audio files MP3 AAC within the same folder where the PLAYLIST is located E g If the PLAYLIST MyAlbum mSu is inside the MyAlbum subfolder all the Tracks referenced in this PLAYLIST like AlbumTrack1 mp3 AloumTrack2 mp3 etc should be located inside the same MyAlbum subfolder where the PLAYLIST is located It is possible to use PLAYLISTS M3U PLS that contain a URL referencing to a STREAM However these special STREAM PLAYLISTS can only have a single URL and it must be placed in the last entry of the PLAYLIST in case there are other audio files included in the PLAYLIST The Portal will recognise this as a normal PLAYLIST and therefore it can be selected as a FAILOVER PLAYLIST see STEP 11 but this is not recommended SOUNDSCAPE PORTAL USER MANUAL STEP 2 Create a BRAND A BRAND is the company that uses and benefits from the service provided by the PROVIDER The Provider Admin can see all the BRANDS that are managed by his account by selecting Brands from the main menu In order to add a new BRAND click on Add New button on the top right of the Brand List page Pa
32. edule Item that is pointing to an external URL which is the source of the stream Streams can be added manually to the Portal from the Track List page by typing the URL of the Stream TRACK A Track is an audio file MP3 or AAC AAC that is synced from the Content server to the Portal A Track is synced when it appears in the Portal with time duration and with Metadata ID3 Tags information Synced Tracks can be added to a Playlist created in the Portal USERS SoundScape Portal users are the users that can log in and interact with the Portal with a username and password and fall into 3 different categories Provider Admin Manages Content Servers Firmware Schedules Brands Groups Locations and Devices of a Provider and all of its Brands Brand Admin Manages Schedules Groups Locations and Devices of a Brand Brand User Can manage Schedules and Playlists Suppress Adverts Update Device Configuration Settings and can be restricted to Locations or Groups within a Brand depending on the Roles and restrictions assigned SOUNDSCAPE PORTAL USER MANUAL 51 7 Legal Information 2015 Barix AG Zurich Switzerland All rights reserved All information is subject to change without notice All mentioned trademarks belong to their respective owners and are used for reference only Barix Exstreamer Instreamer SoniclP and IPzator are trademarks of Barix AG switzerland and are registered in certain countries For information abo
33. er box that communicates regularly with the Portal and plays the content according to the deployed Schedule DEVICE CONFIGURATION SETTINGS These are the settings that will be used by the Devices There are System Settings Call in frequency allowed Device update time window etc and Volume settings Master Volume Treble Bass etc Device Configuration Settings can be set at multiple levels depending on the context chosen Brand Group Location and Device overriding the inherited setting from the higher level Lower level settings will apply e g Location settings will prevail over Group settings FAILOVER PLAYLIST It s the Playlist defined in a Schedule that will play in case the original Scheduled Item is not available e g when the scheduled Stream is not reachable in order to avoid silences Although it is possible to set a Playlist that contains a Stream as a Failover Playlist it is recommended to use a Playlist with only Tracks that can be stored in the local memory of the Device in order to avoid silences in case the Failover Playlist needs to be played when the device is offline FINISH CURRENT TRACK This is a mode of Advert Transition that can be selected when adding a Schedule Item of type Advert It consists of waiting for the Track playing at the Start Time of the Advert to finish before starting to play the Advert Once the Advert is finished the playback will resume with the next Track of the current Playlist Note th
34. f Conflicts Edit Scheduled Items Schedule Deployment Schedule Conflicts YY Activity Overlap starting on 28 Aug 2015 00 00 00 Playlist Magnolia Start Time 28 08 2015 00 00 00 End Time 28 08 2015 12 00 00 Edit Recurrence View Playlist ENS Playlist Soundtracks Start Time 28 08 2015 11 30 00 End Time 28 08 2015 13 30 00 Edit Recurrence View Playlist ENS If one of the conflictive Items has been set with a Repetition or a Recurrence the Portal offers the possibility to Edit Repetition and Edit Recurrence in order to amend the conflict In this case the Portal will also offer the possibility to edit the Primary Item which is the first item from which a Repetition or a Recurrence series starts The user can also View the Item to get more information about it The Edit Item button allows the user to change Start End Time and Date of an individual Item to resolve the conflict SOUNDSCAPE PORTAL USER MANUAL 33 Finally the user can also Delete one of the conflictive Items permanently which will obviously solve the conflict The user can have an at a glance view of the Schedule Conflicts by looking at the Schedule Item Day View Please select a date to view schedule items for 01 07 2014 10 40 10 50 11 00 11 10 11 20 11 30 11 40 11 50 12 00 12 10 12 20 12 30 12 4 Continuity Failover Playlist Background All Music There will be warning sign triangle with exclamation mark
35. f a Recurrence or a Repetition of a Schedule Item Editing a Primary item will affect all the future instances of the Recurrence or Repetition of that Scheduled Item PROVIDER It s the top layer entity in the SoundScape Portal providing the business music service to its Brands and owning the content stored in the Content Server Its related user in the Portal is the Provider Admin RECURRENCE It s the multiple instances of a Schedule Item in multiple days scheduled Items can be set to recur every day week month year in customisable ways All Scheduled Items can be scheduled with a Recurrence but Adverts with a Repetition already set can only be recurred until the end of the month REPETITION It s the multiple instances of an Advert within a day Users can define the frequency and the Start and Stop times of this Repetition within a day Only Adverts can be repeated and a Repetition cannot be set to Adverts with a Recurrence already set RESOLVED ALERT It s a Device Log Error Alert that has been cleared Device reported a success message with code 12xx with a more recent timestamp Resolved Alerts are automatically removed from the Alerts page after 24h of being resolved ROLE A Role is a fixed set of permissions that a Provider or Brand Admin assigns to a Brand User Roles can restrict Brand Users to view limited information or to perform restricted actions on the Portal 50 SOUNDSCAPE PORTAL USER MANUAL SCHEDULE It s
36. in Reports Firmware Update Status Device Logs Alerts ED Activity 1200 Playback according to schedule 29 Sep 2015 16 20 37 UTC 1412 Failover playback empty buffer for Stream ID 11097 29 Sep 2015 16 16 24 UTC 1200 Playback according to schedule 29 Sep 2015 06 58 48 UTC 1202 Recovering Music context from stream error 29 Sep 2015 06 58 48 UTC 1412 Failover playback empty buffer for Stream ID 5325 29 Sep 2015 06 57 38 UTC Note that Device Logs are colour coded Green codes 12xx mean the status is OK Orange codes 13xx are Warnings Red codes 14xx are Errors Error Log codes 14xx sent from a DEVICE will be raised as an ALERT in the Portal The Alerts tab will show the Current Alerts listing the Errors that are still present which will be moved to the Resolved Alerts section at the next 12xx message received from the same DEVICE Resolved Alerts will be cleared automatically after 24h but they will still be available for inspection in the Device Logs section Edit 00 08 e1 04 31 4d Help Home gt Registered Devices List gt Edit 00 08 e1 04 31 4d Edit Tracks Played Call In Reports Firmware Update Status Device Logs Alerts aE Activity Current Alerts 0 Resolved Alerts EM Device reported code 1412 with message Failover playback stream audio buffer drained but has since reported success 10 Sep 2015 21 37 16 UTC SOUNDSCAPE PORTAL USER MANUAL 39 STEP 15 Firmware man
37. it page Edit Choco Dreams Help Home gt Schedule List gt Edit Choco Dreams Edit Scheduled ltems Schedule Deployment Schedule Conflicts 0 Activity View Month Week Day Please select a month to view schedule items for May 2015 v There are no items scheduled for this month The Edit Schedule page has 5 tabs that allow the user to Edit Change Name Colour and Failover Playlist of this SCHEDULE Scheduled Items View Month Week Day and Add new SCHEDULED ITEMS see Add New SCHEDULE ITEM below Schedule Deployment View and Edit Schedule Deployments with Deployment Details and Deployment Locations for that SCHEDULE Schedule Conflicts View and Edit Schedule Conflicts Activity See the change history of this SCHEDULE After editing the SCHEDULE in the Edit tab the user can click on the Save button to have it ready for scheduling Once the SCHEDULE is created and saved it will be an empty SCHEDULE The user has to add SCHEDULE ITEMs to the SCHEDULE in order to program the content that is to be played in that SCHEDULE SOUNDSCAPE PORTAL USER MANUAL 25 Add New SCHEDULE ITEMs In order to start adding content to a SCHEDULE the user has to click on Add New from the Scheduled Items tab of the Edit SCHEDULE page Path Home gt Schedule List gt Edit Schedule Name gt Add Schedule Item
38. ive connections to use host address SOUNDSCAPE PORTAL USER MANUAL 7 Once the CONTENT SERVER has been defined and saved into the portal it will be queued for a first synchronisation The syncing process consist of 2 steps 1 Import the file listing of all the media content 2 Download each Track to the cache memory to analyse it extract information such as duration and ID3 tags metadata and save it into the portal database to make it available for scheduling Periodical syncing of the CONTENT SERVERS will maintain the database in the portal always updated Important Notes 1 This process can take a long time depending on the size of the CONTENT SERVER to be synced so it is advised to do this as early as possible 2 Please make sure the filenames in the CONTENT SERVER are formatted in UTF 8 without any special character accents umlauts etc to avoid any synchronisation problem Each PROVIDER can configure multiple CONTENT SERVERS All the media content associated to a PROVIDER wwill be available to all their BRANDS except specific BRAND Adverts About the internal file structure of the CONTENT SERVER there are some important points that need to be considered by the PROVIDER 1 All ADVERTS should be placed inside a subfolder hanging from the Remote folder of the CONTENT SERVER called Adverts All audio files inside this special subfolder will be considered and marked as ADVERTS in the Portal and availabl
39. le to browse the local drive for the corresponding package file PKG Clicking on Save will upload the PKG file to the Portal and it will make it available for Deployment 40 SOUNDSCAPE PORTAL USER MANUAL Deploy FIRMWARE to DEVICES In order to do deploy a new FIRMWARE version to a DEVICE the user only Portal Administrator and Provider Admins can do this has to go to Firmware Deployment menu under Devices and click on Add new Path Home gt Firmware Deployment List gt Add Firmware Deployment Add Firmware Deployment Home rmware Deployme t gt Ad irmware Deployment Add New Which System Provider is the deployment for System Provider What should be deployed Firmware Version Deployment restrictions Customer Customer Location Group Customer Location When should the devices be updated Deployment Start Date Deployment Start Time 00 00 Deployment End Time 00 00 The fields allow the user to select the System Provider the Firmware Version and optionally a BRAND a GROUP or a LOCATION to restrict the deployment Then the user has to define the Deployment Start Date and Time to effectively deploy the FIRMWARE to the concerning DEVICES Clicking on Save will store all the settings and the deployment will be ready to be executed At the next call in within the allowed download window all the affected DEVICES will download the firmware version The
40. n SOUNDSCAPE PORTAL USER MANUAL 49 LOCATION A Location is the place where a Device is located Locations are linked to a Brand and are used when registering a Device and when deploying Schedules and Firmware versions Locations can belong to a Group to be able make Group deployments that will apply to all the Locations in the Group MASTER VOLUME It s the Device output playback Volume that can be set locally from the Device web Ul keypad arrows up down or remotely from the Portal via the Device Configuration Settings The Master Volume will apply over the Schedule Item Volume for example if a Stream has been scheduled with Volume 80 and Master Volume of the Device is set to 50 the output playback volume in the Device will be 40 The Master Volume of a Device will be applied overwriting the local setting from the Device Web Ul or keypad every time the Device reboots or whenever a new Device Configuration Setting is applied PLAYLIST A Playlist in SoundScape is a list of Tracks Playlists can be synced from a Content Server M3U PLS or XSPF formats or can be created in the Portal itself with Tracks that have already been synced from the Content Server A Playlist can contain one single Stream but it has to be the last entry of the Playlist Synced Playlists from the Content Server need to have the Tracks that they refer to in the same sub folder where the Playlist is located PRIMARY ITEM It s the first instance of the series o
41. ng v Deployment restrictions You can select to deploy only to specific groups or a specific location Alternatively leave both blank to deploy to all locations for the brand Brand Location Groups Add Remove Items Remove Selected Brand Location Firenze v As a Provider Admin the Portal will ask which BRAND is the deployment for and what SCHEDULE is to be deployed When logged in as a Brand Admin only the SCHEDULE to be deployed will need to be set Optionally the user can restrict the GROUPS in the Brand Location Groups section or the particular LOCATIONS in the Brand Location section that the SCHEDULE should be deployed to SOUNDSCAPE PORTAL USER MANUAL 35 The system will use the most specific granularity 1 e LOCATION if present then GROUP then CUSTOMER to determine which SCHEDULE is deployed to a particular DEVICE since it s possible for a LOCATION to be part of several GROUPS each of them belonging to a different GROUP TYPE the Portal will use the Importance set on the GROUP TYPE to determine which SCHEDULE a DEVICE Is given Within hierarchical GROUP TYPES the user will be able to deploy the SCHEDULE at any level The setting at the lowest level will take priority so for example a SCHEDULE deployed to London will be selected over one set for United Kingdom Clicking on the Save button will apply the Schedule Deployment so the next time any of the affected DE
42. om the Brand List with the edit icon then click on the Group Types tab and select the GROUP TYPE that is appropriate for the GROUP that needs to be created with the edit icon This will show the Edit page of the GROUP TYPE and will allow selecting the Groups tab where Add new can be clicked Add Group Home gt Brand List gt Edit Barix SHOP gt Add Group Type gt Edit Size gt Add Group Add New Mandatory fields Group Type Size Name Client Reference Save Save amp create new The Name of the GROUP is mandatory as well as it is the Client Reference which in this case it s a unique identifier within the GROUP TYPE for this GROUP For example if GROUP TYPE is Country and GROUP is France the Client Reference could be FR or a number identifying this GROUP SUB GROUPS e g Alsace can also be created by clicking on the corresponding tab if the GROUP TYPE had been previously defined as Hierarchical 14 SOUNDSCAPE PORTAL USER MANUAL Create LOCATIONS The Portal binds each DEVICE to a LOCATION in order to allow the management of the schedule Configuration and Firmware Deployments as well as helping with the Monitoring of the whole system The Provider Admin or the Brand Admin must define all the LOCATIONS for each BRAND before registering the DEVICES This is done from the Brands main menu selecting
43. ovide information about conflicts in deployed Schedules BRAND It s the end user and beneficiary of the service provided by the Provider Its related users in the Portal are the Brand Admin and the Brand User CONTENT It s any kind of media that the Devices can play Content can be Tracks MP3 AAC AAC Adverts MP3 AAC AAC Streams HTTP or Playlists M3U PLS XSPF CONTENT SERVER It s the remote server HTTP S FTP SFTP FTP SSL NAS where the Provider stores all his library of content The Content Server contains Tracks Adverts and Playlists that are synced in the Portal at regular intervals of time typically every 24h The Portal needs to be in sync with the Content Server before being able to add Schedule Items to a Schedule CURRENT ALERT It s a Device Log Error Alert that is still present and has not been cleared Current Alerts remain highlighted until the Device that reported the Alert sends a success message code 12xx with a more recent timestamp than the Current Alert CUT IN WITH FADING This is a mode of Advert Transition that can be selected when adding a Schedule Item of type Advert It consists of fading out the Playlist or stream that is playing at the Start Time of the Advert playing the Advert and fading back in the Playlist or Stream after the Advert has finished playing 48 SOUNDSCAPE PORTAL USER MANUAL DEVICE It s the BARIX Exstreamer SoundScape or Exstreamer Store amp Play decod
44. racks o Only Adverts o Only Non advert Tracks Clicking on Download CSV Report will automatically download a comma separated values CSV file to the local drive of the user that can be imported to an office suite spreadsheet for further processing Proprietary content royalty fees and advertising billing can be easily derived from the information extracted from the SoundScape Portal using this method 44 SOUNDSCAPE PORTAL USER MANUAL Generate Schedule Deployment Overview Diagram When multiple SCHEDULES have been applied to different GROUPS or LOCATIONS within a BRAND it can be very useful to be able to have an overview of the SCHEDULE deployment The SoundScape Portal offers the possibility to automatically generate a Schedule Deployment Overview Diagram accessible from the Edit page of the Schedule Deployment menu under Schedules main menu There the user will see a click here button in the Deployment Locations section that will give access to the Generate Overview Diagram button 7 This feature is also accessible from the Edit page of the BRAND going to the Deployment Overviews tab and clicking on the Generate Overview Diagram button Edit HolidayHotels Help HC er List gt Edit 00 08 e1 12 34 59 gt Edit HolidayHotels Edit Devices Locations Group Types Users Tracks Deployment Overviews Audit Schedule Deployment Overview Customer Location Co
45. sounnSCAPE by BARIX Soundscape Portal User Manual Provider Admin Manual v1 1 November 2015 NAS ERD LANG cd anita 3 ZOBJE CTN E ra E A SOUNDSCAPE DIAGRAM enasna itech OR atonal estat ioniaee atone 4 AO QUNDSS ARE WORK FEOW nro 5 S OTEP DEFINITION Si Tee 6 SEP l Dene CONTENT SERVER O aaa STER Z Create ABRAN D ia iS 9 STEP 3 Customise the Portal appearance ssssssssrsrrrrerernrrererrrrerrirrrnrerrrrererrerrrerrrr 10 STEP 4 Create additional user ACCOUNTS c cc ccceeeceeeseeeceeceeescaeeseeeceeeseeeseesneesseeeas 11 Brana Ser ROCS oein aa E A A ae ie rooee 12 STEF S Belins BRAND SUG LUNG la 13 Create GROUP TYPES OPI ala 13 Create GROUPS and SUB GROUPS optional cccscscssseusesssceevecasessvesrseees 14 Create LOCATON OS tin rail ttsiced secenetan ehnauais ences sade vaeeoasaeants 15 STEF 6 Device COMMOUPANOM Settings ssl 16 STEP A Reo ste DEY CBs wie dd das 17 STEP 8 Register DEVICES via Export Import CSV file ooccoccoccocincnorincnnonornnnnnos 19 SLEP G rate RIA MOS Scania anda 20 STEP MSCs REAM ctas dadas diia 22 STEP Oa Ey Osio ZO STER 12 Create aU vda aaa 24 Ada New SCHEDULE TIEMS oisnean aA E E 26 Schedule a PLAY EIS E aia 21 SN e 28 ADVER IRENE da 29 CEOS ra o REAN netaps r 30 ii e E r R 31 Rosolo Sehed Gonilcts it dali 33 STEP TSS BENO a SO REDEE ar as 35 OEP AA OC anim special Rehousing din 37 ISAO GANG CVT eea dela ol S Moni
46. tags or metadata has been modified in the CONTENT SERVER The sync process will also download temporarily each Track to analyse the file and extract file duration and all metadata information from the ID3 tags in order to keep the Portal database always updated When DEVICES request the download of any of these files the Portal will download them temporarily encrypt them with the PROVIDER File Encryption Key and cache them temporarily until all DEVICES that requested the file are served Central column Entities involved in SoundScape This is the internal structure of the SoundScape Portal system hierarchy with a PROVIDER that manages one or several BRANDS which in turn control several DEVICEs that are assigned to a LOCATION and might also be organised in GROUPS Right column User Types This is how users interact with each of the entities at multiple levels A Provider Admin can set uo CONTENT SERVERS and control all of his BRANDS and DEVICES in the Portal while a Brand Admin can manage only his own DEVICES and their SCHEDULES in the Portal The Brand User has limited functionality depending on the ROLES and Permissions that he has been granted Finally each DEVICE has also a web UI that can be accessed locally to make playback and configuration changes or used for troubleshooting purposes of the DEVICE 4 SOUNDSCAPE PORTAL USER MANUAL 4 SoundScape workflow The SoundScape Portal requires users to be familiar with the
47. th Home gt Brand List gt Add Brand Add Brand Help Home gt Brand List gt Add Brand Add New Mandatory fields Name Enable Advert Upload Private Adverts sub folder The Name of the BRAND and the Private Adverts sub folder are mandatory The Private Adverts sub folder is where all private Adverts for this particular BRAND are going to be located in the CONTENT SERVER so no other BRAND can see or use these Adverts In the CONTENT SERVER there should be a sub folder called Adverts BRANDNAME to store all the private Adverts for this BRAND Enabling Advert Upload will allow selected users to upload Adverts directly to the Portal and Schedule them without having to upload them to the CONTENT SERVERS and wait for their syncing in the Portal SOUNDSCAPE PORTAL USER MANUAL 9 STEP 3 Customise the Portal appearance Each PROVIDER can customise the appearance of the Portal so any user logging into the Portal under their domain will see the PROVIDER s selected logo and colour scheme Path Home gt Edit Provider Name Theme Optionally set up a colour scheme for this Provider Colours left blank will use a default so you need not set every value Logo Image 4 Permitted file type s jpg jpeg gil png Image Preview click to enlarge Maximum file size 2 MB Choose File no file selected Remove current file Barix Logo Pos gif Brand Colour Text on
48. the Device List Export Import feature In order to use this feature the Provider Admin has to select the BRAND from the Brands List page and then click on the Devices tab On the top right side of the BRAND s Devices tab list there will appear the Import and Export buttons Clicking on Export will download a CSV file that contains multiple columns with information for each of the Registered Devices of this BRAND 4 A B G D E F G H I J K L M N O P Q R MAC Address Hardware Type Name Client Ref Contac Addres Addres Addres County Postco Country Phone Latitude Longitude Notes TimeZone Group Type Customer Ref 00 08 e1 04 31 4d 2014 8085 Eindhoven EIN Netherlands 51 4498617 5 48629761 Europe Zurich Sprungli Language NL 00 08 e1 04 30 6f 2014 8081 Madrid MAD Spain 40 3896063 3 6708069 Europe Madrid Sprungli Language ES 00 08 e1 04 a7 61 2014 8086 Paris PAR France 48 8631902 2 36480713 Europe Paris Sprungli Language FR 00 08 e1 04 2f 94 2014 8081 Frankfurt FRA Germany 50 1239143 8 68057251 Europe Berlin Sprungli Language DE 00 08 e1 04 a7 1b 2014 8086 Donosti DON Spain 43 32296 1 985711 Europe Madrid Sprungli Language EU Eh Win ou MAC address Hardware Type Name of the LOCATION Client Reference of the LOCATION Contact Name Address 1 2 38 fields County Postcode Country Phone Latitude Longitude Notes Time Zone Group Type Customer Reference of
49. tle Genre and Colour and Limit Brands if user is a Content Provider not shown in the picture above Playlist Remove reorder Tracks from the PLAYLIST drag amp drop Add to Playlist Select Tracks normal Tracks Adverts or one Stream to be added at the end of the PLAYLIST from the Track List and add them to the PLAYLIST Activity See the change history of this PLAYLIST After editing the PLAYLIST the user can click on the Save button to have it ready for scheduling SOUNDSCAPE PORTAL USER MANUAL 21 STEP 10 Define STREAMS Provider Admins need to manually enter the URL s of their STREAMs to make them available for Scheduling to their BRANDS In order to add a STREAM to the system the Provider Admin needs to select the Tracks menu under Content and click on the Add new stream button on the top right of the Track List page Path Home gt Add Track Add Track Help Add New Mandatory fie Remote Url Title Genre Sae Save create new The Provider Admin has to insert the STREAM URL and can optionally give it a Title e g the name of the radio station and define its Genre When clicking on Get Title Genre the system will use the STREAM s URL to try to determine the Metadata from the STREAM s header information Clicking on Save will import the STREAM s URL into the database of the system under the
50. toring Tracks Played ti iia 38 DECS LOs and AICINS sarsaran a A ido 39 SIEP TO sFhnware Management naa a E ON 40 Upload new Firmware versions to the Portal occocccccccncncncncnnnnocnnconnoncornnanoss 40 Deploy FIANIWARE To DEVICES cri N A 41 STEP TO MONITOMMG and epoca 42 MOntor Wi LOCATION MaD tur a ana 42 Monitor with Device Communication LOIS ad 43 Generate Track Plays A 44 Generate Schedule Deployment Overview Diagram occcccnoccccnncocnoncnonononnnoss 45 Generate Firmware Deployment Overview Diagram cccccecesseeseeeeseeeeeeeeaees 46 COMIGUFE e males 47 G6 DOUNDSOAF es ICAMO NAR E 48 FASE GA INE OR IM PRION aaa AA 592 2 SOUNDSCAPE PORTAL USER MANUAL 1 Introduction This document aims to present the workflow that users of the SoundScape Portal should follow to set up their system with a sequence of tasks This workflow is divided in STEPs ordered by the importance of the task and the dependencies that it creates Each STEP represents a significant change in the configuration of the Portal some of them being mandatory and other optional The actions described in this document are concerning the PROVIDER and the Provider Admin managing one or multiple BRANDs and its users Lower hierarchy users e g Brand Admins or Brand Users cannot execute the tasks described in higher STEPs For clarity the following formatting convention has been used in this document
51. untry Customer Maui USA July program eal USA July program Phuket Chilling program Schedule Key M i nen a l a a i In the example from the screenshot above we can see that the more generic June program SCHEDULE was deployed at the CUSTOMER level then July Program SCHEDULE was applied only to GROUP USA GROUP TYPE Country and finally Chilling program SCHEDULE was deployed only to Phuket LOCATION SOUNDSCAPE PORTAL USER MANUAL 45 Generate Firmware Deployment Overview Diagram similarly to the SCHEDULES Deployment a BRAND might have different Firmware versions deployed in their DEVICES depending on the GROUP or LOCATION that these DEVICES belong to following the Firmware Deployment scheme The SoundScape Portal offers the user the possibility to generate an overview diagram of the Firmware deployment to show clearly which Firmware version has been deployed for each BRAND GROUP and LOCATION In order to access this feature the user can go to the Edit page of the BRAND and select the Deployment Overviews tab choosing the Hardware Type under the Firmware Deployment Overview section Firmware Deployment Overview Hardware Type Exstreamer 100M D Brand Location Sprungli Language Brand Provider Dutch Euskera French BARIX CP German Spanish Firmware Key SoundScape 0 75 _ SoundScape 0 73 46 SOUNDSCA
52. ut our devices and the latest version of this manual please visit Www barix com Barix AG Seefeldstrasse 303 8008 Zurich SWITZERLAND Phone 41 43 433 22 11 Fax 41 44 274 28 49 Internet Web www barix com Email sales barix com Support supportObarix com 52 SOUNDSCAPE PORTAL USER MANUAL
53. w on the top right will allow the user to create a new GROUP TYPE Path Home gt Brand List gt Edit BRAND gt Add Group Type Add Group Type Home gt Brand List gt Edit Barix SHOP gt Add Group Type Add New Mandatory fields Brand Barix SHOP Save Save amp create new The user has to select the BRAND for which the GROUP TYPE will be created the Name of the GROUP TYPE and setting if it s following a Hierarchical structure to allow the creation of SUB GROUPS The Importance field is an Integer that is used to decide which GROUP TYPE is the most important when deploying Schedules If a LOCATION is part of several GROUPS one for each GROUP TYPE the Portal will use the Importance set on the GROUP TYPE to determine which Schedule the DEVICE is given The Importance ranges from O to 20 where O is the lowest and 20 is the highest Importance that a GROUP TYPE can be assigned SOUNDSCAPE PORTAL USER MANUAL 13 Create GROUPS and SUB GROUPS optional Once the GROUP TYPES have been set up It s time to define the actual GROUPS that will be available for each BRAND The typical kind of GROUPS that can be defined are for example Switzerland and Italy for GROUP TYPE Country North and South for GROUP TYPE Region and Large and Small for GROUP TYPE Size In order to create a GROUP the user has to select a BRAND fr
54. ware Deployment Advert Disabling 0 Activity Schedule deployed to this location Mix of Streams Playlist Adverts Adverts scheduled You can disable adverts for this specific location below and optionally enter a date for them to be automatically re enabled Alphorn Enabled Disabled Taler Enabled Disabled Campbell s Soup Enabled Disabled Re enable on 19 05 2015 Adam Hats Enabled Disabled Comm0041 mp3 Enabled Disabled Save SOUNDSCAPE PORTAL USER MANUAL 37 Monitoring Tracks Played Selecting a DEVICE from the Registered Devices list or from the Devices tab of a particular LOCATION will show multiple tabs to the user One of the tabs is called Tracks Played and displays information of the content being played by the DEVICE with local timestamps Edit 00 08 e1 04 31 58 Li Edit Edit nome Select all Track Title Tracks Played Call In Reports f bife Balafo Y Beaux Din l Actions Export UTA ige 1 f 1024 412 1567 10234 iten 38 SOUNDSCAPE PORTAL USER MANUAL Firmware Update Status Start Time Device Logs Alerts 0 Audit End Time Device Logs and Alerts From the selected DEVICE page the Device Logs tab shows information about the Logs being sent by the Device to the Portal which can be useful for troubleshooting Edit 00 08 e1 04 65 68 Home gt Registered Devices List gt Edit D00 08 e 1 04 65 68 Edit Tracks Played Call
Download Pdf Manuals
Related Search