Cisco Media Experience Engine 3500 ユーザ ガイド
Folder Attendant XML リファレンス
Folder Attendant XML リファレンス
発行日;2012/02/06 | 英語版ドキュメント(2010/12/09 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 4MB) | フィードバック

目次

Folder Attendant XML リファレンス

リファレンス XML コンフィギュレーション ファイル

一般的なタグ

ディレクトリ タグ

コピー完了タグ

ウォッチ タグ

拡張子リスト タグ

拡張子タグ

ジョブ タグ

メタデータ タグ

ファイル入力タグ

システム設定タグ

リファレンス XML アプリケーション コンフィギュレーション ファイル

メディアおよび XML ファイルの送信

リファレンス XML コンフィギュレーション ファイル

Folder Attendant コンフィギュレーション ファイル(faConfig.xml)には、ディレクトリ ウォッチの設定が定義されています。

このファイルは、
C:/Program Files/Cisco/Media Experience Engine/Folder Attendant/bin/faConfg.xml にあります。

この項では、次のタグについて説明します。

「一般的なタグ」

「ディレクトリ タグ」

「コピー完了タグ」

「ウォッチ タグ」

「拡張子リスト タグ」

「拡張子タグ」

「ジョブ タグ」

「メタデータ タグ」

「ファイル入力タグ」

「システム設定タグ」

一般的なタグ

 

タグ
説明

agilityHost

プラットフォーム(ECS)のホスト名。

デフォルトのポートは 3501 です。

monitor-window

前処理および符号化されたイメージをモニタ ウィンドウに表示するかどうかを指定します。

次の選択肢があります。

On

Off

ディレクトリ タグ

ファイルには、1 つまたは複数の <directory> タグが含まれています。

 

タグ
説明

enabled

次の選択肢があります。

ディレクトリのモニタが有効化されている場合は true。

それ以外の場合は false。

id

ディレクトリの一意の識別子(0 よりも大きい整数)

path

視聴するディレクトリ パス。ネットワーク共有の場合と、次の FTP URL の場合があります。

ftp:¥¥[username:password]@hostname[:port]¥directory

refresh

ディレクトリをモニタする頻度(秒)。

maxSubmitRetries

送信できなかったジョブの再送信を試行する最大回数。

submitRetryInterval

失敗したジョブを再送信する頻度(秒)。

コピー完了タグ

ディレクトリには、 <copyComplete> タグを 1 つ含めることができます。

次のパラメータは、ファイルがいつモニタ対象ディレクトリに完全にコピーされ、送信準備ができたかを判断する手法を割り当てるために使用します。オペレーティング システムが違うと、これらの手法の動作も異なります。

 

タグ
説明

method

ファイルのコピーがいつ完了したかを判断する手法。

rename-to-self:ファイル名をそれ自身の名前に変更します。

rename-to-tmp:ファイル名を [filename]-tmp に変更してから、元のファイル名に戻します。

file-size-delay:最後にファイル サイズが変更されてから、fileDelay の秒数だけ待機します。

file-modified-delay:最後に修正時刻が変更されてから、fileDelay の秒数だけ待機します。

control-file:制御ファイル([filename].ctl)がディレクトリに追加されるのを待機します。

exclusive open:ファイルを排他的に開きます。

immediate:ファイルが完全にコピーされるのを待機せず、ただちにそのファイルを処理します。

fileDelay

ファイルのコピーが完了したことを示す、最新のファイル変更以降の最小時間(秒)。このパラメータは、file-size-delay および file-modified-delay 手法だけに適用されます。

ウォッチ タグ

ディレクトリには、1 つまたは複数の <watch> タグが含まれています。

拡張子リスト タグ

ウォッチには <extensionList> タグを 1 つ含めることができます。

拡張子タグ

拡張子リストには、1 つまたは複数の <ext> タグが含まれています。

 

タグ
説明

ext

視聴するファイル拡張子(.mov、.xml など)。

ジョブ タグ

ウォッチには <job> タグを 1 つ含めることができます。

 

タグ
説明

job-priority

