diff --git a/ChangeLog b/ChangeLog index 14dd5328..3498a28d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -23538,3 +23538,5 @@ 2022-10-20 Fred Gleason * Modified the 'List Grids' dialog in rdlogmanager(1) to show all services, with a 'Has Grid' column. +2022-10-20 Fred Gleason + * Documented grid processing bypass in the Operations Guide. diff --git a/docs/opsguide/rdadmin.edit_service_dialog.png b/docs/opsguide/rdadmin.edit_service_dialog.png index bf2e5046..4fcc5dec 100644 Binary files a/docs/opsguide/rdadmin.edit_service_dialog.png and b/docs/opsguide/rdadmin.edit_service_dialog.png differ diff --git a/docs/opsguide/rdadmin.import_parser_fields.png b/docs/opsguide/rdadmin.import_parser_fields.png index fac5bd99..ce35a2e1 100644 Binary files a/docs/opsguide/rdadmin.import_parser_fields.png and b/docs/opsguide/rdadmin.import_parser_fields.png differ diff --git a/docs/opsguide/rdadmin.services_dialog_general.png b/docs/opsguide/rdadmin.services_dialog_general.png index ec1ee828..d1a41e40 100644 Binary files a/docs/opsguide/rdadmin.services_dialog_general.png and b/docs/opsguide/rdadmin.services_dialog_general.png differ diff --git a/docs/opsguide/rdadmin.xml b/docs/opsguide/rdadmin.xml index 8a5fe1c7..1ea34c78 100644 --- a/docs/opsguide/rdadmin.xml +++ b/docs/opsguide/rdadmin.xml @@ -327,6 +327,44 @@ The Service Description field is for a free-form string that describes the service. + + + The Bypass Grid Processing dropdown, + if set to Yes, will completely + disable RDLogManager's native grid/clock/event template system + for this service; helpful for centralizing log template management + in a third-party music scheduler system. (See + + for an overview). Logs generated in this mode will contain a single + music import link covering + the entire broadcast day (00:00:00 through + 23:59:59). See + + for information on encoding transition and time parameters when using + this option. + The Program Code is a string that is sent to PyPAD scripts as part of every Now & Next update. @@ -654,7 +692,7 @@ - + The Log Parser Settings @@ -723,7 +761,64 @@ + + Transition Type: + + + The transition type to be assigned to this event. The + following strings are recognized: + + PLAY + SEGUE + STOP + + + + See for + discussion of the meaning of these types. If left blank, + a PLAY transition will be applied. + + + + + Time Type: + + + The time type to be assigned to this event. The + following strings are recognized: + + + HARD + + + Apply a hard start (Start Immediately) to this + item, using the specified start time of the event. + + + + + SOFT + + + Apply a soft start (Make Next) to this + item, using the specified start time of the event. + + + + + + + If left blank, no time start options will be applied. + + + + + The Transition Type and + Time Type fields are available + only if the Bypass Grid Processing + dropdown has been set to Yes. + Testing Data Importation diff --git a/docs/opsguide/rdlogmanager.log_grids_dialog.png b/docs/opsguide/rdlogmanager.log_grids_dialog.png index 61b92d0f..edf8313e 100644 Binary files a/docs/opsguide/rdlogmanager.log_grids_dialog.png and b/docs/opsguide/rdlogmanager.log_grids_dialog.png differ diff --git a/docs/opsguide/rdlogmanager.xml b/docs/opsguide/rdlogmanager.xml index e5c6171e..8fcab1bc 100644 --- a/docs/opsguide/rdlogmanager.xml +++ b/docs/opsguide/rdlogmanager.xml @@ -45,173 +45,201 @@ Grids - - Each Rivendell service has an RDLogManager grid. To see the list of - available grids, touch the Edit Grids - button to open the Log Grids dialog. - - - - - - - The Log Grids Dialog - - - - To open a particular grid, select its service name and touch the - Edit - button. - - - - - - - The Edit Grid Dialog - - - - Each grid has slots for every hour of every day of the broadcast week - – 168 slots in all. By specifying a particular clock to go into each - of these slots, a set of rules that RDLogManager can use to generate - a log for any given day of the week is built up. To specify a clock, - simply touch the particular hour of interest to open up the - Select Log Clock dialog. - - - - - - - The Log Clocks Dialog - - - - Click the desired clock, then touch the - OK button. To clear the - assignment of any clock to the selected hour, touch the - Clear button, - then OK. - - - It is possible to 'drill down' directly to the underlying - configuration of a clock (to be covered shortly) by right-clicking on - the relevant hour in a grid and selecting - Edit Clock. - - - - Clocks - - An RDLogManager clock is a collection of RDLogManager events, - arranged in terms of their start time (relative to the beginning of - the hour) and length. It basically can be thought of as the - "schedule" of an hour – any hour. - Once defined, a clock - can be plugged into any hour of a grid of any service, thus making - for easy modularization and changes to a service's schedule. - - - To see the list of available clocks, touch the - Edit Clocks button in - RDLogManager's Main Menu to open the Log Clocks dialog. - Each RDLogManager clock can be assigned a - three-letter code and color, as an aid in identifying it when - assigned to grids. To add a new clock, touch the - Add button, or to - edit a clock's parameters, click on it and touch the - Edit button. - In each case, the Edit Clock dialog will open. - Clocks can also be deleted by touching the - Delete button or renamed - by touching the Rename button. - - - - - - - The Log Clock List Dialog - - - - - - - - The Edit Clock Dialog - - - - The Edit Clock dialog consists of three main sections: a tabular - list of events in chronological order, a graphical depiction of the - clock in the traditional “broadcast clock” format, and a series of - action buttons across the bottom. The clock's three-letter code is - set by means of the Code field - in the upper right-hand corner of the - table area. Its color can be set by touching the - Color button. To - save the clock without exiting the dialog, touch the - Save - or Save As - buttons. To add a new event to the clock, touch the - Add button, or - to edit an existing entry touch the - Edit button. In either case, - the Edit Event Assignment dialog will open. To - delete an entry, touch the Delete - button. As in the case of grids, - it is possible to 'drill down' into the underlying RDLogManager - event by right-clicking on the respective entry in the clock event - table and selecting Edit Event. - - - - - - - The Edit Event Assignment Dialog - - - - The Edit Event Assignment dialog simply consists of an - Event field - for the name of the RDLogManager event and - Start Time and - End Time - fields for the start and end times relative to the start of the - hour. A list of available events can be brought up by touching the - Select button to bring up the - Log Events dialog. - - - Each clock can be designated as being associated with one or more - services. This can make finding the correct clock for a given - service much faster, as the - Filter control on the List Clocks dialog - can then be used. To program these associations, touch the - Services List button in the Edit - Clock dialog to bring up the Service - Associations dialog. - - - - - - - The Service Association Dialog - - - - To designate a service as being valid for this clock, select the - services name in the Available Services - list and then touch the Add >> - button. Likewise, to deselect a service, select its name in the - Enabled Services list and then touch - the << Remove button. - - + + Bypassing Grid Processing + + Certain third-party music scheduler systems support the ability to + compose the entire schedule for a service (including placement of + traffic breaks) within its own native user interface, thus potentially + centralizing and simplifying log template maintenance. To facilitate + this mode of operation, it is possible to configure RDLogManager to + bypass its native grid/clock/event template system entirely on a + service by service basis, + instead passing the schedule generated by the music scheduler system + through to Rivendell logs unchanged. + For information on configuring this mode of operation, see + the Bypass Grid Processing dropdown + and related discussion in + . + + + If a service has been configured to bypass grid processing, then + it will not have a grid. Skip forward to + . + + + + Configuring Grids + + Each Rivendell service has an RDLogManager grid. To see the list of + available grids, touch the Edit Grids + button to open the Log Grids dialog. + + + + + + + The Log Grids Dialog + + + + To open a particular grid, select its service name and touch the + Edit + button. + + + + + + + The Edit Grid Dialog + + + + Each grid has slots for every hour of every day of the broadcast week + – 168 slots in all. By specifying a particular clock to go into each + of these slots, a set of rules that RDLogManager can use to generate + a log for any given day of the week is built up. To specify a clock, + simply touch the particular hour of interest to open up the + Select Log Clock dialog. + + + + + + + The Log Clocks Dialog + + + + Click the desired clock, then touch the + OK button. To clear the + assignment of any clock to the selected hour, touch the + Clear button, + then OK. + + + It is possible to 'drill down' directly to the underlying + configuration of a clock (to be covered shortly) by right-clicking on + the relevant hour in a grid and selecting + Edit Clock. + + + + + + + Clocks + + An RDLogManager clock is a collection of RDLogManager events, + arranged in terms of their start time (relative to the beginning of + the hour) and length. It basically can be thought of as the + "schedule" of an hour – any hour. + Once defined, a clock + can be plugged into any hour of a grid of any service, thus making + for easy modularization and changes to a service's schedule. + + + To see the list of available clocks, touch the + Edit Clocks button in + RDLogManager's Main Menu to open the Log Clocks dialog. + Each RDLogManager clock can be assigned a + three-letter code and color, as an aid in identifying it when + assigned to grids. To add a new clock, touch the + Add button, or to + edit a clock's parameters, click on it and touch the + Edit button. + In each case, the Edit Clock dialog will open. + Clocks can also be deleted by touching the + Delete button or renamed + by touching the Rename button. + + + + + + + The Log Clock List Dialog + + + + + + + + The Edit Clock Dialog + + + + The Edit Clock dialog consists of three main sections: a tabular + list of events in chronological order, a graphical depiction of the + clock in the traditional “broadcast clock” format, and a series of + action buttons across the bottom. The clock's three-letter code is + set by means of the Code field + in the upper right-hand corner of the + table area. Its color can be set by touching the + Color button. To + save the clock without exiting the dialog, touch the + Save + or Save As + buttons. To add a new event to the clock, touch the + Add button, or + to edit an existing entry touch the + Edit button. In either case, + the Edit Event Assignment dialog will open. To + delete an entry, touch the Delete + button. As in the case of grids, + it is possible to 'drill down' into the underlying RDLogManager + event by right-clicking on the respective entry in the clock event + table and selecting Edit Event. + + + + + + + The Edit Event Assignment Dialog + + + + The Edit Event Assignment dialog simply consists of an + Event field + for the name of the RDLogManager event and + Start Time and + End Time + fields for the start and end times relative to the start of the + hour. A list of available events can be brought up by touching the + Select button to bring up the + Log Events dialog. + + + Each clock can be designated as being associated with one or more + services. This can make finding the correct clock for a given + service much faster, as the + Filter control on the List Clocks + dialog can then be used. To program these associations, touch the + Services List button in the Edit + Clock dialog to bring up the Service + Associations dialog. + + + + + + + The Service Association Dialog + + + + To designate a service as being valid for this clock, select the + services name in the Available Services + list and then touch the Add >> + button. Likewise, to deselect a service, select its name in the + Enabled Services list and then touch + the << Remove button. + + Events