Write plugins - Out-of-the-box implementations
The IWrite plugin category modifies database objects.
- IWriteMetadataAndBlobPlugin - BlobCompareValue
Compares whether 2 values are the same or not. If not, a DifferentValuesFoundException is thrown. If one or both values contain a nodelist, all node.InnerText strings should match the other value. - IWriteMetadataAndBlobPlugin - BlobConvertTableConditions
Used to copy table conditions to the cells in the table. For DITA, this plugin copies "ishcondition" attributes from the table header (or from the first table row if there is no header) to all colspec and entry elements in the same column. Note that, for DITA, this plugin only works on 'table' elements, not on 'simpletable' elements. - IWriteMetadataAndBlobPlugin - BlobExtractConditions
Extracts all condition names and values used in the document and stores them in metadata. When syntactically incorrect conditions are found, it either logs a warning or throws an error. The resulting metadata contains something like e.g. MODEL:330, MODEL:660, GPRS:Y - IWriteMetadataAndBlobPlugin - BlobExtractDITAConrefs
Extracts conref and conref range targets into the FISHFRAGMENTLINKS and FISHLINKS metadata fields. - IWriteMetadataAndBlobPlugin - BlobExtractFirstMetadata
Copies the InnerXml or InnerText of the first node in the XML content that matches one of the XPath expressions provided in the ExtractXPath* parameters towards the appropriate repository metadata fields (specified by the MetadataField and MetadataFieldLevel parameters). - IWriteMetadataAndBlobPlugin - BlobExtractHyperlinks
Copies the hyperlinks found in the XML content (ExtractXPath parameter) towards the appropriate repository metadata fields (specified by the MetadataField and MetadataFieldLevel parameters). - IWriteMetadataAndBlobPlugin - BlobExtractMetadata
Copies the information found in the XML content (ExtractXPath parameter) towards the appropriate repository metadata fields (specified by the MetadataField and MetadataFieldLevel parameters). - IWriteMetadataAndBlobPlugin - BlobExtractXPath
Searches for attributes containing XPath expressions and execute them to extract information from the XML content towards the appropriate repository metadata fields (specified by the MetadataField and MetadataFieldLevel parameters). - IWriteMetadataAndBlobPlugin - BlobNormalizeDITAKeyrefs
Uppercases the key and/or anchor part of the DITA keys, keyref and conkeyref attributes and gives warnings when the key part contains illegal characters. - IWriteMetadataAndBlobPlugin - BlobRemoveXmlNode
Removes unwanted nodes from the content. - IWriteMetadataAndBlobPlugin - BlobSendEvent
Adds the event to the event queue. - IWriteMetadataAndBlobPlugin - BlobSetXmlNode
Sets the text of all the XML nodes (elements or attributes) specified in the OnNodeXPath parameter to the given value. When the nodes or attributes do not exist, they are created. When the nodes already contain text, the OverWrite parameter will allow to overwrite or not. - IWriteMetadataAndBlobPlugin - BlobValidate
Checks whether the XML content is valid against a DTD. - IWriteMetadataAndBlobPlugin - BlobWordCount
Updates the given metadata field with the word count. - IWriteMetadataAndBlobPlugin - SynchronizeToLiveContent
Adds the ISHSYNCHRONIZETOLIVECONTENT event to the event queue. - IWriteMetadataPlugin - MetadataBindingValidation
Executed when metadata is changed. It always validates the values of the fields defined in the FieldsToValidate parameter, regardless of whether they were changed or not. - IWriteMetadataPlugin - CopyField
Copies the value of the metadata field to another metadata field. - IWriteMetadataPlugin - OnFieldChangeCompare
Checks whether a certain metadata field value is empty or not empty when another field is changed. Optionally you can specify that the compare should only happen when the metadata field changed from a certain value to a certain value. If the value is not what it is supposed to be a ValueEmptyException or ValueNotEmptyException is raised. - IWriteMetadataPlugin - OnFieldChangeMetadataBindingValidation
Executed when metadata is changed. It only validates the values of the fields defined in the FieldsToValidate parameter for which the values changed. - IWriteMetadataPlugin - OnFieldChangeSendEvent
Sends an event when a certain metadata field is changed. Optionally you can specify that the event should only be sent when the metadata field changed from a certain value to a certain value. - IWriteMetadataPlugin - OnMultiFieldChangeSendEvent
Sends an event when one of the fields of theConditionChangedMetadataparameter is changed and other conditions are met. - IWriteMetadataPlugin - OnFieldChangeSendStateTransitionEvent
Sends an STATETRANSITION event when a certain metadata field is changed. Optionally you can specify that the event should only be sent when the metadata field has changed from a certain value to a certain value. This plugin differs from the OnFieldChangeSendEvent in the sense that the eventname is fixed to '[STATETRANSITION]_[FSTATUS Original Value]_[FSTATUS Current Value]' and that the eventdata contains a 'Transitions' XML instead of an 'ishobject' XML. The 'Transitions' event data XML is the XML that is expected by the component(=cNotification IEventHandler plugin) that can be used for sending emails. - IWriteMetadataPlugin - OnFieldChangeSetDate
Sets a date field when a certain metadata field is changed. Optionally you can specify that the date should only be set when the metadata field has changed from a certain value to a certain value. - 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. - IWriteMetadataPlugin - RaisePublishEvent
Sends a publish event with the configured event type when the publication status is changed to 'Pending'. - IWriteMetadataPlugin - RaiseUnpublishEvent
Sends a unpublish event with the configured event type when the publication status is changed to 'Unpublish pending'.