This chapter describes additional DFM configuration options and includes the following information:
The following sections describe additional options for DFM configuration beyond the basic configurations described in Chapter 2.
<incompleteThreshold>If you copy the file into a File Set Mode folder, and during the designated incompleteThreshold seconds it was not archived, the file is marked as incomplete. The default value is 86400 seconds (24 hours).
<incompleteThreshold>86400</incompleteThreshold>
<incompleteProcessingStrategy>This parameter identifies how DIVArchive processes incomplete files. Incomplete files are files that were placed into the Drop Folder without the metadata file (for File Set folders), and also files that cannot be archived to DIVArchive after a specific number of attempts.
DIVArchive uses the following three parameters to identify incomplete files:
incompleteThreshold
maxRejectCountInitializing
maxRejectCountProcessing
The following three options are available to use for the OPTION value in the parameter as shown:
This option tells the system to do nothing with an incomplete file.
This option tells the system to delete the incomplete file.
This option tells the system to rename the file so it is identifiable as an incomplete file.
<incompleteProcessingStrategy>OPTION</incompleteProcessingStrategy>
<mdfConfigPriority>Note:
This parameter only applies to File Set Mode folders.This parameter can have Primary or Secondary values, and determines how the system handles the file during the archive process. This can either be by using the metadata file parameters (Primary), or the folder specific configuration parameters (Secondary). Primary is the default value used when this parameter is empty or missing.
<mdfConfigPriority>Primary</mdfConfigPriority>
The following sections describe additional DFM configuration options related to DIVArchive operations.
<deleteBeforeArchive>Caution:
This optional parameter may lead to content deletion in the DIVArchive system, and must be used with caution.This optional parameter specifies whether DFM should delete the object before the archive request for a specific folder. This parameter can be either true or false. The default value is false.
<deleteBeforeArchive>FALSE</deleteBeforeArchive>
Example:
An object is copied to the Drop Folder and fits into an established Storage Plan. The Storage Plan specifies that the object should be copied to another Source/Destination, and archived to a specific folder. Using this option, the object will be copied to the specified Source/Destination, but then deleted before the Archive action is performed. Therefore, the object is never actually archived.
<numberFilesToArchiveWildcard>This parameter defines a threshold on the number of files in the same folder. If the number of files in the folder is larger than the numberFilesArchiveWildcard parameter, DFM sends the archive request to the DIVArchive Manager using the asterisk wildcard as the File List parameter, instead of the actual list of files for the entire folder. The value must be a positive integer to specify the number of files, or if the asterisk wildcard is used in the request, all files will be archived.
<numberFilesToArchiveWildcard>*</numberFilesToArchiveWildcard>
<objectNameConvertRules>Note:
This parameter only applies to Single File Mode folders.The Object Name Conversion Rules identify how DIVArchive translates file names into object names. Currently, only the Simple conversion method is implemented. The rule syntax for this method is case sensitive and described later.
When you specify a rule using Name.Ext, the object name will be the same as the file name. If you only specify Name, the file name will be the same as the original file name, but the extension will be removed. This applies to all of the following parameters:
This value results in the original file name and extension; no conversion of the file name or extension takes place.
This value results in the original file name being converted to all lowercase, and the file extension is removed.
This value results in the original file name being converted to all upper case, and the file extension is removed.
This value results in the file name being removed, the original file name being converted to the extension, and is all lowercase.
For example, file_name.ext will become only .ext.
This value results in the file name being removed, the original file name being converted to the extension, and is all upper case.
For example, file_name.ext will become only .EXT.
This value results in the original file name being converted to all lowercase, and the original file extension is left intact.
This value results in the original file name being converted to all lowercase, and the original file extension is converted to all upper case.
This value results in the original file name being converted to pre_(original_file_name)_suf, and the original extension is converted to all upper case.
This value results in the original file name being converted to pre_(original_file_name)_suf, and the extension is removed.
For example, the following statement uses the Simple method, and leaves the file name and extension unchanged:
<objectNameConvertRule method="simple">Name.Ext</objectNameConvertRule>
<originalServer>In some configurations, the monitored folder is an intermediate location between the video server and the DIVArchive system. You can specify the originalServer parameter to ensure the original content location is set correctly in the DIVArchive system. The original server is displayed in the GUI, and stored in the database as the original content location, instead of the actual Source/Destination used to archive data from the intermediate location.
In the statement <originalServer>original_server</originalServer>, the value of original_server is the original content location designated by the original host name. For example, the statement <originalServer>VIDEO_SERVER_1</originalServer> identifies VIDEO_SERVER_1 as the original content location.
<originalPath>In some configurations the monitored folder is an intermediate location between the video server and the DIVArchive system. You specify the originalPath parameter to ensure the content path at the original location is set correctly in the DIVArchive system. The original content path is displayed in the GUI, and stored in the database as the path to the original content location, instead of the actual Root Path used to archive data from the intermediate location.
In the statement <originalPath>original_path</originalPath>, the value of original_path identifies the content path at the original_server location (see the previous section describing original_server).
<divaMediaName> and <divaMediaNamePattern>The <divaMediaNamePattern> is the DIVArchive Media Name Pattern used to select the medium for archive requests. Using this pattern allows the GROUP value to be identified.
In the statement <divaMediaNamePattern>folder1/$GROUP/folder3</divaMediaNamePattern>, folder1 and folder3 are actual folder names, while $GROUP indicates the system will identify the group from the .mdf file.
If the pattern was not recognized, then the <divaMediaName> value from the file set's corresponding .mdf file is used as the DIVArchive Media Name for the archived request when working with a File Set Mode folder. If the pattern is recognized, then the <divaMediaName> from the configuration file is used.
The following sections describe additional configuration options related to the DFM monitored folder.
<mdfExtension>This option identifies the extension for the metadata file for each folder. In the following example, the metadata file extension will be mdf:
<mdfExtension>mdf</mdfExtension>
<sourceDestinationDIVAPath>Note:
This parameter only applies to File Set Drop Folders. Because the Actor and DFM could be on different machines, they might view the folder differently. For example, Actor may see the folder as a local disk, while DFM may see it as an FTP folder (or vice versa).This field defines the location of the Drop Folder Root on the DIVArchive Source/Destination. For a dedicated Source/Destination (the Root Path of the Source/Destination in the Configuration Utility points to the root of DFM), the File Path Root of the Source/Destination may already contain a path, and then you can leave this field empty.
In the statement <sourceDestinationDIVAPath>path</sourceDestinationDIVAPath>, the value of path is the full path to the root DIVArchive Source/Destination folder.
For example, the statement <sourceDestinationDIVAPath></sourceDestinationDIVAPath> identifies DROP_FOLDER as the full path to the root Source/Destination folder.
In File Set Mode, the SourceDestinationDivaPath is added to the relative file path. The following examples are for different common configurations.
See File Root Path and Single File Mode Advanced Configuration for more details and examples.
Example 1:
SourceDestinationDivaPath = E:\DFM
Archive File Path Root = E:\DFM\data\tape1\123456
Archive File List = toto.mdf toto0.data folder1\toto1.data folder1\folder2\toto2.data
Results
E:\DFM\data\tape1\123456\toto.mdf
E:\DFM\data\tape1\123456\toto0.data
E:\DFM\data\tape1\123456\folder1\toto1.data
E:\DFM\data\tape1\123456\folder1\folder2\toto2.data
Example 2:
SourceDestinationDivaPath = F:\DFM\:
Archive File Path Root = F:\DFM\data\tape1\123456
Archive File List = toto.mdf toto0.data folder1\toto1.data folder1\folder2\toto2.data
Results
F:\DFM\data\tape1\123456\toto.mdf
F:\DFM\data\tape1\123456\toto0.data
F:\DFM\data\tape1\123456\folder1\toto1.data
F:\DFM\data\tape1\123456\folder1\folder2\toto2.data
Example 3:
SourceDestinationDivaPath = empty (no value entered)
Archive File Path Root = data\tape1\123456
Archive File List = toto.mdf toto0.data folder1\toto1.data folder1\folder2\toto2.data
Results
data\tape1\123456\toto.mdf
data\tape1\123456\toto0.data
data\tape1\123456\folder1\toto1.data
data\tape1\123456\folder1\folder2\toto2.data
Example 4:
SourceDestinationDivaPath = data
Archive File Path Root = data\data\tape1\123456
Archive File List = toto.mdf toto0.data folder1\toto1.data folder1\folder2\toto2.data
Results
data\data\tape1\123456\toto.mdf
data\data\tape1\123456\toto0.data
data\data\tape1\123456\folder1\toto1.data
data\data\tape1\123456\folder1\folder2\toto2.data
<archiveFilePathTemplate>Note:
this parameter is only applicable to Single File Mode Drop Folders.This parameter specifies the rule for how the Root Path of the archive request will be generated. The platform parameter value can be one of the following:
WIN
SOL
CIFS
DETECT
The format of the value is a combination of folder names, separators, and the following keywords:
This keyword identifies the folder name where the definition is located. For example:
DFM_FILE_FULL_PATH = DFM_URL\PARENTn ...\PARENT_3\PARENT_2\PARENT_1\file_name.ext
This keyword identifies the relative path from DFM_URL to PARENTm.
This keyword identifies the relative path from DFM_URL to the file.
The following is an example using this parameter:
<archiveFilePathTemplate platform="DETECT" options="">URL_TO_FILE</archiveFilePathTemplate>
See File Root Path and Single File Mode Advanced Configuration for more details and examples.
<archiveFileNameTemplate>Note:
This parameter is only applicable to Single File Mode Drop Folders.This parameter specifies the rule for identifying how the file names of an Archive request are generated. The platform parameter value can be one of the following:
WIN
SOL
CIFS
DETECT
The format of the value is a combination of folder names, separators, and the following keywords:
This keyword identifies the folder name where the definition is located. For example:
DFM_FILE_FULL_PATH = DFM_URL\PARENTn ...\PARENT_3\PARENT_2\PARENT_1\filename.ext
This keyword identifies the relative path from DFM_URL to the file.
This keyword identifies the original file name.
This keyword identifies the file name without the extension.
In the following example filename and ext represent the keywords of the pattern definition, not the sample file name and extension; filename.ext is not an actual file name.
<archiveFileNameTemplate platform="DETECT" options="">filename.ext</archiveFileNameTemplate>
See File Root Path and Single File Mode Advanced Configuration for more details and examples.
<fileFilter>Note:
The<fileFilter> parameter is optional for the Drop Folder configuration. If you do not specify it in the folder configuration, DFM will archive any file in the folder without using any masks. Only one <fileFilter> can be specified per folder.You use this parameter to filter files to archive. You can specify the type attribute as either include or exclude.
In inclusion mode, no files are archived if there are no filters defined. Each filter will allow archiving of files if they match specific rules. The file will only be archived if the file corresponds to one or more masks. If the file does not correspond to any masks then the file will be ignored by DFM, and not deleted or archived.
In exclusion mode, all files are archived if there are no filters defined. Each filter will restrict the archiving of files if they match specific rules. The file will not be archived if the file corresponds to one or more masks. If the file corresponds to any mask, the file will be ignored by DFM, and not deleted or archived.
You can define the filter as a pattern where the mask has a question mark, indicating any symbol, or an asterisk indicating any string, as a Regular Expression (rexexp), or both.
The following parameters are used within the <fileFilter> configuration parameter:
<mask>This parameter specifies the pattern for the filter.
<regexp>This parameter specifies the regular expression for the filter.
For details on Regular Expressions visit the following websites:
<deleteParentDirectoryAndContentDirectories>This optional parameter specifies whether DFM should delete the parent and child folders of an MDF file. This is useful when a user places an object into a folder, and DFM is not set to delete the files and folders after all actions are executed on the object. Using this parameter, the object's files and folders are not left in the folder where the object was placed. This parameter can be either TRUE (this is the default) or FALSE.
In the following example, the folders will not be deleted:
<deleteParentDirectoryAndContentDirectories>FALSE</deleteParentDirectoryAndContentDirectories>
In the following example, the folders will be deleted:
<deleteParentDirectoryAndContentDirectories>TRUE</deleteParentDirectoryAndContentDirectories>
The examples in the following sections have had all comments that are in the actual configuration files removed to make them easier to understand.
The Object Name Conversion Rule does not apply to Set Mode Folders. Files will be acted on using the original file name and extension.
In the following configuration example:
The local folder is c:\DROPFOLDER.
The type of DFM folder is File Set.
The Priority is 50.
The Category is category1.
The Incomplete Threshold is 60 seconds.
The Source/Destination DIVArchive name is LOCAL1.
The Source/Destination DIVArchive path is C:/DROPFOLDER.
The DIVArchive Media Name is Array1.
The Incomplete File Processing Strategy is Delete.
All incomplete folders will be deleted.
<folderConfig> <url>file:///c:\DROPFOLDER</url> <type>set</type> <priority>50</priority> <categoryName>category1</categoryName> <incompleteThreshold>60</incompleteThreshold> <sourceDestinationDIVAName>LOCAL1</sourceDestinationDIVAName> <sourceDestinationDIVAPath>C:/DROPFOLDER</sourceDestinationDIVAPath> <divaMediaName>Array1</divaMediaName> <incompleteProcessingStrategy>Delete</incompleteProcessingStrategy> </folderConfig>
Using this configuration, if you copy a set of files into the DFM monitored local folder named C:\DROPFOLDER, and it has 3 files in the set with the names file1.ext, file2.ext, and filesetdata.mdf, they will be archived into a single file in DIVArchive with the following parameters:
The Source/Destination is LOCAL1.
The Object Name is filesetdata.ext.
The Category Name is category1.
If the metadata file is not present, the set will be considered incomplete and the files will all be deleted after 60 seconds.
When the DFM Drop Folder is configured on an FTP server, you must copy all content expected to be archived to the DFM Drop Folder using FTP. If you copy the content to the DFM Drop Folder by other means (local copy through the operating system, remote desktop copy, and so on) there is no guarantee of proper processing by DFM.
When DFM is used in a Linux environment to monitor an FTP folder, it must be configured as in the following example:
User: diva
User Home Directory: /ifs
Folder to be Monitored: /ifs/folder1
Correct DFM Configuration: ftp://diva:password@host_ip/folder1
Incorrect DFM Configuration: ftp://diva:password@host_ip/ifs/folder1
<folderConfig> <url>ftp://diva:diva@localhost:21/dropfolder</url> <type>single</type> <priority>20</priority> <categoryName>category2</categoryName> <incompleteThreshold>120</incompleteThreshold> <sourceDestinationDIVAName>FTP1</sourceDestinationDIVAName> <sourceDestinationDIVAPath>/video1/data/</sourceDestinationDIVAPath> <divaMediaName>Array1</divaMediaName> <objectNameConvertRule method="simple">Name</objectNameConvertRule> <divaMediaNamePattern>/def/$GROUP/content</divaMediaNamePattern> </folderConfig>
In this example:
The FTP folder is ftp://diva:diva@localhost:21/dropfolder.
The Type of DFM folder is Single.
The Priority is 20.
The Category is category2.
The Incomplete Threshold is 120 seconds.
The Source/Destination DIVArchive Name is FTP1.
The Source/Destination DIVArchive Path is /video1/data/.
The DIVArchive Media Name is Array1.
The default Object Name Conversion rule for Drop Folders will remove the file extension.
The divaMediaNamePattern is /def/$GROUP/content.
Using this configuration, if a single file is transferred to the FTP server called localhost, on port 21, with the login name diva, the password diva, in the DFM monitored FTP folder named dropfolder, with the file name file1.ext, it will be archived to a single object in DIVArchive with the following parameters:
Source/Destination: FTP1
Object Name: file1
Category Name: category2
If the file is not completely present, or if the archive process does not complete, the file will be considered incomplete and deleted after 120 seconds.
The following example is for when you are using a CIFS folder for the DFM Drop Folder. The Object Name Conversion Rule does not apply to Set Mode Folders. Files will be acted on using the original file name and extension.
In the following example:
The CIFS folder is \\divaserver\dropfolder.
The Type of DFM folder is File Set.
The Priority is 50.
The Category is category3.
The Incomplete Threshold is 60 seconds.
The Source/Destination DIVArchive Name is CIFS1.
The Source/Destination DIVArchive Path is empty.
The DIVArchive Media Name is array1.
The incomplete file processing strategy is Rename.
All incomplete folders will be renamed to failed_ + (original_file_name).
<folderConfig> <url>file:///\\divaserver\dropfolder</url> <type>set</type> <priority>50</priority> <categoryName>category3</categoryName> <incompleteThreshold>60</incompleteThreshold> <sourceDestinationDIVAName>CIFS1</sourceDestinationDIVAName> <sourceDestinationDIVAPath></sourceDestinationDIVAPath> <divaMediaName>array1</divaMediaName> <incompleteProcessingStrategy>Rename</incompleteProcessingStrategy> </folderConfig>
Using this configuration, if a set of files is copied into the DFM monitored CIFS folder named dropfolder, on the computer named divaserver, and has three files in the set with the names file1.ext, file2.ext, and filesetdata.mdf, they will be archived to a single object in DIVArchive with the following parameters:
Source/Destination: CIFS1
Object Name: filesetdata.ext
Category Name: category3
If the metadata file is not there, the set will be considered incomplete and the files will all be deleted after 60 seconds.
Use the following parameters to specify the wrapper log file tracing configuration in Program/conf/dfm/dfm.conf.
wrapper.logfile.loglevelThis parameter specifies the level of messages to be logged.
wrapper.logfile.maxsizeThis parameter specifies the maximum size of the log file in bytes, kilobytes, or megabytes.
wrapper.logfile.maxfilesThis parameter specifies the maximum log files count.
The valid logging levels are as follows:
This logging level produces no output.
This logging level produces only messages for irrecoverable errors.
This logging level produces all error messages.
This logging level produces all warning messages.
This logging level produces all state changes.
This logging level produces all JVM output and informative messages.
This logging level produces detailed debugging information.
The following is a sample log file configuration:
# Log Level for log file output. (See docs for log levels) wrapper.logfile.loglevel=INFO # Maximum size that the log file will be allowed to grow to before # the log is rolled. Size is specified in bytes. The default value # of 0 disables log rolling. May abbreviate with the 'k' (kb) or # 'm' (mb) suffix. For example: 10m = 10 megabytes. wrapper.logfile.maxsize=10m # Maximum number of rolled log files which will be allowed before # old files are deleted. The default value of 0 implies no limit. wrapper.logfile.maxfiles=4
Use the following parameters to specify the tracing configuration for DFM in the file Program/conf/dfm/dfm.trace:
This parameter specifies the level of messages to be logged.
This parameter specifies the maximum size of the log file in bytes, kilobytes, or megabytes.
The maximum lifetime of a logged item, in hours.
The following is a sample dfm.trace configuration:
--------------------------------------------------- # Levels can be: DEBUG, INFO, WARN, ERROR, FATAL LOGGING_TRACE_LEVEL=INFO LOGGING_MAXFILESIZE=7MB LOGGING_LIFETIME=50 ---------------------------------------------------
Caution:
The parameters in the following sections should not be altered unless required, and you are confident of having the ability to do so correctly. Misconfiguration of these parameters could result in an unstable, or non-functioning system, or both! Oracle recommends that you save the original configuration file to a different file name before making any modifications to the configuration (foe example,dfm.conf.original.ini).There are several groups of parameters for the configuration file as follows:
These parameters specify common behavior of DFM.
These parameters specify some default values for folder specific parameters.
These parameters specify folder specific parameters.
These parameters specify tracing parameters.
See Full DFM Configuration File (dfm.conf.ini) to view a sample of the full configuration file.
The DFM configuration XML provides the following elements for connections configuration:
<managerConnetion>This parameter specifies how DFM connects to the DIVArchive Manager. You are not required to define these options unless the DIVArchive system being connected to requires connection parameters outside of the default configuration.
For example:
<address host="..." port="..." userName="..." password="..." applicationName="..."/>
hostThis parameter is required and identifies the address of the DIVArchive Manager.
portThis parameter is required and identifies the port number where the DIVArchive Manager is listening. This must be a positive integer value.
userNameThis parameter is optional and identifies the user name to log in to the DIVArchive system. If the value is NULL or empty, DIVArchive uses the default user name and privileges from the DIVArchive system for this application.
passwordThis parameter is optional and identifies the password for the DIVArchive user. The connection is rejected if the provided password is incorrect.
applicationNameThis parameter is optional and identifies an arbitrary string that is interpreted by DIVArchive as an application name. This is used for information purposes only, and can be NULL or an empty string.
<serviceName>This parameter identifies the DFM Service Name for the currently installed instance. Spaces are not allowed within the Service Name. The Service Name will be DIVArchive DFM - serviceName. If you leave serviceName empty, the Service Name DIVArchive DFM is used.
<foibStateFile>This parameter identifies the file name of the File/Object Information Base dump.
<doibStateFile>This parameter identifies the file name of the Delete File/Object Information Base dump.
<fileReloadingThreshold>This parameter identifies the file reloading threshold in seconds. This interval specifies how often the File Monitor module reloads the state of the DFM folders. This setting must be a positive integer value between 1 and 10,000,000.
<fileReadyThreshold>This parameter identifies the time interval, in seconds. If the last modification time to a file remains unchanged after this interval, the file is marked as copied, and then archived. This setting must be a positive integer value between 1 and 10,000,000.
<dirDeleteThreshold>This parameter identifies the Directory Delete Threshold in seconds. This interval specifies how often the File Monitor module reloads the state of the DFM folders in Delete Mode, and commences with deletion. This setting must be a positive integer value between 1 and 10,000,000.
<fileDeleteThreshold>This parameter identifies the File Delete Threshold in seconds. This interval specifies when a file will be deleted after copying is complete for DFM folders in Delete Mode. This setting must be a positive integer value between 1 and 10,000,000.
<maxArchiveOperations>This parameter identifies the maximum number of simultaneous archive operations that DFM can perform. If the number of requests exceeds this threshold, pending requests must wait until all active archive operations are complete. This setting must be a positive integer value between 1 and 10,000,000.
<maxRejectCountInitializing>This parameter identifies the maximum number of archive retries that DFM can perform for requests rejected by DIVArchive during request initialization. Objects exceeding this limit are marked as incomplete. This setting must be a positive integer value between 1 and 10,000,000.
<maxRejectCountProcessing>This parameter identifies the maximum number of archive retries that DFM can perform for requests rejected by DIVArchive during request processing. Objects exceeding this limit are marked as incomplete. This setting must be a positive integer value between 1 and 10,000,000.
<pollingIntervalOfRequestState>This parameter specifies the frequency of object status polling in seconds. This setting must be a positive integer value between 1 and 10,000,000.
<repeatRequestDIVAThreshold>This parameter identifies the interval in seconds, before DIVArchive's Archive module will resubmit rejected requests. This setting must be a positive integer value between 1 and 10,000,000.
The Folders Default configuration parameter values are used for folders in a folder specific configuration when a parameter is not specified. All default values can be overridden within the folder specific configuration. The Folders Default configuration accepts the following parameters:
<type>There are two types of folders; Single File and File Set. To configure the folder for Single Files, specify single. To configure the folder for File Sets, specify set.
<mode>This parameter identifies the DFM folder work mode. This can be Archive or Delete.
<priority>This parameter identifies the default priority level of the requests for the folder. The folder priority range is 0 - 100. The value 0 is the lowest priority, and 100 is the highest.
<categoryName>This parameter identifies the default value for Category Name. This value will be provided to DIVArchive if it is not overridden in the folder specific configuration, or in the File Set metadata file.
<incompleteThreshold>This parameter identifies the Incomplete Threshold in seconds. This parameter specifies the maximum amount of time that a Single File, or File Set, can reside in the Drop Folder and not be archived before it is marked as incomplete. This must be a positive integer value between 1 and 10,000,000.
<sourceDestinationDIVAName>This parameter identifies the DIVArchive Source/Destination Name to use in the Archive request.
<sourceDestinationDIVAPath>This parameter identifies the DIVArchive Source/Destination Path to use in the Archive request.
<mdfExtension>This parameter identifies the extension of the metadata file for each folder.
<originalServer>This parameter identifies the DIVArchive Source/Destination to store in the object catalog if different from the actual Source/Destination. This is useful when you use an intermediate storage area for archiving, but want to store the original source for the data in the object catalog information.
<originalPath>This parameter identifies the DIVArchive File Root Path to store in the object catalog, if different from the actual File Root Path. This is useful when you use an intermediate storage area for archiving, but want to store the original source for the data in the object catalog information.
<incompleteProcessingStrategy>This parameter identifies the incomplete folder and file processing strategy. The value can be None, Delete, or Rename.
<numberFilesToArchiveWildcard>This parameter identifies the threshold for the number of files in the same folder. If the number of files in the folder becomes larger than the numberFilesToArchiveWildcard value, DFM sends the Archive request to the Manager using the asterisk wildcard for the entire folder. This value must be a positive integer.
<divaMediaNamePattern>The DIVArchive Media Name Pattern specifies the archive medium by extracting a part of the archive Root Path. This option is mutually exclusive with the divaMediaName option.
<deleteBeforeArchive>This parameter specifies whether DFM should delete the object from DIVArchive before the archive operation, if the object already exists. You can set this parameter to either TRUE or FALSE. This is an optional parameter and the default value is FALSE.
<objectNameConvertRule method="simple">Name.Ext</objectNameConvertRule>The value of <objectNameConvertRule> specifies the rule for the algorithm specified. In the current version of DFM, only the Simple conversion method is implemented. See the Object Name Conversion Rules: <objectNameConvertRules> section for the rule syntax for this method.
All folders monitored by DFM must be described in the configuration file. Folder Specific configuration accepts the following parameters:
<url>This parameter identifies the DFM folder URL. This is the monitored folder as viewed by the DFM process.
<type>There are two types of folders; Single File and File Set. To configure the folder for Single Files, specify single. To configure the folder for File Sets, specify set.
<mode>This parameter identifies the DFM folder work mode. This can be Archive or Delete.
<priority>This parameter identifies the default priority level of the requests for the folder. The folder priority range is 0 - 100. The value 0 is the lowest priority, and 100 is the highest.
<categoryName>This parameter identifies the default value for Category Name. This value will be provided to DIVArchive if it is not overridden in the File Set metadata file.
<incompleteThreshold>This parameter identifies the Incomplete Threshold in seconds. This parameter specifies the maximum amount of time that a Single File, or File Set, can reside in the Drop Folder and not be archived before it is marked as incomplete. This must be a positive integer value between 1 and 10,000,000.
<sourceDestinationDIVAName>This parameter identifies the DIVArchive Source/Destination Name to use in the Archive request.
<sourceDestinationDIVAPath>This parameter identifies the DIVArchive Source/Destination Path to use in the Archive request.
<divaMediaName>This parameter identifies the DIVArchive Media Name to use in the Archive request. This option is mutually exclusive with the divaMediaNamePattern option.
<mdfExtension>This parameter identifies the extension of the metadata file for each folder.
<originalServer>This parameter identifies the DIVArchive Source/Destination to store in the object catalog if different from the actual Source/Destination. This is useful when you use an intermediate storage area for archiving, but want to store the original source for the data in the object catalog information.
<originalPath>This parameter identifies the DIVArchive File Root Path to store in the object catalog, if different from the actual File Root Path. This is useful when you use an intermediate storage area for archiving, but want to store the original source for the data in the object catalog information.
<incompleteProcessingStrategy>This parameter identifies the incomplete folder and file processing strategy. The value can be None, Delete, or Rename.
<numberFilesToArchiveWildcard>This parameter identifies the threshold for the number of files in the same folder. If the number of files in the folder becomes larger than the numberFilesToArchiveWildcard value, DFM sends the Archive request to the Manager using the asterisk wildcard for the entire folder. This value must be a positive integer.
<divaMediaNamePattern>The DIVArchive Media Name Pattern specifies the archive medium by extracting a part of the archive Root Path. This option is mutually exclusive with the divaMediaName option.
<deleteBeforeArchive>This parameter specifies whether DFM should delete the object from DIVArchive before the archive operation, if the object already exists. You can set this parameter to either TRUE or FALSE. This is an optional parameter and the default value is FALSE.
<objectNameConvertRule method="simple">Name.Ext</objectNameConvertRule>The value of <objectNameConvertRule> specifies the rule for the algorithm specified. In the current version of DFM, only the Simple conversion method is implemented. See the Object Name Conversion Rules: <objectNameConvertRules> section for the rule syntax for this method.
The DFM configuration receives file information from the remote or local media (FTP server, shared directory, mounted drive, and so on). Based on the file name and folder, DFM generates the DIVArchive File Root Path and DIVArchive file name.
Long path names are supported on both Windows and Linux. Absolute path names are supported on both Windows and Linux to a maximum of 4000 characters. Relative path names are limited to 256 characters on Windows systems (only).
Because requirements for the DIVArchive file name vary, the system can either include or exclude, the parent folder in the file. The requirements for the path also vary because there are several ways the DIVArchive Actor can connect to the media.
You must specify the File Root Path in Single File Mode in the following format:
<archiveFilePathTemplate platform="DETECT" options="">URL_TO_FILE</archiveFilePathTemplate>
You must specify the file name in Single File Mode in the following format:
<archiveFileNameTemplate platform="DETECT" options="">filename.ext</archiveFileNameTemplate>
DFM monitors a DFM URL (FTP, CIFS, Windows disk, or Solaris disk). DFM obtains a File Full Path (for FTP, CIFS, Windows disk, or Solaris disk) for each incoming file.
File Full Path = DFM_URL\PARENTn ...\PARENT3\PARENT2\PARENT1\Filename.Ext
or
File Full Path = URL_TO_PARENTm\PARENTm ...\PARENT3\PARENT2\PARENT1\Filename.Ext
Note:
Your operating system determines whether you use/ or \ for these statements.<archiveFilePathTemplate platform="DETECT" options="">x:\ccc\ddd</archiveFilePathTemplate>
The format of the value is a combination of folder names, separators, and keywords for PARENTn, URL_TO_FILE, and URL_TO_PARENTm.
<archiveFileNameTemplate platform="DETECT" options="">filename.ext</archiveFileNameTemplate>
The format of the value is a combination of folder names, separators, and keywords for PARENTn, URL_TO_PARENTm, URL_TO_FILE, Filename.Ext, and Filename, where the platform is WIN, SOL, CIFS, or DETECT.
Available keywords are as follows:
This keyword identifies the folder name where the definition is located. For example:
DFM_FILE_FULL_PATH = DFM_URL\PARENTn ...\PARENT_3\PARENT_2\PARENT_1\Filename.ext
This keyword identifies the path from DFM_URL to PARENTm.
This keyword identifies the relative path from DFM_URL to the file.
This keyword identifies the original file name.
This keyword identifies the file name without the extension.
It is important to use the correct case in all of the following examples because the file name and extension parameters are case sensitive. For example, filename.ext is different than Filename.Ext.
The files are located in the root of DFM_URL.
The Drop Folder is on CIFS
The Actor is on Windows
DFM_URL = file:///\\aaa\bbb\ccc\ddd
File Full Path = \\aaa\bbb\ccc\ddd\fffffff.txt
The Actor sees the DFM URL as x:\ccc\ddd
The configuration will be as follows:
ARCHIVE_FILE_PATH_TEMPLATE = "x:\ccc\ddd" ARCHIVE_FILE_NAME_TEMPLATE = "Filename.Ext"
Filename.Ext must support both files without the extension, and specifies keeping the extension if there is one.
If some files are located in the root of the DFM_URL, and some are located in subfolders, the path length is not constant.
This can be addressed by using ARCHIVE_FILE_NAME_TEMPLATE = "URL_TO_FILE\Filename.Ext". When the URL_TO_FILE parameter is empty, DFM automatically removes the backslash character. An empty ARCHIVE_FILE_PATH_TEMPLATE value is supported.
The files are located one folder deeper than the root of the DFM URL, and the file names in the File List for the Archive request must not contain the folder names.
The Drop Folder is on FTP
When the DFM Drop Folder is configured on an FTP server, you must copy all content expected to be archived to the DFM Drop Folder using FTP. If you copy the content to the DFM Drop Folder by other means (local copy through the operating system, remote desktop copy, and so on) there is no guarantee of proper processing by DFM.
The Actor is on UNIX
DFM_URL = ftp://user:password@aaa/bbb/ccc/ddd
File Full Path = /aaa/bbb/ccc/ddd/eee/fffffff.txt
The Actor sees the DFM URL as /ccc/ddd
The configuration will be as follows:
ARCHIVE_FILE_PATH_TEMPLATE = "/ccc/ddd/PARENT1" ARCHIVE_FILE_NAME_TEMPLATE = "Filename.Ext"
You must address this using the ARCHIVE_FILE_PATH_TEMPLATE = "/ccc/ddd/URL_TO_FILE" parameter value.
The files are located one folder deeper than the root folder of the DFM URL, and the file names in the File List for the Archive request must contain the folder names.
The Drop Folder is on FTP
When the DFM Drop Folder is configured on an FTP server, you must copy all content expected to be archived to the DFM Drop Folder using FTP. If you copy the content to the DFM Drop Folder by other means (local copy through the operating system, remote desktop copy, and so on) there is no guarantee of proper processing by DFM.
The Actor is on UNIX
DFM_URL = ftp://user:password@aaa/bbb/ccc/ddd
File Full Path = /aaa/bbb/ccc/ddd/eee/fffffff.txt
The Actor sees the DFM URL as /ccc/ddd
The configuration will be as follows:
ARCHIVE_FILE_PATH_TEMPLATE = "/ccc/ddd" ARCHIVE_FILE_NAME_TEMPLATE = "PARENT1/Filename.Ext"
You must address this using the ARCHIVE_FILE_NAME_TEMPLATE = "URL_TO_FILE/Filename.Ext" parameter value.
The files are located in any number of directories deeper than the root of the DFM URL, and the file names in the File List for the Archive request must not contain the folder names.
The Drop Folder is on Windows
The Actor is on UNIX
DFM URL = file:///c:\aaa\bbb\ccc\ddd\
File Full Path = c:\aaa\bbb\ccc\ddd\p1\p2\p3\p4\p5\fffffff.txt
The Actor sees the DFM URL as root /
The configuration will be as follows:
ARCHIVE_FILE_PATH_TEMPLATE = "/URL_TO_FILE/" ARCHIVE_FILE_NAME_TEMPLATE = "Filename.Ext"
The files are located any number of directories deeper than the root of the DFM URL, and the file names in the File List for the Archive request must contain two folder names.
The Drop Folder is on Windows
The Actor is on UNIX
DFM URL = file:///c:\aaa\bbb\ccc\ddd\
File Full Path = c:\aaa\bbb\ccc\ddd\p1\p2\p3\p4\p5\fffffff.txt
The Actor sees the DFM URL as root /
The configuration will be as follows:
ARCHIVE_FILE_PATH_TEMPLATE = "/URL_TO_PARENT2/" ARCHIVE_FILE_NAME_TEMPLATE = "PARENT2/PARENT1/Filename.Ext"
Using the previous example with the assumption that the Actor points to the folder named ddd, the following is true:
DFM URL = file:///c:\aaa\bbb\ccc\ddd\
File Full Path = c:\aaa\bbb\ccc\ddd\p1\p2\p3\p4\p5\fffffff.txt
The Actor sees the DFM URL as root /ddd/
The configuration will be as follows:
ARCHIVE_FILE_PATH_TEMPLATE = "/ddd/URL_TO_PARENT2/" ARCHIVE_FILE_NAME_TEMPLATE = "PARENT2/PARENT1/Filename.Ext"
If DFM monitors the video server using FTP, the file must have a file extension, and the Actor will archive through the server interface without a file extension.
The file must be located in a single folder level
The Drop Folder is on FTP
When the DFM Drop Folder is configured on an FTP server, you must copy all content expected to be archived to the DFM Drop Folder using FTP. If you copy the content to the DFM Drop Folder by other means (local copy through the operating system, remote desktop copy, and so on) there is no guarantee of proper processing by DFM.
The Actor is using a special interface
DFM URL = ftp://user:password@aaa/bbb/ccc/ddd
File Full Path = /aaa/bbb/ccc/ddd/eee/fffffff.txt
The Actor sees the DFM URL as "special_#*:/ddd"
The configuration will be as follows:
ARCHIVE_FILE_PATH_TEMPLATE = "special_#*:/ddd/URL_TO_PARENT1" ARCHIVE_FILE_NAME_TEMPLATE = "PARENT1/Filename.Ext"
This is how the file extension is removed