2022-10-20 Fred Gleason <fredg@paravelsystems.com>

* Documented grid processing bypass in the Operations Guide.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason 2022-10-20 13:04:13 -04:00
parent efefe066d2
commit a24ba90897
7 changed files with 293 additions and 168 deletions

View File

@ -23538,3 +23538,5 @@
2022-10-20 Fred Gleason <fredg@paravelsystems.com> 2022-10-20 Fred Gleason <fredg@paravelsystems.com>
* Modified the 'List Grids' dialog in rdlogmanager(1) to show * Modified the 'List Grids' dialog in rdlogmanager(1) to show
all services, with a 'Has Grid' column. all services, with a 'Has Grid' column.
2022-10-20 Fred Gleason <fredg@paravelsystems.com>
* Documented grid processing bypass in the Operations Guide.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 140 KiB

After

Width:  |  Height:  |  Size: 151 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 29 KiB

View File

@ -327,6 +327,44 @@
The <computeroutput>Service Description</computeroutput> field is The <computeroutput>Service Description</computeroutput> field is
for a free-form string that describes the service. for a free-form string that describes the service.
</para> </para>
<!--
<title>The <computeroutput>General</computeroutput> Section</title>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdadmin.services_dialog_general.png" width="75mm" depth="36mm"/>
</imageobject>
<caption>
<para>The General Section</para>
</caption>
</mediaobject>
</para>
<para>
The <computeroutput>Service Name</computeroutput> field contains
the name of the service (read-only). This value is available in
<link linkend="sect.filepath_wildcards.definition">
filepath wildcards</link> as <userinput>%s</userinput>.
</para>
<para>
The <computeroutput>Service Description</computeroutput> field is
for a free-form string that describes the service.
</para>
-->
<para>
The <computeroutput>Bypass Grid Processing</computeroutput> dropdown,
if set to <computeroutput>Yes</computeroutput>, 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
<xref linkend="sect.rdlogmanager.rdlogmanager.grids.bypassing_grid_processing" />
for an overview). Logs generated in this mode will contain a single
music import link covering
the entire broadcast day (<userinput>00:00:00</userinput> through
<userinput>23:59:59</userinput>). See
<xref linkend="sect.rdadmin.manage_services.general.inline_event_scheduling_parameters" />
for information on encoding transition and time parameters when using
this option.
</para>
<para> <para>
The <computeroutput>Program Code</computeroutput> is a string that The <computeroutput>Program Code</computeroutput> is a string that
is sent to PyPAD scripts as part of every Now &amp; Next update. is sent to PyPAD scripts as part of every Now &amp; Next update.
@ -654,7 +692,7 @@
<para> <para>
<mediaobject> <mediaobject>
<imageobject> <imageobject>
<imagedata align="center" fileref="rdadmin.import_parser_fields.png" width="90mm" depth="54mm"/> <imagedata align="center" fileref="rdadmin.import_parser_fields.png" width="90mm"/>
</imageobject> </imageobject>
<caption> <caption>
<para>The Log Parser Settings</para> <para>The Log Parser Settings</para>
@ -723,7 +761,64 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><computeroutput>Transition Type:</computeroutput></term>
<listitem>
<para>
The transition type to be assigned to this event. The
following strings are recognized:
<simplelist>
<member><userinput>PLAY</userinput></member>
<member><userinput>SEGUE</userinput></member>
<member><userinput>STOP</userinput></member>
</simplelist>
</para>
<para>
See <xref linkend="sect.rdlogedit.event_transitions" /> for
discussion of the meaning of these types. If left blank,
a <userinput>PLAY</userinput> transition will be applied.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput>Time Type:</computeroutput></term>
<listitem>
<para>
The time type to be assigned to this event. The
following strings are recognized:
<variablelist>
<varlistentry>
<term><userinput>HARD</userinput></term>
<listitem>
<para>
Apply a hard start (Start Immediately) to this
item, using the specified start time of the event.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>SOFT</userinput></term>
<listitem>
<para>
Apply a soft start (Make Next) to this
item, using the specified start time of the event.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
If left blank, no time start options will be applied.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
<note>
The <computeroutput>Transition Type</computeroutput> and
<computeroutput>Time Type</computeroutput> fields are available
only if the <computeroutput>Bypass Grid Processing</computeroutput>
dropdown has been set to <computeroutput>Yes</computeroutput>.
</note>
</sect2> </sect2>
<sect2 xml:id="sect.rdadmin.manage_services.testing_data_importation"> <sect2 xml:id="sect.rdadmin.manage_services.testing_data_importation">
<title>Testing Data Importation</title> <title>Testing Data Importation</title>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

