The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This section includes the following topics:
•Reference XML Configuration File
•Reference XML Application Configuration File
•Submitting Media and XML Files
The Folder Attendant Configuration file (faConfig.xml) defines the directory watch configuration.
This file can be found at
C:/Program Files/Cisco/Media Experience Engine/Folder Attendant/bin/faConfg.xml.
This section describes the following tags:
The file may contain one or more <directory> tags.
Directory may contain one <copyComplete> tag.
The following parameters are used to assign method for determining when a file has been completely copied to the monitored directory and is ready for submission. These methods will behave differently on different operating systems.
A directory may contain one or more <watch> tags.
A watch may contain one <extensionList> tag.
An extension list may contain one or more <ext> tags.
|
|
ext |
File extension to watch for (.mov, .xml, etc.). |
A watch may contain one <job> tag.
|
|
job-priority |
Job priority. Positive integer between 1 and 100, with 1 indicating the highest priority. |
A watch many contain one <system-settings> tag.
The following application configuration parameters are defined in the FolderAttendantService.exe.config file:
Once a directory is monitored by the Folder Attendant for a given set of file extensions, if a new or updated (change in file size or last modified date) media or XML file, with a matching file extension, is copied to the directory, the Folder Attendant will submit a job to the Cisco MXE 3500 platform.
For media files, a <jobPackage> XML document containing a <jobList> of nested <jobPackage>s each containing <planner-submit> XML for each matching directory watch will be submitted to the Cisco MXE 3500 platform. Each nested <jobPackage> will contain the system settings configured for the given directory watch. The <planner-submit> XML will include the media file name and configured job parameters (meta data, priority, etc.) for the given directory watch.
For example, consider a directory that has been configured for 2 directory watches, each watching for .MOV files and assigned a different job profile and meta data. The following plan XML will be generated by the Folder Attendant and submitted via the API to the Cisco MXE 3500 platform:
<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>
For XML plan files, a <jobPackage> XML document containing the contents of the XML file and any system settings configured for the given directory watch will be submitted to the Cisco MXE 3500 platform for each matching directory watch. Note that any job parameters (such as meta data, job priority, etc.) configured for the directory watch are ignored. A file is processed as an XML file if the file extension is configured in the following application configuration file parameter (folderAttendant.xmlExtensions). Currently (.xml and .rdf ) are configured as default XML file extensions.
The XML document can support any plan XML format supported by the API including:
•<planner-submit>
•<job>
•<jobPackage>
•<multiPackage> (if licensed)
•Custom plan XML if supported by configured API planners and transforms