Documentation Center

Supported conditions for Admin.XMLWriteObjPluginConfig.xml and Admin.XMLDeleteObjPluginConfig.xml

A list of condition names to determine if the plugin must be executed, for different object types.

Supported conditions for topics, maps, illustrations, libraries and templates

Condition nameDescription
ISHTypeThe type of the object: one of ISHMasterDoc, ISHModule, ISHIllustration, ISHTemplate or ISHLibrary.
ISHLevel

Set this condition to one of logical, version or lng.

This condition has a slightly different effect for write plugins and for delete plugins:
Write plugins
When you modify an object on one level (logical, version or language) and apply your change, the write plugin behaves as if the object was changed on all levels. For example, imagine that you have created two write plugins, one with ISHLevel set to logical, and another with ISHLevel set to lng. Now, a user modifies an item on the language level and applies the change. The result is that all levels (language, version and logical) are considered to have been updated, and therefore, both plugins get triggered.
Delete plugins
Item deletion has several cascade effects:
  • deleting an item on a higher level (say, logical) triggers deletion of the lower-level items (in this case, all versions of the logical object, and all language items of each version)
  • deleting the last remaining item on a lower level (say, deleting the last remaining version of a logical object) triggers deletion of the higher-level item (in this case, the logical object itself).
These cascade effects trigger not only deletion on different levels, but also the delete plugins for those levels. For example, if I delete a version, I trigger the delete plugin whose ISHLevel is version. But I also trigger the deletion of all language items within that version, which in turn triggers the delete plugins whose ISHLevel is lng. I can use the OriginalLevel condition to stop this indirect triggering of delete plugins from happening.
OriginalLevel

This condition is only available for delete plugins.

Set this condition to one of logical, version and lng.

When you delete a logical object, this action triggers the deletion of all version items and all language items of that logical object. But as for delete plugins, only those delete plugins whose OriginalLevel condition is set to logical (or not set at all) will execute.

FMAPIDThe unique identifier of the logical level (that is, LogicalId).
VERSIONThe version number of the object.
DOC-LANGUAGE

The language(s) of the object.

FSOURCELANGUAGE

The source language of the object.

FRESOLUTION

The resolution of the illustration.

EDTThe element name of the EDT (e.g. EDTXML)
ISHUserGroupThe element names of the user groups which has write access to the object (e.g. VUSERGROUPSYSTEMMANAGEMENT)
CurrentActionThe API method which is currently executed like Create, Update, Checkin, SetMetadata, CheckOut, UndoCheckOut and CreateTranslation.

Supported conditions for publications

Condition nameDescription
ISHTypeThe type of the object, that is, ISHPublication.
ISHLevel This controls when to execute the plugin depending on the level of metadata that are updated.

The allowed values are: logical, version and lng.

When updating the language level metadata, the system operates as if the metadata from all levels are updated.

This means that in this update context, the ISHLevel condition will be true for all allowed values.

FMAPIDThe unique identifier of the logical level (= LogicalId).
VERSIONThe version number of the publication.
DOC-LANGUAGE

The language(s) of the publication output.

FISHPUBLNGCOMBINATIONThe language combination of the publication output (e.g. en+fr+de).
FISHOUTPUTFORMATREF

The output format of the publication output.

ISHOutputFormat

The output format of the publication output.

ISHOutputFormat.*

All fields from the output format of the publication output. The condition name is the element name of the field prefixed by ISHOutputFormat.

For example:
  • ISHOutputFormat.FISHOUTPUTEDT: The label (e.g. ZIP) and the element name (e.g. EDTZIP) of the EDT linked with the output format.
  • ISHOutputFormat.FDITAOTTRANSTYPE: The value for the DITA-OT transformation type (e.g. ishditadelivery).
EDTThe element name of the EDT matching the output format (e.g. EDTZIP).
ISHUserGroupThe user groups which has write access to the publication (e.g. VUSERGROUPSYSTEMMANAGEMENT)
CurrentActionThe API method which is currently executed like Create and SetMetadata

Supported conditions for annotations

Condition nameDescription
ISHTypeThe type of the object, that is, ISHAnnotation.
ISHUserGroupThe user group that has write access to the annotation (e.g. VUSERGROUPSYSTEMMANAGEMENT)
ISHLevel

This controls when to execute the plugin, depending on the level of metadata that is updated.

The allowed values are annotation and reply.

CurrentActionThe API method that is currently being executed, like Create and Update

Supported conditions for projects

Condition nameDescription
ISHTypeThe type of the object, that is, ISHProject.
ISHUserGroupThe user group that has write access to the project (e.g. VUSERGROUPSYSTEMMANAGEMENT)
ISHLevelTheoretically, this controls when to execute the plugin, depending on the level of metadata that is updated. In practice, however, projects only allow the value project.
CurrentActionThe API method which is currently executed, like Create and Update

Supported conditions for baselines

Condition nameDescription
ISHTypeThe type of the object, that is, ISHBaseline.
ISHUserGroupThe user group or groups which have write access to the baseline (e.g. VUSERGROUPSYSTEMMANAGEMENT)
ISHLevelTheoretically, this controls when to execute the plugin, depending on the level of metadata that is updated. In practice, however, baselines only allow the value none.
CurrentActionThe API method which is currently executed, like Create, SetMetadata and Update
NAMEThe unique label of the baseline (e.g. Publication MP330-v1-GUID-789BBB3D-8A09-4916-8857-09A246CB6F59-2012/09/21 12:27:01)
FISHBASELINEACTIVE

If you don't set this field, the plugin runs for both active and inactive baselines.

If you set this field to TRUE, the plugin runs for active baselines only.

If you set this field to FALSE, the plugin runs for inactive baselines only.

FISHLABELRELEASED

If you don't set this field, the plugin runs for both released and unreleased baselines.

If you set this field to TRUE, the plugin runs for released baselines only.

If you set this field to FALSE, the plugin runs for unreleased baselines only.