mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-04-09 22:43:11 +02:00
2020-11-16 Fred Gleason <fredg@paravelsystems.com>
* Revised the 'Managing Services' section of the Operations Guide. Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason
parent
5f55a3438d
commit
2a5c8c3752
@ -20583,3 +20583,6 @@
|
||||
2020-11-15 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Added the name of the import file to schedule import failure
|
||||
reports.
|
||||
2020-11-16 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Revised the 'Managing Services' section of the Operations
|
||||
Guide.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
##
|
||||
## docs/opsguide/automake.am for Rivendell
|
||||
##
|
||||
## (C) Copyright 2017-2019 Fred Gleason <fredg@paravelsystems.com>
|
||||
## (C) Copyright 2017-2020 Fred Gleason <fredg@paravelsystems.com>
|
||||
##
|
||||
## This program is free software; you can redistribute it and/or modify
|
||||
## it under the terms of the GNU General Public License version 2 as
|
||||
@ -199,6 +199,7 @@ OPSGUIDE_IMAGES = rdadmin.audio_resource_information_dialog.png\
|
||||
rdadmin.select_pypad_script_dialog.png\
|
||||
rdadmin.select_scheduler_codes_dialog.png\
|
||||
rdadmin.services_dialog.png\
|
||||
rdadmin.services_dialog_general.png\
|
||||
rdadmin.system_wide_settings_dialog.png\
|
||||
rdadmin.test_import_dialog.png\
|
||||
rdadmin.user_dialog.png\
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 99 KiB After Width: | Height: | Size: 118 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 117 KiB After Width: | Height: | Size: 33 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 9.9 KiB After Width: | Height: | Size: 15 KiB |
BIN
docs/opsguide/rdadmin.services_dialog_general.png
Normal file
BIN
docs/opsguide/rdadmin.services_dialog_general.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 39 KiB |
@ -296,6 +296,16 @@
|
||||
</para>
|
||||
<sect2 xml:id="sect.rdadmin.manage_services.general">
|
||||
<title>The <computeroutput>General</computeroutput> Section</title>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.services_dialog_general.png" scale="50"/>
|
||||
</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
|
||||
@ -308,7 +318,7 @@
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Program Code</computeroutput> is a string that
|
||||
is sent to RLM plug-ins as part of every Now & Next update.
|
||||
is sent to PyPAD scripts as part of every Now & Next update.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Log Name Template</computeroutput> field is
|
||||
@ -325,6 +335,17 @@
|
||||
<link linkend="sect.filepath_wildcards.definition">
|
||||
filepath wildcards</link>.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Inline Event Start/Length</computeroutput>
|
||||
dropdown selects how the Start Time and Length will be calculated
|
||||
when inserting Inline Events. See the section on
|
||||
<link linkend="sect.rdadmin.manage_services.general.inline_event_scheduling_parameters">Inline Event Scheduling Parameters</link>
|
||||
for details.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
|
||||
<para>
|
||||
The <computeroutput>Voicetrack Group</computeroutput> dropdown
|
||||
specifies the Rivendell group to be used for storing voicetracks
|
||||
@ -373,6 +394,98 @@
|
||||
If import markers are not included in finished logs, then it will
|
||||
not be possible re-import music or traffic data into those logs.
|
||||
</warning>
|
||||
|
||||
<sect3 xml:id="sect.rdadmin.manage_services.general.inline_event_scheduling_parameters">
|
||||
<title>Inline Event Scheduling Parameters</title>
|
||||
<para>
|
||||
When inserting an Inline Event (such as a Marker, Voice Track
|
||||
or Traffic Break), the Start Time and Length used will be calculated
|
||||
on the basis of the
|
||||
<computeroutput>Inline Event Start/Length</computeroutput> setting,
|
||||
as follows:
|
||||
</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><computeroutput>From Scheduler File</computeroutput></term>
|
||||
<listitem>
|
||||
<para>
|
||||
When this mode is specified, all inline events must be
|
||||
formatted as if they were a regular element of the schedule,
|
||||
with Start Time and Length values explicitly given and the
|
||||
string specified by the
|
||||
<computeroutput>Insert Marker String</computeroutput>,
|
||||
<computeroutput>Insert Voice Track String</computeroutput> or
|
||||
<computeroutput>Insert Traffic Break String</computeroutput>
|
||||
field values aligned as if it was a cart number. Inline Traffic
|
||||
Breaks will generate Traffic Links with Start Time/Length
|
||||
values that correspond to those specified on the respective
|
||||
line of the imported file.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><computeroutput>From Relative Position</computeroutput></term>
|
||||
<listitem>
|
||||
<para>
|
||||
When this mode is specified, the string specified by the
|
||||
<computeroutput>Insert Marker String</computeroutput>,
|
||||
<computeroutput>Insert Voice Track String</computeroutput> or
|
||||
<computeroutput>Insert Traffic Break String</computeroutput>
|
||||
must occur somewhere on the line in the schedule file. The
|
||||
correct placement, Start Time and Length of each inline
|
||||
event will be determined heuristically, with Inline Traffic
|
||||
Breaks generating Traffic Links with Start Time/Length
|
||||
values taken from that of the parent Music Event.
|
||||
</para>
|
||||
<para>
|
||||
N.B. This means that only one Inline Event of each type
|
||||
may be placed within the same parent Music Event!
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<note>
|
||||
The <computeroutput>From Relative Position</computeroutput> mode is
|
||||
<emphasis role="bold">deprecated</emphasis>, and support for it
|
||||
will be removed in a future version of Rivendell. It is currently
|
||||
supported only to avoid breaking existing Rivendell setups. All
|
||||
new installations should use
|
||||
<computeroutput>From Scheduler File</computeroutput>!
|
||||
</note>
|
||||
|
||||
<sect4 xml:id="sect.rdadmin.manage_services.general.inline_event_scheduling_parameters.examples">
|
||||
<title>Examples</title>
|
||||
<para>
|
||||
Example of an inline Track Marker with
|
||||
<computeroutput>Inline Event Start/Length</computeroutput>
|
||||
set to <userinput>From Scheduler File</userinput>,
|
||||
using the
|
||||
<userinput>Rivendell Standard Import</userinput> template:
|
||||
<literallayout>
|
||||
<computeroutput>
|
||||
01:18:04 250098 Southern Nights 00:02:56
|
||||
01:21:00 TRACK Track Marker 00:00:45
|
||||
01:22:30 250101 Come A Little Bit Closer 00:02:44
|
||||
</computeroutput>
|
||||
</literallayout>
|
||||
</para>
|
||||
<para>
|
||||
Example of an inline Track Marker with
|
||||
<computeroutput>Inline Event Start/Length</computeroutput>
|
||||
set to <userinput>From Relative Position</userinput>,
|
||||
using the
|
||||
<userinput>Rivendell Standard Import</userinput> template:
|
||||
<literallayout>
|
||||
<computeroutput>
|
||||
01:18:04 250098 Southern Nights 00:02:56
|
||||
TRACK Track Marker
|
||||
01:22:30 250101 Come A Little Bit Closer 00:02:44
|
||||
</computeroutput>
|
||||
</literallayout>
|
||||
</para>
|
||||
</sect4>
|
||||
</sect3>
|
||||
|
||||
<sect3 xml:id="sect.rdadmin.manage_services.general.configure_autofill_carts">
|
||||
<title>Configuring Autofill Carts</title>
|
||||
<para>
|
||||
@ -445,43 +558,36 @@
|
||||
</mediaobject>
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Linux Import Path</computeroutput> field takes
|
||||
The <computeroutput>Import Path</computeroutput> field takes
|
||||
the fully-qualified path to the file to be used for import events
|
||||
by RDLogManager when run on Linux. This field can take
|
||||
by RDLogManager. This field can take
|
||||
<link linkend="sect.filepath_wildcards.definition">
|
||||
filepath wildcards</link>.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Linux Preimport Command</computeroutput> field
|
||||
The <computeroutput>Preimport Command</computeroutput> field
|
||||
takes the fully-qualified path to the command to be run before
|
||||
attempting to import the file specified in
|
||||
<computeroutput>Linux Import Path</computeroutput>. This field can take
|
||||
<computeroutput>Import Path</computeroutput>. This field can take
|
||||
<link linkend="sect.filepath_wildcards.definition">
|
||||
filepath wildcards</link>.
|
||||
filepath wildcards</link>. This can be useful when a schedule file
|
||||
requires pre-processing of some sort before being imported by
|
||||
<command>rdlogmanager</command><manvolnum>1</manvolnum>.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Windows Import Path</computeroutput> field takes
|
||||
the fully-qualified path to the file to be used for import events
|
||||
by RDLogManager when run on Windows. This field can take
|
||||
<link linkend="sect.filepath_wildcards.definition">
|
||||
filepath wildcards</link>.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Windows Preimport Command</computeroutput> field
|
||||
takes the fully-qualified path to the command to be run before
|
||||
attempting to import the file specified in
|
||||
<computeroutput>Windows Import Path</computeroutput>. This field
|
||||
can take <link linkend="sect.filepath_wildcards.definition">
|
||||
filepath wildcards</link>.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Note Cart String</computeroutput> field can
|
||||
The <computeroutput>Insert Marker String</computeroutput> field can
|
||||
be used to configure placement of a marker event in the generated log.
|
||||
When the string set here is found in the 'cart' field in a line
|
||||
of the specified import file, RDLogManager will insert a marker
|
||||
event, the text of which will be the 'title' field from that same
|
||||
line.
|
||||
</para>
|
||||
<note>
|
||||
See the section on
|
||||
<link linkend="sect.rdadmin.manage_services.general.inline_event_scheduling_parameters">Inline Event Scheduling Parameters</link>
|
||||
for details on how the Start Time and Length parameters are
|
||||
calculated when inserting a Marker String.
|
||||
</note>
|
||||
<para>
|
||||
The <computeroutput>Insert Voice Track String</computeroutput>
|
||||
field can be used to configure placement of a voice track marker
|
||||
@ -490,6 +596,12 @@
|
||||
will insert a voice track event, the text of which will be the
|
||||
'title' field from that same line.
|
||||
</para>
|
||||
<note>
|
||||
See the section on
|
||||
<link linkend="sect.rdadmin.manage_services.general.inline_event_scheduling_parameters">Inline Event Scheduling Parameters</link>
|
||||
for details on how the Start Time and Length parameters are
|
||||
calculated when inserting a Voice Track String.
|
||||
</note>
|
||||
<para>
|
||||
The <computeroutput>Insert Traffic Break String</computeroutput>
|
||||
field can be used to configuration placement of a traffic break
|
||||
@ -505,6 +617,12 @@
|
||||
<computeroutput>Music Data Import</computeroutput> section!
|
||||
</para>
|
||||
</note>
|
||||
<note>
|
||||
See the section on
|
||||
<link linkend="sect.rdadmin.manage_services.general.inline_event_scheduling_parameters">Inline Event Scheduling Parameters</link>
|
||||
for details on how the Link Start Time and Link Length parameters are
|
||||
calculated when inserting a Traffic Break.
|
||||
</note>
|
||||
</sect2>
|
||||
<sect2 xml:id="sect.rdadmin.manage_services.traffic_music_import_parser_settings">
|
||||
<title>Traffic/Music Import Parser Settings</title>
|
||||
@ -521,9 +639,12 @@
|
||||
<para>
|
||||
Rivendell includes the ability to import log schedule files from
|
||||
a variety of third-party scheduling utilities. To configure an import
|
||||
from one of these systems, all that is necessary is to select the
|
||||
appropriate system in the
|
||||
<computeroutput>Import Template</computeroutput> dropdown. If the
|
||||
from one of these systems, all that is usually necessary is to select
|
||||
the appropriate system in the
|
||||
<computeroutput>Import Template</computeroutput> dropdown in the
|
||||
<computeroutput>Traffic Data Import</computeroutput> or
|
||||
<computeroutput>Music Data Import</computeroutput> sections.
|
||||
However, if the
|
||||
target scheduler system is not on this list, or if your system
|
||||
requires custom settings, a custom parser can
|
||||
be defined by selecting <computeroutput>[custom]</computeroutput>
|
||||
@ -531,6 +652,11 @@
|
||||
The <computeroutput>Copy To Custom</computeroutput> button will
|
||||
copy the selected import template values to the custom parser.
|
||||
</para>
|
||||
<warning>
|
||||
Using the <computeroutput>Copy To Custom</computeroutput> action
|
||||
will cause the prior custom import template values to be
|
||||
overwritten!
|
||||
</warning>
|
||||
<para>
|
||||
Log schedule files for Rivendell are assumed to be in so-called
|
||||
"column-aligned" format --i.e. each record occupies a single
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user