ジョブのプライオリティ。1 ~ 100 までの正の整数。1 は最も高いプライオリティを示します。

メタデータ タグ

 

タグ
説明

meta-title

指定されない場合は、デフォルトでソース クリップのファイル名に設定されます。

meta-author

ジョブの作成者。

meta-description

ジョブの説明。

meta-copyright

著作権に関する注意。

meta-rating

視聴率。

meta-keywords

カンマで区切られたキーワードのリスト。

meta-timecode

メディア ファイルから取得された開始タイムコード。

udm-item

ユーザ定義のメタデータ アイテム。アイテム名と値は、タグの属性として次のように示されます。

<udm-item name="myItemName" value="mytextValue"></udm-item>

ファイル入力タグ

 

タグ
説明

profile

ジョブ プロファイルの名前(conform.job.awp など)。このパスは、(システム設定での構成のように)システム プロファイル ディレクトリを使用して構成されます。

source-inpoint

クリップの先頭に対する符号化の開始点。形式は HH.MM.SS.XXX です。

source-outpoint

クリップの符号化の終了点。この数値が正の場合は、クリップの先頭に対する終了点を示しています。この数値が負の場合は、クリップの末尾に対する終了点を示しています。

つまり、-3.0 はクリップ終了の 3 秒前に符号化が停止することを意味します。この形式は、HH.MM.SS.XXX です。シーク非対応のファイル形式では使用できません。

delete-source-after-process

処理が正常に完了した後、ソース クリップが削除されるかどうかを示します。削除は、Cisco MXE 3500 ジョブの終了時にファイル マネージャ ワーカーによって行われます。ジョブが失敗すると、ソース クリップは削除されません。このオプションは、有効値である「true」または「yes」によってオンになります。デフォルトは false です。

(注) XML ファイルは削除されません。

システム設定タグ

ウォッチには <system-settings> タグを 1 つ含めることができます。

 

タグ
説明

output-basename

出力基本名が指定されます。この名前は、$(basename) 変数を介して出力プロファイルで使用できます。符号化されたすべてのファイルには、この基本名から派生する名前が割り当てられます。

次のすべてのタグは、さまざまなタイプの Cisco MXE 3500 出力に対する出力ディレクトリを定義します。マシン名やドライブ文字など、総合的なディレクトリ指定が必要です。

report-dir

(HTTP POST 通知からの)ジョブ実行のファイル レポートの場所。

captionextract-output-dir

抽出されたクローズド キャプション データ用の出力ディレクトリ。

flash-output-dir

--

flash8-output-dir

--

h264-output-dir

--

index-output-dir

インデクサからのデータとサムネイル。

mpeg-output-dir

--

mp3-output-dir

--

ms-output-dir

--

pp-output-dir

--

qt-output-dir

--

real-output-dir

--

thumb-output-dir

サムネイル イメージの出力ディレクトリ。

wav-output-dir

--

リファレンス XML アプリケーション コンフィギュレーション ファイル

次のアプリケーション設定パラメータは、 FolderAttendantService.exe.config ファイルで定義されます。

 

表 A-1 設定パラメータ タグと説明

タグ
説明

folderAttendant.adminPort

管理コマンド リスナー用のポート(3515)。レガシー Folder Attendant(FA)と同じマシン上で動作している場合は、この値を変更する必要があります。

folderAttendant.configFile

FA コンフィギュレーション ファイルの完全修飾パス(c:¥program files¥Cisco¥Media Experience Engine¥Folder Attendant¥bin¥faConfig.xml)。

folderAttendant.xmlExtensions

XML ファイルのファイル拡張子(.rdf、.xml など)。

folderAttendant.fileExclusionRegex

処理から除外するファイル名の正規表現(つまり、ピリオドで始まるファイルを無視するには ^¥. とします)。

ecs.host

デフォルトの ECS ホスト名(localhost)。ECS が別のマシンにインストールされている場合は、この値を変更する必要があります。

Ecs.port

デフォルトの ECS ポート(3501)。

ecs.receiveTimeout

ECS から応答を受け取る際のタイムアウト(ミリ秒)。

