Documentation Center

IWriteMetadataPlugin - OnFieldChangeSetMetadata

Sets a metadata field when a certain metadata field is changed. Optionally you can specify that the fields should only be set when the metadata field has changed from a certain value to a certain value.

Plugin Configuration

The following workset fields need to be configured:
Field NameField Level
The name of the field specified in the ConditionMetadataField parameterThe level of the field specified in the ConditionMetadataFieldLevel parameter
The name of the field specified in the SetMetadataField parameterThe level of the field specified in the SetMetadataFieldLevel parameter
The following parameters can be configured:
ParameterRequiredDefault valueAllowed valuesDescription
ConditionMetadataFieldYes  The metadata field that needs to be checked for changes. Only string fields are supported, number and date fields are not.
ConditionMetadataFieldLevelNolnglogical, version, lngThe metadata field level that needs to be checked for changes.
ConditionMetadataFieldValueTypeNovaluevalue, elementThe metadata field value type.
ConditionMetadataFieldFromValueNo  The current database value of the metadata field should match one of the given values before the SetMetadata will happen. Multiple values can be comma-space separated. If not provided, this means the database value can be anything.
ConditionMetadataFieldToValueNo  The current value of the metadata field should match one of the given values before the SetMetadata will happen. Multiple values can be comma-space separated. If not provided, this means the database value can be anything.
SetMetadataFieldYes  The metadata field to set. Date/number fields are not supported.
SetMetadataFieldLevelNolnglogical, version, lngThe level of the metadata field to set.
SetMetadataFieldValueTypeNovaluevalue, elementThe metadata field value type.
SetMetadataFieldOverwriteExistingNoYesYes, NoWhether to override when the field already has a value or not.
SetMetadataFieldValueNoThe metadata field value to set.
<plugin name="ISHDITADELIVERYSETDEPLOYINGDRAFT" handler="OnFieldChangeSetMetadata" ishcondition="ISHLevel='lng' and CurrentAction='SetMetadata' and ISHOutputFormat.FDITAOTTRANSTYPE='ishditadelivery'">
  <description>Changes the status of a Dynamic Delivery publication output from "Draft" to "Deploying Draft" to indicate it is still being deployed.</description>
  <workingset>
	<ishfields>
	  <ishfield name="FISHPUBSTATUS" level="lng" />
	</ishfields>
  </workingset>
  <initialize>
	<parameters>
	  <parameter name="ConditionMetadataField">FISHPUBSTATUS</parameter>
	  <parameter name="ConditionMetadataFieldLevel">lng</parameter>
	  <parameter name="ConditionMetadataFieldValueType">element</parameter>
	  <parameter name="ConditionMetadataFieldFromValue">VPUBSTATUSPUBLISHING</parameter>
	  <parameter name="ConditionMetadataFieldToValue">VPUBSTATUSPUBLISHEDDRAFT</parameter>
	  <parameter name="SetMetadataField">FISHPUBSTATUS</parameter>
	  <parameter name="SetMetadataFieldLevel">lng</parameter>
	  <parameter name="SetMetadataFieldValueType">element</parameter>
	  <parameter name="SetMetadataFieldOverwriteExisting">Yes</parameter>
	  <parameter name="SetMetadataFieldValue">VPUBSTATUSDEPLOYINGDRAFT</parameter>
	</parameters>
  </initialize>
</plugin>