Viz Multichannel User Guide
Version 4.2 | Published July 31, 2023 ©
Import / Export Settings
Locate channel-specific import and export settings from the cog wheel icon. Select the Channel settings tab.
The Import and Export settings group comprises:
General Settings
Channel Name
-
Channel Name in Schedule: Sets the channel name that corresponds to the channel name given by the imported schedule.
Setting the name is useful if there are schedules for multiple channels in import or update folders.
Remote Hosts
-
Remote Hosts: Defines remote machines that are to receive a copy of the playlist. Multiple hosts are separated by a comma.
Automatic Import Settings
For information on how to set global import settings (import interval and import path), see the global Automatic Import settings. See also the Playlist Importer section for installation, configuration and use of the Playlist Importer.
-
Enable Automatic Import: When checked, automatic imports and updates are enabled. When unchecked, only manual import operations occur.
-
Schedule Import Folder: Enter the folder path where schedules imported from external systems will be found.
-
Schedule Update Folder: The path where a schedule file is located for the purpose of Update of the playlists in the system.
Note: It is highly recommended that the import and update folders are defined as separate folders.
Import Options
-
Create placeholder in Viz One for missing House Ids: If enabled, any request towards a given House Id that is not found in the Viz One system will issue a second query against Viz One to create a placeholder element and retrieve the resulting payload for playlist composite group purposes. Disable this setting if placeholders are not required. This setting is enabled by default.
-
Import Secondary Events as Reference: When checked, all secondary events associated to pages in Viz Multichannel will be imported as Referenced Pages. When unchecked, pages will be instances of the original page.
-
Allow assuming page id is Pilot Data Element as fallback: When checked, any secondary element with an page id that is numerical and that does not have a corresponding entry in the Page Pool or Action Pool, will be assumed to be a Pilot Data Element, stored in a Pilot Database, and the import process will create a Pilot Data Element reference page in the playlist.
-
Self-explanatory options:
-
Remove secondary events that has an offset exceeding the primary events duration.
-
Allow to add Page by Rules with an offset exceeding the Primary Event’s duration.
-
Allow page to force mapping for data content filling.
-
Page Content Filling
In order to use Page Content Filling, the Promo Server component must be installed and configured. See Promo Server Installation and Configuration in the Promo Server chapter.
Options:
-
Refresh Page Content of playlist after Import / Update. Enabled by default.
-
Refresh Page Content of playing playlist after Import / Update. Only useful if segmenting playlists by broadcast days and if you want any update of an upcoming day's playlist to also affect the currents day's data content.
-
Skip refreshing pages that have already been played: The system skips page content filling for pages that have already been played. If this option is unchecked, the system performs page content filling for all pages for which lookup rules or database connections have been set. This option is selected by default.
-
Promo Server Address:. Defines the network address for the server.
-
Max. Pages to Refresh: Maximum pages that will be Refreshed during a full Page Content Filling Refresh session by Integrations Hub or manually requested from the UI.
Translation Tables
Translation Tables are global for translating values when performing Content Filling. Although you can have several tables, only one can be active at any given time. Use New to create a table and add Old and New translations as required. Use Import and Export buttons to load or save translation tables from/to XML-files.
Day Switch Options
-
Activate Day Switch: Activates day switch for split playlists. The default Day Switch is 04:00. This can be changed in Channel Settings as required.
-
Insert Cleanup: Cleans up the program in Viz Engine a set amount of time before the day switch takes place.
-
Insert Initialize: Initializes the program in Viz Engine a set amount of time before the day switch takes place.
Note: Time is relative to the day switch action that is inserted as the last element of the day. For example, if the primary event ends 30 minutes after the preferred day switch time then the switch and all other actions are offset by 30 minutes to adjust for this.
Filtering Options
Import Window
The import window defines what duration of the playlist is to be imported at any given time. This is useful in order to control the amount of secondary and, if relevant, primary events that are imported.
-
Import Start Offset: Sets the relative offset for when to start importing elements according to their start time. Format is HH:MM:SS (hours, minutes and seconds). If the current time is 12:30:00 and the start offset is set to 01:00:00 then only events with a start time set to 11:30:00 and after will be imported.
-
Import End Offset: Sets the relative offset time for when to end the import. Format is HH:MM:SS (hours, minutes and seconds).
-
Import Primary events outside the Import Window range: Imports the primary elements (groups), but does not apply rules or create any secondary elements. This setting should be used in conjunction with the offset settings.
-
Mark partially imported schedule files as .Done: Tags the schedule file already processed as .done so that it is filtered out at the next import or update. Files that failed to import are tagged as .fail.
Setting an import interval allows for improved control over what is imported and reduces the overall load on the system.
Some channels may also benefit from setting a small import window in order to set a more frequent Automatic Import Interval - see Automatic Import Settings.
Primary Event Filtering
These settings allow you to filter the import process, so that source primary events must meet certain criteria in order to be included in the playlist.
Create a Primary Event Filter
-
Select your channel.
-
Click the Settings button to open the Settings window.
-
Select Filtering Options.
-
Under the Primary Event Filtering section click the Add Condition icon.
-
Click the Attribute field to select an attribute from the Field Name column.
These relate to both the Mapping Settings and the Secondary Mapping Settings . -
Click the Operator field and make a selection (see table below).
-
Click the Value field and enter a time, number or text. Time format is hh:mm:ss:ff.
For a list of operator options, see:
Operator |
Description |
= |
equal to |
> |
greater than |
< |
less than |
>= |
greater than or equal to |
<= |
less than or equal to |
<> |
different from |
~= |
Contain string (fuzzy search) |
!~= |
Does NOT contain string (fuzzy search) |
Reg Exp |
A Regular Expression |
Mapping Settings
The primary mapping settings can map from scheduling and/or automation systems. Depending on the local setup, some of the following configuration panels will be presented:
Mapping Settings
-
Import Type: Select the type of external playlist.
-
File name pattern: Enter the specific file format to search for in the import/update folders, for example *.xml, *.lst, *10.txt, etc.
-
Schedule File Name Info: When Reading Channel and Date Values from Filenames, indicate the format that Viz Multichannel should expect. The filename must contain the D/M/Y to represent the day, month and year character location in the filename. C must represent the channel name. Note that the number of occurrences of the letter C is the same as the number of characters in the channel name. X can be used in order to skip characters.
-
Channel10_20100824.txt = CCCCCCCC_YYYYMMDD.
-
20130314_TV2Test.xml = YYYYMMDD_XXXCCCC.
-
Table Columns
The mapping table is used to add all the rows required to map the source playlist to the Viz Multichannel playlist to be created.
-
Field Name: Viz Multichannel’s internal field name. You can either edit the value directly or select values from a drop-down list: click the Field Name entry to show a selectable drop-down list of available Field Name types. See the Basic Mapping Table Field Names section for more information on required and optional field names, and how to use additional field names.
-
Reference: Reference to the data in the schedule file. The reference is then mapped to the Field Name. The actual reference code depends on the input data format (textfile, XML etc).
IMPORTANT! Field names and reference values vary depending on the automation system and data formats in use. For more information, see the Import Guide.
-
Date Field Format: This field is optional. If defined, Viz Multichannel will expect to find dates in the source file based on the format provided here.
-
Date in source file is broadcast date: Check this box if the date in the source file is the same as the broadcast date. Otherwise, leave it unchecked.
-
Values for Primary Event Types: When primary and secondary events are at the same hierarchical level in the source file, enter the text within the fields that denotes primary events. If there is more than one type of denoting text, separate with commas. For example Program,Promo,Commercial. This value will be called from within the event_type field.
-
Values for Secondary Event Types: Enter the text within the fields that denotes secondary events. If there is more than one type of denoting text, separate with commas. For example Logo,Bug. When primary and secondary events are at the same hierarchical level in the source file, the value will be called from within the event_type field. Otherwise, the value will be called from within the secondary_event_type field.
Note: If a field name is empty, duplicate or invalid, the field name(s) in error will be shown with a red border. Fields containing errors must be corrected.
Primary Events Ignore Settings for Page Content Filling
-
Default behavior: Defines the default behavior during import of primary events for Page Content Filling purposes.
-
When set to FALSE the default behavior is to use all primary events for page content filling except those values listed in the Values field.
-
When set to TRUE the default behavior is to not use all primary events for page content filling except those values listed in the Values field.
-
-
Matches for inverted behavior: Primary events that match the comma-separated values will invert the selected default behavior. Note that you need to fill in a reference for the Ignore field name in the mapping table.
Supported wildcards:
-
LIVE- any string that is an exact match “LIVE” is a hit, for example: “LIVE”.
-
*LIVE- any string that ends with “LIVE” is a hit, for example: “MUSICLIVE”, “NOTLIVE” and “LIVE”.
-
LIVE*- any string that starts with “LIVE” is a hit, for example: “LIVESHOW”, “LIVEEVENT” and “LIVE”.
-
*LIVE*- any string that contains “LIVE” is a hit, for example: “VERYLIVEMUSIC”, “MUSICLIVE”, “NOTLIVE”, “LIVESHOW”, “LIVEEVENT” and “LIVE”.
LST Import Settings
-
Use Reconcile key as Viz One House Id: After a playlist has been imported, the reconcile keys are used to set the IDs for the Viz One assets.
-
Get date from schedule file: If the Schedule File Name (see Mapping Settings) is empty, the schedule date will be retrieved from the ADC-100 system’s RCV file.
-
Code Page: During import, bytes in an LST file, stored in the TITLE field, will be converted according to the defined Windows code page. For example, code page with identifier 1256 will convert bytes to ANSI Arabic.
-
Use Universal Sercom Driver: Enable this when USD is used.
-
Universal Sercom Driver name: If left empty, exports Secondary Events as standard secondary events for Harris. If defined, exports secondary events as macro commands for that Universal Sercom Driver (USD) device for Harris (ID=USD_NAME, Title=VIZRT:Media ID, Reconcile Key=Template_name).
-
Macro Name: Sets the macro name used in the Harris system.
Excel Import Settings
-
Header Lines Included: If checked, the header lines will not be read, and reading will start from the first row of data only. If left unchecked, the first line will be read. Only relevant if the import type is Excel (*.xls or *.xlsx).
-
Skip Rows: Set the count here if the Excel file contains any blank lines after the header-line that need to be skipped.
Any Text Import Settings
-
Header Lines in File: Enter the number of header lines in the Any Text file.
-
Skip Lines: Enter the number of lines to skip before beginning to read the import source file for data.
-
Columns Separator: Enter the text symbol (for example *) that separates the columns in the text file.
-
File Encoding: Sets the expected file encoding of the imported text file. Alternatives are ANSI, UTF-8, UTF-8 without BOM, and UTF-16.
-
Code Page: Sets the expected code page of the imported text file (for example 28591 for ISO 8859-1 Latin 1 or 874 for ISO/IEC 8859-11 Latin/Thai).
XML Import Settings
-
Path of Primary Event Nodes: Path to the element that contains the primary events.
-
Secondary Events Nested in Primary Events: Check this box if secondary events are nested as child elements within primary event nodes.
-
Path of Secondary Event Nodes: Path to the element that contains the secondary events.
-
Channel name is defined at the root level: Assumes that the channel name is defined as a meta data entry (at the root level) outside the primary element entries.
-
Playlist date is defined at the root level: Assumes that the playlist date is defined as a meta data entry (at the root level) outside the primary element entries.
Omnibus Import Settings
-
Code Page: Sets the expected code page of the imported text file (for example 28591 for ISO 8859-1 Latin 1 or 874 for ISO/IEC 8859-11 Latin/Thai).
Update Settings
Update Options
-
Automatic Update Mode: Options are:
-
Full: Merges the playlist in its current state in Viz Multichannel with changes that have been made to the original source file.
-
Times: Updates primary event begin time and duration, and any changes made to the original source file. Any primary event additions or deletions are ignored. Only the times are updated.
-
Full update without event deletion: Merges the playlist in its current state in Viz Multichannel with changes that have been made to the original source file, without deleting any (primary) elements.
-
-
Delete Processed Files (days old): Enter the number of days after which processed playlist files (*.done) will be deleted.
-
Lock Events from MSE Time: Sets an interval (hh:mm:ss) during which scheduled events will not be updated. The interval starts as of the next update, whether scheduled or manual, and is timed according to the Media Sequencer clock. The default Lock-Time is 00:01:00.
-
Clear played older than (hh:mm): When updating the playlist, primary and secondary events that have not been played and are older than the time entered in this option are removed.
-
Allow updates for a running playlist: When checked, playlists that are currently active will be updated. When unchecked, only playlists that are not playing will be updated.
-
Allow updates of already played Secondary Events: When checked, all secondary events will be updated. If unchecked, secondary events that already have been played will not be updated.
-
If ‘Date’-mapping is blank retrieve date from running playlist: When checked, an attempt will be made to find the date from the running playlist when “Date”-mapping is blank.
-
Create playlist if one does not exist: If you update a playlist that does not have an existing date, the playlist will be created/imported for you.
-
Send Playlist to remote hosts when import/update playlist: Sends the playlist to remote Media Sequencer hosts (see Remote Hosts).
-
Send Actions to remote host(s): Sends actions to remote Media Sequencer hosts after import or update of a playlist (see Remote Hosts). If the remote host has an action with the same name, its replacement will be skipped. The default value is false.
-
Sync and Transfer pages on each automatic import trigger even when no schedule is imported. Although there is no schedule in the import/update folder, templates and pages are sent to Remote Hosts via the Playlist Importer.
-
Lock edited pages against replacement on updates: self explanatory.
Full Update Options for Secondary Events
These settings apply both manual and automatic updates and are checked by default.
-
Get from external playlist: When checked, secondary events will also be updated from source files when performing full updates. When unchecked, secondary events will not be updated.
-
Reschedule by rules: When checked, secondary events will be updated according to rules (see Working with Rules) when performing full updates. When unchecked, secondary events will not be updated.
-
Leave manually added items: When checked, secondary events added manually in Viz Multichannel will not be affected when performing full updates. When unchecked, secondary events will be affected.
Update Times Options for Secondary Events
These settings apply both manual and automatic updates.
-
Get from external playlist: When checked, secondary events will also be updated from source files when performing update times. When unchecked, secondary events will not be updated.
-
Reschedule by rules: When checked, secondary events will be updated according to rules (see Working with Rules), when performing update times. When unchecked, secondary events will not be updated.
-
Leave manually added items: When checked, secondary events added manually in Viz Multichannel will not be affected, when performing update times. When unchecked, secondary events will be affected.
Export Settings
Export Options
-
Auto Export Folder: Enter the folder path where automatic exports are to be stored.
-
Channel Name in Automation: Enter a channel name that will be recognized by the automation. This is used for all export types except XML. If you leave this field blank, the channel name will be the Channel Name in Schedule under General Settings.
-
Export Secondary Events that do not have offsets: When checked, secondary events that do not have offsets are included in the exported file.
Secondary Event ID Assignment
-
Assignment Mode: Generation of IDs for secondary events during export to an LST file. Options are:
-
Automatic: Generates IDs on secondary events that do not have an ID.
-
Manual: Takes no action.
-
Regenerate: Generates IDs on all secondary events, overwriting existing IDs.
-
-
Generate Random ID/Generate Sequential ID: Select Random ID for IDs to be assigned randomly by the system. Select Sequential ID for the numbers to run sequentially from the first item in the playlist onward.
-
Capital Letters (for Random ID): This option is only relevant if select Random IDs has been selected in the previous option. Selecting capital letters will ensure that the letter portion of the generated ID is always in capitals. Otherwise the letters will be a combination of lower and upper case.
-
Prefix Secondary ID: This option is only relevant if you are generating sequential IDs. Enter the string you wish to use as the ID prefix.
-
Initial Secondary ID: This option is only relevant if you are generating sequential IDs. Enter the first number of the ID list.
Harris (LST)
-
Merge Into Existing File: If left unchecked, the selected playlist is exported from scratch on export. If checked, you are prompted to select an existing file, and any new secondary events are added to that file. The resulting file replaces the old one, which is saved as a backup with the extension{{.orig}}.
Graphic Settings
-
Include graphics when sending playlists: When checked, exported playlists will include Viz Multichannel templates converted back into Viz Artist archive files (.via or{{.eva}}). When unchecked, no graphics will be included.
-
Include graphics data when receiving playlists: When checked, Viz Multichannel will search for and import playlists along with associated graphics. When unchecked, only the playlist events will be imported.
-
Shared Viz Archive Folder: Enter the folder path to the shared folder where the Channel Name (defined in General Settings) will find playlists when Sending Playlists to the Master Control.