The Copy Metadata Between Files and Transfer Metadata statements allow you additional granularity when copying Comments, User Defined Text Items and User Defined URLs. The Actions>Copy Metadata menu items also support the granularity via settings on the Configure Copy Metadata panel.
These statements take the granularity rules from a Multi Item Transfer Rules named variable. Note that prior to v8.0 of Yate, named variable Transfer UDTI Exclusions was used. Transfer UDTI Exclusions supported commas as delimiters. Multi Item Transfer Rules does not support commas.
When executing a Actions>Copy Metadata menu item, the optionally supplied exclusion/inclusion text is effectively in named variable Multi Item Transfer Rules.
All internal functionality which analyzes Multi Item Transfer Rules operates as follows:
When copying metadata via the Actions>Copy Metadata menu items, the optional supplied list of exclusions/inclusions follows the same formatting as the Multi Item Transfer Rules named variable.
The Multi Item Transfer Rules named variable is treated as follows:
Items are delimited by newline (\n) or default list delimiter (\~) sequences.
Case insensitive tokens can be entered to specify which field is associated with items which follow the token. These tokens can specify exclusion or inclusion. It is an error if there are items which are excluded and included for the same field type.
Initially items are treated as a list of UDTIs to be excluded from the copy/transfer. The following case insensitive tokens can be specified to switch the field type of the listed items:
- <-udtis>
Subsequent items are User Defined Text Info items marked for exclusion. This token is implied when parsing of the text commences.- udtis: deprecated
Same as <-udtis>.- <+udtis>
Subsequent items are User Defined Text Info items marked for inclusion.- <-urls>
Subsequent items are User Defined URLs marked for exclusion.- urls: deprecated
Same as <-urls>.- <+urls>
Subsequent items are User Defined URLs marked for inclusion.- <-comments>
Subsequent items are Comments marked for exclusion. See note 4.- comments: deprecated
Same as <-comments>.- <+commants>
Subsequent items are Comments marked for inclusion.
Note 1: When items are copied and the associated field type has a non zero number of exclusions or inclusions, the items copied are added to the destination. This differs from a normal copy where field types are entirely replaced. If you wish to override this behaviour, enter a <flush> token in the desired section. The presence of this token in a field type's list implies that all items of the field type in the destination of the copy are to be removed at the start of the copy. Example: include comments:,<empty>,<flush> will ensure that the destination has no comments other than those with an empty name.
Note 2: If the corresponding type is not effectively marked for copy/transfer, a section is ignored. For example if User Defined Text Info is not enabled, all udti tokens are ignored.
Note 3: Section header tokens which are not followed by items are ignored.
Note 4. As there is a default comment which typically has an empty name, you can specify <empty> to imply an unnamed (default) comment. For example if you only wanted to copy the unnamed (typically default) comment you could specify:
<+comments>
<empty>
Note 4. In Comments, the language property is used to determine uniqueness. However, when this list is used only names are evaluated and language is ignored.
Note 5. When configuring the named variable in an action statement, it might be easier to produce it on the Actions>Configure Copy Metadata panel as the exclusions/inclusions panel has a menu to insert the various tokens. You can copy the text and paste it into the appropriate text field in the action.
Note 6. If for any reason you have an item of the same name as one of the defined tokens, preceding it with a backslash (\) character will escape it. If you are specifying the content in an action you will have to enter \\.