plannersFile

プランナ/XSLT 変換コンフィギュレーション ファイル。

plannersAssemblyPath

設定済みプランナ アセンブリのルート ディレクトリ。

transformsPath

設定済み XSLT 変換のルート ディレクトリ。

profileTypesFile

プロファイル タイプのリストが含まれたコンフィギュレーション ファイル。

settingsDefinitionFile

システム設定定義ファイル。

basePath

API ルート ディレクトリへの完全修飾パス(c:¥program files¥Cisco¥Media Experience Engine¥API)。

メディアおよび XML ファイルの送信

指定された一連のファイル拡張子について、1 つのディレクトリが Folder Attendant によってモニタされている場合、ファイル拡張子が一致する新規または更新された(ファイル サイズまたは最終変更日が変更された)メディア ファイルまたは XML ファイルがそのディレクトリにコピーされると、Folder Attendant は Cisco MXE 3500 プラットフォームにジョブを送信します。

メディア ファイルの場合、一致する各ディレクトリ ウォッチに対応する <jobPackage> XML ドキュメントが Cisco MXE 3500 プラットフォームに送信されます。このドキュメントには、ネストされた <jobPackage> の <jobList> が含まれ、各 <jobPackage> には <planner-submit> XML が格納されます。ネストされた各 <jobPackage> には、所定のディレクトリ ウォッチに対して構成されたシステム設定が含まれています。<planner-submit> XML には、メディア ファイル名と、所定のディレクトリ ウォッチに対して設定されたジョブ パラメータ(メタデータ、プライオリティなど)が含まれています。

たとえば、あるディレクトリが 2 つのディレクトリ ウォッチに対して設定されているとします。各ディレクトリ ウォッチは、.MOV ファイルを視聴し、それぞれ異なるジョブ プロファイルとメタデータが割り当てられています。この場合、次のプラン XML が Folder Attendant によって生成され、API を介して Cisco MXE 3500 プラットフォームに送信されます。

 
<jobPackage>
<submitParameterList>
<jobData>
<folderAttendant>
<fileName>filename of .MOV file</fileName>
</folderAttendant>
</jobData>
</submitParameterList>
<jobList>
<!-- job package for directory watch #1 ->
<jobPackage>
<submitParameterList>
<setting name=”setingName”>watch1 settingValue</setting>
...
</submitParameterList>
<jobList>
<planner-submit>
<profile-dir>watch1 configured job profile</profile-dir>
<source-name>filename of .MOV file</source-name>
<meta-title>watch1 meta title</meta-title>
....
</planner-submit>
</jobList>
</jobPackage>
<!-- job package for directory watch #2 ->
<jobPackage>
<submitParameterList>
<setting name=”setingName”>watch2 settingValue</setting>
...
</submitParameterList>
<jobList>
<planner-submit>
<profile-dir>watch2 configured job profile</profile-dir>
<source-name>filename of .MOV file</source-name>
<meta-title>watch2 meta title</meta-title>
....
</planner-submit>
</jobList>
</jobPackage>
</jobList>
</jobPackage>
 

XML プラン ファイルの場合、一致する各ディレクトリ ウォッチごとに、<jobPackage> XML ドキュメントが Cisco MXE 3500 プラットフォームに送信されます。このドキュメントには、XML ファイルのコンテンツと、所定のディレクトリ ウォッチに対して構成されたシステム設定が含まれています。ディレクトリ ウォッチに設定されたジョブ パラメータ(メタデータ、ジョブ プライオリティなど)は無視されることに注意してください。アプリケーション コンフィギュレーション ファイル パラメータ folderAttendant.xmlExtensions にファイル拡張子が設定されている場合、そのファイルは XML ファイルとして処理されます。現在、.xml と .rdf がデフォルトの XML ファイル拡張子として設定されています。

XML ドキュメントは、API でサポートされる次の プラン XML 形式をサポートできます。

<planner-submit>

<job>

<jobPackage>

<multiPackage>(ライセンス供与されている場合)

カスタム プラン XML(設定済み API プランナおよび変換でサポートされている場合)