mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-04-07 17:32:20 +02:00
2017-11-13 Fred Gleason <fredg@paravelsystems.com>
* Added a 'Managing Services' section to the Operations Guide.
This commit is contained in:
Fred Gleason
parent
fd80263d43
commit
ebd0ea6bce
@ -16373,3 +16373,5 @@
|
||||
* Split the Operations Guide into three parts.
|
||||
* Added a 'Configuring Rivendell with RDAdmin' chapter to part 2
|
||||
of the Operations Guide.
|
||||
2017-11-13 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Added a 'Managing Services' section to the Operations Guide.
|
||||
|
||||
@ -127,12 +127,17 @@ OPSGUIDE_HTML = appendix.filepath_wildcards.html\
|
||||
sect.utilities.rdrevert.html\
|
||||
sect.voicetracking.using_the_voicetracker_dialog.html
|
||||
|
||||
OPSGUIDE_IMAGES = rdadmin.group_dialog.png\
|
||||
OPSGUIDE_IMAGES = rdadmin.autofill_carts_dialog.png\
|
||||
rdadmin.edit_service_dialog.png\
|
||||
rdadmin.group_dialog.png\
|
||||
rdadmin.hosts_dialog.png\
|
||||
rdadmin.log_importation_string_fields.png\
|
||||
rdadmin.login_dialog.png\
|
||||
rdadmin.rdadmin_screenshot.png\
|
||||
rdadmin.rename_group_dialog.png\
|
||||
rdadmin.rivendell_group_list_dialog.png\
|
||||
rdadmin.rivendell_user_list_dialog.png\
|
||||
rdadmin.services_dialog.png\
|
||||
rdadmin.user_dialog.png\
|
||||
rdairplay.audio_meter.png\
|
||||
rdairplay.button_log_widget.png\
|
||||
|
||||
BIN
docs/opsguide/rdadmin.autofill_carts_dialog.png
Normal file
BIN
docs/opsguide/rdadmin.autofill_carts_dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
BIN
docs/opsguide/rdadmin.edit_service_dialog.png
Normal file
BIN
docs/opsguide/rdadmin.edit_service_dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 97 KiB |
BIN
docs/opsguide/rdadmin.hosts_dialog.png
Normal file
BIN
docs/opsguide/rdadmin.hosts_dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
BIN
docs/opsguide/rdadmin.log_importation_string_fields.png
Normal file
BIN
docs/opsguide/rdadmin.log_importation_string_fields.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
BIN
docs/opsguide/rdadmin.services_dialog.png
Normal file
BIN
docs/opsguide/rdadmin.services_dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.9 KiB |
@ -256,4 +256,238 @@
|
||||
</para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
<sect1 xml:id="sect.rdadmin.manage_services">
|
||||
<title>Managing Services</title>
|
||||
<para>
|
||||
To manage services in RDAdmin, touch the
|
||||
<computeroutput>Manage Services</computeroutput> button to open
|
||||
the Rivendell Services dialog.
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.services_dialog.png" scale="45"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>The Rivendell Services Dialog</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
<para>
|
||||
To examine and modify an existing service, touch its entry in the
|
||||
<computeroutput>Services</computeroutput> list and then touch the
|
||||
<computeroutput>Edit</computeroutput> button to open the
|
||||
Group Dialog.
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.edit_service_dialog.png" scale="45"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>The Edit Service Dialog</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
<sect2 xml:id="sect.rdadmin.manage_services.general">
|
||||
<title>The <computeroutput>General</computeroutput> Section</title>
|
||||
<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>Program Code</computeroutput> is a string that
|
||||
is sent to RLM plug-ins as part of every Now & Next update.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Log Name Template</computeroutput> field is
|
||||
a string that defines how logs will be named when generated by
|
||||
RDLogManager. This field can take
|
||||
<link linkend="sect.filepath_wildcards.definition">
|
||||
filepath wildcards</link>.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Log Description Template</computeroutput> field
|
||||
is a string that defines how the
|
||||
<computeroutput>Description</computeroutput> for each log will be
|
||||
formatted for logs generated by RDLogManager. This field can take
|
||||
<link linkend="sect.filepath_wildcards.definition">
|
||||
filepath wildcards</link>.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Voicetrack Group</computeroutput> dropdown
|
||||
specifies the Rivendell group to be used for storing voicetracks
|
||||
for this service.
|
||||
</para>
|
||||
<para>
|
||||
<!--
|
||||
FIXME: Document AutoSpot!
|
||||
-->
|
||||
The <computeroutput>AutoSpot Group</computeroutput> dropdown
|
||||
specifies the Rivendell group to be used for storing carts used
|
||||
for the AutoSpot functionality.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Insert CHAIN TO at log end</computeroutput>,
|
||||
if ticked, will cause a CHAIN-TO event to the following day's log
|
||||
to be appended to the log when generated by RDLogManager.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Enable AutoRefresh By Default</computeroutput>
|
||||
box, if ticked, will cause the log's
|
||||
<computeroutput>Enable AutoRefresh</computeroutput> attribute to
|
||||
be set to <computeroutput>Yes</computeroutput> when generated
|
||||
by RDLogManager.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Purge Logs after</computeroutput> box,
|
||||
if ticked, will set the deletion date for logs to be the
|
||||
specified number of days after being created by RDLogManager.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Purge ELR Data after</computeroutput>
|
||||
box, if ticked, will cause Electronic Log Reconiliation (ELR)
|
||||
as-played data to be purged from the database the specified number
|
||||
of days after being generated.
|
||||
</para>
|
||||
<sect3 xml:id="sect.rdadmin.manage_services.general.configure_autofill_carts">
|
||||
<title>Configuring Autofill Carts</title>
|
||||
<para>
|
||||
The <computeroutput>Configure Autofill Carts</computeroutput>
|
||||
button will bring up the Autofill Carts dialog>
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.autofill_carts_dialog.png" scale="45"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>The Autofill Carts Dialog</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
<para>
|
||||
Carts listed in this dialog will be considered for inclusion
|
||||
in an event by RDLogManager when the event's
|
||||
<computeroutput>Use Autofill</computeroutput> box is ticked.
|
||||
When filling a gap, RDLogManager will recursively scan the list
|
||||
of available carts, working from the longest to to shortest, and
|
||||
insert the longest cart that will fit. The process will stop when
|
||||
either the available gap has been completely filled or no cart
|
||||
short enough to fit has been found.
|
||||
</para>
|
||||
</sect3>
|
||||
<sect3 xml:id="sect.rdadmin.manage_services.general.enabling_hosts_for_service_playout">
|
||||
<title>Enabling Hosts for Service Playout</title>
|
||||
<para>
|
||||
The <computeroutput>Enable Hosts</computeroutput> button will bring
|
||||
up the Hosts dialog, where the hosts for which this service is
|
||||
allowed to be played can be defined
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.hosts_dialog.png" scale="45"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>The Hosts Dialog</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
</sect3>
|
||||
</sect2>
|
||||
<sect2 xml:id="sect.rdadmin.manage_services.traffic_music_data_importation_settings">
|
||||
<title>Traffic/Music Data Importation Settings</title>
|
||||
<para>
|
||||
With the exception of one field
|
||||
(<computeroutput>Insert Traffic Break String</computeroutput>),
|
||||
the <computeroutput>Traffic Data Import</computeroutput> and
|
||||
<computeroutput>Music Data Import</computeroutput> sections are
|
||||
identical. Thus, only the
|
||||
<computeroutput>Music Data Import</computeroutput> section will be
|
||||
described here.
|
||||
</para>
|
||||
<para>
|
||||
The upper part of the section consists of string fields and a dropdown
|
||||
box.
|
||||
</para>
|
||||
<para>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata align="center" fileref="rdadmin.log_importation_string_fields.png" scale="45"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
<para>Log Importation String Fields</para>
|
||||
</caption>
|
||||
</mediaobject>
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Linux 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
|
||||
<link linkend="sect.filepath_wildcards.definition">
|
||||
filepath wildcards</link>.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Linux 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
|
||||
<link linkend="sect.filepath_wildcards.definition">
|
||||
filepath wildcards</link>.
|
||||
</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
|
||||
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>
|
||||
<para>
|
||||
The <computeroutput>Insert Voice Track String</computeroutput>
|
||||
field can be used to configure placement of a voice track marker
|
||||
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 voice track event, the text of which will be the
|
||||
'title' field from that same line.
|
||||
</para>
|
||||
<para>
|
||||
The <computeroutput>Insert Traffic Break String</computeroutput>
|
||||
field can be used to configuration placement of a traffic break
|
||||
from an entry in the music import log. When the string set here is
|
||||
found in the cart field. RDLogManager will insert a traffic import
|
||||
event, using the event specified in the
|
||||
<computeroutput>Import inline traffic</computeroutput> dropdown box
|
||||
in the relevant music event.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
This field is available only in the
|
||||
<computeroutput>Music Data Import</computeroutput> section!
|
||||
</para>
|
||||
</note>
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user