@ -45,173 +45,201 @@
</sect1> </sect1>
<sect1 xml:id="sect.rdlogmanager.grids"> <sect1 xml:id="sect.rdlogmanager.grids">
<title>Grids</title> <title>Grids</title>
<para> <sect2 xml:id="sect.rdlogmanager.rdlogmanager.grids.bypassing_grid_processing">
Each Rivendell service has an RDLogManager grid. To see the list of <title>Bypassing Grid Processing</title>
available grids, touch the <computeroutput>Edit Grids</computeroutput> <para>
button to open the Log Grids dialog. Certain third-party music scheduler systems support the ability to
</para> compose the entire schedule for a service (including placement of
<para> traffic breaks) within its own native user interface, thus potentially
<mediaobject> centralizing and simplifying log template maintenance. To facilitate
<imageobject> this mode of operation, it is possible to configure RDLogManager to
<imagedata align="center" fileref="rdlogmanager.log_grids_dialog.png" width="65mm" depth="53mm" /> bypass its native grid/clock/event template system entirely on a
</imageobject> service by service basis,
<caption><para>The Log Grids Dialog</para></caption> instead passing the schedule generated by the music scheduler system
</mediaobject> through to Rivendell logs unchanged.
</para> For information on configuring this mode of operation, see
<para> the <computeroutput>Bypass Grid Processing</computeroutput> dropdown
To open a particular grid, select its service name and touch the and related discussion in
<computeroutput>Edit</computeroutput> <xref linkend="sect.rdadmin.manage_services" />.
button. </para>
</para> <para>
<para> If a service has been configured to bypass grid processing, then
<mediaobject> it will not have a grid. Skip forward to
<imageobject> <xref linkend="sect.rdlogmanager.generating_logs" />.
<imagedata align="center" fileref="rdlogmanager.edit_grid_dialog.png" width="145mm" depth="95mm" /> </para>
</imageobject> </sect2>
<caption><para>The Edit Grid Dialog</para></caption> <sect2 xml:id="sect.rdlogmanager.grids.configuring_grids">
</mediaobject> <title>Configuring Grids</title>
</para> <para>
<para> Each Rivendell service has an RDLogManager grid. To see the list of
Each grid has slots for every hour of every day of the broadcast week available grids, touch the <computeroutput>Edit Grids</computeroutput>
168 slots in all. By specifying a particular clock to go into each button to open the Log Grids dialog.
of these slots, a set of rules that RDLogManager can use to generate </para>
a log for any given day of the week is built up. To specify a clock, <para>
simply touch the particular hour of interest to open up the <mediaobject>
<computeroutput>Select Log Clock</computeroutput> dialog. <imageobject>
</para> <imagedata align="center" fileref="rdlogmanager.log_grids_dialog.png" width="65mm" />
<para> </imageobject>
<mediaobject> <caption><para>The Log Grids Dialog</para></caption>
<imageobject> </mediaobject>
<imagedata align="center" fileref="rdlogmanager.log_clocks.png" width="96mm" depth="68mm" /> </para>
</imageobject> <para>
<caption><para>The Log Clocks Dialog</para></caption> To open a particular grid, select its service name and touch the
</mediaobject> <computeroutput>Edit</computeroutput>
</para> button.
<para> </para>
Click the desired clock, then touch the <para>
<computeroutput>OK</computeroutput> button. To clear the <mediaobject>
assignment of any clock to the selected hour, touch the <imageobject>
<computeroutput>Clear</computeroutput> button, <imagedata align="center" fileref="rdlogmanager.edit_grid_dialog.png" width="145mm" depth="95mm" />
then <computeroutput>OK</computeroutput>. </imageobject>
</para> <caption><para>The Edit Grid Dialog</para></caption>
<para> </mediaobject>
It is possible to 'drill down' directly to the underlying </para>
configuration of a clock (to be covered shortly) by right-clicking on <para>
the relevant hour in a grid and selecting Each grid has slots for every hour of every day of the broadcast week
<computeroutput> Edit Clock</computeroutput>. 168 slots in all. By specifying a particular clock to go into each
</para> of these slots, a set of rules that RDLogManager can use to generate
</sect1> a log for any given day of the week is built up. To specify a clock,
<sect1 xml:id="sect.rdlogmanager.clocks"> simply touch the particular hour of interest to open up the
<title>Clocks</title> <computeroutput>Select Log Clock</computeroutput> dialog.
<para> </para>
An RDLogManager clock is a collection of RDLogManager events, <para>
arranged in terms of their start time (relative to the beginning of <mediaobject>
the hour) and length. It basically can be thought of as the <imageobject>
&quot;schedule&quot; of an hour <emphasis>any</emphasis> hour. <imagedata align="center" fileref="rdlogmanager.log_clocks.png" width="96mm" depth="68mm" />
Once defined, a clock </imageobject>
can be plugged into any hour of a grid of any service, thus making <caption><para>The Log Clocks Dialog</para></caption>
for easy modularization and changes to a service's schedule. </mediaobject>
</para> </para>
<para> <para>
To see the list of available clocks, touch the Click the desired clock, then touch the
<computeroutput>Edit Clocks</computeroutput> button in <computeroutput>OK</computeroutput> button. To clear the
RDLogManager's Main Menu to open the Log Clocks dialog. assignment of any clock to the selected hour, touch the
Each RDLogManager clock can be assigned a <computeroutput>Clear</computeroutput> button,
three-letter code and color, as an aid in identifying it when then <computeroutput>OK</computeroutput>.
assigned to grids. To add a new clock, touch the </para>
<computeroutput>Add</computeroutput> button, or to <para>
edit a clock's parameters, click on it and touch the It is possible to 'drill down' directly to the underlying
<computeroutput>Edit</computeroutput> button. configuration of a clock (to be covered shortly) by right-clicking on
In each case, the Edit Clock dialog will open. the relevant hour in a grid and selecting
Clocks can also be deleted by touching the <computeroutput> Edit Clock</computeroutput>.
<computeroutput>Delete</computeroutput> button or renamed </para>
by touching the <computeroutput>Rename</computeroutput> button.
</para> </sect2>
<para>
<mediaobject> </sect1>
<imageobject> <sect1 xml:id="sect.rdlogmanager.clocks">
<imagedata align="center" fileref="rdlogmanager.log_clock_list.png" width="97mm" depth="69mm" /> <title>Clocks</title>
</imageobject> <para>
<caption><para>The Log Clock List Dialog</para></caption> An RDLogManager clock is a collection of RDLogManager events,
</mediaobject> arranged in terms of their start time (relative to the beginning of
</para> the hour) and length. It basically can be thought of as the
<para> &quot;schedule&quot; of an hour <emphasis>any</emphasis> hour.
<mediaobject> Once defined, a clock
<imageobject> can be plugged into any hour of a grid of any service, thus making
<imagedata align="center" fileref="rdlogmanager.edit_clock_dialog.png" width="145mm" depth="104mm" /> for easy modularization and changes to a service's schedule.
</imageobject> </para>
<caption><para>The Edit Clock Dialog</para></caption> <para>
</mediaobject> To see the list of available clocks, touch the
</para> <computeroutput>Edit Clocks</computeroutput> button in
<para> RDLogManager's Main Menu to open the Log Clocks dialog.
The Edit Clock dialog consists of three main sections: a tabular Each RDLogManager clock can be assigned a
list of events in chronological order, a graphical depiction of the three-letter code and color, as an aid in identifying it when
clock in the traditional “broadcast clock” format, and a series of assigned to grids. To add a new clock, touch the
action buttons across the bottom. The clock's three-letter code is <computeroutput>Add</computeroutput> button, or to
set by means of the <computeroutput>Code</computeroutput> field edit a clock's parameters, click on it and touch the
in the upper right-hand corner of the <computeroutput>Edit</computeroutput> button.
table area. Its color can be set by touching the In each case, the Edit Clock dialog will open.
<computeroutput>Color</computeroutput> button. To Clocks can also be deleted by touching the
save the clock without exiting the dialog, touch the <computeroutput>Delete</computeroutput> button or renamed
<computeroutput>Save</computeroutput> by touching the <computeroutput>Rename</computeroutput> button.
or <computeroutput>Save As</computeroutput> </para>
buttons. To add a new event to the clock, touch the <para>
<computeroutput>Add</computeroutput> button, or <mediaobject>
to edit an existing entry touch the <imageobject>
<computeroutput>Edit</computeroutput> button. In either case, <imagedata align="center" fileref="rdlogmanager.log_clock_list.png" width="97mm" depth="69mm" />
the Edit Event Assignment dialog will open. To </imageobject>
delete an entry, touch the <computeroutput>Delete</computeroutput> <caption><para>The Log Clock List Dialog</para></caption>
button. As in the case of grids, </mediaobject>
it is possible to 'drill down' into the underlying RDLogManager </para>
event by right-clicking on the respective entry in the clock event <para>
table and selecting <computeroutput>Edit Event</computeroutput>. <mediaobject>
</para> <imageobject>
<para> <imagedata align="center" fileref="rdlogmanager.edit_clock_dialog.png" width="145mm" depth="104mm" />
<mediaobject> </imageobject>
<imageobject> <caption><para>The Edit Clock Dialog</para></caption>
<imagedata align="center" fileref="rdlogmanager.edit_event_assignment_dialog.png" width="88mm" depth="26mm" /> </mediaobject>
</imageobject> </para>
<caption><para>The Edit Event Assignment Dialog</para></caption> <para>
</mediaobject> The Edit Clock dialog consists of three main sections: a tabular
</para> list of events in chronological order, a graphical depiction of the
<para> clock in the traditional “broadcast clock” format, and a series of
The Edit Event Assignment dialog simply consists of an action buttons across the bottom. The clock's three-letter code is
<computeroutput>Event</computeroutput> field set by means of the <computeroutput>Code</computeroutput> field
for the name of the RDLogManager event and in the upper right-hand corner of the
<computeroutput>Start Time</computeroutput> and table area. Its color can be set by touching the
<computeroutput>End Time</computeroutput> <computeroutput>Color</computeroutput> button. To
fields for the start and end times relative to the start of the save the clock without exiting the dialog, touch the
hour. A list of available events can be brought up by touching the <computeroutput>Save</computeroutput>
<computeroutput>Select</computeroutput> button to bring up the or <computeroutput>Save As</computeroutput>
Log Events dialog. buttons. To add a new event to the clock, touch the
</para> <computeroutput>Add</computeroutput> button, or
<para> to edit an existing entry touch the
Each clock can be designated as being associated with one or more <computeroutput>Edit</computeroutput> button. In either case,
services. This can make finding the correct clock for a given the Edit Event Assignment dialog will open. To
service much faster, as the delete an entry, touch the <computeroutput>Delete</computeroutput>
<computeroutput>Filter</computeroutput> control on the List Clocks dialog button. As in the case of grids,
can then be used. To program these associations, touch the it is possible to 'drill down' into the underlying RDLogManager
<computeroutput>Services List</computeroutput> button in the Edit event by right-clicking on the respective entry in the clock event
Clock dialog to bring up the Service table and selecting <computeroutput>Edit Event</computeroutput>.
Associations dialog. </para>
</para> <para>
<para> <mediaobject>
<mediaobject> <imageobject>
<imageobject> <imagedata align="center" fileref="rdlogmanager.edit_event_assignment_dialog.png" width="88mm" depth="26mm" />
<imagedata align="center" fileref="rdlogmanager.service_association_dialog.png" width="65mm" depth="39mm" /> </imageobject>
</imageobject> <caption><para>The Edit Event Assignment Dialog</para></caption>
<caption><para>The Service Association Dialog</para></caption> </mediaobject>
</mediaobject> </para>
</para> <para>
<para> The Edit Event Assignment dialog simply consists of an
To designate a service as being valid for this clock, select the <computeroutput>Event</computeroutput> field
services name in the <computeroutput>Available Services</computeroutput> for the name of the RDLogManager event and
list and then touch the <computeroutput>Add &gt;&gt;</computeroutput> <computeroutput>Start Time</computeroutput> and
button. Likewise, to deselect a service, select its name in the <computeroutput>End Time</computeroutput>
<computeroutput>Enabled Services</computeroutput> list and then touch fields for the start and end times relative to the start of the
the <computeroutput>&lt;&lt; Remove</computeroutput> button. hour. A list of available events can be brought up by touching the
</para> <computeroutput>Select</computeroutput> button to bring up the
</sect1> Log Events dialog.
</para>
<para>
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
<computeroutput>Filter</computeroutput> control on the List Clocks
dialog can then be used. To program these associations, touch the
<computeroutput>Services List</computeroutput> button in the Edit
Clock dialog to bring up the Service
Associations dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdlogmanager.service_association_dialog.png" width="65mm" depth="39mm" />
</imageobject>
<caption><para>The Service Association Dialog</para></caption>
</mediaobject>
</para>
<para>
To designate a service as being valid for this clock, select the
services name in the <computeroutput>Available Services</computeroutput>
list and then touch the <computeroutput>Add &gt;&gt;</computeroutput>
button. Likewise, to deselect a service, select its name in the
<computeroutput>Enabled Services</computeroutput> list and then touch
the <computeroutput>&lt;&lt; Remove</computeroutput> button.
</para>
</sect1>
<sect1 xml:id="sect.rdlogmanager.events"> <sect1 xml:id="sect.rdlogmanager.events">
<title>Events</title> <title>Events</title>
<para> <para>