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 name | Description |
|---|---|
ISHType | The type of the object: one of ISHMasterDoc, ISHModule, ISHIllustration, ISHTemplate or ISHLibrary. |
ISHLevel | Set this condition to one of
This condition has a slightly different effect for write plugins and for delete plugins:
|
OriginalLevel | This condition is only available for delete plugins. Set this condition to one of 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 |
FMAPID | The unique identifier of the logical level (that is, LogicalId). |
VERSION | The 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. |
EDT | The element name of the EDT (e.g. EDTXML) |
ISHUserGroup | The element names of the user groups which has write access to the object (e.g. VUSERGROUPSYSTEMMANAGEMENT) |
CurrentAction | The API method which is currently executed like Create, Update, Checkin, SetMetadata, CheckOut, UndoCheckOut and CreateTranslation. |
Supported conditions for publications
| Condition name | Description |
|---|---|
ISHType | The 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: 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 |
FMAPID | The unique identifier of the logical level (= LogicalId). |
VERSION | The version number of the publication. |
DOC-LANGUAGE | The language(s) of the publication output. |
FISHPUBLNGCOMBINATION | The 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
For example:
|
EDT | The element name of the EDT matching the output format (e.g. EDTZIP). |
ISHUserGroup | The user groups which has write access to the publication (e.g. VUSERGROUPSYSTEMMANAGEMENT) |
CurrentAction | The API method which is currently executed like Create and SetMetadata |
Supported conditions for annotations
| Condition name | Description |
|---|---|
ISHType | The type of the object, that is, ISHAnnotation. |
ISHUserGroup | The 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 |
CurrentAction | The API method that is currently being executed, like Create and Update |
Supported conditions for projects
| Condition name | Description |
|---|---|
ISHType | The type of the object, that is, ISHProject. |
ISHUserGroup | The user group that has write access to the project (e.g. VUSERGROUPSYSTEMMANAGEMENT) |
ISHLevel | Theoretically, 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. |
CurrentAction | The API method which is currently executed, like Create and Update |
Supported conditions for baselines
| Condition name | Description |
|---|---|
ISHType | The type of the object, that is, ISHBaseline. |
ISHUserGroup | The user group or groups which have write access to the baseline (e.g. VUSERGROUPSYSTEMMANAGEMENT) |
ISHLevel | Theoretically, 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. |
CurrentAction | The API method which is currently executed, like Create, SetMetadata and Update |
NAME | The 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 If you set this field to |
FISHLABELRELEASED | If you don't set this field, the plugin runs for both released and unreleased baselines. If you set this field to If you set this field to |